Re: xml2po Error !
- From: Karam Qubsi <karamqubsi gmail com>
- To: jwcampbell gmail com
- Cc: Shaun McCance <shaunm gnome org>, gnome-doc-devel-list gnome org
- Subject: Re: xml2po Error !
- Date: Sat, 21 Jul 2012 01:32:35 +0300
Thank you all
Thank you Jim
Thank you Shaun
I'm now using "itstool"
thank you to inform me about it
I follow the instruction in :
Extract
ITS Tool will scan your XML files and generate a POT (PO template) file. You can edit this file directory, or use tools like msgmerge to merge its messages into an existing PO file. To create a POT file, simply pass a list of XML files to itstool on the command line. By default, itstool simply outputs to standard output. Use the -o option to specify an output file.
For example, to generate a POT file called mydoc.pot from all the Mallard page files in a directory:
itstool -o mydoc.pot *.page
but as you can see in the terminal it gave me the following
what is the problem ?
# itstool -o mydoc.pot *.xml
Error: Could not parse document:
manual.xml:1961: parser error : Entity 'lsquo' not defined
<para>This preference allows for ‘Personal Name
^
manual.xml:1985: parser error : Entity 'lsquo' not defined
for ‘Personal Name Authorities' to replace authors as
^
manual.xml:1988: parser error : Entity 'lsquo' not defined
will only be used if ‘z3950NormalizeAuthor' is set to
^
manual.xml:1989: parser error : Entity 'ldquo' not defined
“Copy". The default field are 700, 701, and 702.</para>
^
manual.xml:2211: parser error : Entity 'ldquo' not defined
as “not for loan". Setting it to “Allow" would
^
manual.xml:2211: parser error : Entity 'ldquo' not defined
as “not for loan". Setting it to “Allow" would
^
manual.xml:2212: parser error : Entity 'ldquo' not defined
allow such items to be checked out, setting it to “Don't
^
manual.xml:2247: parser error : Entity 'ldquo' not defined
of times an item can be renewed. Setting it to “Allow"
^
manual.xml:2249: parser error : Entity 'ldquo' not defined
“Don't allow" would prevent this. This is a preference
^
manual.xml:2250: parser error : Entity 'ldquo' not defined
in which if it is set to “allow" it would allow the
^
manual.xml:2252: parser error : Entity 'ldquo' not defined
limit for special cases, setting it to “Don't allow"
^
manual.xml:2284: parser error : Entity 'ldquo' not defined
or not. If set to “Don't", the staff member checking an
^
manual.xml:2288: parser error : Entity 'ldquo' not defined
location) or returned. Setting it to “Do" will ensure
^
manual.xml:2617: parser error : Entity 'ldquo' not defined
this is set to “Require", then a due date of any checked
^
manual.xml:2619: parser error : Entity 'ldquo' not defined
patron's card expiration. If the setting is left “Don't
^
manual.xml:2818: parser error : Entity 'ldquo' not defined
calendar and mark certain days as “holidays" ahead of
^
manual.xml:2912: parser error : Entity 'ldquo' not defined
marked as “damaged" (items are marked as damaged by
^
manual.xml:2914: parser error : Entity 'ldquo' not defined
“Don't allow" will prevent anyone from placing a hold on
^
manual.xml:2915: parser error : Entity 'ldquo' not defined
such items, setting it to “Allow" will allow it. This
^
manual.xml:2919: parser error : Entity 'ldquo' not defined
library may wish to set this to “Don't allow" if they
^
manual.xml:2922: parser error : Entity 'ldquo' not defined
beyond repair). Setting it to “Allow" would allow a
^
manual.xml:2956: parser error : Entity 'ldquo' not defined
Setting this value to “Don't allow" will prevent anyone
^
manual.xml:2957: parser error : Entity 'ldquo' not defined
from overriding, setting it to “Allow" will allow it.
^
manual.xml:2960: parser error : Entity 'ldquo' not defined
“Allow", exceptions can be made for patrons who are
^
manual.xml:2963: parser error : Entity 'ldquo' not defined
it is set to “Don't allow", no abuse of the system is
^
manual.xml:2996: parser error : Entity 'ldquo' not defined
currently checked out. Setting it to “Don't allow"
^
manual.xml:2999: parser error : Entity 'ldquo' not defined
in the library), setting it to “Allow" allows borrowers
^
manual.xml:3005: parser error : Entity 'ldquo' not defined
from home through the OPAC. Setting it to “Don't allow"
^
manual.xml:3059: parser error : Entity 'ldquo' not defined
If the preference is set to “Allow" patrons can place
^
manual.xml:3060: parser error : Entity 'ldquo' not defined
such holds, if it is set to “Don't allow" they cannot.
^
manual.xml:3066: parser error : Entity 'ldquo' not defined
“Don't allow".</para>
^
manual.xml:3357: parser error : Entity 'lsquo' not defined
<para>This preference refers to ‘item specific' holds
^
manual.xml:3359: parser error : Entity 'lsquo' not defined
preference allows a library to decide whether an ‘item
^
manual.xml:3360: parser error : Entity 'ldquo' not defined
specific' hold is marked as “Waiting" at the time the
^
manual.xml:3362: parser error : Entity 'ldquo' not defined
“Waiting" after the item is checked in. This preference
^
manual.xml:3363: parser error : Entity 'lsquo' not defined
will tell the patron that their item is ‘Waiting' for
^
manual.xml:3392: parser error : Entity 'ldquo' not defined
If the RandomizeHoldsQueueWeight is set as “in random
^
manual.xml:3528: parser error : Entity 'ldquo' not defined
the circulation input field. Setting it to “Try" would
^
manual.xml:3531: parser error : Entity 'ldquo' not defined
completing it. Setting it to “Don't try" would disable
^
manual.xml:3893: parser error : Entity 'ldquo' not defined
circumstance. The “Allow" setting would allow for this
^
manual.xml:3894: parser error : Entity 'ldquo' not defined
option to be utilized by staff, the “Don't allow"
^
manual.xml:4358: parser error : Entity 'ldquo' not defined
OPAC; the 'FRBRizeEditions' option must be turned “On"
^
manual.xml:4972: parser error : Entity 'egrave' not defined
<title>Babelthèque</title>
^
manual.xml:4982: parser error : Entity 'egrave' not defined
citations) from Babelthèque in item detail pages on the
^
manual.xml:5014: parser error : Entity 'egrave' not defined
<screeninfo>Data from Babelthèque on the bib
^
manual.xml:5114: parser error : Entity 'ldquo' not defined
“My Library Bookstore." In order to participate in this
^
manual.xml:5127: parser error : Entity 'ldquo' not defined
the URL. The “key" value (key=) should be appended to
^
manual.xml:5156: parser error : Entity 'eacute' not defined
paid subscription to the external Content Café service
^
manual.xml:5158: parser error : Entity 'eacute' not defined
library's Content Café username and password. Also,
^
manual.xml:5163: parser error : Entity 'eacute' not defined
settings are properly set. The Content Café service is
^
manual.xml:5252: parser error : Entity 'ldquo' not defined
<para>Set to 'Use' to display an “Editions" tab on the
^
manual.xml:5641: parser error : Entity 'ldquo' not defined
<para>Set to 'Use' to display an “Editions" tab on the
^
manual.xml:6938: parser error : Entity 'ldquo' not defined
“Don't show," the lost item is not shown on the OPAC. By
^
manual.xml:6939: parser error : Entity 'ldquo' not defined
setting the value “Show," the lost item is shown on the
^
manual.xml:7495: parser error : Entity 'ldquo' not defined
users. When this preference is switched to “Show" the
^
manual.xml:8034: parser error : Entity 'lsquo' not defined
‘opaclayoutstylesheet' or ‘opacstylesheet'. Styles
^
manual.xml:8034: parser error : Entity 'lsquo' not defined
‘opaclayoutstylesheet' or ‘opacstylesheet'. Styles
^
manual.xml:8296: parser error : Entity 'ldquo' not defined
preference to “Allow" patrons can use this search link
^
manual.xml:8629: parser error : Entity 'ldquo' not defined
show the “Most Popular" link at the top of the OPAC
^
manual.xml:8630: parser error : Entity 'ldquo' not defined
under the search box. The “Most Popular" page shows the
^
manual.xml:8747: parser error : Entity 'ldquo' not defined
to “Allow" reviews are first sent to the staff client
^
manual.xml:9332: parser error : Entity 'ldquo' not defined
their system. If the preference is set to “Don't allow"
^
manual.xml:9334: parser error : Entity 'ldquo' not defined
On the “Home" screen of the OPAC users have the choice
^
manual.xml:9336: parser error : Entity 'ldquo' not defined
preference to “Allow" will display only one branch's
^
manual.xml:10372: parser error : Entity 'ldquo' not defined
example, a search for the word “invent" with auto
^
manual.xml:10376: parser error : Entity 'ldquo' not defined
manually by adding an asterisk (*). Typing “invent*"
^
manual.xml:10410: parser error : Entity 'ldquo' not defined
<para>This preference enables “fuzzy" searching, in
^
manual.xml:11217: parser error : Entity 'ldquo' not defined
enabled or disabled for the library. When set to “Add",
^
manual.xml:11330: parser error : Entity 'lsquo' not defined
‘brief' option displays a one-line summary of the volume
^
manual.xml:11332: parser error : Entity 'lsquo' not defined
library. The ‘full' option displays a more detailed
^
manual.xml:12090: parser error : Entity 'lsquo' not defined
‘participants': Data Providers and Service Providers.
^
manual.xml:16833: parser error : Entity 'pound' not defined
ilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: £
^
manual.xml:16834: parser error : Entity 'pound' not defined
es, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: £
^
manual.xml:25338: parser error : Entity 'nbsp' not defined
item. Learn more about Analytics in Chapter 13 of AACR2.</para>
^
manual.xml:35914: parser error : Entity 'lsquo' not defined
marked as ‘not for loan'</para>
^
manual.xml:35937: parser error : Entity 'lsquo' not defined
‘Calculate and Charge' before go live if you charge
^
manual.xml:36844: parser error : Entity 'egrave' not defined
linkend="Babelthequeprefs">Babelthèque</link></para>
^
manual.xml:36848: parser error : Entity 'egrave' not defined
<para>This is a pay service. Contact Babelthèque to learn
^
manual.xml:37101: parser error : Entity 'eacute' not defined
<firstname>Jean-André</firstname>
^
manual.xml:38648: parser error : Entity 'eacute' not defined
<subfield code="a">Guide des récifs coralliens / A Guide to Coral R
^
manual.xml:38649: parser error : Entity 'eacute' not defined
<subfield code="b">Texte imprimé</subfield>
^
manual.xml:38656: parser error : Entity 'eacute' not defined
<subfield code="c">Delachaux et Niestlé</subfield>
^
manual.xml:39008: parser error : Entity 'infin' not defined
ogue/search.pl?op=do_search{&q=461t&idx=ti}">{461t}</a>{N&infin
^
manual.xml:39135: parser error : Entity 'nbsp' not defined
{995y}</td><td>{995e} </td><td>
^
manual.xml:39135: parser error : Entity 'nbsp' not defined
{995y}</td><td>{995e} </td><td>
^
manual.xml:40597: parser error : Entity 'nbsp' not defined
<para>To prepend data the special character is: ^b To simply
^
manual.xml:41410: parser error : Entity 'ldquo' not defined
just returns a little message that says “renewal failed". Any
^
manual.xml:42125: parser error : Entity 'lsquo' not defined
between a keyword search using the ‘*’ (asterisk) versus
^
manual.xml:42125: parser error : Entity 'rsquor' not defined
between a keyword search using the ‘*’ (asterisk) versus
^
manual.xml:42126: parser error : Entity 'lsquo' not defined
a keyword search using the ‘%’ (percent)? Both work in
^
manual.xml:42126: parser error : Entity 'rsquor' not defined
a keyword search using the ‘%’ (percent)? Both work in
^
manual.xml:42132: parser error : Entity 'lsquo' not defined
in Koha searches are the asterisk (‘*’) and the percent
^
manual.xml:42132: parser error : Entity 'rsquor' not defined
in Koha searches are the asterisk (‘*’) and the percent
^
manual.xml:42133: parser error : Entity 'lsquo' not defined
sign (‘%’). However, these two characters act differently
^
manual.xml:42133: parser error : Entity 'rsquor' not defined
sign (‘%’). However, these two characters act differently
^
manual.xml:42136: parser error : Entity 'lsquo' not defined
<para>The ‘*’ is going to force a more exact search of
^
manual.xml:42136: parser error : Entity 'rsquor' not defined
<para>The ‘*’ is going to force a more exact search of
^
manual.xml:42137: parser error : Entity 'lsquo' not defined
the first few characters you enter prior to the ‘*’. The
^
manual.xml:42137: parser error : Entity 'rsquor' not defined
the first few characters you enter prior to the ‘*’. The
^
manual.xml:42144: parser error : Entity 'lsquo' not defined
<para>The ‘%’ will treat the words you enter in the terms
^
manual.xml:42144: parser error : Entity 'rsquor' not defined
<para>The ‘%’ will treat the words you enter in the terms
^
manual.xml:42145: parser error : Entity 'ldquo' not defined
of “is like”. So a search of Smi% will search for words
^
manual.xml:42145: parser error : Entity 'rdquor' not defined
of “is like”. So a search of Smi% will search for words
^
manual.xml:42151: parser error : Entity 'lsquo' not defined
<para>The bottom line in searching with wildcards: ‘*’ is
^
manual.xml:42151: parser error : Entity 'rsquor' not defined
<para>The bottom line in searching with wildcards: ‘*’ is
^
manual.xml:42152: parser error : Entity 'lsquo' not defined
more exact while ‘%’ searches for like terms.</para>
^
manual.xml:42152: parser error : Entity 'rsquor' not defined
more exact while ‘%’ searches for like terms.</para>
^
manual.xml:42356: parser error : Entity 'nbsp' not defined
truncate session table: </para>
^
manual.xml:42585: parser error : Entity 'copy' not defined
<para>Copyright © 2007 Free Software Foundation, Inc. <ulink
^
manual.xml:42600: parser error : Entity 'mdash' not defined
program—to make sure it remains free software for all its users. We,
^
manual.xml:42661: parser error : Entity 'ldquo' not defined
<para>“This License" refers to version 3 of the
^
manual.xml:42664: parser error : Entity 'ldquo' not defined
<para>“Copyright" also means copyright-like laws that apply to other
^
manual.xml:42667: parser error : Entity 'ldquo' not defined
<para>“The Program" refers to any copyrightable work licensed under
^
manual.xml:42668: parser error : Entity 'ldquo' not defined
this License. Each licensee is addressed as “you". “Licensees"
^
manual.xml:42668: parser error : Entity 'ldquo' not defined
this License. Each licensee is addressed as “you". “Licensees"
^
manual.xml:42669: parser error : Entity 'ldquo' not defined
and “recipients" may be individuals or organizations.</para>
^
manual.xml:42671: parser error : Entity 'ldquo' not defined
<para>To “modify" a work means to copy from or adapt all or part of
^
manual.xml:42673: parser error : Entity 'ldquo' not defined
making of an exact copy. The resulting work is called a “modified
^
manual.xml:42674: parser error : Entity 'ldquo' not defined
version" of the earlier work or a work “based on" the earlier
^
manual.xml:42677: parser error : Entity 'ldquo' not defined
<para>A “covered work" means either the unmodified Program or a work
^
manual.xml:42680: parser error : Entity 'ldquo' not defined
<para>To “propagate" a work means to do anything with it that,
^
manual.xml:42687: parser error : Entity 'ldquo' not defined
<para>To “convey" a work means any kind of propagation that enables
^
manual.xml:42692: parser error : Entity 'ldquo' not defined
<para>An interactive user interface displays “Appropriate Legal
^
manual.xml:42703: parser error : Entity 'ldquo' not defined
<para>The “source code" for a work means the preferred form of the
^
manual.xml:42704: parser error : Entity 'ldquo' not defined
work for making modifications to it. “Object code" means any
^
manual.xml:42707: parser error : Entity 'ldquo' not defined
<para>A “Standard Interface" means an interface that either is an
^
manual.xml:42712: parser error : Entity 'ldquo' not defined
<para>The “System Libraries" of an executable work include anything,
^
manual.xml:42718: parser error : Entity 'ldquo' not defined
“Major Component", in this context, means a major essential
^
manual.xml:42723: parser error : Entity 'ldquo' not defined
<para>The “Corresponding Source" for a work in object code form
^
manual.xml:42815: parser error : Entity 'ldquo' not defined
This requirement modifies the requirement in section 4 to “keep
^
manual.xml:42841: parser error : Entity 'ldquo' not defined
“aggregate" if the compilation and its resulting copyright are not
^
manual.xml:42912: parser error : Entity 'ldquo' not defined
<para>A “User Product" is either (1) a “consumer product",
^
manual.xml:42912: parser error : Entity 'ldquo' not defined
<para>A “User Product" is either (1) a “consumer product",
^
manual.xml:42917: parser error : Entity 'ldquo' not defined
For a particular product received by a particular user, “normally
^
manual.xml:42925: parser error : Entity 'ldquo' not defined
<para>“Installation Information" for a User Product means any
^
manual.xml:42961: parser error : Entity 'ldquo' not defined
<para>“Additional permissions" are terms that supplement the terms
^
manual.xml:43019: parser error : Entity 'ldquo' not defined
“further restrictions" within the meaning of section 10. If the
^
manual.xml:43085: parser error : Entity 'ldquo' not defined
<para>An “entity transaction" is a transaction transferring control
^
manual.xml:43105: parser error : Entity 'ldquo' not defined
<para>A “contributor" is a copyright holder who authorizes use under
^
manual.xml:43107: parser error : Entity 'ldquo' not defined
work thus licensed is called the contributor's “contributor
^
manual.xml:43110: parser error : Entity 'ldquo' not defined
<para>A contributor's “essential patent claims" are all patent
^
manual.xml:43116: parser error : Entity 'ldquo' not defined
definition, “control" includes the right to grant patent sublicenses
^
manual.xml:43124: parser error : Entity 'ldquo' not defined
<para>In the following three paragraphs, a “patent license" is any
^
manual.xml:43127: parser error : Entity 'ldquo' not defined
to sue for patent infringement). To “grant" such a patent license to
^
manual.xml:43139: parser error : Entity 'ldquo' not defined
recipients. “Knowingly relying" means you have actual knowledge
^
manual.xml:43153: parser error : Entity 'ldquo' not defined
<para>A patent license is “discriminatory" if it does not include
^
manual.xml:43207: parser error : Entity 'ldquo' not defined
<acronym>GNU</acronym> General Public License “or any later version"
^
manual.xml:43229: parser error : Entity 'ldquo' not defined
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS" WITHOUT
^
manual.xml:43272: parser error : Entity 'ldquo' not defined
“copyright" line and a pointer to where the full notice is
^
manual.xml:43302: parser error : Entity 'lsquo' not defined
This program comes with ABSOLUTELY NO WARRANTY; for details type ‘<literal
^
manual.xml:43304: parser error : Entity 'lsquo' not defined
under certain conditions; type ‘<literal>show c</literal>' for details.
^
manual.xml:43307: parser error : Entity 'lsquo' not defined
<para>The hypothetical commands ‘<literal>show w</literal>' and
^
manual.xml:43308: parser error : Entity 'lsquo' not defined
‘<literal>show c</literal>' should show the appropriate parts of the
^
manual.xml:43310: parser error : Entity 'ldquo' not defined
different; for a GUI interface, you would use an “about box".</para>
^
manual.xml:43313: parser error : Entity 'ldquo' not defined
school, if any, to sign a “copyright disclaimer" for the program, if
^
I'm using itstool 1.2.0
on debian
and the xml file is docbook file
and its attached in this email :)
--
Karam Qubsi
Koha Arab Translating Team
http://koha.wikibrary.org/Wikibrary for Arab Librarians
http://wikibrary.org
On Wed, Jul 18, 2012 at 8:29 PM, Shaun McCance
<shaunm gnome org> wrote:
On Wed, 2012-07-18 at 10:42 +0300, Karam Qubsi wrote:
> Hi All ,
>
>
> I don't know what is the problem
>
>
> I installed the gnome docs utilities
> and the process of generating the pot and po files from the xml
> (docbook) is done successfully
>
>
> but when try to convert the po to xml !
Hi Karam,
This looks like a problem with the po file, though I can't
be sure without looking at it. Can you run msgfmt on the
po file without errors?
Also, xml2po isn't actively developed anymore. You should
try using itstool instead.
http://itstool.org/
> from termenal :
> xml2po -p manual.ar.po -o manual.ar.xml manual.xml
>
>
> the resulte :
> Traceback (most recent call last):
> File "/usr/bin/xml2po", line 191, in <module>
> main(sys.argv[1:])
> File "/usr/bin/xml2po", line 174, in main
> xml2po_main.merge(mofile, filenames[0])
> File "/usr/lib/python2.7/dist-packages/xml2po/__init__.py", line
> 601, in merge
>
self.gt = gettext.GNUTranslations(mfile)
> File "/usr/lib/python2.7/gettext.py", line 180, in __init__
> self._parse(fp)
> File "/usr/lib/python2.7/gettext.py", line 314, in _parse
> plural = v[1].split('plural=')[1]
> IndexError: list index out of range
>
> So please HELP About this issue
>
>
> we are trying to make manuals of koha translatable
>
>
> koha is an Open source software for library systems
>
>
>
>
> Thanks A lot :)
>
>
> --
> Karam.
>
>
> gnome-doc-devel-list mailing list
> gnome-doc-devel-list gnome org
> https://mail.gnome.org/mailman/listinfo/gnome-doc-devel-list
--
Karam Qubsi
Koha Arab Translating Team
http://koha.wikibrary.org/Wikibrary for Arab Librarians
http://wikibrary.org
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd";>
<book>
<bookinfo id="manual">
<title>Koha 3.8 Manual (en)</title>
<author id="manualauthor">
<firstname>Nicole C.</firstname>
<surname>Engard</surname>
<affiliation>
<orgname>ByWater Solutions/BibLibre</orgname>
</affiliation>
</author>
<copyright id="manualcopy">
<year>2012</year>
<holder>Nicole C. Engard/ByWater Solutions/BibLibre</holder>
</copyright>
<legalnotice id="manuallegal">
<para>This manual is licensed under the <ulink
url="http://www.gnu.org/licenses/gpl.html";>GNU General Public License,
version 3</ulink> or later</para>
<para>Learn more about this license in the <link linkend="gpl">GPL3
Appendix</link></para>
</legalnotice>
<pubdate id="manualpubdate">2012</pubdate>
</bookinfo>
<chapter id="administration">
<title>Administration</title>
<section id="globalsysprefs">
<title>Global System Preferences</title>
<para>Global system preferences control the way your Koha system works
in general. Set these preferences before anything else in Koha.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences</para>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>Global System Preferences Link and Search</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/prefsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>System preferences can be searched (using any part of the
preference name or description) using the search box on the
'Administration' page or the search box at the top of each system
preferences page.</para>
<screenshot>
<screeninfo>Preferences search at the top of System Preference
page</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/prefsearch1.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When editing preferences a '(modified)' tag will appear next to
items you change until you click the 'Save All' button:</para>
<screenshot>
<screeninfo>After editing TagsModeration the '(modified)' label
appears</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/saveallprefs.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>After saving your preferences you'll get a confirmation message
telling you what preferences were saved:</para>
<screenshot>
<screeninfo>Preference save confirmation message</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/saveconfirmation.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Each section of preferences can be sorted alphabetically by
clicking the small down arrow to the right of the word 'Preference' in
the header column</para>
<screenshot>
<screeninfo>Sort option at the top right of each section of
preferences</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/sortprefs.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If the preference refers to monetary values (like <link
linkend="maxoutstanding">maxoutstanding</link>) the currency displayed
will be the default you set in your <link
linkend="currexchangeadmin">Currency and Exchange Rate</link>
administration area. In the examples to follow they will all read USD
for U.S. Dollars.</para>
<section id="acqprefs">
<title>Acquisitions</title>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences > Acquisitions</para>
<section id="acqprefspolicy">
<title>Policy</title>
<section id="AcqCreateItem">
<title>AcqCreateItem</title>
<para>Default: placing an order</para>
<para>Asks: Create an item when ___.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>cataloging a record</para>
</listitem>
<listitem>
<para>placing an order</para>
</listitem>
<listitem>
<para>receiving an order</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference lets you decide when you'd like to
create an item record in Koha. If you choose to add an item
record when 'placing an order' then you will enter item
information in as you place records in your basket. If you
choose to add the item when 'receiving an order' you will be
asked for item record information when you're recieving orders
in acquisitions. If you choose to add the item when
'cataloging a record' then item records will not be created in
acquisitions at all, you will need to go to the cataloging
module to add the items.</para>
</listitem>
</itemizedlist>
</section>
<section id="AcqViewBaskets">
<title>AcqViewBaskets</title>
<para>Default: created by staff member</para>
<para>Asks: Show baskets ___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>created by staff member</para>
</listitem>
<listitem>
<para>from staff member's branch</para>
</listitem>
<listitem>
<para>in system, regardless of owner</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When in acquisitions this preference allows you to
control whose baskets you can see when looking at a vendor.
The default value of 'created by staff member' makes it so
that you only see the baskets you created. Choosing to see
baskets 'from staff member's branch' will show you the baskets
created by anyone at the branch you're logged in at. Finally,
you can choose to set this preference to show you all baskets
regardless of who created it ('in system, regardless of
owner). Regardless of which value you choose for this
preference, superlibrarians can see all baskets created in the
system.</para>
</listitem>
</itemizedlist>
</section>
<section id="BasketConfirmations">
<title>BasketConfirmations</title>
<para>Default: always ask for confirmation</para>
<para>Asks: When closing or reopening a basket, ___.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>always ask for confirmation</para>
</listitem>
<listitem>
<para>do not ask for confirmation</para>
</listitem>
</itemizedlist>
<para>Descriptions:</para>
<itemizedlist>
<listitem>
<para>This preference adds the option to skip confirmations on
closing and reopening a basket. If you skip the confirmation,
you do not create a new basket group.</para>
</listitem>
</itemizedlist>
</section>
<section id="CurrencyFormat">
<title>CurrencyFormat</title>
<para>Default: 360,000.00 (US)</para>
<para>Asks: Display currencies using the following format
___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>360,000.00 (US)</para>
</listitem>
<listitem>
<para>360 000,00 (FR)</para>
</listitem>
</itemizedlist>
</section>
<section id="gist">
<title>gist</title>
<para>Default: 0</para>
<para>Asks: The default tax rate is ___</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference will allow the library to define a
default Goods and Services Tax rate. The default of value of 0
will disable this preference.</para>
</listitem>
</itemizedlist>
<para><tip>
<para>Enter this value as a number (.06) versus a percent
(6%).</para>
</tip></para>
</section>
<section id="UniqueItemFields">
<title>UniqueItemFields</title>
<para>Default: barcode</para>
<para>Asks:___ (space-separated list of fields that should be
unique for items, must be valid SQL fields of <ulink
url="http://schema.koha-community.org/tables/items.html";>items</ulink>
table)</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If this preference is left blank when adding items in
acquisitions there will be no check for uniqueness. This means
that a duplicate barcode can be created in acquisitions which
will cause errors later when checking items in and out.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="acqprefsprinting">
<title>Printing</title>
<section id="OrderPdfFormat">
<title>OrderPdfFormat</title>
<para>Default: pdfformat::layout2pages</para>
<para>Asks: Use ___ when printing basket groups.</para>
</section>
</section>
</section>
<section id="adminprefs">
<title>Administration</title>
<para>These preferences are general settings for your system.</para>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences > Administration</para>
<section id="casauthentication">
<title>CAS Authentication</title>
<para>The Central Authentication Service (CAS) is a single sign-on
protocol for the web. If you don't know what this is, leave these
preferences set to their defaults.</para>
<section id="AllowPkiAuth">
<title>AllowPkiAuth</title>
<para>Default: no</para>
<para>Asks: Use ___ field for SSL client certificate
authentication</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>no</para>
</listitem>
<listitem>
<para>the Common name</para>
</listitem>
<listitem>
<para>the EmailAddress</para>
</listitem>
</itemizedlist>
</section>
<section id="casAuthentication">
<title>casAuthentication</title>
<para>Default: Don't use</para>
<para>Asks: ___ CAS for login authentication.</para>
</section>
<section id="casLogout">
<title>casLogout</title>
<para>Default: Don't logout</para>
<para>Asks: ___ of CAS when logging out of Koha.</para>
</section>
<section id="casServerUrl">
<title>casServerUrl</title>
<para>Asks: The CAS Authentication Server can be found at
___</para>
</section>
</section>
<section id="adminprefsinterface">
<title>Interface options</title>
<para>These preference are related to your Koha interface</para>
<section id="DebugLevel">
<title>DebugLevel</title>
<para>Default: lots of</para>
<para>Asks: Show ___ debugging information in the browser when an
internal error occurs.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>lots of - will show as much information as
possible</para>
</listitem>
<listitem>
<para>no - will only show basic error messages</para>
</listitem>
<listitem>
<para>some - will show only some of the information
available</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference determines how much information will be
sent to the user's screen when the system encounters an error.
The most detail will be sent when the value level is set at 2,
some detail will be sent when the value is set at 1, and only
a basic error message will display when the value is set at 0.
This setting is especially important when a system is new and
the administration is interested in working out the bugs
(errors or problems) quickly. Having detailed error messages
makes quick fixes more likely in problem areas.</para>
</listitem>
</itemizedlist>
</section>
<section id="delimiter">
<title>delimiter</title>
<para>Default: semicolons</para>
<para>Asks: Separate columns in an exported report file with ___
by default.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>#'s</para>
</listitem>
<listitem>
<para>backslashes</para>
</listitem>
<listitem>
<para>commas</para>
</listitem>
<listitem>
<para>semicolons</para>
</listitem>
<listitem>
<para>slashes</para>
</listitem>
<listitem>
<para>tabs</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference determines how reports exported from
Koha will separate data. In many cases you will be able to
change this option when exporting if you'd like.</para>
</listitem>
</itemizedlist>
</section>
<section id="KohaAdminEmailAddress">
<title>KohaAdminEmailAddress</title>
<para>This is the default 'From' address for emails unless there
is one for the particular branch, and is referred to when an
internal error occurs.</para>
<para>Asks: Use ___ as the email address for the administrator of
Koha.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows one email address to be used in
warning messages set to the OPAC. If no email address is set
for the branch this address will receive messages from patrons
regarding modification requests, purchase suggestions, and
questions or information regarding overdue notices. It is
recommended that a email address that can be accessed by
multiple staff members be used for this purpose so that if one
librarian is out the others can address these requests. This
email address can be changed when needed.</para>
</listitem>
</itemizedlist>
</section>
<section id="noItemTypeImages">
<title>noItemTypeImages</title>
<para>Default: Show</para>
<para>Asks: ___ itemtype icons in the catalog.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Shows</para>
</listitem>
<listitem>
<para>Don't show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows the system administrator to
determine if users will be able to set and see an <link
linkend="itemtypeadmin">item type icon</link> the catalog on
both the OPAC and the Staff Client. The images will display in
both the OPAC and the Staff Client/Intranet. If images of item
types are disabled, text labels for item types will still
appear in the OPAC and Staff Client.</para>
</listitem>
</itemizedlist>
</section>
<section id="virtualshelves">
<title>virtualshelves</title>
<para>Default: Allow</para>
<para>Asks: ___ staff and patrons to create and view saved lists
of books.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't Allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference controls whether the lists functionality
will be available in the staff client and opac. If this is set
to "Don't allow" then no one will be able to save items to
public or private lists.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="adminprefslogin">
<title>Login options</title>
<para>These preferences are related to logging into your Koha
system</para>
<section id="AutoLocation">
<title>AutoLocation</title>
<para>Default: Don't require</para>
<para>Asks: ___ staff to log in from a computer in the IP address
range specified by their library (if any).</para>
<itemizedlist>
<listitem>
<para>Set IP address range in the library administration
area</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More >
Administration > Basic Parameters > <link
linkend="libsgroups">Libraries & Groups</link></para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't require</para>
</listitem>
<listitem>
<para>Require</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference protects the system by blocking
unauthorized users from accessing the staff client program and
settings. Authorized and unauthorized users are determined by
their computer's IP addresses. When the preference is set to
'Require', IP authorization is in effect and unauthorized IP
addresses will be blocked. This means that staff cannot work
from home unless their IP address has been authorized. When
set to 'Don't require', anyone with a staff client login will
have access no matter which IP address they are using.</para>
</listitem>
</itemizedlist>
</section>
<section id="IndependantBranches">
<title>IndependantBranches</title>
<para>Default: Don't prevent</para>
<para>Asks: ___ staff (but not superlibrarians) from modifying
objects (holds, items, patrons, etc.) belonging to other
libraries.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't prevent</para>
</listitem>
<listitem>
<para>Prevent</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference should only be used by library systems
which are sharing a single Koha installation among multiple
branches but are considered independent organizations, meaning
they do not share material or patrons with other branches and
do not plan to change that in the future. If set to 'Prevent'
it increases the security between library branches by:
prohibiting staff users from logging into another branch from
within the staff client, filtering out patrons from patron
searches who are not a part of the login branch conducting the
search, limiting the location choices to the login branch when
adding or modifying an item record, preventing users from
other branch locations from placing holds or checking out
materials from library branches other than their own, and
preventing staff from editing item records which belong to
other library branches. All of these security safeguards can
be overridden only by the superlibrarian, the highest level of
privileges.</para>
</listitem>
</itemizedlist>
<important>
<para>It is important that this value be set before going live
and that it NOT be changed</para>
</important>
</section>
<section id="insecure">
<title>insecure</title>
<para>Default: Don't allow</para>
<para>Asks: ___ staff to access the staff client without logging
in.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference controls whether or not authentication
(user login) will be required to gain access to the staff
client. If set to 'Allow', all authentication is bypassed. If
set to 'Don't allow' authentication (login) on the staff
client is required.</para>
</listitem>
</itemizedlist>
<important>
<para>Setting this to 'Allow' is dangerous, and should not be
done in production environments.</para>
</important>
</section>
<section id="SessionStorage">
<title>SessionStorage</title>
<para>Default: in the MySQL database</para>
<para>Asks: Store login session information ___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>as temporary files</para>
</listitem>
<listitem>
<para>in the MySQL database</para>
</listitem>
<listitem>
<para>in the PostgreSQL database</para>
<itemizedlist>
<listitem>
<important>
<para>PostgreSQL is not yet supported</para>
</important>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows administrators to choose what
format session data is stored in during web sessions.</para>
</listitem>
</itemizedlist>
</section>
<section id="timeout">
<title>timeout</title>
<para>Default: 12000000</para>
<para>Asks: Automatically log out users after ___ milliseconds of
inactivity.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference sets the length of time the Staff Client
or OPAC accounts can be left inactive before re-logging in is
necessary. The value of this preference is in seconds. At this
time, the amount of time before a session times out must be
the same for both the Staff Client and the OPAC.</para>
</listitem>
</itemizedlist>
</section>
</section>
</section>
<section id="authprefs">
<title>Authorities</title>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences > Authorities</para>
<section id="generalauthorities">
<title>General</title>
<section id="AutoCreateAuthorities">
<title>AutoCreateAuthorities</title>
<para>Default: do not generate</para>
<para>Asks: When editing records, ___ authority records that are
missing.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>do not generate</para>
</listitem>
<listitem>
<para>generate</para>
</listitem>
</itemizedlist>
<important>
<para><link
linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
must be set to "allow" for this to have any effect</para>
</important>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When this and <link
linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
are both turned on, automatically create authority records for
headings that don't have any authority link when cataloging.
When BiblioAddsAuthorities is on and AutoCreateAuthorities is
turned off, do not automatically generate authority records,
but allow the user to enter headings that don't match an
existing authority. When BiblioAddsAuthorities is off, this
has no effect.</para>
</listitem>
</itemizedlist>
</section>
<section id="BiblioAddsAuthorities">
<title>BiblioAddsAuthorities</title>
<para>Default: allow</para>
<para>Asks: When editing records, ___ them to automatically create
new authority records if needed, rather than having to reference
existing authorities.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>allow</para>
<itemizedlist>
<listitem>
<para>This setting allows you to type values in the fields
controlled by authorities and then adds a new authority if
one does not exist</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>don't allow</para>
<itemizedlist>
<listitem>
<para>This setting will lock the authority controlled
fields, forcing you to search for an authority versus
allowing you to type the information in yourself.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="dontmerge">
<title>dontmerge</title>
<para>Default: Don't</para>
<para>Asks: ___ automatically update attached biblios when
changing an authority record.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Do</para>
</listitem>
<listitem>
<para>Don't</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference tells Koha how to handle changes to your
Authority records. If you edit an authority record and this
preference is set to 'Do' Koha will update all of the bib
records linked to the authority with the new authority
record's data. If this is set to "Don't" then Koha won't edit
bib records when changes are made to authorities.</para>
</listitem>
</itemizedlist>
<important>
<para>If this is set to merge you will need to ask your
administrator to enable the <link
linkend="mergeauthcron">merge_authorities.pl
cronjob</link>.</para>
</important>
</section>
<section id="MARCAuthorityControlField008">
<title>MARCAuthorityControlField008</title>
<para>Default: || aca||aabn | a|a d</para>
<para>Asks: Use the following text for the contents of MARC
authority control field 008 position 06-39 (fixed length data
elements).</para>
<para><important>
<para>Do not include the date (position 00-05) in this
preference, Koha will calculate automatically and put that in
before the values in this preference.</para>
</important>Description:</para>
<itemizedlist>
<listitem>
<para>This preference controls the default value in the 008
field on Authority records. It does not effect bibliographic
records.</para>
</listitem>
</itemizedlist>
</section>
<section id="UseAuthoritiesForTracings">
<title>UseAuthoritiesForTracings</title>
<para>Default: Don't use</para>
<para>Asks: ___ authority record numbers instead of text strings
for searches from subject tracings.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't use</para>
<itemizedlist>
<listitem>
<para>Search links look for subject/author keywords
(example: opac-search.pl?q=su:Business%20networks)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Use</para>
<itemizedlist>
<listitem>
<para>Search links look for an authority record (example:
opac-search.pl?q=an:354)</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>For libraries that have authority files, they may want
to make it so that when a link to an authorized subject or
author is clicked on the OPAC or staff client it takes the
searcher only to a list of results with that authority record.
Most libraries do not have complete authority files and so
setting this preference to 'Don't use' will allow searchers to
click on links to authors and subject headings and perform a
keyword search against those fields, finding all possible
relevant results instead.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="linkerauthorities">
<title>Linker</title>
<para>These preference will control how Koha links bibliographic
records to authority records. All bibliographic records added to
Koha after these preferences are set will link automatically to
authority records, for records added before these preferences are
set there is a script (misc/link_bibs_to_authorities.pl) that your
system administrator can run to link records together.</para>
<section id="CatalogModuleRelink">
<title>CatalogModuleRelink</title>
<para>Default: Do not</para>
<para>Asks: ___ automatically relink headings that have previously
been linked when saving records in the cataloging module.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Do</para>
</listitem>
<listitem>
<para>Do not</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Longtime users of Koha don't expect the authority and
bib records to link consistently. This preference makes it
possible to disable authority relinking in the cataloging
module only (i.e. relinking is still possible if
link_bibs_to_authorities.pl is run). Note that though the
default behavior matches the previous behavior of Koha
(retaining links to outdated authority records), it does not
match the intended behavior (updating biblio/authority link
after bibliographic record is edited). Libraries that want the
intended behavior of authority control rather than the way
Koha used to handle linking should set CatalogModuleRelink to
'Do'. Once setting this to 'Do' the following preferences can
also be set.</para>
</listitem>
</itemizedlist>
</section>
<section id="LinkerKeepStale">
<title>LinkerKeepStale</title>
<para>Default: Do not</para>
<para>Asks: ___ keep existing links to authority records for
headings where the linker is unable to find a match.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Do</para>
</listitem>
<listitem>
<para>Do not</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When set to 'Do', the linker will never remove a link to
an authority record, though, depending on the value of <link
linkend="LinkerRelink">LinkerRelink</link>, it may change the
link.</para>
</listitem>
</itemizedlist>
</section>
<section id="LinkerModule">
<title>LinkerModule</title>
<para>Default: Default</para>
<para>Asks: Use the ___ linker module for matching headings to
authority records.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Default</para>
<itemizedlist>
<listitem>
<para>Retains Koha's previous behavior of only creating
links when there is an exact match to one and only one
authority record; if the <link
linkend="LinkerOptions">LinkerOptions</link> preference is
set to 'broader_headings', it will try to link headings to
authority records for broader headings by removing
subfields from the end of the heading</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>First match</para>
<itemizedlist>
<listitem>
<para>Creates a link to the first authority record that
matches a given heading, even if there is more than one
authority record that matches</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Last match</para>
<itemizedlist>
<listitem>
<para>Creates a link to the last authority record that
matches a given heading, even if there is more than one
record that matches</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference tells Koha which match to use when
searching for authority matches when saving a record.</para>
</listitem>
</itemizedlist>
</section>
<section id="LinkerOptions">
<title>LinkerOptions</title>
<para>Asks: Set the following options for the authority linker
___</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This is a pipe separated (|) list of options. At the
moment, the only option available is "broader_headings." With
this option set to "broader_headings", the linker will try to
match the following heading as follows:</para>
<para>=600 10$aCamins-Esakov, Jared$xCoin
collections$vCatalogs$vEarly works to 1800.</para>
<para>First: Camins-Esakov, Jared--Coin
collections--Catalogs--Early works to 1800</para>
<para>Next: Camins-Esakov, Jared--Coin
collections--Catalogs</para>
<para>Next: Camins-Esakov, Jared--Coin collections</para>
<para>Next: Camins-Esakov, Jared (matches! if a previous
attempt had matched, it would not have tried this)</para>
</listitem>
</itemizedlist>
</section>
<section id="LinkerRelink">
<title>LinkerRelink</title>
<para>Default: Do</para>
<para>Asks: ___ relink headings that have previously been linked
to authority records.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Do</para>
</listitem>
<listitem>
<para>Do not</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When set to 'Do', the linker will confirm the links for
headings that have previously been linked to an authority
record when it runs, correcting any incorrect links it may
find. When set to 'Do not', any heading with an existing link
will be ignored, even if the existing link is invalid or
incorrect.</para>
</listitem>
</itemizedlist>
</section>
</section>
</section>
<section id="catprefs">
<title>Cataloging</title>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences > Cataloging</para>
<section id="catdisplayprefs">
<title>Display</title>
<para/>
<section id="authoritysep">
<title>authoritysep</title>
<para>Default: --</para>
<para>Asks: Separate multiple displayed authors, series or
subjects with ___.</para>
</section>
<section id="hide_marc">
<title>hide_marc</title>
<para>Default: Display</para>
<para>Asks: ___ MARC tag numbers, subfield codes and indicators in
MARC views.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Display -- shows the tag numbers on the cataloging
interface</para>
<screenshot>
<screeninfo>MARC editor with tags showing</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/hide_marc-display.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Don't display -- shows just descriptive text when
cataloging</para>
<screenshot>
<screeninfo>MARC editor without tags showing</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/hide_marc-dont.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="IntranetBiblioDefaultView">
<title>IntranetBiblioDefaultView</title>
<para>Default: ISBD form</para>
<para>Asks: By default, display biblio records in ___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>ISBD form -- displays records in the staff client in the
old card catalog format</para>
<itemizedlist>
<listitem>
<para>See <link linkend="isbdpref">ISBD</link> preference
for more information</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Labelled MARC form -- displays records in the staff
client in MARC with text labels to explain the different
fields</para>
</listitem>
<listitem>
<para>MARC form -- displays records in the staff client in
MARC</para>
</listitem>
<listitem>
<para>normal form -- visual display in the staff client (for
the average person)</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This setting determines the bibliographic record display
when searching the catalog on the staff client. This setting
does not affect the display in the OPAC which is changed using
the <link linkend="BiblioDefaultView">BiblioDefaultView</link>
preference under the OPAC preference tab. This setting changes
the look of the record when first displayed. The MARC and ISBD
views can still be seen by clicking in the sidebar.</para>
</listitem>
</itemizedlist>
</section>
<section id="isbdpref">
<title>ISBD</title>
<para>Default: <link linkend="isbddefault">MARC21 Default
Appendix</link> or <link linkend="unimarcdefault">UNIMARC Default
Appendix</link></para>
<para>Asks: Use the following as the ISBD template:</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This determines how the ISBD information will display.
Elements in the list can be reordered to produce a different
ISBD view. ISBD, the International Standard Bibliographic
Description, was first introduced by IFLA (International
Federation of Library Associations) in 1969 in order to
provide guidelines for descriptive cataloging. The purpose of
ISBD is to aid the international exchange of bibliographic
records for a variety of materials.</para>
</listitem>
</itemizedlist>
</section>
<section id="LabelMARCView">
<title>LabelMARCView</title>
<para>Default: Don't</para>
<para>Asks: ___ collapse repeated tags of the same type into one
tag entry.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Do -- will combine all identical tag numbers under one
heading in the MARC view in the OPAC and Staff Client</para>
<screenshot>
<screeninfo>MARC View in the Staff Client with LabelMARCView
set to Do</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/LabelMARCView-do.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Don't -- will list all of the tags individually in the
MARC view in the OPAC and Staff Client</para>
<screenshot>
<screeninfo>MARC View in the Staff Client with LabelMARCView
set to Don't</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/LabelMARCView-dont.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="OpacSuppression">
<title>OpacSuppression</title>
<para>Default: Don't hide</para>
<para>Asks: ___ items marked as suppressed from OPAC search
results.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't hide -- will show items in OPAC search results if
they are marked suppressed</para>
</listitem>
<listitem>
<para>Hide -- will not show items in OPAC search results if
they're marked as suppressed</para>
<itemizedlist>
<listitem>
<para>Each bib record with items you want to hide from the
OPAC simply need to have the 942n field set to 1. The
index then hides it from display in OPAC but will still
display it in the Staff Client</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>An <link linkend="authorizedvalues">authorized
value</link> for 942$n field should be set to eliminate
errors. One example would be to create an authorized value
titled SUPPRESS with a value of 0 for don't suppress and 1 for
suppress.</para>
</listitem>
</itemizedlist>
<important>
<para>If this preference is set to 'hide' and you have the 942n
field set to 1, it will hide the entire bib record - not just an
individual item.</para>
</important>
<important>
<para>You must have the Suppress index set up in Zebra and at
least one suppressed item, or your searches will be
broken.</para>
</important>
</section>
<section id="URLLinkText">
<title>URLLinkText</title>
<para>Default: Online Resource</para>
<para>Asks: Show ___ as the text of links embedded in MARC
records.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If the 856 field does not have a subfield 3 or y
defined, the OPAC will say 'Click here to access online.' If
you would like the field to say something else enter that in
this field.</para>
</listitem>
</itemizedlist>
</section>
<section id="UseControlNumber">
<title>UseControlNumber</title>
<para>Default: Don't use</para>
<para>Asks: ___ record control number ($w subfields) and control
number (001) for linking of bibliographic records.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't use</para>
<itemizedlist>
<listitem>
<para>When clicking on links to titles that appear next to
'Continues' and 'Continued by' in the detail display Koha
will perform a title search</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Use</para>
<itemizedlist>
<listitem>
<para>When clicking on links to titles that appear next to
'Continues' and 'Continued by' in the detail display Koha
will perform a control number (MARC field 001)
search</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<important>
<para>Unless you are going in and manually changing 773$w to
match your rigorously-defined bibliographic relationships, you
should set this preference to "Don't use" and instead set <link
linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> to
"Display"</para>
</important>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If you have a serial called "Journal of Interesting
Things" which has a separate record from when it was called
"Transactions of the Interesting Stuff Society," you could add
linking fields to indicate the relationship between the two
records. UseControlNumber allows you to use your local
accession numbers for those links. In MARC21, the relevant
sections of the two records might look like
this:<programlisting> =001 12345
=110 2_$aInteresting Stuff Society.
=245 10$aTransactions of the Interesting Stuff Society.
=785 00$aInteresting Stuff Society$tJournal of Interesting Things.$w12346
=001 12346
=110 2_$aInteresting Stuff Society.
=245 10$aJournal of Interesting Things.
=780 00$aInteresting Stuff Society$tTransactions of the Interesting Stuff Society.$w12345</programlisting></para>
<para>With UseControlNumber set to 'Use', the 78x links will
use the Control Numbers is subfield $w, instead of doing a
title search on "Journal of Interesting Things" and
"Transactions of the Interesting Stuff Society"
respectively.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="catinterfaceprefs">
<title>Interface</title>
<para/>
<section id="advancedMARCeditor">
<title>advancedMARCeditor</title>
<para>Default: Don't display</para>
<para>Asks: ___ descriptions of fields and subfields in the MARC
editor.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference determines whether or not MARC field
names will be present when editing or creating MARC
records.</para>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Display</para>
<screenshot>
<screeninfo>MARC editor with text labels</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/advancedMARCeditor-display.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Don't display</para>
<screenshot>
<screeninfo>MARC editor without text labels</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/advancedMARCeditor-dontdisplay.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="DefaultClassificationSource">
<title>DefaultClassificationSource</title>
<para>Default: Dewey Decimal System</para>
<para>Asks: Use ___ as the default classification source.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>ANSCR (Sound Recordings)</para>
</listitem>
<listitem>
<para>Dewey Decimal Classification</para>
</listitem>
<listitem>
<para>Library of Congress Classification</para>
</listitem>
<listitem>
<para>Other/Generic Classification Scheme</para>
</listitem>
<listitem>
<para>SuDoc Classification (U.S. GPO)</para>
</listitem>
<listitem>
<para>Universal Decimal Classification</para>
</listitem>
</itemizedlist>
</section>
<section id="EasyAnalyticalRecords">
<sectioninfo>
<author>
<firstname id="analyticsauthor">Linda</firstname>
<surname>Culberson</surname>
<affiliation>
<orgname>Ms. Dept. of Archives and History</orgname>
</affiliation>
</author>
<pubdate id="analyticspubdate">October 2011</pubdate>
<othercredit id="analyticseditor" role="copyeditor">
<firstname>Nicole C.</firstname>
<surname>Engard</surname>
<contrib id="analyticscredit">Fixed typos, changed content
where necessary and added new screenshots.</contrib>
</othercredit>
</sectioninfo>
<title>EasyAnalyticalRecords</title>
<para>Asks: ___ easy ways to create analytical record
relationships</para>
<para>Default: Don't Display</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Display</para>
</listitem>
<listitem>
<para>Don't Display</para>
</listitem>
</itemizedlist>
<important>
<para>If you decide to use this feature you'll want to make sure
that your <link
linkend="UseControlNumber">UseControlNumber</link> preference is
set to "Don't use" or else the "Show analytics" links in the
staff client and the OPAC will be broken.</para>
</important>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>An analytic entry in a catalog is one that describes a
part of a larger work that is also described in the catalog.
In bibliographic cataloging, analytic entries may be made for
chapters in books or special issues of articles in
periodicals. In archival cataloging, analytic entries may be
made for series or items within a collection. This feature in
Koha allows for an easy way of linking analytic entries to the
host records, and this system preference adds several new menu
options to the staff cataloging detail pages to allow that to
happen.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="catrecordprefs">
<title>Record Structure</title>
<para/>
<section id="AlternateHoldingsField">
<title>AlternateHoldingsField &
AlternateHoldingsSeparator</title>
<para>Asks: Display MARC subfield ___ as holdings information for
records that do not have items, with the subfields separated by
___.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Sometimes libraries migrate to Koha with their holding
info in the 852 field (OCLC holdings information field) and
choose not to transfer that information into the 952 (Koha
holdings information field) because they don't plan on
circulating those items. For those libraries or other
libraries that have data in the 852 fields of their records
that they want to display, these preferences let you choose to
display holdings info from a field other than the 952 field.
The AlternateHoldingsField preference can contain multiple
subfields to look in; for instance 852abhi would look in 852
subfields a, b, h, and i.</para>
</listitem>
<listitem>
<para>With AlternateHoldingsField set to 852abhi and
AlternateHoldingsSeparator set to a space the holdings would
look like the following:</para>
<screenshot>
<screeninfo>Alternate Holdings Display</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/AlternateHoldingsField.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="autoBarcode">
<title>autoBarcode</title>
<para>Default: generated in the form
<branchcode>yymm0001</para>
<para>Asks: Barcodes are ___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>generated in the form <branchcode>yymm0001</para>
</listitem>
<listitem>
<para>generated in the form <year>-0001</para>
</listitem>
<listitem>
<para><year>-0002. generated in the form 1, 2, 3</para>
</listitem>
<listitem>
<para>not generated automatically</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This setting is for libraries wishing to generate
barcodes from within Koha (as opposed to scanning in
pre-printed barcodes or manually assigning them).</para>
</listitem>
</itemizedlist>
</section>
<section id="item-level_itypes">
<title>item-level_itypes</title>
<para>Default: specific item</para>
<para>Asks: Use the item type of the ___ as the authoritative item
type (for determining circulation and fines rules, etc).</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>biblio record</para>
</listitem>
<listitem>
<para>specific item</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference determines whether the item type Koha
uses for issuing rules will be an attribute of the
bibliographic record or the item record. Most libraries refer
to the item record for item types. It also determines if the
item type icon appears on the OPAC search results. If you have
the preference set to 'biblio record' then Koha displays the
item type icon on the search results to the left of the result
info.</para>
<screenshot>
<screeninfo>Item Type Icons to the Left of Result
Information</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/item-level_itypes.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="itemcallnumber">
<title>itemcallnumber</title>
<para>Default: 082ab</para>
<para>Asks: Map the MARC subfield to an item's callnumber.</para>
<tip>
<para>This can contain multiple subfields to look in; for
instance 082ab would look in 082 subfields a and b.</para>
</tip>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This setting determines which MARC field will be used to
determine the call number that will be entered into item
records automatically (952$o). The value is set by providing
the MARC field code (050, 082, 090, 852 are all common) and
the subfield codes without the delimiters ($a, $b would be
ab).</para>
</listitem>
</itemizedlist>
<para>Examples:</para>
<itemizedlist>
<listitem>
<para>Dewey: 082ab or 092ab; LOC: 050ab or 090ab; from the
item record: 852hi</para>
</listitem>
</itemizedlist>
</section>
<section id="marcflavour">
<title>marcflavour</title>
<para>Default: MARC21</para>
<para>Asks: Interpret and store MARC records in the ___
format.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference defines global MARC style (MARC21 or
UNIMARC) used for encoding. MARC21 is the standard style for
the US, Canada and Britain. UNIMARC is a variation of MARC21
that is used in France, Italy, Russia, and many other
countries.</para>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>MARC21</para>
</listitem>
<listitem>
<para>UNIMARC</para>
</listitem>
</itemizedlist>
</section>
<section id="MARCOrgCode">
<title>MARCOrgCode</title>
<para>Default: OSt</para>
<para>Asks: Fill in the MARC organization code ___ by default in
new MARC records (leave blank to disable).</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>The MARC Organization Code is used to identify libraries
with holdings of titles and more.</para>
</listitem>
</itemizedlist>
<para>Learn more and find your library's code on the <ulink
url="http://www.loc.gov/marc/organizations/orgshome.html";>MARC
Code list for Organizations</ulink> or in Canada on the <ulink
url="http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1";>Canadian
Symbols Directory</ulink>.</para>
</section>
<section id="NewItemsDefaultLocation">
<title>NewItemsDefaultLocation</title>
<para>Asks: When items are created, give them the temporary
location of ___ (should be a location code, or blank to
disable).</para>
</section>
<section id="z3950NormalizeAuthor">
<title>z3950NormalizeAuthor & z3950AuthorAuthFields</title>
<para>Defaults: Don't copy & 701,702,700</para>
<para>Asks: ___ authors from the UNIMARC ___ tags (separated by
commas) to the correct author tags when importing a record using
Z39.50.</para>
<para>Description for z3950NormalizeAuthor:</para>
<itemizedlist>
<listitem>
<para>This preference allows for ‘Personal Name
Authorities' to replace authors as the bibliographic
authority. This preference should only be considered by
libraries using UNIMARC.</para>
</listitem>
</itemizedlist>
<para>Values for z3950NormalizeAuthor:</para>
<itemizedlist>
<listitem>
<para>Copy</para>
</listitem>
<listitem>
<para>Don't copy</para>
</listitem>
</itemizedlist>
<para>Description for z3950AuthorAuthFields:</para>
<itemizedlist>
<listitem>
<para>This preference defines which MARC fields will be used
for ‘Personal Name Authorities' to replace authors as
the bibliographic authorities. This preference only applies to
those using UNIMARC encoding. The MARC fields selected here
will only be used if ‘z3950NormalizeAuthor' is set to
“Copy". The default field are 700, 701, and 702.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="catspineprefs">
<title>Spine Labels</title>
<para/>
<section id="SpineLabelAutoPrint">
<title>SpineLabelAutoPrint</title>
<para>Default: don't</para>
<para>Asks: When using the quick spine label printer, ___
automatically pop up a print dialog.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>do</para>
</listitem>
<listitem>
<para>don't</para>
</listitem>
</itemizedlist>
</section>
<section id="SpineLabelFormat">
<title>SpineLabelFormat</title>
<para>Default: <itemcallnumber><copynumber></para>
<para>Asks: Include the following fields on a quick-printed spine
label: (Enter in columns from the biblio, biblioitems or items
tables, surrounded by < and >.)</para>
</section>
<section id="SpineLabelShowPrintOnBibDetails">
<title>SpineLabelShowPrintOnBibDetails</title>
<para>Default: Don't display</para>
<para>Asks: ___ buttons on the bib details page to print item
spine labels.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Display</para>
<screenshot>
<screeninfo>'Print Label' link appears on bibliographic
record in the staff client</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/SpineLabelShowPrintOnBibDetails.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Don't display</para>
</listitem>
</itemizedlist>
</section>
</section>
</section>
<section id="circprefs">
<title>Circulation</title>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences > Circulation</para>
<section id="circcheckoutpolicy">
<title>Checkout Policy</title>
<para/>
<section id="AllFinesNeedOverride">
<title>AllFinesNeedOverride</title>
<para>Default: Require</para>
<para>Asks: ___ staff to manually override all fines, even fines
less than <link
linkend="noissuescharge">noissuescharge</link>.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't require</para>
</listitem>
<listitem>
<para>Require</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference let's you decide if you want to always
be warned that the patron has fines when checking out. If you
have it set to 'Require' then no matter how much money the
patron owes a message will pop up warning you that the patron
owes money.</para>
</listitem>
</itemizedlist>
</section>
<section id="AllowFineOverride">
<title>AllowFineOverride</title>
<para>Default: Don't allow</para>
<para>Asks: ___ staff to manually override and check out items to
patrons who have more than <link
linkend="noissuescharge">noissuescharge</link> in fines.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference lets you decide if you staff can check
out to patrons who owe more money than you usually let them
carry on their account. If set to 'Allow' staff will be warned
that the patrons owes money, but it won't stop the staff from
checking out to the patron.</para>
</listitem>
</itemizedlist>
</section>
<section id="AllowItemsOnHoldCheckout">
<title>AllowItemsOnHoldCheckout</title>
<para>Default: Don't allow</para>
<para>Asks: ___ checkouts of items items reserved to someone else.
If allowed do not generate RESERVE_WAITING and RESERVED warning.
This allows self checkouts for those items.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<important>
<para>This system preference relates only to SIP based self
checkout, not Koha's web based self checkout.</para>
</important>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When this preference is set to 'Allow' patrons will be
able to use your external self check machine to check out a
book to themselves even if it's on hold for someone else. If
you would like Koha to prevent people from checking out books
that are on hold for someone else set this preference to
"Don't allow."</para>
</listitem>
</itemizedlist>
</section>
<section id="AllowNotForLoanOverride">
<title>AllowNotForLoanOverride</title>
<para>Default: Allow</para>
<para>Asks: ___ staff to override and check out items that are
marked as not for loan.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This parameter is a binary setting which controls the
ability of staff (patrons will always be prevented from
checking these items out) to check out items that are marked
as “not for loan". Setting it to “Allow" would
allow such items to be checked out, setting it to “Don't
allow" would prevent this. This setting determines whether
items meant to stay in the library, such as reference
materials, and other library resources can be checked out by
patrons.</para>
</listitem>
</itemizedlist>
</section>
<section id="AllowRenewalLimitOverride">
<title>AllowRenewalLimitOverride</title>
<para>Default: Allow</para>
<para>Asks: ___ staff to manually override the renewal limit and
renew a checkout when it would go over the renewal limit.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference is a binary setting which controls the
ability of staff to override the limits placed on the number
of times an item can be renewed. Setting it to “Allow"
would allow such limits to be overridden, setting it to
“Don't allow" would prevent this. This is a preference
in which if it is set to “allow" it would allow the
library staff to use their judgment for overriding the renew
limit for special cases, setting it to “Don't allow"
prevents an opportunity for abuse by the library staff.</para>
</listitem>
</itemizedlist>
</section>
<section id="AutomaticItemReturn">
<title>AutomaticItemReturn</title>
<para>Default: Do</para>
<para>Asks: ___ automatically transfer items to their home branch
when they are returned.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Do</para>
</listitem>
<listitem>
<para>Don't</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference is a binary setting which determines
whether an item is returned to its home branch automatically
or not. If set to “Don't", the staff member checking an
item in at a location other than the item's home branch will
be asked whether the item will remain at the non-home branch
(in which case the new location will be marked as a holding
location) or returned. Setting it to “Do" will ensure
that items checked in at a branch other than their home branch
will be sent to that home branch.</para>
</listitem>
</itemizedlist>
</section>
<section id="CircControl">
<title>CircControl</title>
<para>Default: the library the item is from</para>
<para>Asks: Use the checkout and fines rules of ___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>the library the item is from</para>
<itemizedlist>
<listitem>
<para>The circulation and fines policies will be
determined by the library that owns the item</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>the library the patron is from</para>
<itemizedlist>
<listitem>
<para>The circulation and fines policies will be
determined the patron's home library</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>the library you are logged in at</para>
<itemizedlist>
<listitem>
<para>The circulation and fines policies will be
determined by the library that checked the item out to the
patron</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="HomeOrHoldingBranch">
<title>HomeOrHoldingBranch</title>
<para>Default: the library the item was checked out from</para>
<para>Asks: Use the checkout and fines rules of ___</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference establishes what may be done with a
loaned item once the item has been returned. It deals with
situations in which one library branch has borrowed materials
from a different branch. Essentially it decides whether a
library may check the borrowed item back out to its patron or
if it must immediately send the item back to the owning
location.</para>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>the library the item is from</para>
</listitem>
<listitem>
<para>the library the item was checked out from</para>
</listitem>
</itemizedlist>
<important>
<para>It is not recommend that this setting be changed after
initial setup of Koha</para>
</important>
<important>
<para>This preference does nothing unless the
IndependantBranches preference is set to 'Prevent'.</para>
</important>
<itemizedlist>
<listitem>
<para><emphasis>Get there: </emphasis>More > Administration
> Global System Preferences > Admin > <link
linkend="IndependantBranches">IndependantBranches</link></para>
</listitem>
</itemizedlist>
</section>
<section id="InProcessingToShelvingCart">
<title>InProcessingToShelvingCart</title>
<para>Default: Don't move</para>
<para>Asks: ___ items that have the location PROC to the location
CART when they are checked in.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't move</para>
</listitem>
<listitem>
<para>Move</para>
</listitem>
</itemizedlist>
</section>
<section id="IssuingInProcess">
<title>IssuingInProcess</title>
<para>Default: Don't prevent</para>
<para>Asks: ___ patrons from checking out an item whose rental
charge would take them over the limit.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't prevent</para>
</listitem>
<listitem>
<para>Prevent</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference determines if a patron can check items
out if there is an overdue fine on the account and any of the
materials the patron wishes to check out will potentially tip
the account balance over the maximum fines policy the library
has in place.</para>
</listitem>
</itemizedlist>
<para>Example: Your library has a $5 limit set for 'fines' (ie,
after incurring $5 in fines, a patron can no longer check out
items). A patron comes to the desk with 5 items to check out (4
books and a video) The patron has $4 in charges already on their
account. One of the videos has a rental charge of $1, therefore
making the total fines on the patron's account suddenly $5 (the
limit).</para>
</section>
<section id="maxoutstanding">
<title>maxoutstanding</title>
<para>Default: 5</para>
<para>Asks: Prevent patrons from making holds on the OPAC if they
owe more than ___ USD in fines.</para>
</section>
<section id="noissuescharge">
<title>noissuescharge</title>
<para>Default: 5</para>
<para>Asks: Prevent patrons from checking out books if they have
more than ___ USD in fines.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference is the maximum amount of money owed to
the library before the user is banned from borrowing more
items. This also coincides with <link
linkend="maxoutstanding">maxoutstanding</link> that limits
patrons from placing holds when the maximum amount is owed to
the library.</para>
</listitem>
</itemizedlist>
</section>
<section id="OverduesBlockCirc">
<title>OverduesBlockCirc</title>
<para>Default: Ask for confirmation</para>
<para>Asks: ___ when checking out to a borrower that has overdues
outstanding</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Ask for confirmation</para>
<itemizedlist>
<listitem>
<para>Will not let you check an item out to patrons with
overdues until a librarian confirms that it is okay</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Block</para>
<itemizedlist>
<listitem>
<para>Block all patrons with overdue items from being able
to check out</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Don't block</para>
<itemizedlist>
<listitem>
<para>Allow all patrons with overdue items to continue to
check out</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="OverdueNoticeBcc">
<title>OverdueNoticeBcc</title>
<para>Asks: Send all notices as a BCC to this email address
___</para>
<para>This preference makes it so that a librarian can get a copy
of every notice sent out to patrons.<tip>
<para>If you'd like more than one person to receive the blind
copy you can simply enter in multiple email addresses
separated by commas.</para>
</tip></para>
</section>
<section id="PrintNoticesMaxLines">
<title>PrintNoticesMaxLines</title>
<para>Asks: Include up to ___ item lines in a printed overdue
notice.</para>
<note>
<para>If the number of items is greater than this number, the
notice will end with a warning asking the borrower to check
their online account for a full list of overdue items.</para>
</note>
<tip>
<para>Set to 0 to include all overdue items in the notice, no
matter how many there are.</para>
</tip>
<important>
<para>This preference only refers to the print notices, not
those sent via email.</para>
</important>
</section>
<section id="RenewalPeriodBase">
<title>RenewalPeriodBase</title>
<para>Default: the old due date of the checkout</para>
<para>Asks: When renewing checkouts, base the new due date on
___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>the old due date of the checkout</para>
</listitem>
<listitem>
<para>the current date</para>
</listitem>
</itemizedlist>
</section>
<section id="ReturnBeforeExpiry">
<title>ReturnBeforeExpiry</title>
<para>Default: Don't require</para>
<para>Asks: ___ patrons to return books before their accounts
expire (by restricting due dates to before the patron's expiration
date).</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't require</para>
</listitem>
<listitem>
<para>Require</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This is preference may prevent a patron from having
items checked out after their library card has expired. If
this is set to “Require", then a due date of any checked
out item can not be set for a date which falls after the
patron's card expiration. If the setting is left “Don't
require" then item check out dates may exceed the expiration
date for the patron's library card.</para>
</listitem>
</itemizedlist>
</section>
<section id="ReturnToShelvingCart">
<title>ReturnToShelvingCart</title>
<para>Default: Don't move</para>
<para>Asks: ___ all items to the location CART when they are
checked in.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't move</para>
</listitem>
<listitem>
<para>Move</para>
</listitem>
</itemizedlist>
</section>
<section id="TransfersMaxDaysWarning">
<title>TransfersMaxDaysWarning</title>
<para>Default: 3</para>
<para>Asks: Show a warning on the "Transfers to Receive" screen if
the transfer has not been received ___ days after it is
sent.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>The TransferMaxDaysWarning preference is set at a
default number of days. This preference allows for a warning
to appear after a set amount of time if an item being
transferred between library branches has not been received.
The warning will appear in the <link
linkend="transferstoreceive">Transfers to Receive</link>
report.</para>
</listitem>
</itemizedlist>
</section>
<section id="UseBranchTransferLimits">
<title>UseBranchTransferLimits &
BranchTransferLimitsType</title>
<para>Defaults: Don't enforce & collection code</para>
<para>Asks: ___ branch transfer limits based on ___</para>
<para>UseBranchTransferLimits Values:</para>
<itemizedlist>
<listitem>
<para>Don't enforce</para>
</listitem>
<listitem>
<para>Enforce</para>
</listitem>
</itemizedlist>
<para>BranchTransferLimitsType Values:</para>
<itemizedlist>
<listitem>
<para>collection code</para>
</listitem>
<listitem>
<para>item type</para>
</listitem>
</itemizedlist>
<para>BranchTransferLimitsType Description:</para>
<itemizedlist>
<listitem>
<para>This parameter is a binary setting which determines
whether items are transferred according to item type or
collection code. This value determines how the library manager
is able to restrict what items can be transferred between the
branches.</para>
</listitem>
</itemizedlist>
</section>
<section id="useDaysMode">
<title>useDaysMode</title>
<para>Default: Don't include</para>
<para>Asks: Calculate the due date using ___.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>circulation rules only.</para>
</listitem>
<listitem>
<para>the calendar to push the due date to the next open
day.</para>
</listitem>
<listitem>
<para>the calendar to skip all days the library is
closed.</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference controls how scheduled library closures
affect the due date of a material. The 'the calendar to skip
all days the library is closed' setting allows for a scheduled
closure not to count as a day in the loan period, the
'circulation rules only' setting would not consider the
scheduled closure at all, and 'the calendar to push the due
date to the next open day' would only effect the due date if
the day the item is due would fall specifically on the day of
closure.</para>
</listitem>
</itemizedlist>
<para>Example:</para>
<itemizedlist>
<listitem>
<para>The library has put December 24th and 25th in as
closures on the calendar. A book checked out by a patron has a
due date of December 25th according to the circulation and
fine rules. If this preference is set to 'circulation rules
only' then the item will remain due on the 25th. If the
preference is set to 'the calendar to push the due date to the
next open day' then the due date will be December 26th. If the
preference is set to 'the calendar to skip all days the
library is closed' then the due date will be pushed to the
27th of December to accommodate for the two closed
days.</para>
</listitem>
</itemizedlist>
<para>The calendar is defined on a branch by branch basis. To
learn more about the calendar, check out the '<link
linkend="calholidays">Calendar & Holidays</link>' section of
this manual.</para>
</section>
</section>
<section id="circfinespolicy">
<title>Fines Policy</title>
<para/>
<section id="finesCalendar">
<title>finesCalendar</title>
<para>Default: not including the days the library is closed</para>
<para>Asks: Calculate fines based on days overdue ___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>directly</para>
</listitem>
<listitem>
<para>not including the days the library is closed</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference will determine whether or not fines will
be accrued during instances when the library is closed.
Examples include holidays, library in-service days, etc.
Choosing 'not including the days the library is closed"
setting will enable Koha to access its <link
linkend="calholidays">Calendar</link> module and be
considerate of dates when the library is closed. To make use
of this setting the administrator must first access Koha's
calendar and mark certain days as “holidays" ahead of
time.</para>
</listitem>
</itemizedlist>
<para>The calendar is defined on a branch by branch basis. To
learn more about the calendar, check out the '<link
linkend="calholidays">Calendar & Holidays</link>' section of
this manual.</para>
</section>
<section id="finesMode">
<title>finesMode</title>
<para>Default: Calculate (but only for mailing to the
admin)</para>
<para>Asks: ___ fines</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Calculate (but only for mailing to the admin)</para>
</listitem>
<listitem>
<para>Calculate and charge</para>
</listitem>
<listitem>
<para>Don't calculate</para>
</listitem>
</itemizedlist>
<important>
<para>Requires that you have the fines cron job running
(misc/cronjobs/fines.pl)</para>
</important>
</section>
</section>
<section id="circholdspolicy">
<title>Holds Policy</title>
<para/>
<section id="AllowHoldDateInFuture">
<title>AllowHoldDateInFuture</title>
<para>Default: Allow</para>
<para>Asks: ___ hold requests to be placed that do not enter the
waiting list until a certain future date.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
<section id="AllowHoldsOnDamagedItems">
<title>AllowHoldsOnDamagedItems</title>
<para>Default: Allow</para>
<para>Asks: ___ hold requests to be placed on damaged
items.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This parameter is a binary setting which controls
whether or not hold requests can be placed on items that are
marked as “damaged" (items are marked as damaged by
editing subfield 4 on the item record). Setting this value to
“Don't allow" will prevent anyone from placing a hold on
such items, setting it to “Allow" will allow it. This
preference is important because it determines whether or not a
patron can place a request for an item that might be in the
process of being repaired or not in good condition. The
library may wish to set this to “Don't allow" if they
were concerned about their patrons not receiving the item in a
timely manner or at all (if it is determined that the item is
beyond repair). Setting it to “Allow" would allow a
patron to place a hold on an item and therefore receive it as
soon as it becomes available.</para>
</listitem>
</itemizedlist>
</section>
<section id="AllowHoldPolicyOverride">
<title>AllowHoldPolicyOverride</title>
<para>Default: Allow</para>
<para>Asks: ___ staff to override hold policies when placing
holds.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference is a binary setting which controls
whether or not the library staff can override the circulation
and fines rules as they pertain to the placement of holds.
Setting this value to “Don't allow" will prevent anyone
from overriding, setting it to “Allow" will allow it.
This setting is important because it determines how strict the
libraries rules for placing holds are. If this is set to
“Allow", exceptions can be made for patrons who are
otherwise normally in good standing with the library, but
there is opportunity for the staff to abuse this function. If
it is set to “Don't allow", no abuse of the system is
possible, but it makes the system entirely inflexible in
respect to holds.</para>
</listitem>
</itemizedlist>
</section>
<section id="AllowOnShelfHolds">
<title>AllowOnShelfHolds</title>
<para>Default: Allow</para>
<para>Asks: ___ hold requests to be placed on items that are not
checked out.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't Allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference is a binary setting which controls the
ability of patrons to place holds on items that are not
currently checked out. Setting it to “Don't allow"
allows borrowers to place holds on items that are checked out
but not on items that are on the shelf (or assumed available
in the library), setting it to “Allow" allows borrowers
to place holds on any item that is available for loan whether
it is checked out or not. This setting might be set to "Allow"
if the library system is a multi branch system and patrons
used the hold system to request items from other libraries, or
if the library wanted to allow users to place holds on items
from home through the OPAC. Setting it to “Don't allow"
would enforce a first come, first served standard.</para>
</listitem>
</itemizedlist>
</section>
<section id="AutoResumeSuspendedHolds">
<title>AutoResumeSuspendedHolds</title>
<para>Default: Allow</para>
<para>Asks: ___ suspended holds to be automatically resumed by a
set date.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If this preference is set to 'Allow' then all suspended
holds will be able to have a date at which they automatically
become unsuspended. If you have this preference set to 'Allow'
you will also need the <link
linkend="unsuspendholdcron">Unsuspend Holds</link> cron job
running.</para>
</listitem>
</itemizedlist>
</section>
<section id="canreservefromotherbranches">
<title>canreservefromotherbranches</title>
<para>Default: Allow</para>
<para>Asks: ___ a user from one library to place a hold on an item
from another library</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference is a binary setting which determines
whether patrons can place holds on items from other branches.
If the preference is set to “Allow" patrons can place
such holds, if it is set to “Don't allow" they cannot.
This is an important setting because it determines if users
can use Koha to request items from another branch. If the
library is sharing an installation of Koha with other
independent libraries which do not wish to allow interlibrary
borrowing it is recommended that this parameter be set to
“Don't allow".</para>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow (with <link
linkend="IndependantBranches">independent
branches</link>)</para>
</listitem>
</itemizedlist>
</section>
<section id="DisplayMultiPlaceHold">
<title>DisplayMultiPlaceHold</title>
<para>Default: Don't enable</para>
<para>Asks: ___ the ability to place holds on multiple biblio from
the search results</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't enable</para>
</listitem>
<listitem>
<para>Enable</para>
</listitem>
</itemizedlist>
</section>
<section id="emailLibrarianWhenHoldIsPlaced">
<title>emailLibrarianWhenHoldIsPlaced</title>
<para>Default: Don't enable</para>
<para>Asks: ___ sending an email to the Koha administrator email
address whenever a hold request is placed.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't enable</para>
</listitem>
<listitem>
<para>Enable</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference enables Koha to email the library staff
whenever a patron requests an item to be held. While this
function will immediately alert the librarian to the patron's
need, it is extremely impractical in most library settings. In
most libraries the hold lists are monitored and maintained
from a separate interface. That said, many libraries that
allow on shelf holds prefer to have this preference turned on
so that they are alerted to pull an item from the
shelf.</para>
</listitem>
</itemizedlist>
<important>
<para>In order for this email to send you must have a <link
linkend="notices">notice</link> template with the code of
HOLDSPLACED</para>
</important>
<important>
<para>This notice will only be sent if the <link
linkend="msgqueuecron">process_message_queue.pl cronjob</link>
being run periodically to send the messages.</para>
</important>
</section>
<section id="ExpireReservesMaxPickUpDelay">
<title>ExpireReservesMaxPickUpDelay</title>
<para>Default: Don't allow</para>
<para>Asks: ___ holds to expire automatically if they have not
been picked by within the time period specified in <link
linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link></para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If set to 'allow' this will cancel holds that have been
waiting for longer than the number of days specified in the
<link
linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
system preference. Holds will only be cancelled if the <link
linkend="expiredholdscron">Expire Holds cron job</link> is
runnning.</para>
</listitem>
</itemizedlist>
</section>
<section id="ExpireReservesMaxPickUpDelayCharge">
<title>ExpireReservesMaxPickUpDelayCharge</title>
<para>Default: 0</para>
<para>Asks: If using <link
linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>,
charge a borrower who allows his or her waiting hold to expire a
fee of ___ USD</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If you are expiring holds that have been waiting too
long you can use this preference to charge the patron for not
picking up their hold. If you don't charge patrons for items
that aren't picked up you can leave this set to the default
which is 0. Holds will only be cancelled and charged if the
<link linkend="expiredholdscron">Expire Holds cron job</link>
is runnning.</para>
</listitem>
</itemizedlist>
</section>
<section id="maxreserves">
<title>maxreserves</title>
<para>Default: 50</para>
<para>Asks: Patrons can only have ___ holds at once.</para>
</section>
<section id="OPACAllowHoldDateInFuture">
<title>OPACAllowHoldDateInFuture</title>
<para>Default: Allow</para>
<para>Asks: ___ patrons to place holds that don't enter the
waiting list until a certain future date.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
<itemizedlist>
<listitem>
<para><link
linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
must also be enabled for this to work</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACAllowUserToChooseBranch">
<title>OPACAllowUserToChooseBranch</title>
<para>Default: Allow</para>
<para>Asks: ___ a user to choose the branch to pick up a hold
from.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Changing this preference will not prevent staff from
being able to transfer titles from one branch to another to
fill a hold, it will only prevent patrons from saying they
plan on picking a book up at a branch other than their home
branch.</para>
</listitem>
</itemizedlist>
</section>
<section id="ReservesControlBranch">
<title>ReservesControlBranch</title>
<para>Default: item's home library</para>
<para>Asks: Check the ___ to see if the patron can place a hold on
the item.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>item's home library.</para>
</listitem>
<listitem>
<para>patron's home library.</para>
</listitem>
</itemizedlist>
</section>
<section id="ReservesMaxPickUpDelay">
<title>ReservesMaxPickUpDelay</title>
<para>Default: 7</para>
<para>Asks: Mark a hold as problematic if it has been waiting for
more than ___ days.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference (based on calendar days, not the <link
linkend="calholidays">Koha holiday calendar</link>) puts an
expiration date on an item a patron has on hold. After this
expiration date the staff will have the option to release the
unclaimed hold which then may be returned to the library shelf
or issued to the next patron on the item's hold list. Items
that are 'expired' by this preference are moved to the 'Holds
Over' tab on the '<link linkend="holdspickup">Holds Awaiting
Pickup</link>' report.</para>
</listitem>
</itemizedlist>
</section>
<section id="ReservesNeedReturns">
<title>ReservesNeedReturns</title>
<para>Default: Don't automatically</para>
<para>Asks: ___ mark holds as found and waiting when a hold is
placed specifically on them and they are already checked
in.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Automatically</para>
</listitem>
<listitem>
<para>Don't automatically</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference refers to ‘item specific' holds
where the item is currently on the library shelf. This
preference allows a library to decide whether an ‘item
specific' hold is marked as “Waiting" at the time the
hold is placed or if the item will be marked as
“Waiting" after the item is checked in. This preference
will tell the patron that their item is ‘Waiting' for
them at their library and ready for check out.</para>
</listitem>
</itemizedlist>
</section>
<section id="holdqueueweight">
<title>StaticHoldsQueueWeight &
RandomizeHoldsQueueWeight</title>
<para>Defaults: 0 & in that order</para>
<para>Asks: Satisfy holds from the libraries ___ (as branchcodes,
separated by commas; if empty, uses all libraries) ___</para>
<para>Descriptions:</para>
<itemizedlist>
<listitem>
<para>RandomizeHoldsQueueWeight randomizes the libraries to
which hold requests are sent. All available libraries may be
randomized or only those libraries listed in the
StaticHoldsQueueWeight preference. RandomizeHoldsQueueWeight
can work with StaticHoldsQueueWeight to determine which
libraries (branch or consortium library) will be targets for
items on holds list. This hold list is produced when patron's
requests for items are generated on a libraries to which holds
are sent. RandomizeHoldsQueueWeight will or will not randomize
the list of libraries that in the StaticHoldsQueueWeight list.
If the RandomizeHoldsQueueWeight is set as “in random
order" the hold requests will be sent randomly to the
libraries on the StaticHoldsQueueWeight list. If
RandomizeHoldsQueueWeight is set as "in that order", hold
requests will be sent to the libraries according to their
order as designated in StaticHoldsQueueWeight or according to
their static ranking in the database. The
StaticHoldsQueueWeight works in conjunction with the
RandomHoldsQueueWeight preference. The StaticHoldsQueueWeight
preference allows for certain libraries or branches to have a
higher weight for holds fulfillment, allowing these libraries
to receive holds before other branch libraries. Previously set
library codes are entered into the preference box, separated
by commas, and these libraries would receive holds before
libraries not listed.</para>
</listitem>
</itemizedlist>
<para>RandomizeHoldsQueueWeight Values:</para>
<itemizedlist>
<listitem>
<para>in random order</para>
</listitem>
<listitem>
<para>in that order</para>
</listitem>
</itemizedlist>
</section>
<section id="SuspendHoldsIntranet">
<title>SuspendHoldsIntranet</title>
<para>Default: Allow</para>
<para>Asks: ___ holds to be suspended from the intranet.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>The holds suspention feature can be turned on and off in
the staff client by altering this system preference. If this
is set to 'allow' you will want to set the <link
linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
system preference.</para>
</listitem>
</itemizedlist>
</section>
<section id="SuspendHoldsOpac">
<title>SuspendHoldsOpac</title>
<para>Default: Allow</para>
<para>Asks: ___ holds to be suspended from the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>The holds suspention feature can be turned on and off in
the OPAC by altering this system preference. If this is set to
'allow' you will want to set the <link
linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
system preference.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="circinterfaceprefs">
<title>Interface</title>
<para/>
<section id="AllowAllMessageDeletion">
<title>AllowAllMessageDeletion</title>
<para>Default: Don't allow</para>
<para>Asks: ___ staff to delete messages added from other
libraries.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
<section id="CircAutocompl">
<title>CircAutocompl</title>
<para>Default: Try</para>
<para>Asks: ___ to automatically fill in the member when entering
a patron search on the circulation screen.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference is a binary setting which determines
whether auto-completion of fields is enabled or disabled for
the circulation input field. Setting it to “Try" would
enable a staff member to begin typing a name or other value
into the field and have a menu pop up with suggestions for
completing it. Setting it to “Don't try" would disable
this feature. This preference can make staff members' jobs
easier or it could potentially slow down the page loading
process.</para>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't try</para>
</listitem>
<listitem>
<para>Try</para>
<screenshot>
<screeninfo>When CircAutocompl is turned on search results
will appear below the search box</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/CircAutocompl.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="CircAutoPrintQuickSlip">
<title>CircAutoPrintQuickSlip</title>
<para>Default: open a print quick slip window</para>
<para>Asks: When an empty barcode field is submitted in
circulation ___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>clear the screen</para>
</listitem>
<listitem>
<para>open a print quick slip window</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If this preference is set to open a quick slip for
printing it will eliminate the need for the librarian to click
the print button to generate a checkout receipt for the patron
they're checking out to. If the preference is set to clear the
screen then "checking out" an empty barcode will clear the
screen of the patron you were last working with.</para>
</listitem>
</itemizedlist>
</section>
<section id="FilterBeforeOverdueReport">
<title>FilterBeforeOverdueReport</title>
<para>Default: Don't require</para>
<para>Asks: ___ staff to choose which checkouts to show before
running the overdues report.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Koha's overdue report shows you all of the overdue items
in your library system. If you have a large library system
you'll want to set this preference to 'Require' to force those
running the report to first limit the data generated to a
branch, date range, patron category or other such filter.
Requiring that the report be filtered before it's run prevents
your staff from running a system heavy report and slowing down
other operations in the system.</para>
<screenshot>
<screeninfo>Overdue Report Filters</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/FilterBeforeOverdueReport.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't require</para>
</listitem>
<listitem>
<para>Require</para>
</listitem>
</itemizedlist>
</section>
<section id="FineNotifyAtCheckin">
<title>FineNotifyAtCheckin</title>
<para>Default: Don't notify</para>
<para>Asks: ___ librarians of overdue fines on the items they are
checking in.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't notify</para>
</listitem>
<listitem>
<para>Notify</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>With this preference set to 'Notify' all books that have
overdue fines owed on them will pop up a warning when checking
them in. This warning will need to acknowledged before you can
continue checking items in. With this preference set to 'Don't
notify,' you will still see fines owed on the patron record,
you just won't have an additional notification at check
in.</para>
<screenshot>
<screeninfo>Fine notification at checkin</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="DisplayClearScreenButton">
<title>DisplayClearScreenButton</title>
<para>Default: Show</para>
<para>Asks: ___ a button to clear the current patron from the
screen on the circulation screen.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
<screenshot>
<screeninfo>No X in the top right</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/DisplayClearScreenButtonOff.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Show</para>
<screenshot>
<screeninfo>X in the top right will clear the
screen</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="itemBarcodeInputFilter">
<title>itemBarcodeInputFilter</title>
<para>Default: Don't filter</para>
<para>Asks: ___ scanned patron barcodes.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Convert from CueCat format</para>
</listitem>
<listitem>
<para>Don't filter</para>
</listitem>
<listitem>
<para>Remove spaces from</para>
</listitem>
<listitem>
<para>Remove the first number from T-prefix style</para>
<itemizedlist>
<listitem>
<para>This format is common among those libraries
migrating from Follett systems</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="NoticeCSS">
<title>NoticeCSS</title>
<para>Asks: Include the stylesheet at ___ on Notices.<important>
<para>This should be a complete URL, starting with
http://</para>
</important></para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If you would like to style your notices with a
consistent set of fonts and colors you can use this preference
to point Koha to a stylesheet specifically for your
notices.</para>
</listitem>
</itemizedlist>
</section>
<section id="numReturnedItemsToShow">
<title>numReturnedItemsToShow</title>
<para>Default: 20</para>
<para>Asks : Show the ___ last returned items on the checkin
screen.</para>
</section>
<section id="previousIssuesDefaultSortOrder">
<title>previousIssuesDefaultSortOrder</title>
<para>Default: earliest to latest</para>
<para>Asks: Sort previous checkouts on the circulation page from
___ due date.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>earliest to latest</para>
</listitem>
<listitem>
<para>latest to earliest</para>
</listitem>
</itemizedlist>
</section>
<section id="RecordLocalUseOnReturn">
<title>RecordLocalUseOnReturn</title>
<para>Default: Don't record</para>
<para>Asks: ___ local use when an unissued item is checked
in.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't record</para>
</listitem>
<listitem>
<para>Record</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When this preference is set to "Don't record" you can
record local use of items by checking items out to the
statistical patron. With this preference set to "Record" you
can record local use by checking out to the statistical patron
and/or by checking in a book that is not currently checked
out.</para>
</listitem>
</itemizedlist>
</section>
<section id="soundon">
<title>soundon</title>
<para>Default: Don't enable</para>
<para>Asks: ___ circulation sounds during checkin and checkout in
the staff interface.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't enable</para>
</listitem>
<listitem>
<para>Enable</para>
</listitem>
</itemizedlist>
<para><important>
<para>This feature is not supported by all browsers. Requires
an HTML5 compliant browser.</para>
</important></para>
</section>
<section id="SpecifyDueDate">
<title>SpecifyDueDate</title>
<para>Default: Allow</para>
<para>Asks: ___ staff to specify a due date for a checkout.</para>
<para>Due dates are calculated using your circulation and fines
rules, but staff can override that if you allow them to specify a
due date at checkout.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows for circulation staff to change a
due date from the automatic due date to another calendar date.
This option would be used for circumstances in which the due
date may need to be decreased or extended in a specific
circumstance. The “Allow" setting would allow for this
option to be utilized by staff, the “Don't allow"
setting would bar staff from changing the due date on
materials.</para>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
<section id="todaysIssuesDefaultSortOrder">
<title>todaysIssuesDefaultSortOrder</title>
<para>Default: latest to earliest</para>
<para>Asks: Sort today's checkouts on the circulation page from
___ due date.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>earliest to latest</para>
</listitem>
<listitem>
<para>latest to earliest</para>
</listitem>
</itemizedlist>
</section>
<section id="UseTablesortForCirc">
<title>UseTablesortForCirc</title>
<para>Default: Don't enable</para>
<para>Asks: ___ the sorting of current patron checkouts on the
circulation screen.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't enable</para>
</listitem>
<listitem>
<para>Enable</para>
</listitem>
</itemizedlist>
<important>
<para>Enabling this function may slow down circulation time for
patrons with many checkouts.</para>
</important>
</section>
<section id="WaitingNotifyAtCheckin">
<title>WaitingNotifyAtCheckin</title>
<para>Default: Don't notify</para>
<para>Asks: ___ librarians of waiting holds for the patron whose
items they are checking in.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't notify</para>
</listitem>
<listitem>
<para>Notify</para>
<screenshot>
<screeninfo>Notification that a hold is waiting</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/WaitingNotifyAtCheckin.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When checking in books you can choose whether or not to
have a notice pop up if the patron who returned the book has a
hold waiting for pick up. If you choose 'Notify' for
WaitingNotifyAtCheckin then every time a hold is found for the
patron who had the book out last a message will appear on your
check in screen.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="circscoprefs">
<title>Self Checkout</title>
<para/>
<section id="AllowSelfCheckReturns">
<title>AllowSelfCheckReturns</title>
<para>Default: Don't allow</para>
<para>Asks: ___ patrons to return items through web-based self
checkout system.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference is used to determine if you want patrons
to be allowed to return items through your self check
machines. By default Koha's self check interface is simply for
checking items out.</para>
</listitem>
</itemizedlist>
</section>
<section id="AutoSelfCheckAllowed">
<title>AutoSelfCheckAllowed, AutoSelfCheckID &
AutoSelfCheckPass</title>
<important>
<para>Most libraries will want to leave this set to 'Don't
allow.' This preference turns off the requirement to log into
the self checkout machine with a staff username and password by
storing the username and password for automatic login.</para>
</important>
<para>AutoSelfCheckAllowed Default: Don't allow</para>
<para>Asks: ___ the web-based self checkout system to
automatically login with this staff login ___ and this password
___ .</para>
<para>AutoSelfCheckAllowed Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>AutoSelfCheckID needs to be set to the username of a staff
member with 'circulate' <link
linkend="patronpermissions">permissions</link>.</para>
<para>AutoSelfCheckPass needs to be set to the password of a staff
member with 'circulate' <link
linkend="patronpermissions">permissions</link>.</para>
</section>
<section id="SelfCheckHelpMessage">
<title>SelfCheckHelpMessage</title>
<para>Asks: Include the following HTML in the Help page of the
web-based self checkout system</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Clicking the 'Help' link in the top right of the self
checkout interface opens up a three step process for using the
self check interface. Adding HTML to this system preference
will print that additional help text above what's already
included.</para>
</listitem>
</itemizedlist>
</section>
<section id="SelfCheckoutByLogin">
<title>SelfCheckoutByLogin</title>
<para>Default: Barcode</para>
<para>Asks: Have patrons login into the web-based self checkout
system with their ___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Barcode</para>
<screenshot>
<screeninfo>Self Checkout Patron Card Number</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/selfcheckout.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Username and password</para>
<screenshot>
<screeninfo>Shelf checkout by login</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference lets you decide how your patrons will
log in to the self checkout machine. Barcode is the patron's
card number and their username and password is set using the
opac/staff username and password fields on the patron
record.</para>
</listitem>
</itemizedlist>
</section>
<section id="SelfCheckTimeout">
<title>SelfCheckTimeout</title>
<para>Default: 120</para>
<para>Asks: Time out the current patron's web-based self checkout
system login after ___ seconds.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>After the machine is idle for the time entered in this
preference the self check out system will log out the current
patron and return to the starting screen.</para>
</listitem>
</itemizedlist>
</section>
<section id="ShowPatronImageInWebBasedSelfCheck">
<title>ShowPatronImageInWebBasedSelfCheck</title>
<para>Default: Don't show</para>
<para>Asks: ___ the patron's picture (if one has been added) when
they use the web-based self checkout.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
</section>
<section id="WebBasedSelfCheck">
<title>WebBasedSelfCheck</title>
<para>Default: Don't enable</para>
<para>Asks: ___ the web-based self checkout system.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't enable</para>
</listitem>
<listitem>
<para>Enable</para>
</listitem>
</itemizedlist>
<para>Enabling this preference will allow access to the <link
linkend="selfcheckout">self checkout</link> module in Koha.</para>
</section>
</section>
</section>
<section id="creatorprefs">
<title>Creators</title>
<para>These preferences have to do with creating content.</para>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences > Creators</para>
<section id="creatorpatcardprefs">
<title>Patron Cards</title>
<para>These preferences are in reference to the <link
linkend="patroncardcreator">Patron Card Creator</link> tool.</para>
<section id="ImageLimit">
<title>ImageLimit</title>
<para>Asks: Limit the number of creator images stored in the
database to ___ images.</para>
</section>
</section>
</section>
<section id="enhancedcontent">
<title>Enhanced Content</title>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences > Enhanced Content</para>
<important>
<para>Always read the terms of service associated with external data
sources to be sure that you are using the products within the
allowed limits.</para>
</important>
<tip>
<para>You cannot have more than one service for cover images
(including local cover images) set up. If you set up more than one
you will get multiple cover images. Instead choose only one source
for cover images.</para>
</tip>
<section id="frbrenhancedprefs">
<title>All</title>
<para/>
<section id="FRBRizeEditions">
<title>FRBRizeEditions</title>
<para>Default: Don't show</para>
<para>Asks: ___ other editions of an item on the staff
client</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
<screenshot>
<screeninfo>Editions tab in staff client</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/editionstab.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Using the rules set forth in the Functional Requirements
for Bibliographic records, this option, when enabled, pulls
all editions of the same title available in your collection
regardless of material type. Items will appear under an
'Editions' tab on the detail page for the title in question..
According to <emphasis>Libraries Unlimited's Online Dictionary
for Library and Information Science</emphasis> (<ulink
url="http://lu.com/odlis/";>http://lu.com/odlis/</ulink>),
FRBRizing the catalog involves collating MARC records of
similar materials. FRBRization brings together entities (sets
of Works, Expressions, or Manifestations), rather than just
sets of Items. It can aid patrons in selecting related items,
expressions, and manifestations that will serve their needs.
When it is set to "Show", the OPAC will query one or more ISBN
web services for associated ISBNs and display an Editions tab
on the details pages. Once this preference is enabled, the
library must select one of the ISBN options (<link
linkend="ThingISBN">ThingISBN</link> or <link
linkend="XISBN">XISBN</link>). This option is only for the
Staff Client; the OPACFRBRizeEditions option must be enabled
to have the Editions tab appear on the OPAC.</para>
</listitem>
</itemizedlist>
<important>
<para>Requires that you turn on one or more of the ISBN services
(ThingISBN, XISBN)</para>
</important>
</section>
<section id="OPACFRBRizeEditions">
<title>OPACFRBRizeEditions</title>
<para>Default: Don't show</para>
<para>Asks: ___ other editions of an item on the OPAC.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Using the rules set forth in the Functional Requirements
for Bibliographic records, this option, when enabled, pulls
all editions of the same title available in your collection
regardless of material type. Items will appear under an
'Editions' tab on the detail page for the title in question..
According to <emphasis>Libraries Unlimited's Online Dictionary
for Library and Information Science</emphasis> (<ulink
url="http://lu.com/odlis/";>http://lu.com/odlis/</ulink>),
FRBRizing the catalog involves collating MARC records of
similar materials. FRBRization brings together entities (sets
of Works, Expressions, or Manifestations), rather than just
sets of Items. It can aid patrons in selecting related items,
expressions, and manifestations that will serve their needs.
When it is set to "Show", the OPAC will query one or more ISBN
web services for associated ISBNs and display an Editions tab
on the details pages. Once this preference is enabled, the
library must select one of the ISBN options (<link
linkend="ThingISBN">ThingISBN</link> or <link
linkend="XISBN">XISBN</link>). This option is only for the
OPAC; the 'FRBRizeEditions' option must be turned “On"
to have the Editions tab appear on the Staff Client.</para>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
<screenshot>
<screeninfo>Editions tab in the OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/editions.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<para>This preference pulls all editions of the same title
available in your collection regardless of material type. Items
will appear under an 'Editions' tab on the detail page for the
title in question.</para>
<important>
<para>Requires that you turn on one or more of the ISBN services
(ThingISBN, XISBN)</para>
</important>
</section>
</section>
<section id="amazonprefs">
<title>Amazon</title>
<para/>
<section id="AmazonEnabled">
<title>AmazonEnabled</title>
<para>Default: Don't use</para>
<para>Asks: ___ data from Amazon on the staff interface (including
reviews and "Search Inside" links on item detail pages).</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't use</para>
</listitem>
<listitem>
<para>Use</para>
</listitem>
</itemizedlist>
<important>
<para>This requires that you have signed up for and entered an
access key.</para>
</important>
<itemizedlist>
<listitem>
<para>Sign up at: <ulink
url="http://aws.amazon.com/";>http://aws.amazon.com/</ulink></para>
</listitem>
<listitem>
<para>Enter your key in the <link
linkend="AWSAccessKeyID">AWSAccessKeyID</link> system
preference</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference does not display any content but instead
enables other Amazon-related preferences (<link
linkend="AmazonCoverImages">AmazonCoverImages</link>, <link
linkend="AmazonSimilarItems">AmazonSimilarItems</link>, <link
linkend="AmazonReviews">AmazonReviews</link>). Before turning
this feature to "Use", the library must first set <link
linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
linkend="AWSPrivateKey">AWSPrivateKey</link>. Furthermore, if
Amazon content is enabled, other jacket services should be
disabled to avoid interference. This preference applies only
to the Staff Client. In order to display Amazon content on the
OPAC, please set the <link
linkend="OPACAmazonEnabled">OPACAmazonEnabled</link>
preference.</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACAmazonEnabled">
<title>OPACAmazonEnabled</title>
<para>Default: Don't use</para>
<para>Asks: ___ data from Amazon on the OPAC (including reviews
and "Search Inside" links on item detail pages).</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't use</para>
</listitem>
<listitem>
<para>Use</para>
</listitem>
</itemizedlist>
<important>
<para>This requires that you have signed up for and entered an
access key.</para>
</important>
<itemizedlist>
<listitem>
<para>Sign up at: <ulink
url="http://aws.amazon.com/";>http://aws.amazon.com/</ulink></para>
</listitem>
<listitem>
<para>Set your enter your key in the <link
linkend="AWSAccessKeyID">AWSAccessKeyID</link> system
preference</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference does not display any content but instead
enables other Amazon-related preferences (<link
linkend="AmazonCoverImages">AmazonCoverImages</link>, <link
linkend="AmazonSimilarItems">AmazonSimilarItems</link>, <link
linkend="AmazonReviews">AmazonReviews</link>). Before turning
this feature to "Use", the library must first set <link
linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
linkend="AWSPrivateKey">AWSPrivateKey</link>. Furthermore, if
Amazon content is enabled, other jacket services should be
disabled to avoid interference. This preference applies only
to the OPAC. In order to display Amazon content on the Staff
Client, please set the <link
linkend="AmazonEnabled">AmazonEnabled</link>
preference.</para>
</listitem>
</itemizedlist>
</section>
<section id="AmazonLocale">
<title>AmazonLocale</title>
<para>Default: American</para>
<para>Asks: Use Amazon data from its ___ website.</para>
<para>Value:</para>
<itemizedlist>
<listitem>
<para>American</para>
</listitem>
<listitem>
<para>British</para>
</listitem>
<listitem>
<para>Canadian</para>
</listitem>
<listitem>
<para>French</para>
</listitem>
<listitem>
<para>German</para>
</listitem>
<listitem>
<para>Japanese</para>
</listitem>
</itemizedlist>
</section>
<section id="AWSAccessKeyID">
<title>AWSAccessKeyID</title>
<para>Asks: Access Amazon content using the access key ___</para>
<para>Sign up at: <ulink
url="http://aws.amazon.com/";>http://aws.amazon.com/</ulink></para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If the library has signed up for an Amazon Web Services
(AWS) account, it will be assigned an Access Key ID. In order
to enable Amazon content, cover images, reviews, and similar
item suggestions, the library's Access Key ID must be entered
here.</para>
</listitem>
</itemizedlist>
<para>Once signed up your keys can be accessed by logging into
your account and going to the 'Security Credentials' page. Your
Access Key will be listed next to the date it was created.</para>
<screenshot>
<screeninfo>Amazon Access Keys</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/amazonkeys.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="AWSPrivateKey">
<title>AWSPrivateKey</title>
<para>Asks: Access Amazon content (other than book jackets) using
the private key ___</para>
<para>Sign up at: <ulink
url="http://aws.amazon.com/";>http://aws.amazon.com/</ulink></para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If the library has signed up for an Amazon Web Services
(AWS) account, it will be assigned a Secret Access Key. In
order to enable Amazon reviews and similar item suggestions,
the library's Secret Access Key must be entered here.</para>
</listitem>
</itemizedlist>
<para>Once signed up your keys can be accessed by logging into
your account and going to the 'Security Credentials' page. Next to
your Access key is a link that says 'Show,' clicking this will
open up your secret access key or your AWSPrivateKey.</para>
<screenshot>
<screeninfo>Amazon Private Key</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/amazonkeys.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="AmazonAssocTag">
<title>AmazonAssocTag</title>
<para>Asks: Put the associate tag ___ on links to Amazon.</para>
<tip>
<para>This can net your library referral fees if a patron
decides to buy an item after clicking through to Amazon from
your site.</para>
</tip>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>An Amazon Associates Tag allows a library to earn a
percentage of all purchases made on Amazon when a patron
accesses Amazon's site via links on the library's website.
More information about the Amazon Associates program is
available at Amazon's Affiliate Program's website, <ulink
url="https://affiliate-program.amazon.com/";>https://affiliate-program.amazon.com/</ulink>.
Before a tag can be obtained, however, the library must first
apply for an Amazon Web Services (AWS) account. Applications
are free of charge and can be made at <ulink
url="http://aws.amazon.com";>http://aws.amazon.com</ulink>.
Once an AWS account has been established, the library can then
obtain the Amazon Associates Tag.</para>
</listitem>
</itemizedlist>
<para>Sign up at: <ulink
url="https://affiliate-program.amazon.com/";>https://affiliate-program.amazon.com/</ulink></para>
</section>
<section id="AmazonCoverImages">
<title>AmazonCoverImages</title>
<para>Default: Don't show</para>
<para>Asks: ___ cover images from Amazon on search results and
item detail pages on the staff interface.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference makes it possible to either allow or
prevent Amazon cover images from being displayed in the Staff
Client. Cover images are retrieved by Amazon, which pulls the
content based on the first ISBN number in the item's MARC
record. Amazon offers this service free of charge, but
interested libraries must first establish an Amazon Web
Services (AWS) account (<ulink
url="http://aws.amazon.com";>http://aws.amazon.com</ulink>). If
the value for this preference is set to "Show", the cover
images will appear in the Staff Client, and if it is set to
"Don't show", the images will not appear. If activating this
feature, the library must first set <link
linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally, if
you're using Amazon cover images, all other cover image
services must be disabled. If they are not disabled, they will
prevent AmazonCoverImages from functioning properly.</para>
</listitem>
</itemizedlist>
<important>
<para>Requires that <link
linkend="AmazonEnabled">AmazonEnabled</link> is set to
'Use'</para>
</important>
</section>
<section id="AmazonReviews">
<title>AmazonReviews</title>
<para>Default: Don't show</para>
<para>Asks: ___ reviews from Amazon on item detail pages on the
staff interface.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference makes it possible to either allow or
prevent Amazon reviews from being displayed in the Staff
Client. Amazon offers this service free of charge, but
interested libraries must first establish an Amazon Web
Services (AWS) account (<ulink
url="http://aws.amazon.com";>http://aws.amazon.com</ulink>). If
the value is set to "Show", the reviews will appear in the
Staff Client, and if it is set to "Don't show", the reviews
will not appear. Before setting this to "Show", the library
must first set <link
linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally, if
AmazonReviews is enabled, all other review services should be
disabled to avoid interference.</para>
</listitem>
</itemizedlist>
<important>
<para>Since a change in terms of service by Amazon, this feature
no longer works.</para>
</important>
</section>
<section id="AmazonSimilarItems">
<title>AmazonSimilarItems</title>
<para>Default: Don't show</para>
<para>Asks: ___ similar items, as determined by Amazon, on item
detail pages on the staff interface.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
<itemizedlist>
<listitem>
<para>This will use Amazon data to determine if you have
similar items in your collection - it will not show items
that you do not already have cataloged at your
library.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference makes it possible to either allow or
prevent Amazon's suggestions for Similar Items from being
displayed in the Staff Client. Amazon offers this service free
of charge, but interested libraries must first establish an
Amazon Web Services (AWS) account (<ulink
url="http://aws.amazon.com";>http://aws.amazon.com</ulink>). If
the value is set to "Show", the Similar Items suggestions will
appear in the Staff Client, and if it is set to "Don't show",
the suggestions will not appear. Before enabling this
preference, the library must first set <link
linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally, if
AmazonSimilarItems is enabled, all other similar item services
should be disabled to avoid interference.</para>
</listitem>
</itemizedlist>
<important>
<para>Since a change in terms of service by Amazon, this feature
no longer works.</para>
</important>
</section>
<section id="OPACAmazonCoverImages">
<title>OPACAmazonCoverImages</title>
<para>Default: Don't show</para>
<para>Asks: ___ cover images from Amazon on search results and
item detail pages on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference makes it possible to either allow or
prevent Amazon cover images from being displayed in the OPAC.
Cover images are retrieved by Amazon, which pulls the content
based on the first ISBN number in the item's MARC record.
Amazon offers this service free of charge, but interested
libraries must first establish an Amazon Web Services (AWS)
account (<ulink
url="http://aws.amazon.com";>http://aws.amazon.com</ulink>). If
the value for this preference is set to "Show", the cover
images will appear in the OPAC, and if it is set to "Don't
show", the images will not appear. If activating this feature,
the library must first set <link
linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally, if
you're using Amazon cover images, all other cover image
services must be disabled. If they are not disabled, they will
prevent AmazonCoverImages from functioning properly.</para>
</listitem>
</itemizedlist>
<important>
<para>Requires that <link
linkend="OPACAmazonEnabled">OPACAmazonEnabled</link> is set to
'Use'</para>
</important>
</section>
<section id="OPACAmazonSimilarItems">
<title>OPACAmazonSimilarItems</title>
<para>Default: Don't show</para>
<para>Asks: ___ similar items, as determined by Amazon, on item
detail pages on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
<itemizedlist>
<listitem>
<para>This will use Amazon data to determine if you have
similar items in your collection - it will not show items
that you do not already have cataloged at your
library.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference makes it possible to either allow or
prevent Amazon's suggestions for Similar Items from being
displayed in the OPAC. Amazon offers this service free of
charge, but interested libraries must first establish an
Amazon Web Services (AWS) account (<ulink
url="http://aws.amazon.com";>http://aws.amazon.com</ulink>). If
the value is set to "Show", the Similar Items suggestions will
appear in the OPAC, and if it is set to "Don't show", the
suggestions will not appear. Before enabling this preference,
the library must first set <link
linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally, if
AmazonSimilarItems is enabled, all other similar item services
should be disabled to avoid interference.</para>
</listitem>
</itemizedlist>
<important>
<para>Since a change in terms of service by Amazon, this feature
no longer works.</para>
</important>
</section>
<section id="OPACAmazonReviews">
<title>OPACAmazonReviews</title>
<para>Default: Don't show</para>
<para>Asks: ___ reviews from Amazon on item detail pages on the
OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference makes it possible to either allow or
prevent Amazon reviews from being displayed in the OPAC.
Amazon offers this service free of charge, but interested
libraries must first establish an Amazon Web Services (AWS)
account (<ulink
url="http://aws.amazon.com";>http://aws.amazon.com</ulink>). If
the value is set to "Show", the reviews will appear in the
OPAC, and if it is set to "Don't show", the reviews will not
appear. Before setting this to "Show", the library must first
set <link linkend="AWSAccessKeyID">AWSAccessKeyID</link> and
<link linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally,
if AmazonReviews is enabled, all other review services should
be disabled to avoid interference.</para>
</listitem>
</itemizedlist>
<important>
<para>Since a change in terms of service by Amazon, this feature
no longer works.</para>
</important>
</section>
</section>
<section id="Babelthequeprefs">
<title>Babelthèque</title>
<para/>
<section id="Babeltheque">
<title>Babeltheque</title>
<para>Default: Don't</para>
<para>Asks: ___ include information (such as reviews and
citations) from Babelthèque in item detail pages on the
OPAC.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference makes it possible to display a
Babeltheque tab in the OPAC, allowing patrons to access tags,
reviews, and additional title information provided by
Babeltheque. The information which Babeltheque supplies is
drawn from the French language-based <ulink
url="http://www.babelio.com/";>Babelio.com</ulink>, a French
service similar to LibraryThing for Libraries. More
information about Babeltheque is available through its
website, <ulink
url="http://www.babeltheque.com/";>http://www.babeltheque.com</ulink>.
Libraries that wish to allow access to this information must
first register for the service at <ulink
url="http://www.babeltheque.com";>http://www.babeltheque.com</ulink>.
Please note that this information is only provided in
French.</para>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Do</para>
<screenshot>
<screeninfo>Data from Babelthèque on the bib
record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/Babeltheque.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Don't</para>
</listitem>
</itemizedlist>
</section>
<section id="Babeltheque_url_js">
<title>Babeltheque_url_js</title>
<para>Asks: ___ Defined the url for the Babeltheque javascript
file (eg. http://www.babeltheque.com/bw_XX.js)</para>
</section>
<section id="Babeltheque_url_update">
<title>Babeltheque_url_update</title>
<para>Asks: ___ Defined the url for the Babeltheque update
periodically (eq.
http://www.babeltheque.com/.../file.csv.bz2).</para>
</section>
</section>
<section id="btcontentprefs">
<title>Baker & Taylor</title>
<important>
<para>This is a pay service, you must contact Baker & Taylor
to subscribe to this service before setting these options.</para>
</important>
<section id="BakerTaylorEnabled">
<title>BakerTaylorEnabled</title>
<para>Default: Don't add</para>
<para>Asks: ___ Baker and Taylor links and cover images to the
OPAC and staff client. This requires that you have entered in a
username and password (which can be seen in image links).</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Add</para>
</listitem>
<listitem>
<para>Don't add</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference makes it possible to display Baker &
Taylor content (book reviews, descriptions, cover images,
etc.) in both the Staff Client and the OPAC. Libraries that
wish to display Baker & Taylor content must first register
and pay for this service with Baker & Taylor (<ulink
url="http://www.btol.com";>http://www.btol.com</ulink>). If
Baker & Taylor content is enabled be sure to turn off
other cover and review services to prevent
interference.</para>
</listitem>
</itemizedlist>
<important>
<para>To use this you will need to also set the <link
linkend="btuserpass">BakerTaylorUsername &
BakerTaylorPassword</link> system preferences</para>
</important>
</section>
<section id="BakerTaylorBookstoreURL">
<title>BakerTaylorBookstoreURL</title>
<para>Asks: Baker and Taylor "My Library Bookstore" links should
be accessed at https:// ___ isbn</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Some libraries generate additional funding for the
library by selling books and other materials that are
purchased from or have been previously leased from Baker &
Taylor. These materials can be accessed via a link on the
library's website. This service is often referred to as
“My Library Bookstore." In order to participate in this
program, the library must first register and pay for the
service with Baker & Taylor. Additional information about
this and other services provided by Baker & Taylor is
available at the Baker & Taylor website, <ulink
url="http://www.btol.com";>http://www.btol.com</ulink>. The
BakerTaylorBookstoreURL preference establishes the URL in
order to link to the library's Baker & Taylor-backed
online bookstore, if such a bookstore has been established.
The default for this field is left blank; if no value is
entered, the links to My Library Bookstore will remain
inactive. If enabling this preference, enter the library's
Hostname and Parent Number in the appropriate location within
the URL. The “key" value (key=) should be appended to
the URL, and https:// should be prepended.</para>
</listitem>
</itemizedlist>
<para>This should be filled in with something like
koha.mylibrarybookstore.com/MLB/actions/searchHandler.do?nextPage=bookDetails&parentNum=10923&key=</para>
<tip>
<para>Leave it blank to disable these links.</para>
</tip>
<important>
<para>Be sure to get this information from Baker & Taylor
when subscribing.</para>
</important>
</section>
<section id="btuserpass">
<title>BakerTaylorUsername & BakerTaylorPassword</title>
<para>Asks: Access Baker and Taylor using username ___ and
password ___</para>
<para>Descriptions:</para>
<itemizedlist>
<listitem>
<para>This setting in only applicable if the library has a
paid subscription to the external Content Café service
from Baker & Taylor. Use the box provided to enter in the
library's Content Café username and password. Also,
ensure that the <link
linkend="BakerTaylorBookstoreURL">BakerTaylorBookstoreURL</link>
and <link
linkend="BakerTaylorEnabled">BakerTaylorEnabled</link>
settings are properly set. The Content Café service is
a feed of enhanced content such as cover art, professional
reviews, and summaries that is displayed along with Staff
Client/OPAC search results. For more information on this
service please see the Baker & Taylor website: <ulink
url="http://www.btol.com";>http://www.btol.com</ulink></para>
</listitem>
</itemizedlist>
<important>
<para>Be sure to get this information from Baker & Taylor
when subscribing.</para>
</important>
</section>
</section>
<section id="googleprefs">
<title>Google</title>
<para/>
<section id="GoogleJackets">
<title>GoogleJackets</title>
<para>Default: Don't add</para>
<para>Asks: ___ cover images from Google Books to search results
and item detail pages on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Add</para>
</listitem>
<listitem>
<para>Don't add</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This setting controls the display of applicable cover
art from the free Google Books database, via the Google Books
API. Please note that to use this feature, all other cover
services should be turned off.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="librarythingprefs">
<title>LibraryThing</title>
<para>LibraryThing for Libraries is a pay service. You must first
contact LibraryThing directly for pricing and subscription
information. Learn more at <ulink
url="http://www.librarything.com/forlibraries";>http://www.librarything.com/forlibraries</ulink>.
Also, for further configuration instructions please see the
LibraryThing Wiki: <ulink
url="http://www.librarything.com/wiki/index.php/Koha";>http://www.librarything.com/wiki/index.php/Koha</ulink></para>
<section id="ThingISBN">
<title>ThingISBN</title>
<para>Default: Don't use</para>
<para>Asks: ___ the ThingISBN service to show other editions of a
title</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't use</para>
</listitem>
<listitem>
<para>Use</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Set to 'Use' to display an “Editions" tab on the
item's detail page. Editions are listed, complete with cover
art (if you have one of the cover services enabled) and
bibliographic information. The feed comes from LibraryThing's
ThingISBN web service. This is a free service to
non-commercial sites with fewer than 1,000 requests per
day.</para>
</listitem>
</itemizedlist>
<important>
<para>Requires <link
linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
'show'</para>
</important>
<important>
<para>This is separate from Library Thing for Libraries and does
not have a cost associated with it.</para>
</important>
</section>
<section id="LibraryThingForLibrariesEnabled">
<title>LibraryThingForLibrariesEnabled</title>
<para>Default: Don't show</para>
<para>Asks: ___ reviews, similar items, and tags from Library
Thing for Libraries on item detail pages on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This setting is only applicable if the library has a
paid subscription to the external LibraryThing for Libraries
service. This service can provide patrons with the display of
expanded information on catalog items such as book
recommendations. It also can offer advanced features like
tagged browsing, patron written reviews, and a virtual library
display accessed from the details tab.</para>
</listitem>
</itemizedlist>
<important>
<para>If this is set to 'show' you will need to enter a value in
the '<link
linkend="LibraryThingForLibrariesID">LibraryThingForLibrariesID</link>'
system preference.</para>
</important>
</section>
<section id="LibraryThingForLibrariesID">
<title>LibraryThingForLibrariesID</title>
<para>Asks: Access Library Thing for Libraries using the customer
ID ___</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This setting is only applicable if the library has a
paid subscription to the external LibraryThing for Libraries
service. Use the box provided to enter in the library's
LibraryThing for Libraries ID as provided to the library by
LibraryThing. The ID number is a series of numbers in the form
###-#########, and can be found on the library's account page
at LibraryThing for Libraries. This service can provide
patrons with the display of expanded information on catalog
items such as book recommendations and cover art. It also can
offer advanced features like tagged browsing, patron written
reviews, and a virtual library display accessed from the
details tab.</para>
</listitem>
</itemizedlist>
</section>
<section id="LibraryThingForLibrariesTabbedView">
<title>LibraryThingForLibrariesTabbedView</title>
<para>Default: in line with bibliographic information</para>
<para>Asks: Show Library Thing for Libraries content ___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>in line with bibliographic information</para>
</listitem>
<listitem>
<para>in tabs</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This setting is only applicable if the library has a
paid subscription to the external LibraryThing for Libraries
service. This service can provide patrons with the display of
expanded information on catalog items such as book
recommendations and cover art. It also can offer advanced
features like tagged browsing, patron written reviews, and a
virtual library display accessed from the details tab.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="localimages">
<title>Local Cover Images</title>
<para/>
<section id="AllowMultipleCovers">
<title>AllowMultipleCovers</title>
<para>Default: Don't allow</para>
<para>Asks: ___ multiple images to be attached to each
bibliographic record.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If this preference is set to 'Allow' then you can upload
multiple images that will appear in the images tab on the bib
record in the OPAC and the staff client. This preference
requires that either one or both <link
linkend="LocalCoverImages">LocalCoverImages</link> and <link
linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> are
set to 'Display.'</para>
<screenshot>
<screeninfo>Multiple cover images</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="LocalCoverImages">
<title>LocalCoverImages</title>
<para>Default: Don't display</para>
<para>Asks: ___ local cover images on intranet search and details
pages.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Display</para>
</listitem>
<listitem>
<para>Don't display</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Setting this preference to 'Display' allows you to
upload your own cover images to bib records and display them
on the detail page in the staff client. At this time the cover
will only show under the 'Images' tab on the holdings table on
the detail display, not next to the title at the top left or
on the search results.</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACLocalCoverImages">
<title>OPACLocalCoverImages</title>
<para>Default: Don't display</para>
<para>Asks: ___ local cover images on OPAC search and details
pages.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Display</para>
</listitem>
<listitem>
<para>Don't display</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Setting this preference to 'Display' allows you to
upload your own cover images to bib records and display them
on the detail page and search results in the OPAC.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="novelistselect">
<title>Novelist Select</title>
<para>Novelist Select is not a free service. Contact your Ebsco
representitive to get your log in information to embed this content
in the OPAC.<important>
<para>Novelist Select does not include cover images for the
search results and bibliographic detail pages. You can choose
any other cover image service for this content.</para>
</important></para>
<section id="NovelistSelectEnabled">
<title>NovelistSelectEnabled</title>
<para>Default: Don't add</para>
<para>Asks: ___ Novelist Select content to the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Add</para>
</listitem>
<listitem>
<para>Don't add</para>
</listitem>
</itemizedlist>
<para><important>
<para>Enabling this requires that you have entered in a user
profile and password in the <link
linkend="NovelistSelectProfile">NovelistSelectProfile &
NovelistSelectPassword</link> preferences</para>
</important>Description:</para>
<itemizedlist>
<listitem>
<para>Novelist Select from Ebsco is a subscription service
that can provide additional content in the OPAC.</para>
</listitem>
</itemizedlist>
</section>
<section id="NovelistSelectProfile">
<title>NovelistSelectProfile & NovelistSelectPassword</title>
<para>Asks: Access Novelist Select using user profile ___ and
password ___.</para>
<important>
<para>This information will be visible if someone views the
source code on your OPAC.</para>
</important>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Novelist Select from Ebsco is a subscription service
that can provide additional content in the OPAC.</para>
</listitem>
</itemizedlist>
</section>
<section id="NovelistSelectView">
<title>NovelistSelectView</title>
<para>Default: in an OPAC tab</para>
<para>Asks: Display Novelist Select content ___</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Novelist Select provides a lot of content, for that
reason you have four choices of where to display this content.
The default view is in a tab in the holdings table.</para>
<screenshot>
<screeninfo>Novelist Select in a tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/novelisttab.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The content is the same if you choose to show it above
the holdings table or below it. If shown in the right column
of the page it's the same content, but displays a bit
differently since space is limited.</para>
<screenshot>
<screeninfo>Novelist Select on the side</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/novelistside.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>above the holdings table</para>
</listitem>
<listitem>
<para>below the holdings table</para>
</listitem>
<listitem>
<para>in an OPAC tab</para>
</listitem>
<listitem>
<para>under the Save Record dropdown on the right</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="oclcprefs">
<title>OCLC</title>
<para/>
<section id="XISBN">
<title>XISBN</title>
<para>Default: Don't use</para>
<para>Asks: ___ the OCLC xISBN service to show other editions of a
title</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Set to 'Use' to display an “Editions" tab on the
item's detail page. Editions are listed, complete with cover
art and bibliographic information. The feed comes from OCLC's
xISBN web service. The feed limit for non-commercial sites is
1000 requests per day.</para>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't use</para>
</listitem>
<listitem>
<para>Use</para>
</listitem>
</itemizedlist>
<important>
<para>Requires <link
linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
'show'</para>
</important>
</section>
<section id="OCLCAffiliateID">
<title>OCLCAffiliateID</title>
<para>Asks: Use the OCLC affiliate ID ___ to access the xISBN
service.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This setting is only applicable if the library has an
OCLC Affiliate ID. This allows WorldCat searching in the OPAC
via the XISBN programming interface. Simply enter the
library's OCLC Affiliate ID in the box provided. Please note
that using this data is only necessary if <link
linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> and
<link linkend="XISBN">XISBN</link> settings are enabled. For
more information on this service please visit the OCLC
website: <ulink
url="http://www.worldcat.org/affiliate/default.jsp";>http://www.worldcat.org/affiliate/default.jsp</ulink>.</para>
</listitem>
</itemizedlist>
<important>
<para>Unless you have signed up for an ID with OCLC, you are
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>
</important>
</section>
<section id="XISBNDailyLimit">
<title>XISBNDailyLimit</title>
<para>Default: 999</para>
<para>Asks: Only use the xISBN service ___ times a day.</para>
<important>
<para>Unless you have signed up for an ID with OCLC, you are
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>
</important>
</section>
</section>
<section id="OpenLibraryPrefs">
<title>Open Library</title>
<section id="OpenLibraryCovers">
<title>OpenLibraryCovers</title>
<para>Default: Don't add</para>
<para>Asks: ___ cover images from Open Library to search results
and item detail pages on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Add</para>
</listitem>
<listitem>
<para>Don't add</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This setting controls the display of applicable cover
art from the free Open Library database, via the Open Library
API. Please note that to use this feature, all other cover
services should be turned off.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="Syndeticsprefs">
<title>Syndetics</title>
<para>Syndetics is a pay service. You must first contact Syndetics
directly for pricing and subscription information.</para>
<section id="SyndeticsEnabled">
<title>SyndeticsEnabled</title>
<para>Default: Don't use</para>
<para>Asks: ___ content from Syndetics.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't use</para>
</listitem>
<listitem>
<para>Use</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When this option is enabled any of the Syndetics options
can be used.</para>
</listitem>
</itemizedlist>
<important>
<para>Requires that you enter your <link
linkend="SyndeticsClientCode">SyndeticsClientCode</link> before
this content will appear.</para>
</important>
</section>
<section id="SyndeticsClientCode">
<title>SyndeticsClientCode</title>
<para>Asks: Use the client code ___ to access Syndetics.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Once the library signs up for Syndetics' services,
Syndetics will provide the library with an access code. (Visit
the Syndetics homepage at <ulink
url="http://www.bowker.com/syndetics/";>http://www.bowker.com/syndetics/</ulink>
for more information.) This is the code that must be entered
to access Syndetics' subscription services. Syndetics is a
paid subscription service. This value must be entered before
<link linkend="SyndeticsEditions">SyndeticsEditions</link> can
be enabled. If the code is lost, corrupted, or forgotten, a
new one can be obtained from <ulink
url="http://www.bowker.com/syndetics/";>http://www.bowker.com/syndetics/</ulink>.</para>
</listitem>
</itemizedlist>
<important>
<para>You will need to get your client code directly from
Syndetics.</para>
</important>
</section>
<section id="SyndeticsCoverImages">
<title>SyndeticsCoverImages & SyndeticsCoverImageSize</title>
<para>SyndeticsCoverImages Default: Don't show</para>
<para>SyndeticsCoverImageSize Default: medium</para>
<para>Asks: ___ cover images from Syndetics on search results and
item detail pages on the OPAC in a ___ size.</para>
<para>Descriptions:</para>
<itemizedlist>
<listitem>
<para>When enabled, SyndeticsCoverImages, allows libraries to
display Syndetics' collection of full-color cover images for
books, videos, DVDs and CDs on their OPAC. For each book or
item that comes up during a user search, the cover image for
that title will be displayed. Since these cover images come in
three sizes, the optimum size must be selected using the
SyndeticsCoverImageSize preference after SyndeticsCoverImages
are enabled. Syndetics cover images come in two sizes:
mid-size (187 x 187 pixels), and large (400 x 400 pixels).
Syndetics is a paid subscription service. The <link
linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
be entered and the <link
linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
be activated before this service can be used. Other cover
image preferences should also be disabled to avoid
interference.</para>
</listitem>
</itemizedlist>
<para>SyndeticsCoverImages Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>SyndeticsCoverImageSize Values:</para>
<itemizedlist>
<listitem>
<para>medium</para>
</listitem>
<listitem>
<para>large</para>
</listitem>
</itemizedlist>
</section>
<section id="SyndeticsAuthorNotes">
<title>SyndeticsAuthorNotes</title>
<para>Default: Don't show</para>
<para>Asks: ___ notes about the author of a title from Syndetics
on item detail pages on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When this option is set to "Show", Syndetics provides
notes and short author biographies for more that 300,000
authors, in both fiction and nonfiction. With this option
enabled the library can display Syndetics Author Notes on the
OPAC. According to the Syndetics Solutions website (<ulink
url="http://www.bowker.com/syndetics/";>http://www.bowker.com/syndetics/</ulink>),
Author Notes include lists of contributors for many
multi-author texts and compilations. The <link
linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
be entered and the <link
linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
be activated before this service can be used.</para>
</listitem>
</itemizedlist>
</section>
<section id="SyndeticsAwards">
<title>SyndeticsAwards</title>
<para>Default: Don't show</para>
<para>Asks: ___ information from Syndetics about the awards a
title has won on item detail pages on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When this option is set to "Show", Syndetics provides
its clients with a list of awards that any title has won. With
this service enabled the library can display those awards for
each book on its website. For each book or item that comes up
during a user search, the list of awards for that title will
be displayed. When a user clicks on a given award, information
about that award is presented along with a list of the other
titles that have won that award. If the user clicks on any
title in the list, they will see holdings information about
that title in their region. This option is a paid subscription
service. The <link
linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
be entered and the <link
linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
be activated before this service can be used.</para>
</listitem>
</itemizedlist>
</section>
<section id="SyndeticsEditions">
<title>SyndeticsEditions</title>
<para>Default: Don't show</para>
<para>Asks: ___ information about other editions of a title from
Syndetics on item detail pages on the OPAC</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When enabled this option shows information on other
editions of a title from Syndetics on the item detail pages of
the OPAC. Syndetics is a paid subscription service. The <link
linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
be entered and the <link
linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
be activated before this service can be used.</para>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<important>
<para>Requires <link
linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
'show'</para>
</important>
</section>
<section id="SyndeticsExcerpt">
<title>SyndeticsExcerpt</title>
<para>Default: Don't show</para>
<para>Asks: ___ excerpts from of a title from Syndetics on item
detail pages on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows Syndetics to display excerpts
given to them from selected publishers. The excerpts are
available from prominently reviewed new titles, both fiction
and non-fiction. The excerpts include poems, essays, recipes,
forwards and prefaces. Automatic links provided by the ISBNs
within local MARC records are required to integrate Syndetics
secured, high-speed Internet servers to the library OPACs. For
more information see (<ulink
url="http://www.bowker.com/syndetics/";>http://www.bowker.com/syndetics/</ulink>).</para>
</listitem>
</itemizedlist>
</section>
<section id="SyndeticsReviews">
<title>SyndeticsReviews</title>
<para>Default: Don't show</para>
<para>Asks: ___ reviews of a title from Syndetics on item detail
pages on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Syndetics Reviews is an accumulation of book reviews
available from a variety of journals and serials. The reviews
page displays colored images of reviewed books dust jackets,
partnered with the names of the journal or serial providing
the review. Clicking on an icon opens a window revealing the
book title, author's name, book cover icon and the critic's
opinion of the book. Automatic links provided by the ISBNs
within local MARC records are required to integrate Syndetics
secured, high-speed Internet servers to the library OPACs. For
more information see (<ulink
url="http://www.bowker.com/syndetics/";>http://www.bowker.com/syndetics/</ulink>).</para>
</listitem>
</itemizedlist>
</section>
<section id="SyndeticsSeries">
<title>SyndeticsSeries</title>
<para>Default: Don't show</para>
<para>Asks: ___ information on other books in a title's series
from Syndetics on item detail pages on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Each fiction title within a series is linked to the
complete series record. The record displays each title in
reading order and also displays the publication order, if
different. Alternate series titles are also displayed.
Automatic links provided by the ISBNs within local MARC
records are required to integrate Syndetics secured, high-
speed Internet servers to the library OPACs. For more
information see (<ulink
url="http://www.bowker.com/syndetics/";>http://www.bowker.com/syndetics/</ulink>).</para>
</listitem>
</itemizedlist>
</section>
<section id="SyndeticsSummary">
<title>SyndeticsSummary</title>
<para>Default: Don't show</para>
<para>Asks: ___ a summary of a title from Syndetics on item detail
pages on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Providing more than 5.6 million summaries and
annotations derived from book jackets, edited publisher copy,
or independently written annotations from Book News, Inc.
Covering fiction and non-fiction, this summaries option
provides annotations on both trade and scholarly titles. For
more information see (<ulink
url="http://www.bowker.com/syndetics/";>http://www.bowker.com/syndetics/</ulink>).</para>
</listitem>
</itemizedlist>
</section>
<section id="SyndeticsTOC">
<title>SyndeticsTOC</title>
<para>Default: Don't show</para>
<para>Asks: ___ the table of contents of a title from Syndetics on
item detail pages on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows staff and patrons to review the
Table of Contents from a wide variety of publications from
popular self-help books to conference proceedings. Specific
Information access is the main purpose for this option,
allowing patrons guidance to their preferred section of the
book. Special arrangements with selected book services is used
to obtain the table of contents for new publications each
year. Automatic links provided by the ISBNs within local MARC
records are required to integrate Syndetics secured,
high-speed Internet servers to the library OPACs. For more
information see (<ulink
url="http://www.bowker.com/syndetics/";>http://www.bowker.com/syndetics/</ulink>).</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="taggingprefs">
<title>Tagging</title>
<section id="TagsEnabled">
<title>TagsEnabled</title>
<para>Default: Allow</para>
<para>Asks: ___ patrons and staff to put tags on items.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Set to 'Allow' enable tagging. A tag is metadata, a word
added to identify an item. Tags allow patrons to classify
materials on their own. TagsEnabled is the main switch that
permits the tagging features. TagsEnable must be set to
'Allow' to allow for other tagging features.</para>
</listitem>
</itemizedlist>
</section>
<section id="TagsModeration">
<title>TagsModeration</title>
<para>Default: Don't require</para>
<para>Asks: ___ that tags submitted by patrons be reviewed by a
staff member before being shown.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't require</para>
</listitem>
<listitem>
<para>Require</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When set to 'Require,' all tags to be first filtered by
the tag moderator. Only approved tags will be visible to
patrons. When set to 'Don't require' tags will bypass the tag
moderator and patrons' tags to be immediately visible. When
this preference is enabled the moderator, a staff member,
would approve the tag in the Staff Client. The moderator will
have the option to approve or reject each pending tag
suggestion.</para>
</listitem>
</itemizedlist>
<para>When moderation is required all tags go through the tag
moderation tool before becoming visible.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools >
<link linkend="tagsmoderation">Tags</link></para>
</listitem>
</itemizedlist>
</section>
<section id="TagsShowOnList">
<title>TagsShowOnList</title>
<para>Default: 6</para>
<para>Asks: Show ___ tags on search results on the OPAC.</para>
<tip>
<para>Set the value to 0 (zero) to turn this feature off.</para>
</tip>
</section>
<section id="TagsInputOnList">
<title>TagsInputOnList</title>
<para>Default: Allow</para>
<para>Asks: ___ patrons to input tags on search results on the
OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
<screenshot>
<screeninfo>Tags on Search Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/TagsInputOnList.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
<section id="TagsShowOnDetail">
<title>TagsShowOnDetail</title>
<para>Default: 10</para>
<para>Asks: Show ___ tags on item detail pages on the OPAC.</para>
<tip>
<para>Set the value to 0 (zero) to turn this feature off.</para>
</tip>
</section>
<section id="TagsInputOnDetail">
<title>TagsInputOnDetail</title>
<para>Default: Allow</para>
<para>Asks: ___ patrons to input tags on item detail pages on the
OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
<screenshot>
<screeninfo>Add Tags on Detail</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/TagsInputOnDetail.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
<section id="TagsExternalDictionary">
<title>TagsExternalDictionary</title>
<para>Asks: Allow tags in the dictionary of the ispell executable
___ on the server to be approved without moderation.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>The dictionary includes a list of accepted and rejected
tags. The accepted list includes all the tags that have been
pre-allowed. The rejected list includes tags that are not
allowed. This preference identifies the "accepted" dictionary
used. Ispell is an open source dictionary which can be used as
a list of accepted terms. Since the dictionary allows for
accurately spelled obscenities, the libraries policy may
dictate that modifications are made to the Ispell dictionary
if this preference is use. For more information about Ispell
<ulink
url="http://www.gnu.org/software/ispell/ispell.html";>http://www.gnu.org/software/ispell/ispell.html</ulink>.
Enter the path on your server to a local ispell executable,
used to set $Lingua::Ispell::path.</para>
</listitem>
</itemizedlist>
</section>
</section>
</section>
<section id="l18nprefs">
<title>I18N/L10N</title>
<para><emphasis><emphasis>These preferences control your
Internationalization and Localization
settings.</emphasis></emphasis></para>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences > I18N/L10N</para>
<section id="CalendarFirstDayOfWeek">
<title>CalendarFirstDayOfWeek</title>
<para>Default: Sunday</para>
<para>Asks: Use ___ as the first day of week in the calendar.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Monday</para>
</listitem>
<listitem>
<para>Sunday</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Using this preference you can control what day shows as
the first day of the week in the calendar pop ups throughout
Koha and on the Calendar tool. If you change this preference and
don't see a change in your browser try clearing your cache since
it makes changes to the Javascript on these pages.</para>
</listitem>
</itemizedlist>
</section>
<section id="dateformat">
<title>dateformat</title>
<para>Default: mm/dd/yyyy</para>
<para>Asks: Format dates like ___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>dd/mm/yyyy</para>
</listitem>
<listitem>
<para>mm/dd/yyyy</para>
</listitem>
<listitem>
<para>yyyy/mm/dd</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference controls how the date is displayed. The
options are the United States method, mm/dd/yyyy (04/24/2010),
the metric method, dd/mm/yyyy (24/04/2010) or ISO, which is the
International Standard of Organization, yyyy/mm/dd (2010/04/24).
The International Standard of Organization would primarily be
used by libraries with locations in multiple nations that may
use different date formats, to have a single display type, or if
the library would be in a region that does not use the United
States or metric method. More information regarding the ISO date
format can be found at <ulink
url="http://www.iso.org/iso/iso_catalogue.htm";>http://www.iso.org/iso/iso_catalogue.htm</ulink>.</para>
</listitem>
</itemizedlist>
</section>
<section id="languagepref">
<title>language</title>
<para>Default: English</para>
<para>Asks: Enable the following languages on the staff
interface</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>English</para>
</listitem>
</itemizedlist>
<para>To install additional languages you need to run
misc/translation/install-code.pl. For example, to install French you
would run the following command <emphasis>install-code.pl
fr-FR</emphasis> to make the templates, once they exist and are in
the right place then they will show up as an option in this
preference.</para>
</section>
<section id="opaclanguages">
<title>opaclanguages</title>
<para>Default: English</para>
<para>Asks: Enable the following languages on the OPAC</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>English</para>
</listitem>
</itemizedlist>
<para>To install additional languages you need to run
misc/translation/install-code.pl. For example, to install French you
would run the following command <emphasis>install-code.pl
fr-FR</emphasis> to make the templates, once they exist and are in
the right place then they will show up as an option in this
preference.</para>
</section>
<section id="opaclanguagesdisplay">
<title>opaclanguagesdisplay</title>
<para>Default: Don't allow</para>
<para>Asks: ___ patrons to select their language on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
<screenshot>
<screeninfo>When this preference is on, patrons can choose
their language from a list at the bottom of the
OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/opaclanguagesdisplay.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="localprefs">
<title>Local Use</title>
<para><emphasis><emphasis>These preferences are defined
locally.</emphasis></emphasis></para>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences > Local Use<tip>
<para>Sometimes preferences which are either new or outdated will
appear in this tab, if you didn't add any preferences to this tab
then it's best to ignore preferences listed here.</para>
</tip></para>
</section>
<section id="logs">
<title>Logs</title>
<para>Logs keep track of transaction on the system. You can decide
which actions you want to log and which you don't using these
preferences.</para>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences > Logs</para>
<section id="AuthoritiesLog">
<title>AuthoritiesLog</title>
<para>Default: Don't log</para>
<para>Asks: ___ changes to authority records.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't log</para>
</listitem>
<listitem>
<para>Log</para>
</listitem>
</itemizedlist>
</section>
<section id="BorrowersLog">
<title>BorrowersLog</title>
<para>Default: Log</para>
<para>Asks: ___ changes to patron records.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't log</para>
</listitem>
<listitem>
<para>Log</para>
</listitem>
</itemizedlist>
</section>
<section id="CataloguingLog">
<title>CataloguingLog</title>
<para>Default: Don't log</para>
<para>Asks: ___ any changes to bibliographic or item records.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't log</para>
</listitem>
<listitem>
<para>Log</para>
</listitem>
</itemizedlist>
<important>
<para>Since this occurs whenever a book is cataloged, edited, or
checked in or out it can be very resource intensive - slowing down
your system.</para>
</important>
</section>
<section id="FinesLog">
<title>FinesLog</title>
<para>Default: Log</para>
<para>Asks: ___ when overdue fines are charged or automatically
forgiven.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't log</para>
</listitem>
<listitem>
<para>Log</para>
</listitem>
</itemizedlist>
</section>
<section id="IssueLog">
<title>IssueLog</title>
<para>Default: Log</para>
<para>Asks: ___ when items are checked out.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't log</para>
</listitem>
<listitem>
<para>Log</para>
</listitem>
</itemizedlist>
</section>
<section id="LetterLog">
<title>LetterLog</title>
<para>Default: Log</para>
<para>Asks: ___ when an automatic claim notice is sent.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't log</para>
</listitem>
<listitem>
<para>Log</para>
</listitem>
</itemizedlist>
<tip>
<para>This log tracks all notices that go to patrons including the
overdue notices.</para>
</tip>
</section>
<section id="ReturnLog">
<title>ReturnLog</title>
<para>Default: Log</para>
<para>Asks: ___ when items are returned.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't log</para>
</listitem>
<listitem>
<para>Log</para>
</listitem>
</itemizedlist>
</section>
<section id="SubscriptionLog">
<title>SubscriptionLog</title>
<para>Default: Log</para>
<para>Asks: ___ when serials are added, deleted or changed.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't log</para>
</listitem>
<listitem>
<para>Log</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="opacprefs">
<title>OPAC</title>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences > OPAC</para>
<section id="opacappearanceprefs">
<title>Appearance</title>
<para>These preferences control how things appear in the
OPAC.</para>
<section id="AuthorisedValueImages">
<title>AuthorisedValueImages</title>
<para>Default: Don't show</para>
<para>Asks: ___ images for authorized values (such as lost
statuses and locations) in search results and item detail pages on
the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para><emphasis>Get there:</emphasis> More > Administration
> <link linkend="authorizedvalues">Authorized
Values</link></para>
</section>
<section id="BiblioDefaultView">
<title>BiblioDefaultView</title>
<para>Default: in simple form</para>
<para>Asks: By default, show bib records ___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>as specified in the ISBD template.</para>
<itemizedlist>
<listitem>
<para>See <link linkend="isbdpref">ISBD</link> preference
for more information</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>in simple form.</para>
</listitem>
<listitem>
<para>in their MARC format.</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference determines the level of bibliographic
detail that the patron will see on the OPAC detail page. The
simple form displays the graphical interface; MARC format
displays the MARC21 cataloging view; ISBD displays the ISBD
(International Standard Bibliographic Description, AACR2)
view.</para>
</listitem>
</itemizedlist>
</section>
<section id="COinSinOPACResults">
<title>COinSinOPACResults</title>
<para>Default: Include</para>
<para>Asks: ___ COinS / OpenURL / Z39.88 in OPAC search
results.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't include</para>
<itemizedlist>
<listitem>
<para>If you choose not to include COinS on the search
results, it will still be loaded on the individual
bibliographic records.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Include</para>
<itemizedlist>
<listitem>
<para>Enabling this feature will slow OPAC search response
times.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>COinS stands for ContextObjects in Spans. COinS is a
method to embed bibliographic metadata in the HTML code of web
pages. This allows bibliographic software to publish
machine-readable bibliographic items and client reference
management software (such as Zotero) to retrieve bibliographic
metadata. The metadata can also be sent to an OpenURL
resolver. This allows, for instance, searching for a copy of a
book in one's own library.</para>
</listitem>
</itemizedlist>
</section>
<section id="DisplayOPACiconsXSLT">
<title>DisplayOPACiconsXSLT</title>
<para>Default: Don't show</para>
<para>Asks: On pages displayed with XSLT stylesheets on the OPAC,
___ icons for itemtype and authorized values.<important>
<para><link
linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link>
and/or <link
linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
must be set to use an XSLT stylesheet for this to show
(default or custom)</para>
</important></para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
<screenshot>
<screeninfo>DisplayOPACiconsXSLT</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/DisplayOPACiconsXSLT.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<para><tip>
<para>See the <link linkend="XSLTiTypes">XSLT Icon
Guide</link> for more information on these icons.</para>
</tip></para>
</section>
<section id="hidelostitems">
<title>hidelostitems</title>
<para>Default: Don't show</para>
<para>Asks: ___ lost items on search and detail pages.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Items that are marked lost by the library can either be
shown or not shown on the OPAC. By setting the value to
“Don't show," the lost item is not shown on the OPAC. By
setting the value “Show," the lost item is shown on the
OPAC for patrons to view with a status of 'lost.'</para>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
<screenshot>
<screeninfo>Lost item showing in the OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/hidelostitems.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="LibraryName">
<title>LibraryName</title>
<para>Asks: Show ___ as the name of the library on the
OPAC.</para>
<tip>
<para>This value will appear in the title bar of the
browser</para>
</tip>
<tip>
<para>Edit '<link linkend="opacheader">opacheader</link>' if
you'd like to add a library name above your search box on the
OPAC</para>
</tip>
<screenshot>
<screeninfo>Browser title and address bar</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/LibraryName.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="OpacAddMastheadLibraryPulldown">
<title>OpacAddMastheadLibraryPulldown</title>
<para>Default: Don't add</para>
<para>Asks: ___ a library select pulldown menu on the OPAC
masthead.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Add</para>
<screenshot>
<screeninfo>Library select box on Koha OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-add.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Don't Add</para>
<screenshot>
<screeninfo>No library select box on Koha OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-dontadd.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="OPACBaseURL">
<title>OPACBaseURL</title>
<para>Asks: The OPAC is located at http:// ___</para>
<important>
<para>This must be filled in correctly for RSS, unAPI, and
search plugins to work.</para>
</important>
<important>
<para>This must be filled in to show 'OPAC View' links from bib
records in the staff client:</para>
</important>
<screenshot>
<screeninfo>With OPACBaseURL set, links to the OPAC will appear
on each individual bib record in the staff client</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OPACBaseURL.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="opaccolorstylesheet">
<title>opaccolorstylesheet</title>
<para>Asks: Include the additional CSS stylesheet ___ to override
specified settings from the default stylesheet.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>The preference can look for stylesheets in the template
directory for your OPAC language, for instance:
/koha-tmpl/opac-tmpl/prog/en/css. If you upload a custom file,
opac-mystyles.css to this directory, you can specify it by
entering opac-mystyles.css in your opaccolorstylesheet system
preference. This adds your custom stylesheet as a linked
stylesheet alongside the OPAC's default CSS files. This method
is preferable because linked stylesheets are cached by the
user's browser, meaning upon repeat visits to your site the
user's browser will not have to re-download the stylesheet,
instead using the copy in the browser's cache.</para>
</listitem>
<listitem>
<para>If you would rather, you can upload your CSS to another
server and enter the full URL pointing to it's location
remember to begin the URL with http://</para>
</listitem>
</itemizedlist>
<tip>
<para>Leave this field blank to disable it</para>
</tip>
<para><note>
<para>This file will add a linked CSS, not replace the
existing default CSS.</para>
</note></para>
</section>
<section id="opaccredits">
<title>opaccredits</title>
<para>Asks: Include the following HTML in the footer of all pages
in the OPAC:</para>
<tip>
<para>Click the 'Click to edit; link to enter HTML to appear at
the bottom of every page in the OPAC</para>
</tip>
<screenshot>
<screeninfo>HTML version of a footer for your OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/opaccredits-html.png"/>
</imageobject>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>A sample of what can appear in your OPAC
credits/footer</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/opaccredits.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This setting is for credits that will appear at the
bottom of your OPAC pages. Credits traditionally encompass
copyright information, last date updated, hyperlinks or other
information represented in an HTML format. This is static
information and any updates must be entered manually.</para>
</listitem>
</itemizedlist>
<para>Learn more in the <link linkend="editableopac">OPAC Editable
Regions</link> section.</para>
</section>
<section id="OPACDisplay856uAsImage">
<title>OPACDisplay856uAsImage</title>
<para>Default: Neither details or results page</para>
<para>Asks: Display the URI in the 856u field as an image on:
___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Both results and details pages</para>
<itemizedlist>
<listitem>
<important>
<para>Not implemented yet</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Detail page only</para>
<itemizedlist>
<listitem>
<important>
<para><link
linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
needs to be on for this preference to work.</para>
</important>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>Showing the 856u as an image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OPACDisplay856uAsImage.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Neither details or results page</para>
</listitem>
<listitem>
<para>Results page only</para>
<itemizedlist>
<listitem>
<important>
<para>Not yet implemented</para>
</important>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>In addition to this option being set, the corresponding
XSLT option must be turned on. Also, the corresponding 856q
field must have a valid MIME image extension (e.g., "jpg") or
MIME image type (i.e. starting with "image/"), or the generic
indicator "img" entered in the field. When all of the
requirements are met, an image file will be displayed instead
of the standard link text. Clicking on the image will open it
in the same way as clicking on the link text. When you click
on the image it should open to full size, in the current
window or in a new window depending on the value in the system
pref <link
linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
<screenshot>
<screeninfo>Sample 856 in MARC Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="OPACDisplayRequestPriority">
<title>OPACDisplayRequestPriority</title>
<para>Default: Don't</para>
<para>Asks: ___ patrons the priority level of their holds in the
OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
<screenshot>
<screeninfo>Patron record in the OPAC shows where in line
the patron waits for their hold.</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OPACDisplayRequestPriority.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para><link linkend="opacuserlogin">opacuserlogin</link>
needs to be set to 'allow'</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="OpacExportOptions">
<title>OpacExportOptions</title>
<para>Default:
bibtex|dc|marcxml|marc8|utf8|marcstd|mods|ris</para>
<para>Asks: List export options that should be available from OPAC
detail page separated by |: ___</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>In the OPAC on the right of each bib record there is a
menu that allows for saving the record in various formats.
This patch will allow you to define which options are in the
pull down menu. Available options are: BIBTEX (bibtex), Dublin
Core (dc), MARCXML (marcxml), MARC-8 encoded MARC (marc8),
Unicode/UTF-8 encoded MARC (utf8), Unicode/UTF-8 encoded MARC
without local use -9xx, x9x, xx9- fields and subfields
(marcstd), MODS (mods), and RIS (ris).</para>
</listitem>
</itemizedlist>
</section>
<section id="OpacFavicon">
<title>OpacFavicon</title>
<para>Asks: Use the image at ___ for the OPAC's favicon.
<important>
<para>This should be a complete URL, starting with
http://</para>
</important></para>
<tip>
<para>Turn your logo into a favicon with the <ulink
url="http://antifavicon.com/";>Favicon Generator</ulink>.</para>
</tip>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>The favicon is the little icon that appears next to the
URL in the address bar in most browsers. The default value for
this field (if left blank) is the small 'K' in the Koha
logo.</para>
<screenshot>
<screeninfo>Default Koha Favicon</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/favicon.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="opacheader">
<title>opacheader</title>
<para>Asks: Include the following HTML in the header of all pages
in the OPAC</para>
<screenshot>
<screeninfo>Sample HTML to be displayed at the top of my
OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/opacheader-html.png"/>
</imageobject>
</mediaobject>
</screenshot>
<tip>
<para>This value will appear above the main content of your
page</para>
</tip>
<screenshot>
<screeninfo>OPAC display of the value from
'opacheader'</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/opacheader.png"/>
</imageobject>
</mediaobject>
</screenshot>
<tip>
<para>Edit '<link linkend="LibraryName">LibraryName</link>' if
you'd like to edit the contents of the <title> tag</para>
</tip>
<para>Learn more in the <link linkend="editableopac">OPAC Editable
Regions</link> section.</para>
</section>
<section id="OpacHighlightedWords">
<title>OpacHighlightedWords</title>
<para>Default: Don't highlight</para>
<para>Asks: ___ words the patron searched for in their search
results.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't highlight</para>
</listitem>
<listitem>
<para>Highlight</para>
</listitem>
</itemizedlist>
</section>
<section id="OpacKohaUrl">
<title>OpacKohaUrl</title>
<para>Default: Don't show</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When this preference is set to 'Show' text will appear
in the bottom right of the OPAC footer stating 'Powered by
Koha' and linking to the official Koha website.</para>
<screenshot>
<screeninfo>Powered by Koha</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OpacKohaUrl.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="opaclayoutstylesheet">
<title>opaclayoutstylesheet</title>
<para>Default: opac.css</para>
<para>Asks: Use the CSS stylesheet /css/ ___ on all pages in the
OPAC, instead of the default</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This setting's function is to point to the *.css file
used to define the OPAC layout. A *.css file is a cascading
stylesheet which is used in conjunction with HTML to set how
the HTML page is formatted and will look on the OPAC. There
are two stylesheets that come with the system; opac.css and
opac2.css. A custom stylesheet may also be used. A style sheet
designated in the <link
linkend="opacstylesheet">opacstylesheet</link> preference will
override the stylesheet listed here. The stylesheets listed in
the opaclayoutstylesheet preference are held on the Koha
server.</para>
</listitem>
</itemizedlist>
<tip>
<para>Leave this field blank to disable it and let Koha use the
default file instead</para>
</tip>
</section>
<section id="OpacMaintenance">
<title>OpacMaintenance</title>
<para>Default: Don't show</para>
<para>Asks: ___ a warning that the OPAC is under maintenance,
instead of the OPAC itself. <note>
<para>this shows the same warning as when the database needs
to be upgraded, but unconditionally.</para>
</note></para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows the system administrator to turn
off the OPAC during maintenance and display a message to
users. When this preference is switched to “Show" the
OPAC is not usable. The text of this message is not editable
at this time.</para>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
<itemizedlist>
<listitem>
<para>When this preference is set to show the maintenance
message the ability to search the OPAC is disabled and a
message appears</para>
<screenshot>
<screeninfo>OPAC Maintenance Message</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/opacmaintenance.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="OpacMainUserBlock">
<title>OpacMainUserBlock</title>
<para>Default: Welcome to Koha... <hr></para>
<para>Asks: Show the following HTML in its own column on the main
page of the OPAC</para>
<para>HTML entered in this field will appear in the center of the
main page of your OPAC</para>
<screenshot>
<screeninfo>Sample OpacMainUserBlock appears below the search
bar</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OpacMainUserBlock.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Learn more in the <link linkend="editableopac">OPAC Editable
Regions</link> section.</para>
</section>
<section id="OPACMySummaryHTML">
<title>OPACMySummaryHTML</title>
<para>Asks: Include a "Links" column on the "my summary" tab when
a user is logged in to the OPAC, with the following HTML (leave
blank to disable).</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>In this preference you can enter HTML that will appear
on the 'Checked Out' tab on the 'My Summary' section when
logged in to the OPAC. The placeholders {BIBLIONUMBER},
{TITLE}, {ISBN} and {AUTHOR} will be replaced with information
from the displayed record. This can be used to enter in
'share' links for social networks or generate searches against
other library catalogs.</para>
<screenshot>
<screeninfo>Example of 'Links' column with a value in the
OPACMySummaryHTML preference</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OPACMySummaryHTML.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<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>
<br />TITLE: {TITLE}
<br />AUTHOR: {AUTHOR}
<br />ISBN: {ISBN}
<br />BIBLIONUMBER: {BIBLIONUMBER}</p></programlisting></para>
</section>
<section id="OpacNav">
<title>OpacNav</title>
<para>Default: Important links here.</para>
<para>Asks: Show the following HTML on the left hand column of the
main page and patron account on the OPAC (generally navigation
links)</para>
<screenshot>
<screeninfo>Sample navigation links</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OpacNav.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Learn more in the <link linkend="editableopac">OPAC Editable
Regions</link> section.</para>
</section>
<section id="OpacNavBottom">
<title>OpacNavBottom</title>
<para>Asks: Show the following HTML on the left hand column of the
main page and patron account on the OPAC, after <link
linkend="OpacNav">OpacNav</link>, and before patron account links
if available:</para>
<para>Description: When a patron is logged in to their account
they see a series of tabs to access their account information.
<link linkend="OpacNav">OpacNav</link> appears above this list of
tabs and OpacNavBottom will appear below them. When not on the
patron account pages the HTML in OpacNavBottom will just appear
right below <link linkend="OpacNav">OpacNav</link>.</para>
<screenshot>
<screeninfo>OpacNav and OpacNavBottom on Patron
Account</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OpacNavBottom.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="OPACNoResultsFound">
<title>OPACNoResultsFound</title>
<para>No Default</para>
<para>Asks: Display this HTML when no results are found for a
search in the OPAC</para>
<para>This HTML will display below the existing notice that no
results were found for your search.</para>
<screenshot>
<screeninfo>HTML in OPACNoResultsFound will appear below lines
that look like this</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OPACNoResultsFound.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="OpacPublic">
<title>OpacPublic</title>
<para>Default: Enable</para>
<para>Asks: ___ Koha OPAC as public. Private OPAC requires
authentication before accessing the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't enable</para>
</listitem>
<listitem>
<para>Enable</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference determines if your OPAC is accessible
and searchable by anyone or only by members of the library. If
set to 'Don't enable' only members who are logged into the
OPAC can search. Most libraries will leave this setting at its
default of 'Enable' to allow their OPAC to be searched by
anyone and only require login for access to personalized
content.</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACResultsSidebar">
<title>OPACResultsSidebar</title>
<para>Asks: Include the following HTML under the facets in OPAC
search results</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>The HTML entered in this preference will appear on the
search results pages below the list of facets on the left side
of the screen.</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACSearchForTitleIn">
<title>OPACSearchForTitleIn</title>
<para>Default: <li><a
href="http://worldcat.org/search?q={TITLE}";
target="_blank">Other Libraries (WorldCat)</a></li>
<li><a
href="http://www.scholar.google.com/scholar?q={TITLE}";
target="_blank">Other Databases (Google
Scholar)</a></li> <li><a
href="http://www.bookfinder.com/search/?author={AUTHOR}&title={TITLE}&st=xl&ac=qr";
target="_blank">Online Stores
(Bookfinder.com)</a></li></para>
<para>Asks: Include a "More Searches" box on the detail pages of
items on the OPAC, with the following HTML (leave blank to
disable)</para>
<note>
<para>The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE},
{ISBN}, {ISSN} and {AUTHOR} will be replaced with information
from the displayed record.</para>
</note>
<tip>
<para>You can use this field to add social networking share
links by using code similar to this</para>
<programlisting></ul></div></div><div class="detailtagcell">
<script
src="http://connect.facebook.net/en_US/all.js#xfbml=1"></script><fb:like
href="http://opac.mylibrary.tld/bib/{BIBLIONUMBER}"; show_faces="true"
width="450" font=""></fb:like>
<div><a href="http://twitter.com/share"; class="twitter-share-button"
data-url="http://opac.mylibrary.tld/bib/{BIBLIONUMBER}"; data-text="I'm reading
this" data-count="horizontal">Tweet</a><script type="text/javascript"
src="http://platform.twitter.com/widgets.js"></script></div></div><div><div><ul></programlisting>
<para>The starting </ul> is necessary to break out of the
'Search for this Title In' pull down menu</para>
<screenshot>
<screeninfo>OPACSearchForTitleIn with Social Networking
Links</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OPACSearchForTitleIn.png"/>
</imageobject>
</mediaobject>
</screenshot>
</tip>
</section>
<section id="OPACShowCheckoutName">
<title>OPACShowCheckoutName</title>
<para>Default: Don't show</para>
<para>Asks: ___ the name of the patron that has an item checked
out on item detail pages on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows all patrons to see who has the
item checked out if it is checked out. In small corporate
libraries (where the OPAC is behind a firewall and not
publicly available) this can be helpful so coworkers can just
contact the patron with the book themselves. In larger public
and academic libraries setting this to 'Show' would pose
serious privacy issues.</para>
</listitem>
</itemizedlist>
</section>
<section id="OpacShowRecentComments">
<title>OpacShowRecentComments</title>
<para>Default: Don't show</para>
<para>Asks: ___ a link to recent comments in the OPAC
masthead.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If you have chosen to allow comments in your OPAC by
setting <link linkend="reviewson">reviewson</link> to 'Allow'
you can include a link to the recent comments under the search
box at the top of your OPAC with this preference.</para>
<screenshot>
<screeninfo>Recent Comments link on OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OpacShowRecentComments.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="opacsmallimage">
<title>opacsmallimage</title>
<para>Asks: Use the image at ___ in the OPAC header, instead of
the Koha logo. If this image is a different size than the Koha
logo, you will need to customize the CSS.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>The opacsmallimage system pref is a little tricky to
deal with because you really have to tweak some CSS at the
same time. The default CSS defines a region just large enough
to display the Koha logo, and if your logo doesn't match the
Koha logo's dimensions (120 pixels wide by 38 pixels high), it
won't display correctly.</para>
</listitem>
</itemizedlist>
<important>
<para>This should be a complete URL, starting with
http://</para>
</important>
</section>
<section id="OpacStarRatings">
<title>OpacStarRatings</title>
<para>Default: no</para>
<para>Asks: Show star-ratings on ___ pages.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>no</para>
</listitem>
<listitem>
<para>only details</para>
<screenshot>
<screeninfo>Star Ratings on the Details Page</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OpacStarRatings-details.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>results and details</para>
<screenshot>
<screeninfo>OPAC Star Ratings on the Search
Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OpacStarRatings-results.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Star ratings are a way for your patrons to leave ratings
without having to leave a full review. Patrons who are not
logged in will only be able to see the stars, once logged in
patrons can click on the stars on the details page to leave
their own rating. Clicking on the stars on the search results
will not submit a rating.</para>
</listitem>
</itemizedlist>
</section>
<section id="opacstylesheet">
<title>opacstylesheet</title>
<para>Asks: Use the remote CSS stylesheet ___ on all pages in the
OPAC, instead of the default.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows the administrator to completely
replace the default stylesheet with their own alternate
stylesheet. This allows the administrator to completely
customize the look of the OPAC. To change the stylesheet,
enter a complete URL, including the http:// to the custom
stylesheet. Content in the custom/alternate stylesheet will
overwrite any data in the default stylesheet defined in the
<link
linkend="opaclayoutstylesheet">opaclayoutstylesheet</link>
setting. The default stylesheet will likely be found at
http://your_koha_address/opac-
tmpl/prog/en/css/opac.css</para>
</listitem>
</itemizedlist>
<tip>
<para>Leave this field blank to disable it and let Koha use the
default file instead</para>
</tip>
<important>
<para>This should be a complete URL, starting with
http://</para>
</important>
</section>
<section id="opacthemes">
<title>opacthemes</title>
<para>Default: prog</para>
<para>Asks: Use the ___ theme on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>prog</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACURLOpenInNewWindow">
<title>OPACURLOpenInNewWindow</title>
<para>Default: don't</para>
<para>Asks: When patrons click on a link to another website from
your OPAC (like Amazon or OCLC), ___ open the website in a new
window.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>do</para>
</listitem>
<listitem>
<para>don't</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference determines if URLs in the OPAC will open
in a new window or not. When clicking on a link in the OPAC, a
patron does not need to worry about navigating away from their
search results.</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACUserCSS">
<title>OPACUserCSS</title>
<para>Asks: Include the following CSS on all pages in the
OPAC</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>OPACUserCSS allows the administrator to enter styles
that will overwrite the OPAC's default CSS as defined in
‘opaclayoutstylesheet' or ‘opacstylesheet'. Styles
may be entered for any of the selectors found in the default
style sheet. The default stylesheet will likely be found at
http://your_koha_address/opac-tmpl/prog/en/css/opac.css.
Unlike <link
linkend="opaccolorstylesheet">opaccolorstylesheet</link>,
<link
linkend="opaclayoutstylesheet">opaclayoutstylesheet</link> and
<link linkend="opacstylesheet">opacstylesheet</link> this
preference will embed the CSS directly on your OPAC
pages.</para>
</listitem>
</itemizedlist>
</section>
<section id="opacuserjs">
<title>opacuserjs</title>
<para>Asks: Include the following JavaScript on all pages in the
OPAC</para>
<screenshot>
<screeninfo>OPAC login box before opacuserjs edit</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/opacuserjs-before.png"/>
</imageobject>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>JavaScript in opacuserjs to change the OPAC login
box</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/opacuserjs.png"/>
</imageobject>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>New OPAC login box after editing
opacuserjs</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/opacuserjs-after.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows the administrator to enter
JavaScript or JQuery that will be embedded across all pages of
the OPAC. Administrators may use this preference to customize
some of the interactive sections of Koha, customizing the text
for the login prompts, for example. Sample JQuery scripts used
by Koha libraries can be found on the wiki: <ulink
url="http://wiki.koha-community.org/wiki/JQuery_Library";>http://wiki.koha-community.org/wiki/JQuery_Library</ulink>.</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACXSLTDetailsDisplay">
<title>OPACXSLTDetailsDisplay</title>
<para>Default: default</para>
<para>Asks: Display OPAC details using XSLT stylesheet at
___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>leave empty to not use the XSLT stylesheet</para>
<itemizedlist>
<listitem>
<para>In previous versions of Koha this was the setting
that read 'normally'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>enter "default" for the default one</para>
</listitem>
<listitem>
<para>put a path to define a XSLT file</para>
<itemizedlist>
<listitem>
<para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
</listitem>
<listitem>
<para>If in a multi-language system you can enter
{langcode} in the path to tell Koha to look in the right
language folder</para>
<itemizedlist>
<listitem>
<para>ex:
/home/koha/src/koha-tmpl/opac/prog/{langcode}/xslt/OpacDetail.xsl</para>
</listitem>
<listitem>
<para>ex.
http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>put an URL for an external specific stylesheet</para>
<itemizedlist>
<listitem>
<para>ex: http://mykohaopac.org/stylesheet.xsl</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>XSLT stylesheets allow for the customization of the
details shows on the screen when viewing a bib record. This
preference will allow you either use the default look that
comes with Koha or design your own stylesheet.</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACXSLTResultsDisplay">
<title>OPACXSLTResultsDisplay</title>
<para>Default: default</para>
<para>Asks: Display OPAC results using XSLT stylesheet at
___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>leave empty to not use the XSLT stylesheet</para>
<itemizedlist>
<listitem>
<para>In previous versions of Koha this was the setting
that read 'normally'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>enter "default" for the default one</para>
</listitem>
<listitem>
<para>put a path to define a XSLT file</para>
<itemizedlist>
<listitem>
<para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
</listitem>
<listitem>
<para>If in a multi-language system you can enter
{langcode} in the path to tell Koha to look in the right
language folder</para>
<itemizedlist>
<listitem>
<para>ex:
/home/koha/src/koha-tmpl/opac/prog/{langcode}/xslt/OpacDetail.xsl</para>
</listitem>
<listitem>
<para>ex.
http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>put an URL for an external specific stylesheet</para>
<itemizedlist>
<listitem>
<para>ex: http://mykohaopac.org/stylesheet.xsl</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>XSLT stylesheets allow for the customization of the
details shows on the screen when viewing the search results.
This preference will allow you either use the default look
that comes with Koha or design your own stylesheet.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="opacfeaturesprefs">
<title>Features</title>
<para/>
<section id="numSearchRSSResults">
<title>numSearchRSSResults</title>
<para>Default: 50</para>
<para>Asks: Display ___ search results in the RSS feed.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>By default the RSS feed that is automatically generated
for every search results page will list 50 items. This can
sometimes be too much for some RSS feed readers and for some
people this isn't enough. This preference allows you to adjust
this number to show the best number of results for your
patrons.</para>
</listitem>
</itemizedlist>
</section>
<section id="OpacAuthorities">
<title>OpacAuthorities</title>
<para>Default: Allow</para>
<para>Asks: ___ patrons to search your authority records.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference displays the link on the OPAC for the
authority search (titled 'Browse by Subject'). By setting the
preference to “Allow" patrons can use this search link
of the OPAC.</para>
</listitem>
</itemizedlist>
<important>
<para>While labeled 'Browse' it is important to note that this
is in fact an authority search, not an authority browse.</para>
<screenshot>
<screeninfo>Authority Search in the OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/authoritysearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
</important>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
<itemizedlist>
<listitem>
<para>A link labeled 'Browse by Subject' will appear at
the top of your OPAC under the search box</para>
<screenshot>
<screeninfo>'Browse by Subject' link under search box on
OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OpacAuthorities.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
<section id="opacbookbag">
<title>opacbookbag</title>
<para>Default: Allow</para>
<para>Asks: ___ patrons to store items in a temporary "Cart" on
the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows the user to temporarily save a
list of items found on the catalog. By using the Book Bag, or
Cart, the user can print out or email a list of items found.
The user does not need to be logged in. This list is temporary
and will be emptied, or cleared, at the end of the
session.</para>
</listitem>
</itemizedlist>
</section>
<section id="OpacBrowser">
<title>OpacBrowser</title>
<important>
<para>This preference only applies to French systems at this
time.</para>
</important>
<para>Default: Don't allow</para>
<para>Asks: ___ patrons to browse subject authorities on
OPAC</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para><important>
<para>run the <link linkend="authbrowsercron">Authorities
Browser Cron Job</link> to create the browser list</para>
</important></para>
</section>
<section id="OpacBrowseResults">
<title>OpacBrowseResults</title>
<para>Default: enable</para>
<para>Asks: ___ browsing and paging search results from the OPAC
detail page.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>disable</para>
</listitem>
<listitem>
<para>enable</para>
<screenshot>
<screeninfo>Browsing and Paging Search Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OpacBrowseResults.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference will control the option to return to
your results and/or browse them from the detail page in the
OPAC.</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACFinesTab">
<title>OPACFinesTab</title>
<para>Default: Allow</para>
<para>Asks: ___ patrons to access the Fines tab on the My Account
page on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
<itemizedlist>
<listitem>
<para><link linkend="opacuserlogin">opacuserlogin</link>
needs to be set to 'allow'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
<section id="OpacPasswordChange">
<title>OpacPasswordChange</title>
<para>Default: Allow</para>
<para>Asks: ___ patrons to change their own password on the
OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
<itemizedlist>
<listitem>
<para><link linkend="opacuserlogin">opacuserlogin</link>
needs to be set to 'allow'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<important>
<para>Enabling this will break LDAP authentication.</para>
</important>
</section>
<section id="OPACPatronDetails">
<title>OPACPatronDetails</title>
<para>Default: Allow</para>
<para>Asks: ___ patrons to notify the library of changes to their
contact information from the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
<itemizedlist>
<listitem>
<para><link linkend="opacuserlogin">opacuserlogin</link>
needs to be set to 'allow'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If patrons are allowed to notify the library of changes
an email will be sent to the library administration email
address with the changes. Lines that start with the fieldname
in all caps are the lines that the patron made changes
to.</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACpatronimage">
<title>OPACpatronimage</title>
<para>Default: Don't show</para>
<para>Asks: ___ patron images on the patron information page in
the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If <link linkend="patronimages">patronimages</link> is
set to allow the upload of patron images via the staff client,
then setting this preference to 'show' will show the patron
what image you have on file for them when they view their
personal information on their account in the OPAC.</para>
</listitem>
</itemizedlist>
</section>
<section id="OpacTopissue">
<title>OpacTopissue</title>
<para>Default: Don't allow</para>
<para>Asks: ___ patrons to access a list of the most checked out
items on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
<itemizedlist>
<listitem>
<para>A link to 'Most Popular' will appear at the top of
your OPAC</para>
<screenshot>
<screeninfo>'Most Popular' link under the search
box</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OpacTopissue.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows the administrator to choose to
show the “Most Popular" link at the top of the OPAC
under the search box. The “Most Popular" page shows the
top circulated items in the library, as determined by the
number of times a title has been circulated. This allows users
to see what titles are popular in their community. It is
recommended that you leave this preference set to 'Don't
allow' until you have been live on Koha for a couple of
months, otherwise the data that it shows will not be an
accurate portrayal of what's popular in your library.</para>
<screenshot>
<screeninfo>Sample top issues page</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/topissues.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="opacuserlogin">
<title>opacuserlogin</title>
<para>Default: Allow</para>
<para>Asks: ___ patrons to log in to their accounts on the
OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
<itemizedlist>
<listitem>
<para>The OPAC will still be searchable if patrons can't
log in, this just disables the patron account access via
the OPAC</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="RequestOnOpac">
<title>RequestOnOpac</title>
<para>Default: Allow</para>
<para>Asks: ___ patrons to place holds on items from the
OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
<itemizedlist>
<listitem>
<para><link linkend="opacuserlogin">opacuserlogin</link>
needs to be set to 'allow'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
<section id="reviewson">
<title>reviewson</title>
<para>Default: Allow</para>
<para>Asks: ___ patrons to make comments on items on the
OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
<itemizedlist>
<listitem>
<para>Patrons comments/reviews all require moderation
before they appear in the OPAC</para>
</listitem>
<listitem>
<para><link linkend="opacuserlogin">opacuserlogin</link>
needs to be set to 'Allow'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This button allows the patrons to submit comments on
books they have read via the OPAC. If this preference is set
to “Allow" reviews are first sent to the staff client
for staff approval before the review is displayed in the OPAC.
The staff member who reviews and approves comments may find
the pending comments on the <link
linkend="comments">Comments</link> tool. The staff member can
then choose to approve or delete the comments.</para>
</listitem>
</itemizedlist>
</section>
<section id="ShowReviewer">
<title>ShowReviewer</title>
<para>Default: full name</para>
<para>Asks: Show ___ of commenter with comments in OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>first name</para>
</listitem>
<listitem>
<para>first name and last initial</para>
</listitem>
<listitem>
<para>full name</para>
</listitem>
<listitem>
<para>last name</para>
</listitem>
<listitem>
<para>no name</para>
</listitem>
<listitem>
<para>username</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If you would like to protect your patron's privacy in
the OPAC you can choose to hide their names or parts of their
names from any of the comments they leave on bib records in
your system. <link linkend="reviewson">reviewson</link> needs
to be set to 'Allow' for this to preference to come in to
play</para>
</listitem>
</itemizedlist>
</section>
<section id="ShowReviewerPhoto">
<title>ShowReviewerPhoto</title>
<para>Default: Show</para>
<para>Asks: ___ reviewer's photo beside comments in OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Hide</para>
</listitem>
<listitem>
<para>Show</para>
<itemizedlist>
<listitem>
<para><link linkend="reviewson">reviewson</link> needs to
be set to 'Allow' and <link
linkend="ShowReviewer">ShowReviewer</link> needs to be set
to 'Show' for this to preference to come in to play</para>
<screenshot>
<screeninfo>ShowReviewerPhoto set to 'Show'</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/ShowReviewerPhoto.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This system preference allows libraries to show avatars
next to patron's comments in the OPAC. These avatars are
pulled from the <ulink
url="https://www.libravatar.org";>Libravatar</ulink> library,
an open source powered product that allows Internet users to
choose a small icon to display next to their name on various
different websites. The library has no control over the images
the patron chooses to display.</para>
</listitem>
</itemizedlist>
</section>
<section id="SocialNetworks">
<title>SocialNetworks</title>
<para>Default: Disable</para>
<para>Asks: ___ social network links in opac detail pages</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Disable</para>
</listitem>
<listitem>
<para>Enable</para>
<screenshot>
<screeninfo>Social Networks</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/SocialNetworks.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference will enable a line of social network
share buttons below the right hand column on the detail pages
of records in the OPAC.</para>
</listitem>
</itemizedlist>
</section>
<section id="suggestionspref">
<title>suggestion</title>
<para>Default: Allow</para>
<para>Asks: ___ patrons to make purchase suggestions on the
OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
<itemizedlist>
<listitem>
<para><link linkend="opacuserlogin">opacuserlogin</link>
needs to be set to 'allow' unless <link
linkend="AnonSuggestions">AnonSuggestions</link> is set to
'allow'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="opacpolicyprefs">
<title>Policy</title>
<para/>
<section id="AllowPurchaseSuggestionBranchChoice">
<title>AllowPurchaseSuggestionBranchChoice</title>
<para>Default: Don't allow</para>
<para>Asks: ___ patrons to select branch when making a purchase
suggestion</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If your library system lets patrons make purchase
suggestions for a specific branch you can set this preference
to 'Allow' to add a branch selection option to the purchase
suggestion form.</para>
</listitem>
</itemizedlist>
</section>
<section id="OpacAllowPublicListCreation">
<title>OpacAllowPublicListCreation</title>
<para>Default: Allow</para>
<para>Asks: ___ opac users to create public lists</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Public lists are visible to anyone who visits your OPAC.
With this preference you can control whether or now patrons
are allowed to create these public lists. If this is set to
"Don't allow" then only staff will be able to create public
lists.</para>
</listitem>
</itemizedlist>
<important>
<para>This preference will only be taken in to account if you
have <link linkend="virtualshelves">virtualshelves</link> set to
'Allow'</para>
</important>
</section>
<section id="OpacAllowSharingPrivateLists">
<title>OpacAllowSharingPrivateLists</title>
<important>
<para>This feature is not active yet but will be released
soon</para>
</important>
<para>Default: Don't allow</para>
<para>Asks: ___ opac users to share private lists with other
patrons.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This feature will add the option for patrons to share
their lists with other patrons.</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACFineNoRenewals">
<title>OPACFineNoRenewals</title>
<para>Default: 99999</para>
<para>Asks: Only allow patrons to renew their own books on the
OPAC if they have less than ___ USD in fines</para>
<tip>
<para>Leave this field blank to disable</para>
</tip>
<important>
<para>To allow renewals in the OPAC, <link
linkend="opacuserlogin">opacuserlogin</link> needs to be set to
'allow'</para>
</important>
</section>
<section id="OpacHiddenItems">
<title>OpacHiddenItems</title>
<para>Asks: Allows to define custom rules for hiding specific
items at opac. <tip>
<para>See docs/opac/OpacHiddenItems.txt in your Koha install
directory for more information</para>
</tip></para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>In this field you can enter criteria for items you would
like to hide from display in the OPAC. This field takes any
combination of item fields (from the items table in the Koha
database) for blocking. For example a value of:</para>
<para><programlisting>itype: [07, 10]
location: [STAFF, ISO]</programlisting>Will block items with an itype code of
07 or 10 as well as items that have a shelving location of
STAFF or ISO.</para>
<para>In items my items.itype 07 is defined in Item Types
Administration as Staff Assigned My items.itype 10 in Item
Types is Archival Copy The locations STAFF and ISO are in
Authorized Values for category=LOC STAFF means it's assigned
to the staff reading room and ISO means it is in the isolation
room.</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACItemHolds">
<title>OPACItemHolds</title>
<para>Default: Allow</para>
<para>Asks: ___ patrons to place holds on specific items in the
OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
<itemizedlist>
<listitem>
<para>Patrons can place holds on specific items as well as
the next available item.</para>
</listitem>
<listitem>
<para><link linkend="opacuserlogin">opacuserlogin</link>
needs to be set to 'allow'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Don't allow</para>
<itemizedlist>
<listitem>
<para>If this is disabled, users can only put a hold on
the next available item.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="OpacRenewalAllowed">
<title>OpacRenewalAllowed</title>
<para>Default: Don't allow</para>
<para>Asks: ___ patrons to renew their own books on the
OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
<itemizedlist>
<listitem>
<para><link linkend="opacuserlogin">opacuserlogin</link>
needs to be set to 'allow'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Don't allow</para>
<itemizedlist>
<listitem>
<para>Staff will still be able to renew items for patrons
via the staff client</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows the administration to choose if
patrons can renew their checked out materials via their
checked out history in the OPAC. It allows patrons to renew
their materials without having to contact the library or
having to return to the library.</para>
</listitem>
</itemizedlist>
</section>
<section id="OpacRenewalBranch">
<title>OpacRenewalBranch</title>
<para>Default: the branch the item was checked out from</para>
<para>Asks: Use ___ as branchcode to store in the statistics
table</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>NULL</para>
</listitem>
<listitem>
<para>'OPACRenew'</para>
</listitem>
<listitem>
<para>the item's home branch</para>
</listitem>
<listitem>
<para>the patron's home branch</para>
</listitem>
<listitem>
<para>the branch the item was checked out from</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This value is used in the statistics table to help with
reporting. The statistics table in Koha keeps track of all
checkouts and renewals, this preference defines which branch
is entered in to the table when a patron renews an item for
themselves via the OPAC.</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACViewOthersSuggestions">
<title>OPACViewOthersSuggestions</title>
<para>Default: Don't show</para>
<para>Asks: ___ purchase suggestions from other patrons on the
OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
<itemizedlist>
<listitem>
<para><link linkend="opacuserlogin">opacuserlogin</link>
needs to be set to 'allow'</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="SearchMyLibraryFirst">
<title>SearchMyLibraryFirst</title>
<para>Default: Don't limit</para>
<para>Asks: ___ patrons' searches to the library they are
registered at.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't limit</para>
<itemizedlist>
<listitem>
<para>Searching the OPAC will show results from all
libraries</para>
</listitem>
<listitem>
<para>If you're a one branch system, choose 'Don't
limit'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Limit</para>
<itemizedlist>
<listitem>
<para>Patrons will still be able to search other libraries
via the Advanced search page - but will be limited to
searches for their library only from the basic search
box</para>
</listitem>
<listitem>
<para><link linkend="opacuserlogin">opacuserlogin</link>
needs to be set to 'allow'</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="singleBranchMode">
<title>singleBranchMode</title>
<para>Default: Don't allow</para>
<para>Asks: ___ patrons to select their branch on the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
<itemizedlist>
<listitem>
<para><link linkend="opacuserlogin">opacuserlogin</link>
needs to be set to 'allow'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference is for libraries that have branches but
do not want to share their items among other branches within
their system. If the preference is set to “Don't allow"
then holdings will be shown for all branches within a system.
On the “Home" screen of the OPAC users have the choice
of narrowing down results by item location. Setting this
preference to “Allow" will display only one branch's
holdings.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="opacprivacyprefs">
<title>Privacy</title>
<para/>
<section id="AnonSuggestions">
<title>AnonSuggestions</title>
<para>Default: Don't allow</para>
<para>Asks: ___ patrons that aren't logged in to make purchase
suggestions. <important>
<para>If set to 'Allow', suggestions are connected to the
<link linkend="AnonymousPatron">AnonymousPatron</link></para>
</important></para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
<section id="AnonymousPatron">
<title>AnonymousPatron</title>
<para>Default: 0</para>
<para>Asks: Use borrowernumber ___ as the Anonymous Patron (for
anonymous suggestions and reading history) <tip>
<para>Before setting this preference <link
linkend="addnewpatron">create a patron</link> to be used for
all anonymous suggestions and/or reading history items. This
patron can be any type and should be named something to make
it clear to you that they're anonymous (ex. Anonymous
Patron).</para>
</tip></para>
</section>
<section id="EnableOpacSearchHistory">
<title>EnableOpacSearchHistory</title>
<para>Default: Keep</para>
<para>Asks: ___ patron search history in the OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't keep</para>
</listitem>
<listitem>
<para>Keep</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACPrivacy">
<title>OPACPrivacy</title>
<para>Default: Don't allow</para>
<para>Asks: ___ patrons to choose their own privacy settings for
their reading history. <important>
<para>This requires <link
linkend="opacreadinghistory">opacreadinghistory</link> set to
'Allow' and <link
linkend="AnonymousPatron">AnonymousPatron</link> to be set to
your anonymous patron's borrowernumber.</para>
</important></para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
<section id="opacreadinghistory">
<title>opacreadinghistory</title>
<para>Default: Allow</para>
<para>Asks: ___ patrons to see what books they have checked out in
the past.</para>
<important>
<para>Enabling this will make it so that patrons can view their
circulation history in the OPAC unless you have OPACPrivacy set
to 'Allow.'</para>
</important>
<important>
<para>This data is stored in the system regardless of your
choice, unless your patrons have chosen to never have their
reading history kept.</para>
</important>
</section>
</section>
<section id="shelfbrowseprefs">
<title>Shelf Browser</title>
<para/>
<section id="OPACShelfBrowser">
<title>OPACShelfBrowser</title>
<para>Default: Show</para>
<para>Asks: ___ a shelf browser on item details pages, allowing
patrons to see what's near that item on the shelf.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
<screenshot>
<screeninfo>OPACShelfBrowser</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/OPACShelfBrowser.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows patrons to view what is located
on the shelf near the item they looked up. The shelf browser
option appears on the details page to the right of each items'
call number. Clicking the 'Browse Shelf' link allows for a
virtual shelf browsing experience via the OPAC and lets
patrons see other books that may relate to their search and
items that sit on the shelf near the item they are looking
at.</para>
</listitem>
</itemizedlist>
<important>
<para>This uses up a fairly large amount of resources on your
server, and should be avoided if your collection has a large
number of items.</para>
</important>
</section>
<section id="ShelfBrowserUsesCcode">
<title>ShelfBrowserUsesCcode</title>
<para>Default: Don't use</para>
<para>Asks: ___ the item collection code when finding items for
the shelf browser.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't use</para>
</listitem>
<listitem>
<para>Use</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If your library uses collection codes then you might
want the shelf browser to take into consideration what
collection the books belong to when populating the virtual
shelf browser.</para>
</listitem>
</itemizedlist>
</section>
<section id="ShelfBrowserUsesHomeBranch">
<title>ShelfBrowserUsesHomeBranch</title>
<para>Default: Use</para>
<para>Asks: ___ the item home branch when finding items for the
shelf browser.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't use</para>
</listitem>
<listitem>
<para>Use</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If you have a multiple branch system you may want to
make sure that Koha takes into consideration what branch owns
the books when populating the virtual shelf browser for
accuracy.</para>
</listitem>
</itemizedlist>
</section>
<section id="ShelfBrowserUsesLocation">
<title>ShelfBrowserUsesLocation</title>
<para>Default: Use</para>
<para>Asks: ___ the item location when finding items for the shelf
browser.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't use</para>
</listitem>
<listitem>
<para>Use</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If your library uses shelving locations then you might
want the shelf browser to take into consideration what
shelving location the books belong to when populating the
virtual shelf browser.</para>
</listitem>
</itemizedlist>
</section>
</section>
</section>
<section id="patronprefs">
<title>Patrons</title>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences > Patrons</para>
<section id="AddPatronLists">
<title>AddPatronLists</title>
<para>Default: specific categories</para>
<para>Asks: List ___ under the new patron menu.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>general patron types</para>
<screenshot>
<screeninfo>Add patron options with AddPatronLists set to
general patron types</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/AddPatronLists-category.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>specific categories</para>
<screenshot>
<screeninfo>Add patron options with AddPatronLists set to
specific categories</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/AddPatronLists-specific.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="AutoEmailOPACUser">
<title>AutoEmailOpacUser</title>
<para>Default: Don't send</para>
<para>Asks: ___ an email to newly created patrons with their account
details.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>AutoEmailOpacUser allows library users to be notified by
email of their account details when a new account is opened at
the email address specified in the <link
linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
preference. The email contains the username and password given
to or chosen by the patron when signing up for their account and
can be customized by editing the <link
linkend="ACCTDETAILS">ACCTDETAILS</link> notice.</para>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't send</para>
</listitem>
<listitem>
<para>Send</para>
</listitem>
</itemizedlist>
</section>
<section id="AutoEmailPrimaryAddress">
<title>AutoEmailPrimaryAddress</title>
<para>Default: alternate</para>
<para>Asks: Use ___ patron email address for sending out
emails.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>alternate</para>
</listitem>
<listitem>
<para>first valid</para>
</listitem>
<listitem>
<para>home</para>
</listitem>
<listitem>
<para>work</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If you choose 'first valid' as the value for
AutoEmailPrimaryAddress the system will check the email fields
in this order: home, work, then alternate. Otherwise the system
will use the email address you specify.</para>
</listitem>
</itemizedlist>
</section>
<section id="autoMemberNum">
<title>autoMemberNum</title>
<para>Default: Do</para>
<para>Asks: ___ default the card number field on the patron addition
screen to the next available card number</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Do</para>
<itemizedlist>
<listitem>
<para>If the largest currently used card number is
26345000012941, then this field will default to
26345000012942 for the next patron</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Don't</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference determines if the patron's barcode is
automatically calculated. This prevents the person setting up
the library card account from having to assign a number to the
new card. If set to 'Do' the system will calculate a new patron
barcode by adding 1 to the maximum barcode already present in
the database.</para>
</listitem>
</itemizedlist>
</section>
<section id="BorrowerMandatoryField">
<title>BorrowerMandatoryField</title>
<para>Default: surname|cardnumber|barcode</para>
<para>Asks: The following database columns must be filled in on the
patron entry screen: ___</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference enables the system administrator to choose
which fields your library would like required for patron
accounts. Enter field names separated by | (bar). This ensures
that basic information is included in each patron record. If a
patron leaves one of the required fields blank an error message
will issue and the account will not be created.</para>
</listitem>
</itemizedlist>
<important>
<para>Separate columns with |</para>
</important>
<tip>
<para>For help with field names, ask your system administrator or
<ulink
url="http://schema.koha-community.org/tables/borrowers.html";>view
the database structure</ulink> associated with the borrowers
table.</para>
</tip>
</section>
<section id="borrowerRelationship">
<title>borrowerRelationship</title>
<para>Default: father|mother</para>
<para>Asks: Guarantors can be the following of those they guarantee
___</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference enables the system administrator to define
valid relationships between a guarantor (usually a parent) &
a guarantee (usually a child). Defining values for this field
does not make the guarantor field required when adding a
guarantee type patron. This preference creates a drop down list
identifying the relationship of the guarantor to the guarantee.
To disable the ability to add children types in Koha you can
leave this field blank.</para>
</listitem>
</itemizedlist>
<important>
<para>Input multiple choices separated by |</para>
</important>
</section>
<section id="BorrowerRenewalPeriodBase">
<title>BorrowerRenewalPeriodBase</title>
<para>Default: current date</para>
<para>Asks: When renewing borrowers, base the new expiry date on
___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>current date.</para>
</listitem>
<listitem>
<para>current membership expiry date.</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference controls what the patron's new expiration
date will be when you renew their card. Using the 'current date'
will add the subscription period to today's date when
calculating the new expiration date. Using 'current membership
expiry date' will add the susbscription period to the old
expiration date for the patron when renewing their
account.</para>
</listitem>
</itemizedlist>
</section>
<section id="BorrowersTitles">
<title>BorrowersTitles</title>
<para>Default: Mr|Mrs|Miss|Ms</para>
<para>Asks: Borrowers can have the following titles ___</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows the staff to choose the titles that
can be assigned to patrons. The choices present as a drop down
list when creating a patron record.</para>
</listitem>
</itemizedlist>
<important>
<para>Input multiple choices separated by |</para>
</important>
</section>
<section id="checkdigit">
<title>checkdigit</title>
<para>Default: Don't</para>
<para>Asks: ___ check and construct borrower card numbers in the
Katipo style.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Do</para>
</listitem>
<listitem>
<para>Don't</para>
</listitem>
</itemizedlist>
<important>
<para>This overrides <link
linkend="autoMemberNum">autoMemberNum</link> if on.</para>
</important>
</section>
<section id="EnhancedMessagingPreferences">
<title>EnhancedMessagingPreferences</title>
<para>Default: Allow</para>
<para>Asks: ___ patrons to choose which notices they receive and
when they receive them.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<important>
<para>This only applies to certain kinds of notices, overdue
notices will be sent based on the library's rules, not the
patron's choice.</para>
</important>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>These messages are in addition to the overdue notices that
the library sends. The difference between these notices and
overdues is that the patron can opt-in and out of these. Setting
this preference to 'Allow' will allow patrons to choose to
receive any one of the following messages:</para>
<itemizedlist>
<listitem>
<para>Item Checkout : A notice that lists all the of the
items the patron has just checked out, this is an electronic
form of the checkout receipt</para>
</listitem>
<listitem>
<para>Item Due : A notice on the day and item is due back at
the library</para>
</listitem>
<listitem>
<para>Hold Filled : A notice when you have confirmed the
hold is waiting for the patron</para>
</listitem>
<listitem>
<para>Item Checkin : A notice that lists all the of the
items the patron has just checked in</para>
</listitem>
<listitem>
<para>Advanced Notice : A notice in advance of the patron's
items being due (The patron can choose the number of days in
advance)</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="ExtendedPatronAttributes">
<title>ExtendedPatronAttributes</title>
<para>Default: Enable</para>
<para>Asks: ___ searching, editing and display of custom attributes
on patrons.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't enable</para>
</listitem>
<listitem>
<para>Enable</para>
<itemizedlist>
<listitem>
<para>Define attributes in Koha administration</para>
</listitem>
<listitem>
<para>Get there: More > Administration > <link
linkend="patronattributetypes">Patron Attribute
Types</link></para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Patron attributes are library-defined custom fields that
can be applied to patron records.</para>
</listitem>
</itemizedlist>
<tip>
<para>Use custom attributes for fields that the default patron
record does not support such as driver's license number or student
ID number.</para>
</tip>
</section>
<section id="intranetreadinghistory">
<title>intranetreadinghistory</title>
<para>Default: Allow</para>
<para>Asks: ___ staff to access a patron's checkout
history<important>
<para>If you have the <link
linkend="OPACPrivacy">OPACPrivacy</link> preference set to
'Allow' and the patron has decided to not have their history
kept staff will only see currently checked out items.</para>
</important></para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
<important>
<para>This data is stored in the system regardless of your
choice.</para>
</important>
</section>
<section id="MaxFine">
<title>MaxFine</title>
<para>Default: 9999</para>
<para>Asks: The late fine for a specific checkout will only go up to
___ USD.</para>
</section>
<section id="memberofinstitution">
<title>memberofinstitution</title>
<para>Default: Don't</para>
<para>Asks: ___ allow patrons to be linked to institutions</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Do</para>
</listitem>
<listitem>
<para>Don't</para>
</listitem>
</itemizedlist>
<important>
<para>In order to allow this, the library must have Institution
patrons to link members to</para>
</important>
</section>
<section id="minPasswordLength">
<title>minPasswordLength</title>
<para>Default: 3</para>
<para>Asks: Login passwords for staff and patrons must be at least
___ characters long.</para>
<important>
<para>This applies to both the staff login and the patron OPAC
login.</para>
</important>
</section>
<section id="NotifyBorrowerDeparture">
<title>NotifyBorrowerDeparture</title>
<para>Default: 30</para>
<para>Asks: Show a notice that a patron is about to expire ___ days
beforehand.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When the patron attempts to check out materials, a warning
will appear in the check out window of the Staff Client telling
the librarian that the patrons account is about to
expire.</para>
</listitem>
</itemizedlist>
<important>
<para>This notice will appear on the patron's record in the staff
client.</para>
</important>
</section>
<section id="patronimages">
<title>patronimages</title>
<para>Default: Allow</para>
<para>Asks: ___ images to be uploaded and shown for patrons on the
staff client.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
<section id="PatronsPerPage">
<title>PatronsPerPage</title>
<para>Default: 20</para>
<para>Asks: By default, show ___ results per page in the staff
client.</para>
</section>
<section id="SMSSendDriver">
<title>SMSSendDriver</title>
<para>Asks: Use the SMS::Send:: ___ driver to send SMS
messages.</para>
<para>Some examples of values are:</para>
<itemizedlist>
<listitem>
<para>SMS::Send::Us::Ipipi</para>
</listitem>
<listitem>
<para>SMS::Send::US::TMobile</para>
</listitem>
<listitem>
<para>SMS::Send::US::Verizon</para>
</listitem>
</itemizedlist>
<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
</ulink></para>
<important>
<para>Only drivers available as Perl modules will work in this
preference, so make sure a Perl module is available before
choosing an SMS service.</para>
</important>
<para>Once a driver is entered in the preference an option will
appear in the staff client and the OPAC on the patron messaging form
to choose to receive messages as SMS</para>
<screenshot>
<screeninfo>SMSSendDriver Options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/SMSSendDriver.png"/>
</imageobject>
</mediaobject>
</screenshot>
<important>
<para>You must allow <link
linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
for this to work.</para>
</important>
</section>
<section id="BorrowerUnwantedField">
<title>BorrowerUnwantedField</title>
<para>Asks: The following database columns will not appear on the
patron entry screen: ___</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference enables the system administrator to choose
which fields your library doesn't need to see on the patron
entry form. Enter field names separated by | (bar).</para>
</listitem>
</itemizedlist>
<important>
<para>Separate columns with |</para>
</important>
<tip>
<para>For help with field names, ask your system administrator or
<ulink
url="http://schema.koha-community.org/tables/borrowers.html";>view
the database structure</ulink> associated with the borrowers
table.</para>
</tip>
</section>
<section id="uppercasesurnames">
<title>uppercasesurnames</title>
<para>Default: Don't</para>
<para>Asks: ___ store and display surnames (last names) in upper
case.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Do</para>
</listitem>
<listitem>
<para>Don't</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="searchingprefs">
<title>Searching</title>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences > Searching</para>
<section id="searchfeatureprefs">
<title>Features</title>
<para/>
<section id="NoZebra">
<title>NoZebra</title>
<para>Default: Use</para>
<para>Asks: ___ the Zebra search engine. Searches are very slow on
even modest sized collections when Zebra is off.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't use</para>
</listitem>
<listitem>
<para>Use</para>
</listitem>
</itemizedlist>
</section>
<section id="NoZebraIndexes">
<title>NoZebraIndexes</title>
<para>Default: See the <link linkend="nozebradefault">Systems
Preferences Appendix</link></para>
</section>
<section id="OpacGroupResults">
<title>OpacGroupResults</title>
<para>Default: Don't use</para>
<para>Asks: ___ PazPar2 to group similar results on the
OPAC.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't use</para>
</listitem>
<listitem>
<para>Use</para>
</listitem>
</itemizedlist>
<important>
<para>This requires that <ulink
url="http://www.indexdata.com/pazpar2";>PazPar2</ulink> is set up
and running.</para>
</important>
</section>
<section id="QueryAutoTruncate">
<title>QueryAutoTruncate</title>
<para>Default: automatically</para>
<para>Asks: Perform wildcard searching (where, for example, Har
would match Harry and harp) ___ (The * character would be used
like so: Har* or *logging.)</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>automatically</para>
</listitem>
<listitem>
<para>only if * is added</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This setting allows for searches to be automatically
truncated or for additional characters to be added to the end
of a search string. When set to "automatically" the search
string automatically ends with a wildcard function. For
example, a search for the word “invent" with auto
truncation enabled will also retrieve results for inventor,
invention, inventory, etc. If you don't want this to happen
automatically you can still be perform wildcard searches
manually by adding an asterisk (*). Typing “invent*"
even with auto truncation disabled will retrieve the same
inventor, invention, inventory results. Auto truncation
bypasses the necessity to type long search strings in their
entirety.</para>
</listitem>
</itemizedlist>
</section>
<section id="QueryFuzzy">
<title>QueryFuzzy</title>
<para>Default: Try</para>
<para>Asks: ___ to match similarly spelled words in a search (for
example, a search for flang would also match flange and
fang)</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't try</para>
</listitem>
<listitem>
<para>Try</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference enables “fuzzy" searching, in
which the search engine returns results that are similar to,
but not exactly matching, the word or words entered by the
user. This preference enables the search function to
compensate for slightly misspelled names or phrases.</para>
</listitem>
</itemizedlist>
<important>
<para>Requires that <link linkend="NoZebra">NoZebra</link> is
set to 'Use' and <link linkend="UseICU">UseICU</link> set to
'Not using'</para>
</important>
</section>
<section id="QueryRemoveStopwords">
<title>QueryRemoveStopwords</title>
<para>Default: Don't remove</para>
<para>Asks: ___ stop words specified in Koha from searches.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't remove</para>
<itemizedlist>
<listitem>
<important>
<para>If <link linkend="NoZebra">NoZebra</link> is set
to 'Use' leave this preference set to 'Don't
remove'</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Remove</para>
<itemizedlist>
<listitem>
<para>Requires that you have updated your Koha <link
linkend="stopwordsadmin">Stop Words</link> list</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<important>
<para>Requires that NoZebra is set to 'Don't use'</para>
</important>
<important>
<para>Zebra, on its own, handles a few of the most common stop
words</para>
</important>
</section>
<section id="QueryStemming">
<title>QueryStemming</title>
<para>Default: Try</para>
<para>Asks: ___ to match words of the same base in a search</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't try</para>
</listitem>
<listitem>
<para>Try</para>
<itemizedlist>
<listitem>
<para>A search for enabling would also match enable and
enabled</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference enables word stemming. Stemming allows
the search function to return multiple versions of the same
word, as well as related terms (i.e., both fish and fishing
would be returned).</para>
</listitem>
</itemizedlist>
<important>
<para>Requires that <link linkend="NoZebra">NoZebra</link> is
set to 'Use'</para>
</important>
</section>
<section id="QueryWeightFields">
<title>QueryWeightFields</title>
<para>Default: Enable</para>
<para>Asks: ___ ranking of search results by relevance</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Disable</para>
</listitem>
<listitem>
<para>Enable</para>
</listitem>
</itemizedlist>
<important>
<para>Requires that <link linkend="NoZebra">NoZebra</link> is
set to 'Use'</para>
</important>
</section>
<section id="TraceCompleteSubfields">
<title>TraceCompleteSubfields</title>
<para>Default: Force</para>
<para>Asks: ___ subject tracings in the OPAC and Staff Client to
search only for complete-subfield matches.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't force</para>
<itemizedlist>
<listitem>
<para>Searches for subject keywords (example:
opac-search.pl?q=su:World%20Wide%20Web)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Force</para>
<itemizedlist>
<listitem>
<para>Searches for complete subject fields (example:
opac-search.pl?q=su,complete-subfield:World%20Wide%20Web)</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When TraceCompleteSubfields is set to "force," clicking
on links in non-authority controlled subject tracings will
only find other records where the entire subfields match.
Leaving it at "don't force" does a keyword search of the
subject indexes.</para>
</listitem>
</itemizedlist>
<important>
<para>This preference assumes that you're using XSLT stylesheets
as set in the <link
linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
preference.</para>
</important>
</section>
<section id="TraceSubjectSubdivisions">
<title>TraceSubjectSubdivisions</title>
<para>Default: Include</para>
<para>Asks: ___ subdivisions for searches generated by clicking on
subject tracings.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't include</para>
<itemizedlist>
<listitem>
<para>Searches for subject keywords (example:
opac-search.pl?q=su,complete-subfield:%22Web%20sites%22)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Include</para>
<itemizedlist>
<listitem>
<para>Searches for complete subject fields (example:
opac-search.pl?q=(su,complete-subfield:%22Web%20sites%22)%20and%20(su,complete-subfield:%22Design.%22))</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When TraceSubjectSubdivisions is set to "Include," if
you click on a subject with subdivisions (subfields other than
'a') they will be searched along with the subject heading
(subfield 'a'). To have only the subject heading (subfield
'a') searched, set this preference to "Don't include."</para>
</listitem>
</itemizedlist>
<important>
<para>This preference assumes that you're using XSLT stylesheets
as set in the <link
linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
preference.</para>
</important>
</section>
<section id="UseICU">
<title>UseICU</title>
<para>Default: Not using</para>
<para>Asks: ___ ICU Zebra indexing.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Not using</para>
</listitem>
<listitem>
<para>Using</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>ICU is a set of code libraries providing Unicode and
Globalization support for software applications. What this
means is ICU Zebra indexing is only necessary if you use
non-roman characters in your cataloging. If using ICU Zebra
indexing you will want to not use <link
linkend="QueryFuzzy">QueryFuzzy</link>.</para>
</listitem>
</itemizedlist>
<important>
<para>This setting will not affect Zebra indexing, it should
only be used to tell Koha that you have activated ICU indexing
if you have actually done so, since there is no way for Koha to
figure this out on its own.</para>
</important>
<important>
<para>Talk to your system administrator when changing this
preference to make sure that your system is set up properly for
this to work.</para>
</important>
</section>
</section>
<section id="searchresultsprefs">
<title>Results Display</title>
<para/>
<section id="defaultSortField">
<title>defaultSortField & defaultSortOrder</title>
<para>defaultSortField Default: author</para>
<para>defaultSortOrder Default: ascending</para>
<para>Asks: By default, sort search results in the staff client by
___, ____</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>These preferences set the default sort field and sort
order for searches on the staff side. Regardless of your
choice, the other sort options are still available in the drop
down list on the advanced search page.</para>
</listitem>
</itemizedlist>
<para>defaultSortField Values:</para>
<itemizedlist>
<listitem>
<para>author</para>
</listitem>
<listitem>
<para>call number</para>
</listitem>
<listitem>
<para>date added</para>
</listitem>
<listitem>
<para>date of publication</para>
</listitem>
<listitem>
<para>relevance</para>
</listitem>
<listitem>
<para>title</para>
</listitem>
<listitem>
<para>total number of checkouts</para>
</listitem>
</itemizedlist>
<para>defaultSortOrder Values:</para>
<itemizedlist>
<listitem>
<para>ascending</para>
</listitem>
<listitem>
<para>descending</para>
</listitem>
<listitem>
<para>from A to Z</para>
</listitem>
<listitem>
<para>from Z to A</para>
</listitem>
</itemizedlist>
</section>
<section id="displayFacetCount">
<title>displayFacetCount</title>
<para>Default: Don't show</para>
<para>Asks: ___ facet counts.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference lets you decide if you show how many
times a facet is used in your search results in the OPAC and
the staff client. The relevance of these numbers highly
depends on the value of the <link
linkend="maxRecordsForFacets">maxRecordsForFacets</link>
preference. Showing these numbers can potentially effect the
performance of your searching, so test your system with
different values for this preference to see what works
best.</para>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
<screenshot>
<screeninfo>Number of times each Facet is found in
results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/displayFacetCount.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="FacetLabelTruncationLength">
<title>FacetLabelTruncationLength</title>
<para>Default: 20</para>
<para>Asks: Truncate facets length to ___ characters, in
OPAC/staff interface.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>In the OPAC and the staff client your facets are cut off
at 20 characters by default. Depending on your layout this may
be too many or two few letters, this preference lets you
decide what number is best for your library's design.</para>
</listitem>
</itemizedlist>
</section>
<section id="maxItemsInSearchResults">
<title>maxItemsInSearchResults</title>
<para>Default: 20</para>
<para>Asks: Show up to ___ items per biblio in the search
results</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference will let you set how many results
display by default when a search is run on the Staff
Client.</para>
</listitem>
</itemizedlist>
</section>
<section id="maxRecordsForFacets">
<title>maxRecordsForFacets</title>
<para>Default: 20</para>
<para>Asks: Build facets based on ___ records from the search
results.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>By default Koha only bases facets on the first page of
results (usually 20 results). This preference lets you tell
Koha to based the facet descriptions and numbers on any number
of search results returned. The higher this number the longer
it will take for your search results to return, so test with
various different values to find the best balance for your
library.</para>
</listitem>
</itemizedlist>
</section>
<section id="numSearchResults">
<title>numSearchResults</title>
<para>Default: 20</para>
<para>Asks: By default, show ___ results per page in the staff
client.</para>
</section>
<section id="opacdefaultsort">
<title>OPACdefaultSortField & OPACdefaultSortOrder</title>
<para>OPACdefaultSortField Default: relevance</para>
<para>OPACdefaultSortOrder Default: ascending</para>
<para>Asks: By default, sort search results in the OPAC by ___,
___</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>These preferences set the default sort field and sort
order for searches on the OPAC. Regardless of your choice, the
other sort options are still available in the drop down list
on the advanced search page.</para>
</listitem>
</itemizedlist>
<para>OPACdefaultSortField Values:</para>
<itemizedlist>
<listitem>
<para>author</para>
</listitem>
<listitem>
<para>call number</para>
</listitem>
<listitem>
<para>date added</para>
</listitem>
<listitem>
<para>date of publication</para>
</listitem>
<listitem>
<para>relevance</para>
</listitem>
<listitem>
<para>title</para>
</listitem>
<listitem>
<para>total number of checkouts</para>
</listitem>
</itemizedlist>
<para>OPACdefaultSortOrder Values:</para>
<itemizedlist>
<listitem>
<para>ascending</para>
</listitem>
<listitem>
<para>descending</para>
</listitem>
<listitem>
<para>from A to Z</para>
</listitem>
<listitem>
<para>from Z to A</para>
</listitem>
</itemizedlist>
<para/>
</section>
<section id="OPACItemsResultsDisplay">
<title>OPACItemsResultsDisplay</title>
<para>Default: Don't show</para>
<para>Asks: ___ an item's branch, location and call number in OPAC
search results.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This setting selects the information about an item that
will display in the search results page of the OPAC. The
results can display the status of an item and/or full details
including branch, location, and call number. While the 'Show'
option allows for more information to be displayed on the
search results page, the information can be overwhelming for
large collections with multiple branches.</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACnumSearchResults">
<title>OPACnumSearchResults</title>
<para>Default: 20</para>
<para>Asks: By default, show ___ results per page in the
OPAC.</para>
</section>
</section>
<section id="searchformprefs">
<title>Search Form</title>
<section id="AdvancedSearchTypes">
<title>AdvancedSearchTypes</title>
<para>Default: itemtype</para>
<para>Asks: Show tabs in OPAC and staff-side advanced search for
limiting searches on the ___ fields (separate values with
|).</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>On the advanced search page you can choose to allow
filters on one or all of the following: Item types
(itemtypes), Collection Codes (ccode) and Shelving Location
(loc). If you would like to be able to limit searches on item
type and shelving location for example you would enter
itemtypes|loc in the preference input box. The order of these
fields will determine the order of the tabs in the OPAC and
staff client advanced search screens. Values within the search
type are OR'ed together, while each different search type is
AND'ed together in the query limits. The current stored values
are supported without any required modification.Each set of
advanced search fields are displayed in tabs in both the OPAC
and staff client. The first value in the AdvancedSearchTypes
syspref is the selected tab; if no values are present,
"itemtypes" is used. For non-itemtype values, the value in
AdvancedSearchTypes must match the Authorised Value name, and
must be indexed with 'mc-' prefixing that name.</para>
<screenshot>
<screeninfo>Searching by Item Type and Shelving
Location</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/AdvancedSearchTypes.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="expandedSearchOption">
<title>expandedSearchOption</title>
<para>Default: don't show</para>
<para>Asks: By default, ___ "More options" on the OPAC and staff
advanced search pages.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>don't show</para>
</listitem>
<listitem>
<para>show</para>
</listitem>
</itemizedlist>
</section>
</section>
</section>
<section id="serialsprefs">
<title>Serials</title>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences > Serials</para>
<section id="opacSerialDefaultTab">
<title>opacSerialDefaultTab</title>
<para>Default: Subscriptions tab</para>
<para>Asks: Show ___ as default tab for serials in OPAC. <important>
<para>Please note that the Serial Collection tab is currently
available only for systems using the UNIMARC standard.</para>
</important></para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Holdings tab</para>
</listitem>
<listitem>
<para>Serial Collection tab</para>
</listitem>
<listitem>
<para>Subscriptions tab</para>
</listitem>
</itemizedlist>
</section>
<section id="OPACSerialIssueDisplayCount">
<title>OPACSerialIssueDisplayCount</title>
<para>Default: 3</para>
<para>Asks: Show the ___ previous issues of a serial on the
OPAC.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows the administrator to select the
number of recent issues for each serial which appear in the OPAC
when the serial is accessed. This is just the default value,
patrons can always click to see a full list of serials.</para>
</listitem>
</itemizedlist>
</section>
<section id="RenewSerialAddsSuggestion">
<title>RenewSerialAddsSuggestion</title>
<para>Default: Don't add</para>
<para>Asks: ___ a suggestion for a biblio when its attached serial
is renewed.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Add</para>
</listitem>
<listitem>
<para>Don't add</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If set to "Add", this preference will automatically add a
serial to the Acquisitions Purchase Suggestions menu when
clicking the 'renew' option. If you don't use the Acquisitions
module to manage serials purchases it's best to leave this set
as 'Don't add.'</para>
</listitem>
</itemizedlist>
</section>
<section id="RoutingListAddReserves">
<title>RoutingListAddReserves</title>
<para>Default: Place</para>
<para>Asks: ___ received serials on hold if they are on a routing
list.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Place</para>
</listitem>
<listitem>
<para>Don't place</para>
</listitem>
</itemizedlist>
</section>
<section id="RoutingListNote">
<title>RoutingListNote</title>
<para>Asks: Include following note on all routing lists</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>Text entered in this box will appear below the routing
list information.</para>
</listitem>
</itemizedlist>
</section>
<section id="RoutingSerials">
<title>RoutingSerials</title>
<para>Default: Don't add</para>
<para>Asks: ___ received serials to the routing list.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference determines if serials routing lists are
enabled or disabled for the library. When set to “Add",
serials routing is enabled and a serial can be directed through
a list of people by identifying who should receive it next. The
list of people can be established for each serial to be passed
using the Serials module. This preference can be used to ensure
each person who needs to see a serial when it arrives at the
library will get it. Learn more in the <link
linkend="routinglist">routing list</link> section of this
manual.</para>
</listitem>
</itemizedlist>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Add</para>
</listitem>
<listitem>
<para>Don't add</para>
</listitem>
</itemizedlist>
</section>
<section id="StaffSerialIssueDisplayCount">
<title>StaffSerialIssueDisplayCount</title>
<para>Default: 3</para>
<para>Asks: Show the ___ previous issues of a serial on the staff
client.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows the administrator to select the
number of recent issues for each serial which appear in the
Staff Client when the serial is accessed. This is just the
default value, staff members can always click to see a full list
of serials.</para>
</listitem>
</itemizedlist>
</section>
<section id="SubscriptionDuplicateDroppedInput">
<title>SubscriptionDuplicateDroppedInput</title>
<para>Asks: List of fields which must not be rewritten when a
subscription is duplicated (Separated by pipe |) ___</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>When duplicating a subscription sometimes you don't want
all of the fields duplicated, using this preference you can list
the fields that you don't want to be duplicated. These field
names come from the subscription table in the Koha database.
Learn what fields are in that table on the <ulink
url="http://schema.koha-community.org/tables/subscription.html";>Koha
DB Schema</ulink> site.</para>
</listitem>
</itemizedlist>
</section>
<section id="SubscriptionHistory">
<title>SubscriptionHistory</title>
<para>Default: full history</para>
<para>Asks: When showing the subscription information for a
bibliographic record, preselect ___ view of serial issues.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>brief history</para>
<screenshot>
<screeninfo>Brief History</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/SubscriptionHistory-brief.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>full history</para>
<screenshot>
<screeninfo>Full History</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/SubscriptionHistory-full.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference determines what information appears in the
OPAC when the user clicks the More Details option. The
‘brief' option displays a one-line summary of the volume
and issue numbers of all issues of that serial held by the
library. The ‘full' option displays a more detailed
breakdown of issues per year, including information such as the
issue date and the status of each issue.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="staffprefs">
<title>Staff Client</title>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences > Staff Client</para>
<section id="Display856uAsImage">
<title>Display856uAsImage</title>
<para>Default: Neither details or results page</para>
<para>Asks: Display the URI in the 856u field as an image on:
___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Both results and details pages</para>
<itemizedlist>
<listitem>
<important>
<para>Not implemented yet</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Detail page only</para>
<itemizedlist>
<listitem>
<important>
<para><link
linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link>
needs to be on for this preference to work.</para>
</important>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>Showing the 856u as an image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/Display856uAsImage.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Neither details or results page</para>
</listitem>
<listitem>
<para>Results page only</para>
<itemizedlist>
<listitem>
<important>
<para>Not yet implemented</para>
</important>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>In addition to this option being set, the corresponding
XSLT option must be turned on. Also, the corresponding 856q
field must have a valid MIME image extension (e.g., "jpg") or
MIME image type (i.e. starting with "image/"), or the generic
indicator "img" entered in the field. When all of the
requirements are met, an image file will be displayed instead of
the standard link text. Clicking on the image will open it in
the same way as clicking on the link text. When you click on the
image it should open to full size, in the current window or in a
new window depending on the value in the system pref <link
linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
<screenshot>
<screeninfo>Sample 856 Field</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="staffappearprefs">
<title>Appearance</title>
<para/>
<section id="intranet_includes">
<title>intranet_includes</title>
<para>Default: includes</para>
<para>Asks: Use include files from the ___ directory in the
template directory, instead of includes/. (Leave blank to
disable)</para>
</section>
<section id="intranetcolorstylesheet">
<title>intranetcolorstylesheet</title>
<para>Asks: Include the stylesheet /intranet-tmpl/prog/en/css/ ___
on all pages in the staff interface.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference is used to set the background color and
style of the Staff Client. The value is a .css file. The
system administrator should determine which file is
appropriate.</para>
</listitem>
</itemizedlist>
<important>
<para>Leave this field blank to disable.</para>
</important>
</section>
<section id="IntranetFavicon">
<title>IntranetFavicon</title>
<para>Asks: Use the image at ___ for the Staff Client's favicon.
<important>
<para>This should be a complete URL, starting with
http://</para>
</important></para>
<tip>
<para>Turn your logo into a favicon with the <ulink
url="http://antifavicon.com/";>Favicon Generator</ulink>.</para>
</tip>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>The favicon is the little icon that appears next to the
URL in the address bar in most browsers. The default value for
this field (if left blank) is the small 'K' in the Koha
logo.</para>
<screenshot>
<screeninfo>Default Koha Favicon</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/favicon.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="IntranetmainUserblock">
<title>IntranetmainUserblock</title>
<para>Asks: Show the following HTML in its own column on the main
page of the staff client</para>
<screenshot>
<screeninfo>Sample HTML for IntranetmainUserblock</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/IntranetmainUserblock-html.png"/>
</imageobject>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>Message from IntranetmainUserblock as it appears on
the Staff Client main page</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/IntranetmainUserblock.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="IntranetNav">
<title>IntranetNav</title>
<para>Asks: Show the following HTML in the More menu at the top of
each page on the staff client (should be a list of links or
blank)</para>
</section>
<section id="intranetstylesheet">
<title>intranetstylesheet</title>
<para>Asks: Include the stylesheet at ___ on all pages in the
staff interface, instead of the default.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>The Intranetstylesheet preference is a layout and design
feature for the intranet or staff client. To change the
stylesheet from the original, place in this preference the
file path to the style sheet - include the entire url starting
with http://. This preference allows a library to customize
the appearance of the Staff Client.</para>
</listitem>
</itemizedlist>
<important>
<para>This should be a complete URL, starting with
http://</para>
</important>
</section>
<section id="IntranetUserCSS">
<title>IntranetUserCSS</title>
<para>Asks: Include the following CSS on all pages in the staff
client</para>
</section>
<section id="intranetuserjs">
<title>intranetuserjs</title>
<para>Asks: Include the following JavaScript on all pages in the
staff interface</para>
<screenshot>
<screeninfo>Sample JavaScript to alter the staff client
login</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/intranetuserjs-code.png"/>
</imageobject>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>Link to Self Checkout appears on staff client login
because of JavaScript</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/intranetuserjs.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This preference allows the administrator to enter
JavaScript or JQuery that will be embedded across all pages of
the Staff Client. Administrators may use this preference to
customize some of the interactive sections of Koha,
customizing the text for the login prompts, for example.
Sample JQuery scripts used by Koha libraries can be found on
the wiki: <ulink
url="http://wiki.koha-community.org/wiki/JQuery_Library";>http://wiki.koha-community.org/wiki/JQuery_Library</ulink>.</para>
</listitem>
</itemizedlist>
</section>
<section id="SlipCSS">
<title>SlipCSS</title>
<para>Asks: Include the stylesheet at ___ on Issue and Reserve
Slips.<important>
<para>This should be a complete URL, starting with
http://</para>
</important></para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>If you would like to style your receipts or slips with a
consistent set of fonts and colors you can use this preference
to point Koha to a stylesheet specifically for your
slips.</para>
</listitem>
</itemizedlist>
</section>
<section id="StaffAuthorisedValueImages">
<title>StaffAuthorisedValueImages</title>
<para>Default: Show</para>
<para>Asks: ___ images for authorized values (such as lost
statuses and locations) in search results.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
</section>
<section id="staffClientBaseURL">
<title>staffClientBaseURL</title>
<para>Asks: The staff client is located at http:// ___</para>
</section>
<section id="template">
<title>template</title>
<para>Default: prog</para>
<para>Asks: Use the ___ theme on the staff interface.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>prog</para>
</listitem>
</itemizedlist>
</section>
<section id="XSLTDetailsDisplay">
<title>XSLTDetailsDisplay</title>
<para>Default: default</para>
<para>Asks: Display details in the staff client using XSLT
stylesheet at ___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>leave empty to not use the XSLT stylesheet</para>
<itemizedlist>
<listitem>
<para>In previous versions of Koha this was the setting
that read 'normally'</para>
<screenshot>
<screeninfo>Detail display without XSLT
stylesheets</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-off.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>enter "default" for the default one</para>
<screenshot>
<screeninfo>Detail display using XSLT
stylesheets</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-on.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>put a path to define a XSLT file</para>
<itemizedlist>
<listitem>
<para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
</listitem>
<listitem>
<para>If in a multi-language system you can enter
{langcode} in the path to tell Koha to look in the right
language folder</para>
<itemizedlist>
<listitem>
<para>ex:
/home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
</listitem>
<listitem>
<para>ex.
http://mykoha.org/{langcode}/stylesheet.xsl</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>put an URL for an external specific stylesheet</para>
<itemizedlist>
<listitem>
<para>ex: http://mykoha.org/stylesheet.xsl</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>XSLT stylesheets allow for the customization of the
details shows on the screen when viewing a bib record. This
preference will allow you either use the default look that
comes with Koha or design your own stylesheet.</para>
</listitem>
</itemizedlist>
</section>
<section id="XSLTResultsDisplay">
<title>XSLTResultsDisplay</title>
<para>Default: default</para>
<para>Asks: Display results in the staff client using XSLT
stylesheet at ___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>leave empty to not use the XSLT stylesheet</para>
<itemizedlist>
<listitem>
<para>In previous versions of Koha this was the setting
that read 'normally'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>enter "default" for the default one</para>
</listitem>
<listitem>
<para>put a path to define a XSLT file</para>
<itemizedlist>
<listitem>
<para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
</listitem>
<listitem>
<para>If in a multi-language system you can enter
{langcode} in the path to tell Koha to look in the right
language folder</para>
<itemizedlist>
<listitem>
<para>ex:
/home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
</listitem>
<listitem>
<para>ex.
http://mykoha.org/{langcode}/stylesheet.xsl</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>put an URL for an external specific stylesheet</para>
<itemizedlist>
<listitem>
<para>ex: http://mykoha.org/stylesheet.xsl</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>XSLT stylesheets allow for the customization of the
details shows on the screen when viewing the search results.
This preference will allow you either use the default look
that comes with Koha or design your own stylesheet.</para>
</listitem>
</itemizedlist>
</section>
<section id="yuipath">
<title>yuipath</title>
<para>Default: included with Koha</para>
<para>Asks: Use the Yahoo UI libraries ___</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>from Yahoo's servers</para>
<itemizedlist>
<listitem>
<para>With this option there is less demand on your
servers, but if the Internet goes down there will be
issues</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>included with Koha</para>
<itemizedlist>
<listitem>
<para>With this option calls are made faster, and they
will still work if the Internet goes down</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>The yuipath preference allows for the user to define a
local path or web URL to the Yahoo User Interface Library
(<ulink
url="http://developer.yahoo.com/yui/2/";>http://developer.yahoo.com/yui/2/</ulink>).
This library is a resource of developer tools including
JavaScript and style sheets.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="staffoptsprefs">
<title>Options</title>
<section id="HidePatronName">
<title>HidePatronName</title>
<para>Default: Show</para>
<para>Asks: ___ the names of patrons that have items checked out
or on hold on detail pages or the "Place Hold" screen.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
</section>
<section id="intranetbookbag">
<title>intranetbookbag</title>
<para>Default: Show</para>
<para>Asks: ___ the cart option in the staff client.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Don't show</para>
</listitem>
<listitem>
<para>Show</para>
</listitem>
</itemizedlist>
</section>
<section id="viewISBD">
<title>viewISBD</title>
<para>Default: Allow</para>
<para>Asks: ___ staff to view records in ISBD form on the staff
client.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
<section id="viewLabeledMARC">
<title>viewLabeledMARC</title>
<para>Default: Allow</para>
<para>Asks: ___ staff to view records in labeled MARC form on the
staff client.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
<section id="viewMARC">
<title>viewMARC</title>
<para>Default: Allow</para>
<para>Asks: ___ staff to view records in plain MARC form on the
staff client.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Allow</para>
</listitem>
<listitem>
<para>Don't allow</para>
</listitem>
</itemizedlist>
</section>
</section>
</section>
<section id="webserviceprefs">
<title>Web Services</title>
<para><emphasis>Get there:</emphasis> More > Administration >
Global System Preferences > Web Services</para>
<section id="ilsdiprefs">
<title>ILS-DI</title>
<para/>
<section id="ILS-DI">
<title>ILS-DI</title>
<para>Default: Disable</para>
<para>Asks: ___ ILS-DI services for OPAC users</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Disable</para>
</listitem>
<listitem>
<para>Enable</para>
</listitem>
</itemizedlist>
</section>
<section id="ILS-DIAuthorized_IPs">
<title>ILS-DI:AuthorizedIPs</title>
<para>Asks: ___ allowed IPs to use the ILS-DI services</para>
</section>
</section>
<section id="oaiprefs">
<title>OAI-PMH</title>
<para/>
<section id="OAI-PMH">
<title>OAI-PMH</title>
<para>Default: Disable</para>
<para>Asks: ___ Koha's OAI-PMH server.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Disable</para>
</listitem>
<listitem>
<para>Enable</para>
</listitem>
</itemizedlist>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>For the Open Archives Initiative-Protocol for Metadata
Harvesting (OAI-PMH) there are two groups of
‘participants': Data Providers and Service Providers.
Data Providers (open archives, repositories) provide free
access to metadata, and may, but do not necessarily, offer
free access to full texts or other resources. OAI-PMH provides
an easy to implement, low barrier solution for Data Providers.
Service Providers use the OAI interfaces of the Data Providers
to harvest and store metadata. Note that this means that there
are no live search requests to the Data Providers; rather,
services are based on the harvested data via OAI-PMH. Koha at
present can only act as a Data Provider. It can not harvest
from other repositories. The biggest stumbling block to having
Koha harvest from other repositories is that MARC is the only
metadata format that Koha indexes natively. Visit <ulink
url="http://www.oaforum.org/tutorial/english/page3.htm";>http://www.oaforum.org/tutorial/english/page3.htm</ulink>
for diagrams of how OAI-PMH works.</para>
</listitem>
</itemizedlist>
<para>Learn more about OAI-PMH at: <ulink
url="http://www.openarchives.org/pmh/";>http://www.openarchives.org/pmh/</ulink></para>
</section>
<section id="OAI-PMHarchiveID">
<title>OAI-PMH:archiveID</title>
<para>Default: KOHA-OAI-TEST</para>
<para>Asks: Identify records at this site with the prefix ___
:</para>
</section>
<section id="OAI-PMHAutoUpdateSets">
<title>OAI-PMH:AutoUpdateSets</title>
<para>Default: Disable</para>
<para>Asks: ___ automatic update of OAI-PMH sets when a
bibliographic record is created or updated.</para>
<para>Values:</para>
<itemizedlist>
<listitem>
<para>Disable</para>
</listitem>
<listitem>
<para>Enable</para>
</listitem>
</itemizedlist>
</section>
<section id="OAI-PMHConfFile">
<title>OAI-PMH:ConfFile</title>
<para>If this preference is left empty, Koha's OAI Server operates
in normal mode, otherwise it operates in extended mode. In
extended mode, it's possible to parameter other formats than
marcxml or Dublin Core. OAI-PMH:ConfFile specify a YAML
configuration file which list available metadata formats and XSL
file used to create them from marcxml records.</para>
<para>For more information, see the <link
linkend="oaiconfsample">sample conf file</link> in the
appendix.</para>
</section>
<section id="OAI-PMHMaxCount">
<title>OAI-PMH:MaxCount</title>
<para>Default: 50</para>
<para>Asks: Only return ___ records at a time in response to a
ListRecords or ListIdentifiers query.</para>
<para>Description:</para>
<itemizedlist>
<listitem>
<para>This is the maximum number of records that would be
returned based on ListRecord or ListIdentifier queries from
harvesters. ListRecords harvest the entire records while the
ListIdentifier is an abbreviated form of ListRecords,
retrieving only headers rather than records.</para>
</listitem>
</itemizedlist>
</section>
</section>
</section>
</section>
<section id="basicparams">
<title>Basic Parameters</title>
<para><emphasis>Get there:</emphasis> More > Administration</para>
<important>
<para>Configure all 'parameters' in the order they appear.</para>
</important>
<section id="libsgroups">
<title>Libraries & Groups</title>
<para>When setting up your Koha system you will want to add
information for every library that will be sharing your system. This
data is used in several areas of Koha.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Basic Parameters > Libraries and Groups</para>
</listitem>
</itemizedlist>
<para>When visiting this page you are presented with a list of the
libraries and groups that have already been added to the
system.</para>
<screenshot>
<screeninfo>Library List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/librarylist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>Group Lists</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/grouplists.png"/>
</imageobject>
</mediaobject>
</screenshot>
<section id="addingalibrary">
<title>Adding a Library</title>
<para>To add a new library:</para>
<itemizedlist>
<listitem>
<para>Click 'New Library'</para>
</listitem>
<listitem>
<para>The top of the form asks for some basics about the
library</para>
<screenshot>
<screeninfo>Basic Library Info</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/newlibrary.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>The library code should not contain any spaces and be
10 or fewer characters. This code will be used as a unique
identifier in the database.</para>
</listitem>
<listitem>
<para>The name will be displayed on the OPAC wherever the
library name displays to the public and should be a name
that makes sense to your patrons.</para>
</listitem>
<listitem>
<para>If you have <link
linkend="addinglibgroup">groups</link> set up you can choose
what group this library belongs to after entering in the
code and name</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Next you can enter basic contact info about the
branch</para>
<screenshot>
<screeninfo>Library Contact Info</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/librarycontact.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>The address and contact fields can be used to make
notices custom for each library</para>
</listitem>
<listitem>
<para>The email address field is not required, but it should
be filled for every library in your system</para>
<itemizedlist>
<listitem>
<important>
<para>Be sure to enter a library email address to make
sure that notices are sent to and from the right
address</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If the URL field is populated then the library name
will be linked in the holdings table on the OPAC</para>
<screenshot>
<screeninfo>Linked Library Name</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/librarylink.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>The OPAC Info box is for you to put information about
the library that will appear in the OPAC when the branch
name is moused over in the holdings table</para>
<screenshot>
<screeninfo>OPAC Info</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/opacinfo.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>IP Address does not have be filled in unless you plan
on limiting access to your staff client to a specific IP
Address</para>
<itemizedlist>
<listitem>
<important>
<para>An IP address is required if you have enabled
<link
linkend="AutoLocation">AutoLocation</link></para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Finally, if you have any notes you can put them here.
These will not show in the OPAC</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<tip>
<para>Of the fields listed, only 'Library code' and 'Name' are
required</para>
</tip>
<para/>
</section>
<section id="editingalibrary">
<title>Editing/Deleting a Library</title>
<para>You will be unable to delete any library that has patrons or
items attached to it.</para>
<screenshot>
<screeninfo>Staff will be presented with a warning when trying to
delete a library that is being used</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/cannotdeletelibrary.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Each library will have an 'Edit' link to the right of it.
Click this link to edit/alter details associated with the library in
question.</para>
<important>
<para>You will be unable to edit the 'Library code'</para>
</important>
</section>
<section id="addinglibgroup">
<title>Adding a group</title>
<para>To add a Search Domain or Library Property Group click the
'New Group' button at the top of the screen</para>
<screenshot>
<screeninfo>Add group form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/addlibgroup.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Of the fields on the group form, 'Category code' and 'Name'
are the only required fields</para>
<section id="searchdomaingroups">
<title>Search Domain Groups</title>
<para>Search Domain Groups allow you to search a group of
libraries at the same time instead of searching just one library
or all libraries.</para>
<screenshot>
<screeninfo>Search Domain Groups</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/searchgroup.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To see Search Domain Groups in action visit the staff client
advanced search page in your Koha system:</para>
<screenshot>
<screeninfo>Library group search on staff client</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/stafflibgroupsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="libpropertygroups">
<title>Library Property Groups</title>
<para>You can assign specific categories to your libraries by
adding groups for them</para>
<screenshot>
<screeninfo>Library Property Groups</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/groupproperties.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Properties are then applied to libraries via the add or edit
library form</para>
<screenshot>
<screeninfo>Groups on the Add/Modify library form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/addlibrarytogroup.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
</section>
<section id="itemtypeadmin">
<title>Item Types</title>
<para>Koha allows you to organize your collection by item types and
collection codes.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Basic Parameters > Item Types</para>
</listitem>
</itemizedlist>
<para>Item types typically refer to the material type (book, cd, dvd,
etc), but can be used in any way that works for your library.</para>
<screenshot>
<screeninfo>Item Types</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/itemtypes.png"/>
</imageobject>
</mediaobject>
</screenshot>
<section id="additemtype">
<title>Adding Item Types</title>
<para>To add a new item type, simply click the 'New Item Type'
button at the top of the Item Types page.</para>
<screenshot>
<screeninfo>Sample DVD Item Type</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/additemtype.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>In the 'Item Type' field, enter a short code for your item
type</para>
</listitem>
<listitem>
<para>The description is the plain text definition of the item
type</para>
</listitem>
<listitem>
<para>You can choose to have an image associated with your item
type</para>
<itemizedlist>
<listitem>
<para>You can choose from a series of image
collections</para>
</listitem>
<listitem>
<para>You can link to a remote image</para>
</listitem>
<listitem>
<para>Or you can just have no image associated with the item
type</para>
</listitem>
<listitem>
<important>
<para>To have your item type images appear in the OPAC you
need to set noItemTypeImages to 'Show'</para>
</important>
<itemizedlist>
<listitem>
<para><emphasis>Get there: </emphasis>More >
Administration > Global System Preferences > <link
linkend="adminprefs">Admin</link></para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>For items that do not circulate, check the 'Not for loan'
options</para>
<itemizedlist>
<listitem>
<para>Items marked 'Not for loan' will appear in the
catalog, but cannot be checked out to patrons</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Enter the total number of renewals allowed for the item
type in the 'Renewals' box</para>
</listitem>
<listitem>
<para id="rentalcharge">For items that you charge a rental fee
for, enter the total fee you charge in the 'Rental charge'
field</para>
<itemizedlist>
<listitem>
<important>
<para>Do not enter symbols in this field, only numbers and
decimal points (ex. $5.00 should be entered as 5 or
5.00)</para>
</important>
</listitem>
<listitem>
<para>This will charge the patron on checkout</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>When finished, click 'Save Changes'</para>
<itemizedlist>
<listitem>
<tip>
<para>All fields, with the exception of the 'Item Type'
will be editable from the Item Types list</para>
</tip>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Your new item type will now appear on the list</para>
<screenshot>
<screeninfo>New DVD Item Type</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/newitemtype.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="edititemtype">
<title>Editing Item Types</title>
<para>Each item type has an Edit button beside it. To edit an item
simply click the 'Edit' link.</para>
<important>
<para>You will not be able to edit the code you assigned as the
'Item Type' but you will be able to edit the description for the
item.</para>
</important>
</section>
<section id="deleteitemtype">
<title>Deleting Item Types</title>
<para>Each item has a Delete button beside it. To delete an item,
simply click the 'Delete' link.</para>
<important>
<para>You will not be able to delete item types that are being
used by items within your system.</para>
</important>
<screenshot>
<screeninfo>Warning when you try to delete an item that is in
use</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/nodeleteitemtype.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="authorizedvalues">
<title>Authorized Values</title>
<para>Authorized values can be used in several areas of Koha. One
reason you would add an authorized value category would be to control
the values that can be entered into MARC fields by catalogers.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Basic Parameters > Authorized Values</para>
</listitem>
</itemizedlist>
<section id="existingauthvalues">
<title>Existing Values</title>
<para>Koha installs with pre-defined values that your library is
likely to use, for instance 'Lost'.</para>
<itemizedlist>
<listitem>
<para>Asort1</para>
<itemizedlist>
<listitem>
<para>Used for acquisitions statistical purposes</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Asort2</para>
<itemizedlist>
<listitem>
<para>Used for acquisitions statistical purposes</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para id="bornotes">BOR_NOTES</para>
<itemizedlist>
<listitem>
<para>Values for custom patron notes that appear on the
circulation screen and the OPAC</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Bsort1</para>
<itemizedlist>
<listitem>
<para>Used for patron statistical purposes</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Bsort2</para>
<itemizedlist>
<listitem>
<para>Used for patron statistical purposes</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>CART</para>
<itemizedlist>
<listitem>
<para>Is the shelving cart location, used by <link
linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>
and <link
linkend="ReturnToShelvingCart">ReturnToShelvingCart</link></para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para id="ccode">CCODE</para>
<itemizedlist>
<listitem>
<para>Collection codes (appears when cataloging and working
with items)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>DAMAGED</para>
<itemizedlist>
<listitem>
<para>Descriptions for items marked as damaged (appears when
cataloging and working with items)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>HINGS_AS</para>
<itemizedlist>
<listitem>
<para>General Holdings: Acquisition Status Designator ::
This data element specifies acquisition status for the unit
at the time of the holdings report.a</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>HINGS_C</para>
<itemizedlist>
<listitem>
<para>General Holdings: Completeness Designator</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>HINGS_PF</para>
<itemizedlist>
<listitem>
<para>Physical Form Designators</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>HINGS_RD</para>
<itemizedlist>
<listitem>
<para>General Holdings: Retention Designator :: This data
element specifies the retention policy for the unit at the
time of the holdings report.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>HINGS_UT</para>
<itemizedlist>
<listitem>
<para>General Holdings: Type of Unit Designator</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para id="shelvelocvals">LOC</para>
<itemizedlist>
<listitem>
<para>Shelving location (usually appears when adding or
editing an item)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para id="lost">LOST</para>
<itemizedlist>
<listitem>
<para>Descriptions for the items marked as lost (appears
when adding or editing an item)</para>
</listitem>
<listitem>
<important>
<para>Values given to lost statuses should be numeric and
not alphabetical in order for statuses to appear
properly</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para id="manualinvvals">MANUAL_INV</para>
<itemizedlist>
<listitem>
<para>Values for manual invoicing types</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para id="notforloan">NOT_LOAN</para>
<itemizedlist>
<listitem>
<para>Reasons why a title is not for loan</para>
</listitem>
<listitem>
<important>
<para>Values given to lost statuses should be numeric and
not alphabetical in order for statuses to appear
properly</para>
</important>
</listitem>
<listitem>
<tip>
<para>Negative number values will still allow holds (use
for on order statuses for example) where as positive
numbers will not allow holds or checkouts</para>
</tip>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>PROC</para>
<itemizedlist>
<listitem>
<para>The location to be used for <link
linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link>
(change description as desired), also the location expected
by <link
linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para id="restricted">RESTRICTED</para>
<itemizedlist>
<listitem>
<para>Restricted status of an item</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para id="suggestauthorized">SUGGEST</para>
<itemizedlist>
<listitem>
<para>List of patron suggestion reject or accept reasons
(appears when managing suggestions)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>WITHDRAWN</para>
<itemizedlist>
<listitem>
<para>Description of a withdrawn item (appears when adding
or editing an item)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>YES_NO</para>
<itemizedlist>
<listitem>
<para>A generic authorized value field that can be used
anywhere you need a simple yes/no pull down menu.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="newauthvalcat">
<title>Add new Authorized Value Category</title>
<para>In addition to the existing categories that come by default
with Koha, librarians can add their own authorized value categories
to control data that is entered into the system. To add a new
category:</para>
<itemizedlist>
<listitem>
<para>Click 'New Category'</para>
<screenshot>
<screeninfo>New Authorized Category form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/addauthcat.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Limit your Category to 10 characters (something short to
make it clear what the category is for)</para>
<itemizedlist>
<listitem>
<important>
<para>Category cannot have spaces or special characters
other than underscores and hyphens in it.</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>When adding a new category you're asked to create at least
one authorized value</para>
<itemizedlist>
<listitem>
<para>Enter a code for your Authorized Value into the
'Authorized value' field</para>
<itemizedlist>
<listitem>
<important>
<para>Authorized value is limited to 80 characters and
cannot have spaces or special characters other than
underscores and hyphens in it.</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Use the Description field for the actual value that
will be displayed. If you want something different to show
in the OPAC, enter a 'Description (OPAC)'</para>
</listitem>
<listitem>
<para>If you have <link
linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
and/or <link
linkend="AuthorisedValueImages">AuthorisedValueImages</link>
set to show images for authorized values you can choose the
image under 'Choose an icon'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Click 'Save'</para>
</listitem>
<listitem>
<para>Your new category and value will appear on the list of
Authorized Values</para>
<screenshot>
<screeninfo>Custom Authorized Value on list of
values</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/authvallist.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="newauthval">
<title>Add new Authorized Value</title>
<para>New authorized values can be added to any existing or new
category. To add a value:</para>
<itemizedlist>
<listitem>
<para>Click 'New authorized value for ...'</para>
<screenshot>
<screeninfo>New Authorized Value form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/addauthvalue.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Enter a code for your Authorized Value into the
'Authorized value' field</para>
<itemizedlist>
<listitem>
<important>
<para>Authorized value is limited to 80 characters and
cannot have spaces or special characters other than
underscores and hyphens in it.</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Use the Description field for the actual value that will
be displayed. If you want something different to show in the
OPAC, enter a 'Description (OPAC)'</para>
</listitem>
<listitem>
<para>If you have <link
linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
and/or <link
linkend="AuthorisedValueImages">AuthorisedValueImages</link> set
to show images for authorized values you can choose the image
under 'Choose an icon'</para>
</listitem>
<listitem>
<para>Click 'Save'</para>
</listitem>
<listitem>
<para>The new value will appear in the list along with existing
values</para>
<screenshot>
<screeninfo>List of authorized values in MARC504
category</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/basicparams/authvals.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
</section>
</section>
<section id="patscirc">
<title>Patrons & Circulation</title>
<para>Settings for controlling circulation and patron
information.</para>
<section id="patcats">
<title>Patron Categories</title>
<para>Patron categories allow you to organize your patrons into
different roles, age groups, and patron types.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Patrons & Circulation > Patron Categories</para>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>Patron category list</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/patroncatlist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Patrons are assigned to one of six main categories:</para>
<itemizedlist>
<listitem>
<para>Adult</para>
<itemizedlist>
<listitem>
<para>Most common patron type, usually used for a general
'Patron' category.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Child</para>
<itemizedlist>
<listitem>
<para>Children patrons can have a guardian to be attached to
them.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Staff</para>
<itemizedlist>
<listitem>
<para>Librarians (and library workers) should be assigned the
staff category so that you can <link
linkend="patronpermissions">set their permissions</link> and
give them access to the staff client.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Organizational</para>
<itemizedlist>
<listitem>
<para>Organizational patrons are organizations. Organizations
can be used as guarantors for Professional patrons.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Professional</para>
<itemizedlist>
<listitem>
<para>Professional patrons can be linked to Organizational
patrons</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Statistical</para>
<itemizedlist>
<listitem>
<para>This patron type is used strictly for statistical
purposes, such as in house use of items.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<section id="addingpatroncat">
<title>Adding a patron category</title>
<para>To add a new patron category click 'New Category' at the top
of the page</para>
<screenshot>
<screeninfo>New patron category form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/newpatroncat.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>The 'Category Code' is an identifier for your new
code.</para>
<itemizedlist>
<listitem>
<important>
<para>The category code is limited to 10 characters
(numbers and letters)</para>
</important>
</listitem>
<listitem>
<important>
<para>This field is required in order to save your patron
category. If left blank you will be presented with an
error.</para>
<screenshot>
<screeninfo>Missing fields error</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
</imageobject>
</mediaobject>
</screenshot>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Enter a plain text version of the category in the
'Description' field.</para>
<itemizedlist>
<listitem>
<important>
<para>This field is required in order to save your patron
category. If left blank you will be presented with an
error.</para>
<screenshot>
<screeninfo>Missing fields error</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
</imageobject>
</mediaobject>
</screenshot>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Enrollment period (in months) should be filled in if you
have a limited enrollment period for your patrons (eg. Student
cards expire after 9 months or until a specific date)</para>
<itemizedlist>
<listitem>
<important>
<para>You cannot enter both a month limit and a date
until. Choose to enter either one or the other.</para>
</important>
</listitem>
<listitem>
<important>
<para>This field is required in order to save your patron
category. If left blank you will be presented with an
error.</para>
<screenshot>
<screeninfo>Missing fields error</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
</imageobject>
</mediaobject>
</screenshot>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Some patron categories can have a minimum age (in years)
requirement associated with them, enter this age in the 'Age
required'</para>
</listitem>
<listitem>
<para>Patron categories can also have a maximum age (in years)
associated with them (such as children), enter this age in the
'Upperage limit'</para>
</listitem>
<listitem>
<para>If you charge a membership fee for your patrons (such as
those who live in another region) you can enter that in the
'Enrollment fee' field.</para>
<itemizedlist>
<listitem>
<important>
<para>Only enter numbers and decimals in this field</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If you want your patron to receive overdue notices, set
the 'Overdue notice required' to 'Yes'</para>
</listitem>
<listitem>
<para>You can decide on a patron category basis if lost items
are shown in the staff client by making a choice from the 'Lost
items in staff client' pull down</para>
<screenshot>
<screeninfo>Choose a value for 'Hide Lost Items'</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/hidelostitemspatron.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<important>
<para>Note that this is only applicable in the staff
client, so changing this value on patron categories who do
not have access to the staff client won't make any
difference</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If you charge patrons for placing holds on items, enter
the fee amount in the 'Hold fee' field.</para>
<itemizedlist>
<listitem>
<important>
<para>Only enter numbers and decimals in this field</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>In the 'Category type' field choose one of the six main
parent categories</para>
<screenshot>
<screeninfo>Six main patron categories</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/patroncatpulldown.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<important>
<para>This field is required in order to save your patron
category. If left blank you will be presented with an
error.</para>
<screenshot>
<screeninfo>Missing fields error</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
</imageobject>
</mediaobject>
</screenshot>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Finally you can assign advanced messaging preferences by
default to a patron category</para>
<itemizedlist>
<listitem>
<important>
<para>Requires that you have <link
linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
enabled</para>
</important>
</listitem>
<listitem>
<important>
<para>These can be changed for individual patrons, this
setting is just a default to make it easier to set up
messages for an entire category</para>
</important>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
</section>
<section id="citytowns">
<title>Cities and Towns</title>
<para>To standardize patron input you can define cities or towns
within your region so that when new patrons are added librarians
simply have to select the town from a list instead of having to type
the town and zip (or postal) code information.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Patrons & Circulation > Cities and Towns</para>
</listitem>
</itemizedlist>
<section id="addingcity">
<title>Adding a City</title>
<para>To add a new city, click the 'New City' button at the top of
the page and enter the city name, state, zip/postal code and
country.</para>
<screenshot>
<screeninfo>New city entry form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/newcity.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>One you click Submit, your city will be saved and will be
listed on the Cities and Towns page</para>
<screenshot>
<screeninfo>List of Cities</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/cities.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Cities can be edited or deleted at any time.</para>
</section>
<section id="citiesonpatform">
<title>Viewing Cities on Patron Add Form</title>
<para>If you have defined local cities using the New city form, then
when adding or editing a patron record you will see those cities in
a pull down menu to make city selection easy.</para>
<screenshot>
<screeninfo>Cities pull down on the patron record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/patroncity.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>This will allow for easy entry of local cities into the patron
record without risking the potential for typos or mistaken
zip/postal codes.</para>
</section>
</section>
<section id="roadtypes">
<title>Road Types</title>
<para>To standardize patron input you can define road types within
your region so that when new patrons are added librarians simply have
to select the road from a list instead of having to type it in.</para>
<tip>
<para>If you want your patrons to have their road types abbreviated
all of the time then you can enter the appropriate abbreviations
here, if you'd like the road types to always be spelled out you can
do that here as well.</para>
</tip>
<section id="addroadtype">
<title>Adding Road Types</title>
<para>To add a road type, click 'New Road Type' and then enter the
road type the way you'd like it displayed.</para>
<screenshot>
<screeninfo>New Road</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/newroad.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you submit the form, your new road type will be listed on
the Road Types page</para>
<screenshot>
<screeninfo>Roads in Koha</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/roads.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="roadtypeonpatform">
<title>Viewing Road Types on Patron Add form</title>
<para>When adding or editing a patron, if you have road types
defined, there will be a pull down to choose the road type
from.</para>
<screenshot>
<screeninfo>Road types on patron record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/patronroad.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="patronattributetypes">
<title>Patron Attribute Types</title>
<para>Patron attributes can be used to define custom fields to
associate with your patron records. In order to enable the use of
custom fields you need to set the <link
linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
system preference.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Patrons & Circulation > Patron attribute types</para>
</listitem>
</itemizedlist>
<para>A common use for this field would be for a student ID number or
a Driver's license number.</para>
<screenshot>
<screeninfo>List of Patron Attributes</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/attributes.png"/>
</imageobject>
</mediaobject>
</screenshot>
<section id="addpatattributes">
<title>Adding Patron Attributes</title>
<para>To add a new Patron Attribute Type, click the 'New Patron
Attribute Type' button at the top of the page</para>
<screenshot>
<screeninfo>Add Patron Attribute Type form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/addattribute.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>In the 'Patron attribute type code', enter a short code to
identify this field</para>
<itemizedlist>
<listitem>
<important>
<para>This field is limited to 10 characters (numbers and
letters only)</para>
</important>
</listitem>
<listitem>
<important>
<para>This setting cannot be changed after an attribute is
defined</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>In the 'Description' field, enter a longer (plain text)
explanation of what this field will contain</para>
</listitem>
<listitem>
<para>Check the box next to 'Repeatable' to let a patron record
have multiple values of this attribute.</para>
<itemizedlist>
<listitem>
<important>
<para>This setting cannot be changed after an attribute is
defined</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If 'Unique identifier' is checked, the attribute will be a
unique identifier which means, if a value is given to a patron
record, the same value cannot be given to a different
record.</para>
<itemizedlist>
<listitem>
<important>
<para>This setting cannot be changed after an attribute is
defined</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Check 'Allow password' to make it possible to associate a
password with this attribute.</para>
</listitem>
<listitem>
<para>Check 'Display in OPAC' to display this attribute on a
patron's details page in the OPAC.</para>
</listitem>
<listitem>
<para>Check 'Searchable' to make this attribute searchable in
the staff patron search.</para>
</listitem>
<listitem>
<para>Check 'Display in check-out' to make this attribute
visible in the patron's short detail display on the left of the
checkout screen and other patron pages</para>
<screenshot>
<screeninfo>Show attribute in patron detail on the
left</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/showattribute.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Authorized value category; if one is selected, the patron
record input page will only allow values to be chosen from the
authorized value list.</para>
<itemizedlist>
<listitem>
<para>You will first need to add an authorized value list
for it to appear in this menu</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there: </emphasis>More >
Administration > Basic Parameters > <link
linkend="authorizedvalues">Authorized
Values</link></para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<important>
<para>an authorized value list is not enforced during
batch patron import.</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If you'd like to only show this attribute on patrons of
one type choose that patron type from the 'Category' pull
down</para>
</listitem>
<listitem>
<para>If you have a lot of attributes it might be handy to group
them so that you can 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 you can then
change your attributes page to have sections of
attributes</para>
<screenshot>
<screeninfo>Patron Attributes Sorted</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/pa_class.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Click Save to save your new attribute</para>
</listitem>
</itemizedlist>
<para>Once added your attribute will appear on the list of
attributes and also on the patron record add/edit form</para>
<screenshot>
<screeninfo>Patron Attributes list on the Patron add/edit
form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/patronattribute.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you have set up classes for organizing attributes they will
appear that way on the add/edit patron form</para>
<screenshot>
<screeninfo>Grouped Attributes</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/pa_class-patron.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="editpatattributes">
<title>Editing/Deleting Patron Attributes</title>
<para>Each patron attribute has an edit and a delete link beside it
on the list of attributes.</para>
<para>Some fields in the attribute will not be editable once
created:</para>
<itemizedlist>
<listitem>
<para>Patron attribute type code</para>
</listitem>
<listitem>
<para>Repeatable</para>
</listitem>
<listitem>
<para>Unique identifier</para>
</listitem>
</itemizedlist>
<para>You will be unable to delete an attribute if it's in
use.</para>
<screenshot>
<screeninfo>Warning when trying to delete an attribute that is in
use</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/deletepatronattr.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="circfinerules">
<title>Circulation and Fine Rules</title>
<para>These rules define how your items are circulated, how/when fines
are calculated and how holds are handled.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Patrons & Circulation > Circulation and fines
rules</para>
</listitem>
</itemizedlist>
<para>The rules are applied from most specific to less specific, using
the first found in this order:</para>
<itemizedlist>
<listitem>
<para>same library, same patron type, same item type</para>
</listitem>
<listitem>
<para>same library, same patron type, all item type</para>
</listitem>
<listitem>
<para>same library, all patron types, same item type</para>
</listitem>
<listitem>
<para>same library, all patron types, all item types</para>
</listitem>
<listitem>
<para>all libraries, same patron type, same item type</para>
</listitem>
<listitem>
<para>all libraries, same patron type, all item types</para>
</listitem>
<listitem>
<para>all libraries, all patron types, same item type</para>
</listitem>
<listitem>
<para>all libraries, all patron types, all item types</para>
</listitem>
</itemizedlist>
<tip>
<para>If you are a single library system choose your branch name
before creating rules (sometimes having only rules for the 'all
libraries' option can cause issues with holds)</para>
</tip>
<para><important>
<para>At the very least you will need to set a default circulation
rule. This rule should be set for all item types, all libraries
and all patron categories. That will catch all instances that do
not match a specific rule. When checking out if you do not have a
rule for all libraries, all item types and all patron types then
you may see patrons getting blocked from placing holds. You will
also want a rule for your specific library set for all item types
and all patron types to avoid this holds issue. Koha needs to know
what rule to fall back on.</para>
</important></para>
<section id="defaultcircrules">
<title>Default Circulation Rules</title>
<para>Using the issuing rules matrix you can define rules that
depend on patron/item type combos. To set your rules, choose a
library from the pull down (or 'all libraries' if you want to apply
these rules to all branches):</para>
<screenshot>
<screeninfo>Libraries to apply the rules to</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/selectissuinglibrary.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From the matrix you can choose any combination of patron
categories and item types to apply the rules to</para>
<screenshot>
<screeninfo>Setting issuing rules for your libraries</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/addcircrule.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>First choose which patron category you'd like the rule to
be applied to. If you leave this to 'All' it will apply to all
patron categories</para>
</listitem>
<listitem>
<para>Choose the 'Item Type' you would like this rule to apply
to. If you leave this to 'All' it will apply to all item
types</para>
</listitem>
<listitem>
<para>Limit the number of items a patron can have checked out at
the same time by entering a number in the 'Current Checkouts
Allowed' field</para>
</listitem>
<listitem>
<para>Define the period of time an item can be checked out to a
patron by entering the number of units (days or hours) in the
'Loan Period' box.</para>
</listitem>
<listitem>
<para>Choose which unit of time, Days or Hours, that the loan
period and fines will be calculate in</para>
</listitem>
<listitem>
<para>You can also define a hard due date for a specific patron
category and item type. A hard due date ignores your usual
circulation rules and makes it so that all items of the type
defined are due on, before or after the date you specify.</para>
</listitem>
<listitem>
<para>'Fine Amount' should have the amount you would like to
charge for overdue items</para>
<itemizedlist>
<listitem>
<important>
<para>Enter only numbers and decimal points (no currency
symbols).</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Enter the 'Fine Charging Interval' in the unit you set
(ex. charge fines every 1 day, or every 2 hours)</para>
</listitem>
<listitem>
<para>The 'Fine Grace Period' is the period of time an item can
be overdue before you start charging fines.</para>
<itemizedlist>
<listitem>
<important>
<para>This can only be set for the Day unit, not in
Hours</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If your library 'fines' patrons by suspending their
account you can enter the number of days their fine should be
suspended in the 'Suspension in Days' field</para>
<itemizedlist>
<listitem>
<important>
<para>This can only be set for the Day unit, not in
Hours</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Next decide if the patron can renew this item type and if
so, enter how many times they can renew it in the 'Renewals
Allowed' box</para>
</listitem>
<listitem>
<para>If the patron can place holds on this item type, enter the
total numbers of items (of this type) that can be put on hold in
the 'Holds Allowed' field</para>
</listitem>
<listitem>
<para>Finally, if you charge a <link
linkend="rentalcharge">rental fee</link> for the item type and
want to give a specific patron type a discount on that fee,
enter the percentage discount (without the % symbol) in the
'Rental Discount' field</para>
</listitem>
</itemizedlist>
<para>When finished, click 'Add' to save your changes. To modify a
rule, create a new one with the same patron type and item type. If
you would like to delete your rule, simply click the 'Delete' link
to the right of the rule.</para>
<para>To save time you can clone rules from one library to another
by choosing the clone option above the rules matrix.</para>
<screenshot>
<screeninfo>Circulation & Fine Rules Clone Tool</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/clonerules.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>After choosing to clone you will be presented with a
confirmation message.</para>
<screenshot>
<screeninfo>Circulation & Fine Rules Successfully Cloned
Message</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/rulescloned.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="defaultcheckoutpolicy">
<title>Default Checkouts and Hold Policy</title>
<para>You can set a default maximum number of checkouts and hold
policy that will be used if none is defined below for a particular
item type or category.</para>
<screenshot>
<screeninfo>Default Checkouts and Hold Policy</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/defaultcheckholds.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From this menu you can set a default to apply to all item
types and patrons in the library.</para>
<itemizedlist>
<listitem>
<para>In 'Total Current Checkouts Allowed' enter the total
number of items patrons can have checked out at one time</para>
</listitem>
<listitem>
<para>Control where patrons can place holds from using the 'Hold
Policy' menu</para>
<itemizedlist>
<listitem>
<para>From Any Library: Patrons from any library may put
this item on hold. (default if none is defined)</para>
</listitem>
<listitem>
<para>From Home Library: Only patrons from the item's home
library may put this book on hold.</para>
</listitem>
<listitem>
<para>No Holds Allowed: No patron may put this book on
hold.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Control where the item returns to once it is checked
in</para>
<itemizedlist>
<listitem>
<para>Item returns home</para>
</listitem>
<listitem>
<para>Item returns to issuing branch</para>
</listitem>
<listitem>
<para>Item floats</para>
<itemizedlist>
<listitem>
<para>When an item floats it stays where it was checked
in and does not ever return 'home'</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Once your policy is set, you can unset it by clicking the
'Unset' link to the right of the rule</para>
</listitem>
</itemizedlist>
</section>
<section id="checkoutperpatron">
<title>Checkouts Per Patron</title>
<para>For this library, you can specify the maximum number of loans
that a patron of a given category can make, regardless of the item
type.</para>
<screenshot>
<screeninfo>Set default checkouts per patron category</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/checkoutsperpatron.png"/>
</imageobject>
</mediaobject>
</screenshot>
<tip>
<para>If the total amount loanable for a given patron category is
left blank, no limit applies, except possibly for a limit you
define for a specific item type.</para>
</tip>
</section>
<section id="holdpolicies">
<title>Item Hold Policies</title>
<para>For this library, you can edit rules for given itemtypes,
regardless of the patron's category. Currently, this means hold
policies.</para>
<screenshot>
<screeninfo>Hold policies per item type</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/holdsperitem.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The various Hold Policies have the following effects:</para>
<itemizedlist>
<listitem>
<para>From Any Library: Patrons from any library may put this
item on hold. (default if none is defined)</para>
</listitem>
<listitem>
<para>From Home Library: Only patrons from the item's home
library may put this book on hold.</para>
</listitem>
<listitem>
<para>No Holds Allowed: No patron may put this book on
hold.</para>
</listitem>
</itemizedlist>
<important>
<para>Note that if the system preference <link
linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
set to 'allow', these policies can be overridden by your
circulation staff.</para>
</important>
<important>
<para>These policies are based on the patron's home branch, not
the branch that the reserving staff member is from.</para>
</important>
<para>The various Return Policies have the following effects:</para>
<itemizedlist>
<listitem>
<para>Item returns home: The item will prompt the librarian to
transfer the item to its home library</para>
<itemizedlist>
<listitem>
<important>
<para>If the <link
linkend="AutomaticItemReturn">AutomaticItemReturn</link>
preference is set to automatically transfer the items
home, then a prompt will not appear</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Item returns to issuing branch: The item will prompt the
librarian to transfer the item back to the library where it was
checked out</para>
<itemizedlist>
<listitem>
<important>
<para>If the <link
linkend="AutomaticItemReturn">AutomaticItemReturn</link>
preference is set to automatically transfer the items
home, then a prompt will not appear</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Item floats: The item will not be transferred from the
branch it was checked in at, instead it will remain there until
transferred manually or checked in at another branch</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="libtransferlimits">
<title>Library Transfer Limits</title>
<para>Limit the ability to transfer items between libraries based on
the library sending, the library receiving, and the collection code
involved.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Patrons & Circulation > Library Transfer Limits</para>
</listitem>
</itemizedlist>
<para>These rules only go into effect if the preference <link
linkend="UseBranchTransferLimits">UseBranchTransferLimits</link> is
set to 'enforce'.</para>
<para>Before you begin you will want to choose which library you are
setting these limits for.</para>
<screenshot>
<screeninfo>Choose the library you're setting limits
for</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/librarytransferselect.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Transfer limits are set based on the collections codes you have
applied via the <link linkend="authorizedvalues">Authorized
Value</link> administration area.</para>
<screenshot>
<screeninfo>Collection Code values assigned in the Authorized Value
area</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/collectcodes.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Collection codes will appear as tabs above the
checkboxes:</para>
<screenshot>
<screeninfo>Collection Code tabs</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/limittocollcode.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Check the boxes for the libraries that you accept checkins from
for the item type you have selected at the top (in the example below -
FIC)</para>
<screenshot>
<screeninfo>Example transfer limits set up</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/transferlimits.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>In the above example, Centerville library will allow patrons to
return items from all libraries except Liberty and Franklin to their
branch.</para>
</section>
<section id="itemcircalerts">
<title>Item Circulation Alerts</title>
<para>Libraries can decide if they want to have patrons automatically
notified of circulation events (check ins and check outs).</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Patrons & Circulation > Item Circulation Alerts</para>
</listitem>
</itemizedlist>
<para>These preferences are set based on patron types and item
types.</para>
<important>
<para>These preference can be overwritten by changes in the
individual patron's messaging preferences.</para>
</important>
<para>To set up circulation alerts:</para>
<itemizedlist>
<listitem>
<para>Choose your library from the pull down at the top of the
screen</para>
<screenshot>
<screeninfo>Libraries to set Circulation Alerts</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/librariesforalert.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>To set preferences for all libraries, keep the menu set
to 'Default'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>By default all item types and all patrons are notified of
check ins and check outs. To change this, click on the item/patron
type combo that you would like to stop notices for.</para>
<screenshot>
<screeninfo>Circulation Alert Matrix</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/patroncirc/alertmatrix.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>In the above example, Juveniles and Kids will not
receive check out notices.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
</section>
<section id="catadmin">
<title>Catalog Administration</title>
<para>Set these controls before you start cataloging on your Koha
system.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration >
Catalog</para>
</listitem>
</itemizedlist>
<section id="marcbibframeworks">
<title>MARC Bibliographic Frameworks</title>
<para>Think of Frameworks as templates for creating new bibliographic
records. Koha comes with some predefined frameworks that can be edited
or deleted, and librarians can create their own frameworks for content
specific to their libraries.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Catalog > MARC Bibliographic Frameworks</para>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>Frameworks List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/frameworks.png"/>
</imageobject>
</mediaobject>
</screenshot>
<important>
<para>Do not delete or edit the Default Framework since this will
cause problems with your cataloging records - always create a new
template based on the Default Framework, or alter the other
Frameworks.</para>
</important>
<para>After clicking the 'MARC structure' link to the right of each
framework you can decide how many fields you want to see on one screen
by using the pagination options at the top of the table.</para>
<screenshot>
<screeninfo>Pagination options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/frameworkoptions.png"/>
</imageobject>
</mediaobject>
</screenshot>
<section id="addframework">
<title>Add New Framework</title>
<para>To add a new framework</para>
<itemizedlist>
<listitem>
<para>Click 'New Framework'</para>
<screenshot>
<screeninfo>Add Framework Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/addframework.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Enter a code of 4 or fewer characters</para>
</listitem>
<listitem>
<para>Use the Description field to enter a more detailed
definition of your framework</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Click 'Submit'</para>
</listitem>
<listitem>
<para>Once your Framework is added click 'MARC structure' to the
right of it on the list of Frameworks</para>
<screenshot>
<screeninfo>Choose basis for new Framework</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/startnewframework.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>You will be asked to choose a Framework to base your
new Framework off of, this will make it easier than starting
from scratch</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Once your Framework appears on the screen you can edit or
delete each field by following the instructions for <link
linkend="editsubfields">editing subfields</link></para>
</listitem>
</itemizedlist>
</section>
<section id="editframeworks">
<title>Edit Existing Frameworks</title>
<para>Clicking 'Edit' to the right of a Framework will only allow
you to edit the Description for the Framework:</para>
<screenshot>
<screeninfo>Edit Framework</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/editframework.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To make edits to the fields associated with the Framework you
must first click 'MARC Structure' and then follow the instructions
for <link linkend="editsubfields">editing subfields</link></para>
</section>
<section id="addsubfieldsframework">
<title>Add subfields to Frameworks</title>
<para>To add a field to a Framework click the 'New Tag' button at
the top of the Framework definition</para>
<screenshot>
<screeninfo>New Tag Button</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/newtag.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>This will open up a blank form for entering MARC field
data</para>
<screenshot>
<screeninfo>Add a new tag to framework</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/newtagform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Enter the information about your new tag:</para>
<itemizedlist>
<listitem>
<para>The 'Tag' is the MARC field number</para>
</listitem>
<listitem>
<para>The 'Label for lib' is the text that will appear in the
staff client when in the cataloging module</para>
</listitem>
<listitem>
<para>The 'Label for OPAC' is the text that will appear in the
OPAC when viewing the MARC version of the record</para>
</listitem>
<listitem>
<para>If this field can be repeated, check the 'Repeatable'
box</para>
</listitem>
<listitem>
<para>If this field is mandatory, check the 'Mandatory'
box</para>
</listitem>
<listitem>
<para>If you want this field to be a pull down with limited
possible answers, choose which 'Authorized value' list you want
to use</para>
</listitem>
</itemizedlist>
<para>When you're finished, click 'Save Changes' and you will be
presented with your new field</para>
<screenshot>
<screeninfo>New tag and link to subfields</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/subfieldslink.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To the right of the new field is a link to 'Subfields,' you
will need to add subfields before this tag will appear in your MARC
editor. The process of entering the settings for the new subfield is
the same as those found in the <link linkend="editsubfields">editing
subfields in frameworks</link> section of this manual.</para>
</section>
<section id="editsubfields">
<title>Edit Framework Subfields</title>
<para>Frameworks are made up of MARC fields and subfields. To make
edits to most Frameworks you must edit the fields and subfields.
Clicking 'Edit' to the right of each subfield will allow you to make
changes to the text associated with the field</para>
<screenshot>
<screeninfo>Modify MARC Field</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/editfield.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Each field has a tag (which is the MARC tag)</para>
<itemizedlist>
<listitem>
<para>The 'Label for lib' is what will show in the staff
client if you have <link
linkend="advancedMARCeditor">advancedMARCeditor</link> set
to display labels</para>
</listitem>
<listitem>
<para>The 'Label for OPAC' is what will show on the MARC
view in the OPAC</para>
</listitem>
<listitem>
<para>If you check 'Repeatable' then the field will have a
plus sign next to it allowing you to add multiples of that
tag</para>
</listitem>
<listitem>
<para>If you check 'Mandatory' the record will not be
allowed to save unless you have a value assigned to this
tag</para>
</listitem>
<listitem>
<para>'Authorized value' is where you define an <link
linkend="authorizedvalues">authorized value</link> that your
catalogers can choose from a pull down to fill this field
in</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>To edit the subfields associated with the tag, click
'Subfields' to the right of the tag on the 'MARC Structure'
listing</para>
<itemizedlist>
<listitem>
<para>From the list of subfields you can click 'Delete' to the
right of each to delete the subfields</para>
</listitem>
<listitem>
<para>To edit the subfields click 'Edit Subfields'</para>
<screenshot>
<screeninfo>Editing the 504 Subfield</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/editsubfield.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>For each subfield you can set the following values</para>
<itemizedlist>
<listitem>
<para>Text for librarian</para>
<itemizedlist>
<listitem>
<para>what appears before the subfield in the librarian
interface</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Text for OPAC</para>
<itemizedlist>
<listitem>
<para>what appears before the field in the OPAC.</para>
<itemizedlist>
<listitem>
<para>If left empty, the text for librarian is used
instead</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Repeatable</para>
<itemizedlist>
<listitem>
<para>the field will have a plus sign next to it
allowing you to add multiples of that tag</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Mandatory</para>
<itemizedlist>
<listitem>
<para>the record will not be allowed to save unless you
have a value assigned to this tag</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Managed in tab</para>
<itemizedlist>
<listitem>
<para>defines the tab where the subfield is shown. All
subfields of a given field must be in the same tab or
ignored. Ignore means that the subfield is not
managed.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Default value</para>
<itemizedlist>
<listitem>
<para>defines what you want to appear in the field by
default, this will be editable, but it saves time if you
use the same note over and over or the same value in a
field often.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>hidden</para>
<itemizedlist>
<listitem>
<para>allows you to select from 19 possible visibility
conditions, 17 of which are implemented. They are the
following:</para>
<itemizedlist>
<listitem>
<para>-9 => Future use</para>
</listitem>
<listitem>
<para>-8 => Flag</para>
</listitem>
<listitem>
<para>-7 => OPAC !Intranet !Editor
Collapsed</para>
</listitem>
<listitem>
<para>-6 => OPAC Intranet !Editor
!Collapsed</para>
</listitem>
<listitem>
<para>-5 => OPAC Intranet !Editor
Collapsed</para>
</listitem>
<listitem>
<para>-4 => OPAC !Intranet !Editor
!Collapsed</para>
</listitem>
<listitem>
<para>-3 => OPAC !Intranet Editor
Collapsed</para>
</listitem>
<listitem>
<para>-2 => OPAC !Intranet Editor
!Collapsed</para>
</listitem>
<listitem>
<para>-1 => OPAC Intranet Editor Collapsed</para>
</listitem>
<listitem>
<para>0 => OPAC Intranet Editor !Collapsed</para>
</listitem>
<listitem>
<para>1 => !OPAC Intranet Editor Collapsed</para>
</listitem>
<listitem>
<para>2 => !OPAC !Intranet Editor
!Collapsed</para>
</listitem>
<listitem>
<para>3 => !OPAC !Intranet Editor
Collapsed</para>
</listitem>
<listitem>
<para>4 => !OPAC Intranet Editor
!Collapsed</para>
</listitem>
<listitem>
<para>5 => !OPAC !Intranet !Editor
Collapsed</para>
</listitem>
<listitem>
<para>6 => !OPAC Intranet !Editor
!Collapsed</para>
</listitem>
<listitem>
<para>7 => !OPAC Intranet !Editor
Collapsed</para>
</listitem>
<listitem>
<para>8 => !OPAC !Intranet !Editor
!Collapsed</para>
</listitem>
<listitem>
<para>9 => Future use • URL : if checked,
the subfield is an URL, and can be clicked</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>( ! means 'not visible' or in the case of
Collapsed 'not Collapsed')</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Is a URL</para>
<itemizedlist>
<listitem>
<para>if checked, it means that the subfield is a URL
and can be clicked</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Link</para>
<itemizedlist>
<listitem>
<para>If you enter a field/subfield here (200b), a link
appears after the subfield in the MARC Detail view. This
view is present only in the staff client, not the OPAC.
If the librarian clicks on the link, a search is done on
the database for the field/subfield with the same value.
This can be used for 2 main topics :</para>
<itemizedlist>
<listitem>
<para>on a field like author (200f in UNIMARC), put
200f here, you will be able to see all bib records
with the same author.</para>
</listitem>
<listitem>
<para>on a field that is a link (4xx) to reach
another bib record. For example, put 011a in 464$x,
will find the serials that are with this
ISSN.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<warning>
<para>This value should not change after data has been
added to your catalog</para>
</warning>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Koha link</para>
<itemizedlist>
<listitem>
<para>Koha is multi-MARC compliant. So, it does not know
what the 245$a means, neither what 200$f (those 2 fields
being both the title in MARC21 and UNIMARC). So, in this
list you can "map" a MARC subfield to its meaning. Koha
constantly maintains consistency between a subfield and
its meaning. When the user want to search on "title",
this link is used to find what is searched (245 if
you're MARC21, 200 if you're UNIMARC).</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Authorized value</para>
<itemizedlist>
<listitem>
<para>means the value cannot by typed by the librarian,
but must be chosen from a pull down generated by the
<link linkend="authorizedvalues">authorized value</link>
list</para>
</listitem>
<listitem>
<para>In the example above, the 504a field will show the
MARC504 Authorized Values when cataloging</para>
<screenshot>
<screeninfo>Example of an Authorized
Subfield</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/504auth.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Thesaurus</para>
<itemizedlist>
<listitem>
<para>means that the value is not free text, but must be
searched in the authority/thesaurus of the selected
category</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Plugin</para>
<itemizedlist>
<listitem>
<para>means the value is calculated or managed by a
plugin. Plugins can do almost anything.</para>
</listitem>
<listitem>
<para>For example, in UNIMARC there are plugins for
every 1xx fields that are coded fields. The plugin is a
huge help for cataloger ! There are also two plugins
(unimarc_plugin_210c and unimarc_plugin_225a that can
"magically" find the editor from an ISBN, and the
collection list for the editor)</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>To save your changes simply click the 'Save Changes'
button at the top of the screen</para>
</listitem>
</itemizedlist>
<para/>
</section>
<section id="importexportframeworks">
<title>Import/Export Frameworks</title>
<para>Next to each framework is a link to either import or export
the framework.</para>
<section id="exportframeworks">
<title>Export Framework</title>
<para>To export a framework simply click the 'Export' link to the
right of framework title.</para>
<screenshot>
<screeninfo>Export link next to framework</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/importexport.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When you click 'Export' you will be prompted to choose what
format to export the file in.</para>
<screenshot>
<screeninfo>Export formats</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/exportoptions.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>A framework exported this way can be imported into any other
Koha installation using the import framework option.</para>
</section>
<section id="importframeworks">
<title>Import Framework</title>
<para>An easy way to create a new framework is to import it from
another Koha database. To import a framework you first need to
create <link linkend="addframework">a new framework</link>. Once
you have that framework, click 'Import' to the right of the new
framework.</para>
<screenshot>
<screeninfo>Import link next to framework</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/importexport.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You will be prompted to find a file on your computer to
import into the framework.</para>
<screenshot>
<screeninfo>Choose a file to import</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/importfile.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You will be asked to confirm your actions before the file is
imported.</para>
<screenshot>
<screeninfo>Confirm your desire to import</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/importconfirm.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>As your file is uploaded you will see an image that will
confirm that the system is working.</para>
<screenshot>
<screeninfo>Import timer</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/importtimer.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once your import is complete you will be brought to the
framework edit tool where you can make any changes you need to the
framework you imported.</para>
</section>
</section>
</section>
<section id="kohamarcmapping">
<title>Koha to MARC Mapping</title>
<para>While Koha stores the entire MARC record, it also stores common
fields for easy access in various tables in the database. Koha to MARC
Mapping is used to tell Koha where to find these values in the MARC
record. In many cases you will not have to change the default values
set by in this tool on installation, but it is important to know that
the tool is here and can be used at any time.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Catalog > Koha to MARC Mapping</para>
</listitem>
</itemizedlist>
<para>The Koha to MARC Mapping page offers you the option of choosing
from one of three tables in the database to assign values to.</para>
<screenshot>
<screeninfo>Koha to MARC Mapping Table Pull Down</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/kohamarcmapping.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>After choosing the table you would like to view, click 'OK.' To
edit any mapping click on the 'Koha Filed' or the 'Edit' link.</para>
<screenshot>
<screeninfo>Map MARC Field to Koha Field</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/mapmarc.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Choose which MARC field you would like to map to this Koha Field
and click the 'OK' button. If you would like to clear all mappings,
click the 'Click to "Unmap"' button.</para>
<important>
<para>At this time you can map only 1 MARC field to 1 Koha field.
This means that you won't be able to map both the 100a and the 700a
to the author field, you need to choose one or the other.</para>
</important>
<para/>
</section>
<section id="keywordmapping">
<title>Keywords to MARC Mapping</title>
<para>This tool will allow you to map MARC fields to a set of
predefined keywords.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Catalog > Keywords to MARC Mapping</para>
</listitem>
</itemizedlist>
<important>
<para>This tool only effects sites that are not using the XSLT
Stylesheets.</para>
</important>
<para>At this time the only keyword in use is 'subtitle.'</para>
<para>Using this tool you can define what MARC field prints to the
detail screen of the bibliographic record using keywords. The
following example will use the subtitle field.</para>
<para>Using the Framework pull down menu, choose the <link
linkend="marcbibframeworks">Framework</link> you would like to apply
this rule to. For example, the subtitle for books can be found in the
245$b field.</para>
<screenshot>
<screeninfo>Assigning Book Subtitle</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/subtitlebookmapping.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>However the subtitle for DVDs appears in 245$p</para>
<screenshot>
<screeninfo>Assigning DVD Subtitle</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/subtitledvdmapping.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Using this tool you can tell Koha to print the right field as
the subtitle when viewing the bibliographic record in the OPAC.</para>
<screenshot>
<screeninfo>Subtitle display in the OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/subtitlebookinopac.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>This tool can be used to chain together pieces of the record as
well. If you want the series number to show in the title on your
search results you simply have to map 490 $v to 'subtitle' along with
the 245 $b. <tip>
<para>Chain together the fields you want to show after the item
title in the order in which you want them to appear.</para>
</tip></para>
<para>Future developments will include additional keyword assigned
fields.</para>
</section>
<section id="marcbibframeworkstest">
<title>MARC Bibliographic Framework Test</title>
<para>Checks the MARC structure.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Catalog > MARC Bibliographic Framework Test</para>
</listitem>
</itemizedlist>
<para>If you change your MARC Bibliographic framework it's recommended
that you run this tool to test for errors in your definition.</para>
<screenshot>
<screeninfo>Framework Test</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/frameworktest.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="authoritiesadmin">
<title>Authority Types</title>
<para>Authority Types are basically MARC Frameworks for Authority
records and because of that they follow the same editing rules found
in the <link linkend="marcbibframeworks">MARC Bibliographic
Frameworks</link> section of this manual. Koha comes with many of the
necessary Authority frameworks already installed. To learn how to add
and edit Authority Types, simply review the <link
linkend="marcbibframeworks">MARC Bibliographic Frameworks</link>
section of this manual.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Catalog > Authority Types</para>
</listitem>
</itemizedlist>
</section>
<section id="classificationsources">
<sectioninfo>
<author>
<firstname id="classsourceauthor">Savitra</firstname>
<surname>Sirohi</surname>
<affiliation>
<orgname>Nucsoft OSS Labs</orgname>
</affiliation>
</author>
<pubdate id="classsourcepubdate">August 2010</pubdate>
<othercredit id="classsourceeditor" role="copyeditor">
<firstname>Nicole C.</firstname>
<surname>Engard</surname>
<contrib id="classsourcecredit">Fixed typos, changed content where
necessary and added new screenshots.</contrib>
</othercredit>
</sectioninfo>
<title>Classification Sources</title>
<para>Source of classification or shelving scheme is an <link
linkend="authorizedvalues">Authorized Values</link> category that is
mapped to field 942$2 in Koha's MARC Bibliographic frameworks.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Catalog > Classification sources</para>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>Classification Sources</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/classsources.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Commonly used values of this field are:</para>
<itemizedlist>
<listitem>
<para>ddc - Dewey Decimal Classification</para>
</listitem>
<listitem>
<para>lcc - Library of Congress Classification</para>
</listitem>
</itemizedlist>
<para>If you chose to install classification sources during Koha's
installation, you would see other values too:</para>
<itemizedlist>
<listitem>
<para>ANSCR (sound recordings)</para>
</listitem>
<listitem>
<para>SuDOC classification</para>
</listitem>
<listitem>
<para>Universal Decimal Classification</para>
</listitem>
<listitem>
<para>Other/Generic Classification</para>
</listitem>
</itemizedlist>
<section id="addingclasssource">
<title>Adding/Editing Classification Sources</title>
<para>You can add your own source of classification by using the New
Classification Source button. To edit use the Edit link.</para>
<screenshot>
<screeninfo>Add classification source</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/addclasssource.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When creating or editing:</para>
<itemizedlist>
<listitem>
<para>You will need to enter a code and a description.</para>
</listitem>
<listitem>
<para>Check the 'Source in use?' checkbox if you want the value
to appear in the drop down list for this category.</para>
</listitem>
<listitem>
<para>Select the appropriate <link
linkend="classfilingrules">filing rule</link> from the drop down
list.</para>
</listitem>
</itemizedlist>
<para/>
</section>
<section id="classfilingrules">
<title>Classification Filing Rules</title>
<para>Filing rules determine the order in which items are placed on
shelves.</para>
<para>Values that are pre-configured in Koha are:</para>
<itemizedlist>
<listitem>
<para>Dewey</para>
</listitem>
<listitem>
<para>LCC</para>
</listitem>
<listitem>
<para>Generic</para>
</listitem>
</itemizedlist>
<para>Filing rules are mapped to <link
linkend="addingclasssource">Classification sources</link>. You can
setup new filing rules by using the New Filing Rule button. To edit
use the Edit link.</para>
<para>When creating or editing:</para>
<itemizedlist>
<listitem>
<para>Enter a code and a description</para>
</listitem>
<listitem>
<para>Choose an appropriate filing routine - dewey, generic or
lcc</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="recordmatchingrules">
<title>Record Matching Rules</title>
<para>Record matching rules are used when importing MARC records into
Koha.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Catalog > Record Matching Rules</para>
</listitem>
</itemizedlist>
<para>The rules that you set up here will be referenced with you <link
linkend="stagemarc">Stage MARC Records for Import</link>.</para>
<para>To create a new matching rule :</para>
<itemizedlist>
<listitem>
<para>Click 'New Record Matching Rule'</para>
<screenshot>
<screeninfo>Add record matching rule</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/newmatchrule.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Choose a unique name and enter it in the 'Matching rule
code' field</para>
</listitem>
<listitem>
<para>'Description' can be anything you want to make it clear
to you what rule you're picking</para>
</listitem>
<listitem>
<para>'Match threshold' - The total number of 'points' a
biblio must earn to be considered a 'match'</para>
</listitem>
<listitem>
<para>Match points are set up to determine what fields to
match on</para>
</listitem>
<listitem>
<para>'Search index' can be found by looking at the
ccl.properties file on your system which tells the zebra
indexing what data to search for in the MARC data".</para>
</listitem>
<listitem>
<para>'Score' - The number of 'points' a match on this field
is worth. If the sum of each score is greater than the match
threshold, the incoming record is a match to the existing
record</para>
</listitem>
<listitem>
<para>Enter the MARC tag you want to match on in the 'Tag'
field</para>
</listitem>
<listitem>
<para>Enter the MARC tag subfield you want to match on in the
'Subfields' field</para>
</listitem>
<listitem>
<para>'Offset' - For use with control fields, 001-009</para>
</listitem>
<listitem>
<para>'Length' - For use with control fields, 001-009</para>
</listitem>
<listitem>
<para>Koha only has one 'Normalization rule' that removes
extra characters such as commas and semicolons. The value you
enter in this field is irrelevant to the normalization
process.</para>
</listitem>
<listitem>
<para>'Required match checks' - ??</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para/>
<section id="samplerecordmatch">
<title>Sample Record Matching Rule: Control Number</title>
<screenshot>
<screeninfo>LOC Matching Rule</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/samplematchrule.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Match threshold: 100</para>
</listitem>
<listitem>
<para>Matchpoints (just the one):</para>
</listitem>
<listitem>
<para>Search index: Control-number</para>
</listitem>
<listitem>
<para>Score: 101</para>
</listitem>
<listitem>
<para>Tag: 001</para>
<itemizedlist>
<listitem>
<note>
<para>this field is for the control number assigned by the
organization creating, using, or distributing the
record</para>
</note>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Subfields: a</para>
</listitem>
<listitem>
<para>Offset: 0</para>
</listitem>
<listitem>
<para>Length: 0</para>
</listitem>
<listitem>
<para>Normalization rule: Control-number</para>
</listitem>
<listitem>
<para>Required Match checks: none (remove the blank one)</para>
<screenshot>
<screeninfo>Remove match check</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/cataloging/removematchcheck.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
</section>
<section id="oaisetsconfig">
<title>OAI Sets Configuration</title>
<para>On this page you can create, modify and delete OAI-PMH
sets</para>
<section id="oaicreate">
<title>Create a set</title>
<para>To creat a set:</para>
<itemizedlist>
<listitem>
<para>Click on the link 'Add a new set'</para>
</listitem>
<listitem>
<para>Fill the mandatory fields 'setSpec' and 'setName'</para>
</listitem>
<listitem>
<para>Then you can add descriptions for this set. To do this
click on 'Add description' and fill the newly created text box.
You can add as many descriptions as you want.</para>
</listitem>
<listitem>
<para>Click on 'Save' button'</para>
</listitem>
</itemizedlist>
</section>
<section id="oaimodify">
<title>Modify/Delete a set</title>
<para>To modify a set, just click on the link 'Modify' on the same
line of the set you want to modify. A form similar to set creation
form will appear and allow you to modify the setSpec, setName and
descriptions.</para>
<para>To delete a set, just click on the link 'Delete' on the same
line of the set you want to delete.</para>
</section>
<section id="oaimapping">
<title>Define mappings</title>
<para>Here you can define how a set will be build (what records will
belong to this set) by defining mappings. Mappings are a list of
conditions on record content. A record only need to match one
condition to belong to the set.</para>
<itemizedlist>
<listitem>
<para>Fill the fields 'Field', 'Subfield' and 'Value'. For
example if you want to include in this set all records that have
a 999$9 equal to 'XXX'. Fill 'Field' with 999, 'Subfield' with 9
and 'Value' with XXX.</para>
</listitem>
<listitem>
<para>If you want to add another condition, click on 'OR' button
and repeat step 1.</para>
</listitem>
<listitem>
<para>Click on 'Save'</para>
</listitem>
</itemizedlist>
<para>To delete a condition, just leave at least one of 'Field',
'Subfield' or 'Value' empty and click on 'Save'.<note>
<para>Actually, a condition is true if value in the
corresponding subfield is strictly equal to what is defined if
'Value'. A record having 999$9 = 'XXX YYY' will not belong to a
set where condition is 999$9 = 'XXX'.</para>
</note></para>
<para>And it is case sensitive : a record having 999$9 = 'xxx' will
not belong to a set where condition is 999$9 = 'XXX'.</para>
</section>
<section id="oaibuild">
<title>Build sets</title>
<para>Once you have configured all your sets, you have to build the
sets. This is done by calling the script
misc/migration_tools/build_oai_sets.pl.</para>
</section>
</section>
</section>
<section id="acqadmin">
<title>Acquisitions</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration >
Acquisitions</para>
</listitem>
</itemizedlist>
<section id="currexchangeadmin">
<title>Currencies and Exchange Rates</title>
<para>If you place orders from more than one country you will want to
input currency exchange rates so that your acquisitions module will
properly calculate totals.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Acquisitions > Currencies and Exchange Rates</para>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>Currencies</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/acquisitions/currencies.png"/>
</imageobject>
</mediaobject>
</screenshot>
<tip>
<para>This data is not automatically updated, so be sure to keep it
up to date so that your accounting is kept correct.</para>
</tip>
<para>The active currency is the main currency you use in your
library. Your active currency will have a check mark in the 'Active'
column. If you don't have an active currency you will see an error
message telling you to choose an active currency.</para>
<screenshot>
<screeninfo>No active currency warning</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/acquisitions/nocurrency.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="budgetplanning">
<title>Budgets</title>
<para>Budgets are the top level used for tracking accounting values
related to acquisitions.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Acquisitions > Budgets</para>
</listitem>
</itemizedlist>
<para>An example would be to create a budget for the current year and
then breaking that into Funds for different areas of the
library.</para>
<section id="addbudget">
<title>Add a budget</title>
<para>Budgets can either be created from scratch or by duplicating
the previous year's budget.</para>
<para>To duplicate a budget from a previous year, click on the link
for the budget name from the list of budgets</para>
<screenshot>
<screeninfo>Budgets List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>On the screen listing the budget breakdown click the Edit
button at the top and choose to Duplicate budget</para>
<screenshot>
<screeninfo>Duplicate Budget</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/acquisitions/duplicatebudget.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You will be presented with a form where you simply need to
enter the new start and end date and save the budget.</para>
<screenshot>
<screeninfo>New Duplicate Budget</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/acquisitions/duplicatestartend.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>This will not only duplicate your budget, but all of the funds
associated with that budget so that you can reuse budgets and funds
from year to year.</para>
<para>If you haven't used Koha before for acquisitions then you'll
need to start fresh with a new budget. To add a new budget click the
'New Budget' button.</para>
<screenshot>
<screeninfo>New Budget Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/acquisitions/newbudgetform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Choose the time period this budget is for, whether it's an
academic year, a fiscal year, a quarter, etc.</para>
</listitem>
<listitem>
<para>The Description should be something that will help you
identify the budget when ordering</para>
</listitem>
<listitem>
<para>In the amount box do not use any symbols, simply enter the
amount of the budget with numbers and decimals.</para>
</listitem>
<listitem>
<para>Marking a budget active makes it usable when placing
orders in the acquisitions module, even if the order is placed
after the budget end date. This will allow you to record orders
that were places in a previous budget period.</para>
</listitem>
<listitem>
<para>Locking a budget means that Funds will not be able to be
modified by librarians</para>
</listitem>
</itemizedlist>
<para>Once you have made your edits, click the 'Save Changes'
button. You will be brought to a list of your existing
budgets.</para>
<screenshot>
<screeninfo>List of Budgets</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/acquisitions/budgetlist.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="funds">
<title>Funds</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Acquisitions > Funds</para>
</listitem>
</itemizedlist>
<section id="addbudgetfund">
<title>Add a Fund</title>
<para>A fund is added to a budget.</para>
<para><important>
<para>A <link linkend="addbudget">budget</link> must be defined
before a fund can be created.</para>
</important>To add a new fund click the New button and then choose
which Budget you would like to add the fund to.</para>
<screenshot>
<screeninfo>Choose which budget to add a fund to</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/acquisitions/newfund.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>In the form that appears you wan to enter the basics about
your fund.</para>
<screenshot>
<screeninfo>New Fund Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/acquisitions/newfundform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The three first fields are required, the rest are
optional</para>
<itemizedlist>
<listitem>
<para>Fund Code is a unique identifier for your fund</para>
</listitem>
<listitem>
<para>The Fund Name should be something that librarians will
understand</para>
</listitem>
<listitem>
<para>Amount should be entered with only numbers and decimals,
no other characters</para>
</listitem>
<listitem>
<para><emphasis>Encumbrance ??</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Expenditure ??</emphasis></para>
</listitem>
<listitem>
<para>You can choose to assign this fund to a librarian. Doing
so will make it so that only that librarian can make changes to
the Fund</para>
</listitem>
<listitem>
<para>Choose which library will be using this fund</para>
</listitem>
<listitem>
<para>You can restrict who can order from this fund by choosing
either the owner or the library from the 'Restrict access to'
menu</para>
<screenshot>
<screeninfo>Restrict Fund Access</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/acquisitions/restrictfund.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Notes are simply for any descriptive notes you might want
to add so that librarians know when to use this fund</para>
</listitem>
<listitem>
<para>Planning categories are used for statistical purposes. To
learn more about planning categories, check out the <link
linkend="planningcatfaq">Planning Category FAQ</link>.</para>
</listitem>
</itemizedlist>
<para>When complete, click 'Submit' and you will be brought to a
list of all of the funds for the budget.</para>
<screenshot>
<screeninfo>List of funds</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/acquisitions/fundlist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To the right of each fund you will find the 'Edit,' 'Delete,'
and 'Add Child Fund' options. A child fund simply a sub-fund of the
fund listed. An example would be to have a fund for 'Fiction' and
under that have a fund for 'New Releases' and a fund for 'Science
Fiction.' It is an optional way to further organize your
finances.</para>
</section>
<section id="fundsplanning">
<title>Budget Planning</title>
<para>When viewing the list of funds click the 'Planning' button and
choose how you would like to plan to spend your budget.</para>
<screenshot>
<screeninfo>Planning pull down menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/acquisitions/planningpulldown.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you choose 'Plan by MONTHS' you will see the budgeted
amount broken down by months:</para>
<screenshot>
<screeninfo>Budget Planning Formula</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/acquisitions/planningbymonths.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To hide some of the columns you can click the minus sign (-)
to the right (or below as in the screenshot above) the dates. To add
more columns you can click the 'Show a column' link found below the
'Fund Remaining' heading.</para>
<screenshot>
<screeninfo>Choose columns to add</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/acquisitions/addplanningcol.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From here you can plan your budget spending by manually
entering values or by clicking the 'Auto-fill row' button. If you
choose to auto-fill the form the system will try to divide the
amount accordingly, you may have to make some edits to split things
more accurately.</para>
<screenshot>
<screeninfo>Auto-filled columns</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/acquisitions/autofill.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once your changes are made, click the 'Save' button. If you
would like to export your data as a CSV file you can do so by
entering a file name in the 'Output to a file named' field and
clicking the 'Output' button.</para>
<screenshot>
<screeninfo>Export planning as CSV</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/acquisitions/planningcsv.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
</section>
<section id="additionaladmin">
<title>Additional Parameters</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration >
Additional Parameters</para>
</listitem>
</itemizedlist>
<section id="stopwordsadmin">
<title>Stop Words</title>
<important>
<para>If NoZebra is set to 'Use' this option will not appear on the
administration menu</para>
</important>
<para>Stop words are words that you want the search system to
ignore.</para>
<itemizedlist>
<listitem>
<para>>Get there: More > Administration > Additional
Parameters > Stop Words</para>
</listitem>
</itemizedlist>
<para>Koha comes with a standard list of stop words that can be edited
by visiting the Stop Word administration area.</para>
<screenshot>
<screeninfo>Stop word list</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/additional/stopwords.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To add a new stop word to the list, click the 'New Stop Word'
button and add the word you'd like ignored</para>
<screenshot>
<screeninfo>New stop word</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/additional/newstop.png"/>
</imageobject>
</mediaobject>
</screenshot>
<important>
<para>If you change something in this table, ask your administrator
to run misc/batchRebuildBiblioTables.pl script.</para>
</important>
</section>
<section id="z3950admin">
<title>Z39.50 Servers</title>
<para>Koha has a powerful copy cataloging tool. Using Koha you can
connect to any Z39.50 target that is publicly available or that you
have the log in information to.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Additional Parameters > Z39.50 Servers</para>
</listitem>
</itemizedlist>
<para>Koha comes with a default list of Z39.50 targets set up that you
can add to, edit or delete</para>
<screenshot>
<screeninfo>List of Z39.50 Servers in Koha</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/additional/z39list.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To find additional targets you use IndexData's IRSpy: <ulink
url="http://irspy.indexdata.com/";>http://irspy.indexdata.com</ulink></para>
<section id="addztarget">
<title>Add a Z39.50 Target</title>
<itemizedlist>
<listitem>
<para>From the main Z39.50 page, click 'New Z39.50
Server'</para>
<itemizedlist>
<listitem>
<para>Userid and Password are only required for servers that
are password protected</para>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>New Z39.50 Server Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/additional/newz39.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="suggestztarget">
<title>Suggested Z39.50 Targets</title>
<para>The following targets have been used successfully by other
Koha libraries (in the Americas):</para>
<itemizedlist>
<listitem>
<para>BIBLIOS z3950.biblios.net:210 bibliographic</para>
</listitem>
<listitem>
<para>BIG COUNTRY KOHA bcls.kohalibrary.com:210 bcls_koha</para>
</listitem>
<listitem>
<para>CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210
INNOPAC</para>
</listitem>
<listitem>
<para>GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC</para>
</listitem>
<listitem>
<para>HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210
horizon</para>
</listitem>
<listitem>
<para>HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton_hills</para>
</listitem>
<listitem>
<para>LIBRARY OF CONGRESS z3950.loc.gov:7090 Voyager</para>
</listitem>
<listitem>
<para>LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210
INNOPAC</para>
</listitem>
<listitem>
<para>MANITOBA PUBLIC library.gov.mb.ca:210 horizon</para>
</listitem>
<listitem>
<para>MILTON PL cat.mpl.on.ca:210 horizon</para>
</listitem>
<listitem>
<para>NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210
default</para>
</listitem>
<listitem>
<para>TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200
unicorn</para>
</listitem>
<listitem>
<para>TRI-UNI 129.97.129.194:7090 voyager</para>
</listitem>
<listitem>
<para>VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon</para>
</listitem>
</itemizedlist>
</section>
</section>
</section>
</chapter>
<chapter id="tools">
<title>Tools</title>
<para>Tools in Koha all perform some sort of action. Often many of the
items listed under Tools in Koha are referred to as 'Reports' in other
library management systems.</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools</para>
</listitem>
</itemizedlist>
<section id="patrontools">
<title>Patrons and Circulation</title>
<para/>
<section id="comments">
<title>Comments</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Patrons
and Circulation > Comments</para>
</listitem>
</itemizedlist>
<para>All comments added by patrons via the OPAC to bibliographic
records require moderation by the librarians. If there are comments
awaiting moderation they will be listed on the main staff dashboard
under the Tools label:</para>
<screenshot>
<screeninfo>Comments pending approval</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/comments/commentswaiting.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To moderate comments click on the notification on the main
dashboard or go directly to the Comments Tool and click 'Approve' or
'Delete' to the right of the comments awaiting moderation.</para>
<screenshot>
<screeninfo>Comment awaiting moderation</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/comments/commentmoderation.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If there are no comments to moderate you will see a message
saying just that</para>
<screenshot>
<screeninfo>No comments to moderate</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/comments/nocomments.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also review and unapprove comments you have approved in
the past by choosing the 'Approved comments' tab</para>
<screenshot>
<screeninfo>Approved comments</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/comments/commentapproved.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="patronimport">
<title>Patron Import</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Patrons
and Circulation > Import Patrons</para>
</listitem>
</itemizedlist>
<para>The patron import tool can be used at any time to add patrons in
bulk. It is commonly used in universities and schools when a new batch
of students registers.</para>
<section id="createpatronfile">
<title>Creating Patron File</title>
<para>Your Koha installation comes with a blank CSV file that you
can use as a template for your patron records. If you would like to
create the file yourself, make sure that your file has the following
fields in this order as the header row:</para>
<para>borrowernumber, cardnumber, surname, firstname, title,
othernames, initials, streetnumber, streettype, address, address2,
city, zipcode, country, email, phone, mobile, fax, emailpro,
phonepro, B_streetnumber, B_streettype, B_address, B_address2,
B_city, B_zipcode, B_country, B_email, B_phone, dateofbirth,
branchcode, categorycode, dateenrolled, dateexpiry, gonenoaddress,
lost, debarred, contactname, contactfirstname, contacttitle,
guarantorid, borrowernotes, relationship, ethnicity, ethnotes, sex,
password, flags, userid, opacnote, contactnote, sort1, sort2,
altcontactfirstname, altcontactsurname, altcontactaddress1,
altcontactaddress2, altcontactaddress3, altcontactzipcode,
altcontactcountry, altcontactphone, smsalertnumber,
patron_attributes</para>
<important>
<para>The 'password' value should be stored in plain text, and
will be converted to a md5 hash (which is an encrypted version of
the password).</para>
<itemizedlist>
<listitem>
<para>If your passwords are already encrypted, talk to your
systems administrator about options</para>
</listitem>
</itemizedlist>
</important>
<important>
<para>Date formats should match your <link
linkend="dateformat">system preference</link>, and must be
zero-padded, e.g. '01/02/2008'.</para>
</important>
<important>
<para>The fields 'branchcode' and 'categorycode' are required and
must match valid entries in your database.</para>
</important>
<tip>
<para>If loading <link linkend="patronattributetypes">patron
attributes</link>, the 'patron_attributes' field should contain a
comma-separated list of attribute types and values.</para>
<itemizedlist>
<listitem>
<para>The attribute type code and a colon should precede each
value.</para>
<itemizedlist>
<listitem>
<para>For example: <emphasis
role="bold">INSTID:12345,LANG:fr</emphasis> or <emphasis
role="bold">STARTDATE:January 1
2010,TRACK:Day</emphasis></para>
</listitem>
<listitem>
<para>If an input record has more than one attribute, the
fields should either be entered as an unquoted string
(previous examples), or with each field wrapped in
separate double quotes and delimited by a comma:</para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">"STARTDATE:January 1,
2010","TRACK:Day"</emphasis></para>
</listitem>
<listitem>
<para>This syntax would be required if the data might
have a comma in it, like a date string.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</tip>
</section>
<section id="importpatrons">
<title>Importing Patrons</title>
<para>Once you have created your file, you can use the Patron Import
Tool to bring the data into Koha.</para>
<screenshot>
<screeninfo>Import Patron Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/importpatrons/importpatrons.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Choose your CSV file and choose to match on 'Cardnumber'
to prevent adding of duplicate card numbers to the system</para>
</listitem>
<listitem>
<para>Next you can choose default values to apply to all patrons
you are importing</para>
<itemizedlist>
<listitem>
<para>ex. If you're importing patrons specific to one branch
you can use the field on the Import form to apply the branch
code to all those you are importing.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Finally you need to decide on what data you want to
replace if there are duplicates.</para>
<screenshot>
<screeninfo>Record matching options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/importpatrons/patronmatching.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>A matching record is found using the field you chose
for matching criteria to prevent duplication</para>
</listitem>
<listitem>
<para>If you included patron attributes in your file you can
decide whether to add your values to existing values or
erase existing values and enter only your new values.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
</section>
<section id="notices">
<title>Notices & Slips</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Patrons
and Circulation > Notices & Slips</para>
</listitem>
</itemizedlist>
<para>All notices and circulation receipts (or slips) generated by
Koha can be customized using the Notices & Slips Tool. The system
comes with several predefined templates that will appear when you
first visit this tool.</para>
<screenshot>
<screeninfo>Notices & Slips Tool</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/notices/notices.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Each notice can be edited, but only a few can be deleted, this
is to prevent system errors should a message try to send without a
template. Each notice and slip can be edited on a per library basis,
by default you will see the notices for all libraries.</para>
<para>If you have a style you'd like applied to all slips you can
point the <link linkend="SlipCSS">SlipCSS</link> preference to a
stylesheet. The same is true for notices, using the <link
linkend="NoticeCSS">NoticeCSS</link> preference to define a
stylesheet.</para>
<section id="addnotices">
<title>Adding Notices & Slips</title>
<para>To add a new notice or slip</para>
<itemizedlist>
<listitem>
<para>Click 'New Notice'</para>
<screenshot>
<screeninfo>New Notice Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/notices/newnotice.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Choose which library this notice or slip is for</para>
</listitem>
<listitem>
<para>Choose the module this notice is related to</para>
</listitem>
<listitem>
<para>The Code is limited to 20 characters</para>
<itemizedlist>
<listitem>
<important>
<para>When working with the overdue notices you want each
notice at each branch ot have a unique code. Think about
using the branch code in front of the notice code for each
branch.</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Use the name field to expand on your Code</para>
<itemizedlist>
<listitem>
<tip>
<para>With overdue notices, be sure to put your branch
name in the description as well so that it will be visible
when setting up your <link
linkend="noticetriggers">triggers</link>.</para>
</tip>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If you plan on writing the notice or slip in HTML check
the 'HTML Message' box, otherwise the content will be generated
as plain text</para>
</listitem>
<listitem>
<para>Message Subject is what will appear in the subject line of
the email</para>
</listitem>
<listitem>
<para>In the message body feel free to type whatever message you
feel is best, use the fields on the left hand side to enter
individualized data from the from database.</para>
<itemizedlist>
<listitem>
<important>
<para>Overdue notices can use
<<items.content>> tags by themselves, or use
<item></item> to span all of the tags. Learn
more about the <link linkend="noticemarkup">Overdue Notice
Markup</link></para>
<itemizedlist>
<listitem>
<para>On overdue notices make sure to use
<<items.content>> tags to print out the
data related to all items that are overdue.</para>
</listitem>
</itemizedlist>
<itemizedlist>
<listitem>
<para>The other option, only for overdue notices, is
to use the <item></item> tags to span the
line so that it will print out multiple lines One
example for the <item></item> tag option
is:</para>
<para><item>"<<biblio.title>>" by
<<biblio.author>>,
<<items.itemcallnumber>>, Barcode:
<<items.barcode>> , Checkout date:
<<issues.issuedate>>, Due date:
<<issues.date_due>> Fine:
<fine>USD</fine> Due date:
<<issues.date_due>> </item></para>
</listitem>
</itemizedlist>
</important>
</listitem>
<listitem>
<important>
<para>Only the overdue notices take advantage of the
<item></item> tags, all other notices
referencing items need to use
<<items.content>></para>
</important>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<section id="noticemarkup">
<title>Overdue Notice Markup</title>
<para>When creating your overdue notices there are two tags in
addition to the various database fields that you can use in your
notices.<important>
<para>These new tags only work on the overdue notices, not
other circulation related notices at this time.</para>
</important></para>
<itemizedlist>
<listitem>
<para><item></item> which should enclose all
fields from the biblio, biblioitems, and items tables.</para>
</listitem>
<listitem>
<para><fine></fine> which should be enclosed by
the item tag and should enclose a currency identifier per ISO
4217. If this tag is present with a proper identifier, the
fine for that item will be displayed in the proper currency
format.</para>
<itemizedlist>
<listitem>
<para>Note: ISO 4217 changes from time to time therefore
all currencies may not be supported. If you find one that
is not supported, please file a bug with the
Locale::Currency::Format author Tan D Nguyen <tnguyen
at cpan doe org>.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>An example of using these two tags in a notice template
might be like:</para>
<programlisting> The following item(s) is/are currently overdue:
<item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <fine>GBP</fine></item></programlisting>
<para>Which, assuming two items were overdue, would result in a
notice like:<programlisting> The following item(s) is/are currently overdue:
"A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: £3.50
"History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: £3.50</programlisting></para>
</section>
</section>
<section id="existingnotices">
<title>Existing Notices & Slips</title>
<para>Among the default notices are notices for several common
actions within Koha. All of these notices can be customized by
altering their text via the Notices & Slips tool and their style
using the <link linkend="NoticeCSS">NoticeCSS</link> preference to
define a stylesheet. Here are some of what those notices do</para>
<itemizedlist>
<listitem>
<para id="ACCTDETAILS">ACCTDETAILS</para>
<itemizedlist>
<listitem>
<para>Sent to patrons when their account is set up if the
<link linkend="AutoEmailOPACUser">AutoEmailOPACUser</link>
preference is set to 'Send'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para id="ACQCLAIM">ACQCLAIM (Acquisition Claim)</para>
<itemizedlist>
<listitem>
<para>Used in the claim acquisition module</para>
</listitem>
<listitem>
<para><emphasis>Get there:</emphasis> More > Acquisitions
> Late issues</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para id="HOLDnotice">HOLD (Hold Available for Pickup)</para>
<itemizedlist>
<listitem>
<para>This notice is used if two criteria are met:</para>
<orderedlist>
<listitem>
<para>The <link
linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
is set to 'Allow'</para>
</listitem>
<listitem>
<para>The patron has requested to receive this
notice</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there: </emphasis>OPAC >
Login > my messaging</para>
</listitem>
<listitem>
<para><emphasis>Get there: </emphasis>Staff Client
> Patron Record > <link
linkend="patnotices">Notices</link></para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
</listitem>
<listitem>
<para>When this notice references the branches table it is
referring to the pickup branch information.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para id="HOLDPLACED">HOLDPLACED (a notice to the library staff
that a hold has been placed)</para>
<itemizedlist>
<listitem>
<para>This notice requires the <link
linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
system preference to be set to 'Enable'</para>
</listitem>
<listitem>
<para>When this notice references the branches table it is
referring to the pickup branch information.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para id="HOLD_PRINT">HOLD_PRINT (Printed notice when hold
available for pickup)</para>
<itemizedlist>
<listitem>
<para>This notice is used for hold confirmation notices that
are sent out in print format. This will not effect what the
email notice looks like.</para>
</listitem>
<listitem>
<para>When this notice references the branches table it is
referring to the pickup branch information.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para id="ODUE">ODUE (Overdue Notice)</para>
<itemizedlist>
<listitem>
<para>This notice is used to send Overdue Notices to
Patrons</para>
</listitem>
<listitem>
<para>See a <link linkend="samplenotice">Sample Overdue
Notice</link></para>
</listitem>
<listitem>
<para>Requires that you set <link
linkend="noticetriggers">Overdue Notice/Status
Triggers</link></para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para id="RLIST">RLIST (Routing List)</para>
<itemizedlist>
<listitem>
<para>Used in the serials module to notify patrons/staff of
new issues of a serial</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Serials
> <link linkend="newsubscription">New
Subscription</link></para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>You have the option to select the 'Routing List'
notice when creating a new subscription (Choose from the
'Patron notification' drop down).</para>
</listitem>
<listitem>
<tip>
<para>Notice also that if you'd like to notify patrons of
new serial issues, you can click on 'define a notice'
which will take you to the 'Notices' tool</para>
</tip>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>There are also a set of predefined slips (or receipts) listed
on this page. All of these slips can be customized by altering their
text via the Notices & Slips tool and their style using the
<link linkend="SlipCSS">SlipCSS</link> preference to define a
stylesheet. Here is what those slips are used for:</para>
<itemizedlist>
<listitem>
<para>ISSUEQSLIP</para>
<itemizedlist>
<listitem>
<para>Used to print the quick slip in circulation</para>
</listitem>
<listitem>
<para>The quick slip only includes items that were checked
out today</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>ISSUESLIP</para>
<itemizedlist>
<listitem>
<para>Used to print a full slip in circulation</para>
</listitem>
<listitem>
<para>The slip or receipt will show items checked out today
as well as items that are still checked out</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>RESERVESLIP</para>
<itemizedlist>
<listitem>
<para>Used to print a holds slip</para>
</listitem>
<listitem>
<para>The holds slip is generated when a hold is
confirmed</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>TRANSFERSLIP</para>
<itemizedlist>
<listitem>
<para>Used to print a transfer slip</para>
</listitem>
<listitem>
<para>The transfer sliip is printed when you confirm a
transfer from one branch to another in your system</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
</section>
<section id="noticetriggers">
<title>Overdue Notice/Status Triggers</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Patrons
and Circulation > Overdue Notice/Status Triggers</para>
</listitem>
</itemizedlist>
<para>In order to send the overdue notices that you defined using the
<link linkend="notices">Notices</link> tool, you need to first set the
triggers to have these messages.</para>
<important>
<para>In order to have overdue notices sent to your patrons, you
need to <link linkend="addingpatroncat">set that patron
category</link> to require overdue notices.</para>
</important>
<para>The Overdue Notice/Status Triggers tool gives the librarian the
power to send up to three notices to each patron type notifying them
of overdue items</para>
<screenshot>
<screeninfo>Overdue Notice/Status Triggers Tool</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/triggers.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Delay is the number of days after an issue is due before an
action is triggered.</para>
<itemizedlist>
<listitem>
<important>
<para>If you want Koha to trigger an action (send a letter
or restrict member), a delay value is required.</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>To send additional notices, click on the tabs for 'Second'
and 'Third' notice</para>
</listitem>
<listitem>
<para>If you would like to prevent a patron from checking items
out because of their overdue items, check the 'Restrict' box, this
will put a notice on the patron's record at checkout informing the
librarian that the patron cannot check out due to overdue
items.</para>
</listitem>
<listitem>
<para>See a <link linkend="samplenotice">Sample Overdue
Notice</link></para>
</listitem>
</itemizedlist>
</section>
<section id="patroncardcreator">
<title>Patron Card Creator</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Patrons
and Circulation > Patron Card Creator</para>
</listitem>
</itemizedlist>
<para>The Patron Card Creator allow you to use layouts and templates
which you design to print a nearly unlimited variety of patron cards
including barcodes. Here are some of the features of the Patron Card
Creator module:</para>
<itemizedlist>
<listitem>
<para>Customize patron card layouts</para>
</listitem>
<listitem>
<para>Design custom card templates for printed patron cards</para>
</listitem>
<listitem>
<para>Build and manage batches of patron cards</para>
</listitem>
<listitem>
<para>Export single or multiple batches</para>
</listitem>
<listitem>
<para>Export single or multiple patron cards from within a
batch</para>
</listitem>
<listitem>
<para>Export card data as a PDF readable by any standard PDF
reader, making patron cards printable directly on a printer</para>
</listitem>
</itemizedlist>
<para>At the top of each screen within the Patron Card Creator, you
will see a toolbar allowing quick access to relevant functions. The
menu to the left of each screen also allows easy access to the
different sections of the Patron Card Creator. The breadcrumb trail
near the top of each screen will give specific indication as to where
you are within the Patron Card Creator module and allow quick
navigation to previously traversed sections. And finally, you can find
more detailed information on each section of the Patron Card Creator
by clicking the online help link at the upper left-hand corner of
every page.</para>
<section id="patrontemplate">
<title>Templates</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools >
Patron Card Creator > Templates</para>
</listitem>
</itemizedlist>
<para>A template is the label/card stock you are using. This might
be Avery 5160 for address labels, Gaylord 47-284 for spine labels or
Avery 28371 for your patron cards, just to give a couple of
examples. These labels will include all of the information you will
need for setting up a Koha, this information may be on the
packaging, and if not it can usually be found on the vendor's
website.</para>
<section id="addcardtemplate">
<title>Add a Template</title>
<para>To add a new template, you want to click on the 'Templates'
button at the top of your page and choose 'New Template'</para>
<screenshot>
<screeninfo>New Template Button</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/newtemplate.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Using the form that appears you can define the template for
your sheet of labels or cards.</para>
<screenshot>
<screeninfo>Add Patron Card Template</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/edittemplate.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Template ID will be automatically generated after saving
your template, this is simply a system generated unique
id</para>
</listitem>
<listitem>
<para>Template Code should be something you can use to
identify your template on a list of templates</para>
</listitem>
<listitem>
<para>You can use the Template Description to add additional
information about the template</para>
</listitem>
<listitem>
<para>The Units pull down is used to define what measurement
scale you're going to be using for the template. This should
probably match the unit of measurement used on the template
description provided by the product vendor.</para>
<screenshot>
<screeninfo>Measurement Units</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/units.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>The measurements can be found on the vendor product
packaging or website.</para>
</listitem>
<listitem>
<para>A profile is a set of "adjustments" applied to a given
template just prior to printing which compensates for
anomalies unique and peculiar to a given printer (to which the
profile is assigned).</para>
<itemizedlist>
<listitem>
<para>Before picking a profile try printing some sample
cards so that you can easily define a profile that is
right for your printer/template combination.</para>
</listitem>
<listitem>
<para>After finding any anomalies in the printed document,
<link linkend="addcardprofile">create a profile</link> and
assign it to the template.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>After saving, your templates will appear on the 'Manage
Templates' page.</para>
<screenshot>
<screeninfo>Manage Templates</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/managetemplates.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="patronprofile">
<title>Profiles</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools >
Patron Card Creator > Profiles</para>
</listitem>
</itemizedlist>
<para>A profile is a set of "adjustments" applied to a given <link
linkend="patrontemplate">template</link> just prior to printing
which compensates for anomalies unique and peculiar to a given
printer (to which the profile is assigned). This means if you set a
template up and then print a sample set of data and find that the
items are not all aligned the same on each card, you need to set up
a profile for each printer to make up for the differences in
printing styles, such as the shifting of text to the left, right,
top or bottom.</para>
<para>If your cards are printing just the way you want, you will not
need a profile.</para>
<section id="addcardprofile">
<title>Add a Profile</title>
<para>To add a new profile, you want to click on the 'Profiles'
button at the top of your page and choose 'New Profile'</para>
<screenshot>
<screeninfo>New Profile Button</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/newprofile.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Using the form that appears you can create a profile to fix
any problems with your template.</para>
<screenshot>
<screeninfo>Add Printer Profile</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/addprofile.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>The Printer Name and Paper Bin do not have to match your
printer exactly, they are for your reference so you can
remember what printer you have set the profile for. So if you
want to use the Printer model number in printer name or you
can call it 'the printer on my desk'</para>
</listitem>
<listitem>
<para>Template will be filled in once you have chosen which
template to apply the profile to on the <link
linkend="addcardtemplate">template edit form</link></para>
</listitem>
<listitem>
<para>The Units pull down is used to define what measurement
scale you're going to be using for your profile.</para>
<screenshot>
<screeninfo>Units of Measurement</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/units.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Offset describes what happens when the entire image is
off center either vertically or horizontally and creep
describes a condition where the distance between the labels
changes across the page or up and down the page</para>
<itemizedlist>
<listitem>
<para>For these values, negative numbers move the error up
and to the left and positive numbers move the error down
and to the right</para>
</listitem>
<listitem>
<para>Example: the text is .25" from the left edge of the
first label, .28" from the left edge of the second label
and .31" from the left edge of the third label. This means
the horizontal creep should be set to .03" to make up for
this difference.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>After saving, your profiles will appear on the 'Manage
Profiles' page.</para>
<screenshot>
<screeninfo>Manage Profiles</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/manageprofiles.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you have saved your new profile, you can return to the
list of templates and choose to edit the template that this
profile is for.</para>
</section>
</section>
<section id="cardlayouts">
<title>Layouts</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools >
Patron Card Creator > Layouts</para>
</listitem>
</itemizedlist>
<para>A layout defines the text and images that will be printed on
to the card and where it will appear.</para>
<section id="addcardlayout">
<title>Add a Layout</title>
<para>To add a new layout, you want to click on the 'Layouts'
button at the top of your page and choose 'New Layout'</para>
<screenshot>
<screeninfo>New Layout Button</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/newlayout.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Using the form that appears you can create a profile to fix
any problems with your template.</para>
<screenshot>
<screeninfo>Add New Layout</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/addlayout.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>The name you assign to the layout is for your benefit,
name it something that will be easy to identify at a later
date</para>
</listitem>
<listitem>
<para>The Units pull down is used to define what measurement
scale you're going to be using for your layout.</para>
<screenshot>
<screeninfo>Units of Measurement</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/units.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Next note if this layout is for the front or the back of
the patron card</para>
<itemizedlist>
<listitem>
<para>You will need a layout for both the front and back
of your card if you have 2-sided library cards</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>You have the option of adding up to 3 lines of text to
your card. Your text can be static text of your choosing
and/or fields from the patron record. If you want to print
fields from the patron record you want to put the field names
in brackets like so - <firstname></para>
</listitem>
<listitem>
<para>For each line of text, you can choose your font, font
size and the location of the text on the card using the lower
X and Y coordinates</para>
</listitem>
<listitem>
<para>In order to show the barcode and the patron card number
you will need to check the 'Print Card Number as Barcode'
option. This will turn the patron card number into a barcode.
If you want the number to print in human readable format you
will need to check the 'Print Card Number as Text Under
Barcode' option.</para>
</listitem>
<listitem>
<para>Finally you can choose up to two images to print on the
card.</para>
<itemizedlist>
<listitem>
<para>One can be the <link
linkend="uploadpatronimages">patron image</link> which you
can resize to meet your needs.</para>
</listitem>
<listitem>
<para>The other image can be something like a library logo
or symbol that you uploaded using the '<link
linkend="managecardimages">Manage Images</link>' module of
the Patron Card Creator Tool.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>After saving, your layouts will appear on the 'Manage
Layouts' page.</para>
<screenshot>
<screeninfo>Manage Layouts</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/managelayouts.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="patroncardbatches">
<title>Batches</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools >
Patron Card Creator > Batches</para>
</listitem>
</itemizedlist>
<para>A batch is a collection of patrons for whom you want to
generate cards.</para>
<section id="addcardbatch">
<title>Add a Batch</title>
<para>To add a new batch, you want to click on the 'Batches'
button at the top of your page and choose 'New Batch'</para>
<screenshot>
<screeninfo>New Batch Button</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/newbatch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para/>
</section>
</section>
<section id="managecardimages">
<title>Manage Images</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools >
Patron Card Creator > Manage Images</para>
</listitem>
</itemizedlist>
<para>Images uploaded using this tool will appear on the menu when
creating <link linkend="cardlayouts">patron card layouts</link>. You
are limited in how many images you can upload (not counting patron
images) by the <link linkend="ImageLimit">ImageLimit</link> system
preference.</para>
<important>
<para>Images must be under 500k in size.</para>
</important>
<tip>
<para>Pictures uploaded with this tool should be at least 300dpi
which is the minimum quality for a printable image.</para>
</tip>
<para>In the center of the screen is a simple upload form, simply
browse for the file on your computer and give it a name you'll
recognize later.</para>
<screenshot>
<screeninfo>Upload Images</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/imageupload.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once the file is uploaded you will be presented with a
confirmation message.</para>
<screenshot>
<screeninfo>Image Uploaded</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/imageuploaded.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>And the image will be listed with all of your others on the
right hand side of the page.</para>
<screenshot>
<screeninfo>Images</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/imagedelete.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To delete one or multiple of these images, click the checkbox
to the right of each image you want to delete and click the 'Delete'
button.</para>
</section>
</section>
<section id="anonpatrons">
<title>Patrons (anonymize, bulk-delete)</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Patrons
and Circulation > Patrons (anonymize, bulk-delete)</para>
</listitem>
</itemizedlist>
<para>This tool allows you to bulk anonymize circulation histories
(this means that you keep records of how many times items were checked
out - but not the patrons who checked the items out) or bulk delete
patrons (remove them from the system completely).<important>
<para>Patrons with outstanding fines or items checked out are not
saved. They are not completely removed from the system (moved to
the delete_borrowers table), but this tool does not provide as
many checks as one may desire.</para>
</important></para>
<screenshot>
<screeninfo>Patron Anonymize/Bulk Delete Tool</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/anonymize/patronbulkdelete.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To either delete or anonymize patrons</para>
<itemizedlist>
<listitem>
<para>Check the task you would like to perform (Delete or
Anonymize)</para>
</listitem>
<listitem>
<para>Enter a date before which you want to alter the data</para>
</listitem>
<listitem>
<para>Click 'Next'</para>
</listitem>
<listitem>
<para>A confirmation will appear asking if you're sure this is
what you want to happen</para>
<screenshot>
<screeninfo>Patron Anonymize/Bulk Delete
Confirmation</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/anonymize/patronanonconfirm.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Clicking 'Finish' will delete or anonymize your data</para>
<screenshot>
<screeninfo>Completed Process</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/anonymize/patronanoncomplete.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="tagsmoderation">
<title>Tag Moderation</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Patrons
and Circulation > Tags</para>
</listitem>
</itemizedlist>
<para>Depending on your <link linkend="taggingprefs">tagging system
preferences</link>, librarians may need to approve tags before they
are published on the OPAC. This is done via the Tag Moderation Tool.
If there are tags awaiting moderation they will be listed on the main
staff dashboard under the Tools label:</para>
<screenshot>
<screeninfo>Tags pending approval</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/tagging/pendingtags.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To moderate the tags visit the Tags tool. When first visiting
the tool, you will be presented with a list of tags that are pending
approval or rejection by a librarian</para>
<screenshot>
<screeninfo>Tags pending moderation</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/tagging/tagpending.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>To approve a tag, you can either click the 'Approve' button
inline with the term, or check all terms you want to approve and
click 'Approve' below the table.</para>
</listitem>
<listitem>
<para>To reject a tag, you can either click the 'Reject' button
inline with the term, or check all terms you want to approve and
click 'Reject' below the table.</para>
</listitem>
</itemizedlist>
<para>Once a tag has been approved or rejected it will be moved to the
appropriate list of tags. A summary of all tags will appear on the
right of the screen.</para>
<screenshot>
<screeninfo>Summary of tags</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/tagging/tagsummary.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Even though a tag is approved or rejected, it can still be moved
to another list. When viewing approved tags each tag has the option to
reject:</para>
<screenshot>
<screeninfo>Approved Tags</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/tagging/tagapproved.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To check terms against the approved and rejected lists (and
possibly against <link linkend="TagsExternalDictionary">the
dictionary</link> you have assigned for tag moderation) simply enter
the term into the search box on the bottom right of the screen to see
the status of the term</para>
<screenshot>
<screeninfo>Sample Blacklist/Whitelist test search</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/tagging/tagblacklisttest-neither.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="uploadpatronimages">
<title>Upload Patron Images</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Patrons
and Circulation > Upload Patron Images</para>
</listitem>
</itemizedlist>
<para>Patron images can be uploaded in bulk if you are <link
linkend="patronimages">allowing patron images</link> to be attached to
patron records. These images can also be used when creating <link
linkend="patroncardcreator">patron cards</link>.</para>
<itemizedlist>
<listitem>
<para>Create a txt file and title it "DATALINK.TXT" or
"IDLINK.TXT"</para>
</listitem>
<listitem>
<para>On each line in the text file enter the patron's card number
followed by comma (or tab) and then the image file name</para>
<screenshot>
<screeninfo>Sample file and image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patronphotos/uploadphotosfile.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Make sure that your TXT file is a plain text document,
not RTF.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Zip up the text file and the image files</para>
</listitem>
<listitem>
<para>Go to the Upload Patron Images Tool</para>
<screenshot>
<screeninfo>Upload Image Tool for Single Image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patronphotos/uploadimagetool.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>For a single image, simply point to the image file and enter
the patron card number</para>
</listitem>
<listitem>
<para>For multiple images, choose to upload a zip file</para>
</listitem>
<listitem>
<para>After uploading you will be presented with a
confirmation</para>
<screenshot>
<screeninfo>Image Upload Confirmation</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patronphotos/imageuploadconfirm.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<important>
<para>There is a limit of 520K on the size of the picture uploaded
and it is recommended that the image be 200x300 pixels, but smaller
images will work as well.</para>
</important>
</section>
</section>
<section id="catalogtools">
<title>Catalog</title>
<para/>
<section id="batchmodifyitems">
<title>Batch item modification</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Catalog
> Batch item modification</para>
</listitem>
</itemizedlist>
<para>This tool will allow you to modify a batch of item records in
Koha.</para>
<screenshot>
<screeninfo>Batch Modification Tool</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/batchmod/batchmod.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From the tool you can choose to upload a file of barcodes or
item ids, or you can scan items one by one into the box below the
upload tool. Once you have your file uploaded or the barcodes listed
you can click 'Continue.'</para>
<screenshot>
<screeninfo>Batch Modify Summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/batchmod/batchmodsummary.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You will be presented with a summary of the items you want to
modify. From here you can uncheck the items you don't want to modify
before making changes in the form below. You can also hide columns you
don't need to see to prevent having to scroll from left to right to
see the entire item form.</para>
<para>Using the edit form you can choose which fields to make edits
to. By checking the checkbox to the right of each field you can clear
the values in that field for the records you are modifying.</para>
<screenshot>
<screeninfo>Choose fields you want to change in bulk</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/batchmod/batchmodform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you have made you changes you will be presented with the
resulting items.</para>
<screenshot>
<screeninfo>Item results summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/batchmod/batchmodresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="batchdeleteitems">
<title>Batch item deletion</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Catalog
> Batch item deletion</para>
</listitem>
</itemizedlist>
<para>This tool will allow you to delete a batch of item records from
Koha.</para>
<para>From the tool you can choose to upload a file of barcodes or
item ids, or you can scan items one by one into the box below the
upload tool.</para>
<screenshot>
<screeninfo>Batch Deletion Tool</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/batchdelete/batchdel.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you have your file uploaded or the barcodes scanned you can
click 'Continue.'</para>
<para>You will be presented with a confirmation screen. From here you
can uncheck the items you don't want to delete and decide if Koha
should delete the bib record if the last item is being deleted before
clicking 'Delete selected items.'</para>
<screenshot>
<screeninfo>Confirm Deletion</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/batchdelete/confirmbatchdel.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If your file (or list of scanned barcodes) has more than 1000
barcodes, Koha will be unable to present you with a list of the items.
You will still be able to delete them, but not able to choose which
items specifically to delete or delete the biblio records.</para>
<screenshot>
<screeninfo>More than 1000 records in the file</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/batchdelete/toomanytodelete.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If the items are checked out you will be presented with an error
after clicking 'Delete selected items' and the items will not be
deleted.</para>
<screenshot>
<screeninfo>Items not Deleted</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/batchdelete/nobatchdel.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If the items can be deleted they will be and you will be
presented with a confirmation of your deletion.</para>
<screenshot>
<screeninfo>Batch Deletion Confirmation</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/batchdelete/batchdeldone.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="exportbibs">
<title>Export Bibliographic and Holdings Data (MARC Export)</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Catalog
> Export Bibliographic and Holdings Data</para>
</listitem>
</itemizedlist>
<para>Koha comes with a tool that will allow you to export your
bibliographic and/or holdings data in bulk. This can be used to send
your records to fellow libraries, organizations or services; or simply
for backup purposes.</para>
<itemizedlist>
<listitem>
<para>Fill in the form in order to limit your export to a specific
range (all fields are optional)</para>
<screenshot>
<screeninfo>Select Records to Export</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/exportmarc/marcexport-pt1.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Choose to limit your export by any one or more of the
following options</para>
<itemizedlist>
<listitem>
<para>Limit to a bib number range</para>
</listitem>
<listitem>
<para>Limit to a specific item type</para>
</listitem>
<listitem>
<para>Limit to a specific library</para>
</listitem>
<listitem>
<para>Limit to a call number range</para>
</listitem>
<listitem>
<para>Limit to an acquisition date range</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Next choose what to skip when exporting</para>
<screenshot>
<screeninfo>Export options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/exportmarc/marcexport-pt2.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>By default items will be exported, if you would like
to only export bibliographic data, check the 'Don't export
items' box</para>
</listitem>
<listitem>
<para>To limit your export only to items from the library
you're logged in as (if you leave the 'Library' field set
to 'All') or to the library you selected above check the
'Remove non-local items' box</para>
</listitem>
<listitem>
<para>You can also choose what fields you don't want to
export. This can be handy if you're sharing your data, you
can remove all local fields before sending your data to
another library</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Finally choose the file type and file name</para>
<screenshot>
<screeninfo>File export format</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/exportmarc/marcexport-pt3.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Choose to export your data in marc or marcxml
format</para>
</listitem>
<listitem>
<para>Choose the name you want your file to save as</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Click 'Export'</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="inventory">
<title>Inventory/Stocktaking</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Catalog
> Inventory/Stocktaking</para>
</listitem>
</itemizedlist>
<para>Koha's Inventory Tool can be used in one of two ways, the first
is by printing out a shelf list that you can then mark items off on,
or by uploading a text files of barcodes gathered by a portable
scanner.</para>
<para>If you do not have the ability to use your barcode scanner on
the floor of the library, the first option available to you is to
generate a shelf list based on criteria you enter.</para>
<screenshot>
<screeninfo>Inventory & Stocktaking Tool</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/inventory/generateshelflist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Choose which library, shelving location, call number range, item
status and when the item was last seen to generate a shelf list that
you can then print to use while walking around the library checking
your collection</para>
<screenshot>
<screeninfo>Shelf List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/inventory/shelflist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Alternatively you can export the list to a CSV file for altering
in an application on your desktop. Simply check the box next to
'Export to csv file' to generate this file.</para>
<para>Once you have found the items on your shelves you can return to
this list and check off the items you found to have the system update
the last seen date to today.</para>
<para>If you have a portable scanner (or a laptop and USB scanner) you
can walk through the library with the scanner in hand and scan
barcodes as you come across them. Once finished you can then upload
the text file generated by the scanner to Koha</para>
<screenshot>
<screeninfo>Barcode Import for Inventory Tool</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/inventory/importbarcodes.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Choose the text file and the date you want to mark all items as
seen and click 'Submit.'</para>
</section>
<section id="labelcreator">
<title>Label Creator</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Catalog
> Label Creator</para>
</listitem>
</itemizedlist>
<para>The Label Creator allow you to use layouts and templates which
you design to print a nearly unlimited variety of labels including
barcodes. Here are some of the features of the Label Creator
module:</para>
<itemizedlist>
<listitem>
<para>Customize label layouts</para>
</listitem>
<listitem>
<para>Design custom label templates for printed labels</para>
</listitem>
<listitem>
<para>Build and manage batches of labels</para>
</listitem>
<listitem>
<para>Export single or multiple batches</para>
</listitem>
<listitem>
<para>Export single or multiple labels from within a batch</para>
</listitem>
<listitem>
<para>Export label data in one of three formats:</para>
<itemizedlist>
<listitem>
<para>PDF - Readable by any standard PDF reader, making labels
printable directly on a printer</para>
</listitem>
<listitem>
<para>CSV - Export label data after your chosen layout is
applied allowing labels to be imported in to a variety of
applications</para>
</listitem>
<listitem>
<para>XML - Included as an alternate export format</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>At the top of each screen within the Label Creator, you will see
a toolbar allowing quick access to relevant functions. The menu to the
left of each screen also allows easy access to the different sections
of the Label Creator. The breadcrumb trail near the top of each screen
will give specific indication as to where you are within the Label
Creator module and allow quick navigation to previously traversed
sections. And finally, you can find more detailed information on each
section of the Label Creator by clicking the online help link at the
upper left-hand corner of every page.</para>
<section id="labeltemplates">
<title>Templates</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Label
Creator > Templates</para>
</listitem>
</itemizedlist>
<para>A template is based on the label/card stock you are using.
This might be Avery 5160 for address labels, Gaylord 47-284 for
spine labels or Avery 28371 for your patron cards, just to give a
couple of examples. These labels will include all of the information
you will need for setting up a Koha, this information may be on the
packaging, and if not it can usually be found on the vendor's
website.</para>
<section id="addlabeltemplate">
<title>Add a Template</title>
<para>To add a new template, you want to click on the 'Templates'
button at the top of your page and choose 'New Template'</para>
<screenshot>
<screeninfo>New Label Template Option</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/newtemplate.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Using the form that appears you can define the template for
your sheet of labels or cards.</para>
<screenshot>
<screeninfo>Label Template Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/labelform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Template ID will be automatically generated after saving
your template, this is simply a system generated unique
id</para>
</listitem>
<listitem>
<para>Template Code should be something you can use to
identify your template on a list of templates</para>
</listitem>
<listitem>
<para>You can use the Template Description to add additional
information about the template</para>
</listitem>
<listitem>
<para>The Units pull down is used to define what measurement
scale you're going to be using for the template. This should
probably match the unit of measurement used on the template
description provided by the product vendor.</para>
<screenshot>
<screeninfo>Measurement Units</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/units.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>The measurements, number of columns and number of rows
can be found on the vendor product packaging or
website.</para>
<itemizedlist>
<listitem>
<important>
<para>If you do not supply a left text margin in the
template, a 3/16" (13.5 point) left text margin will
apply by default.</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>A profile is a set of "adjustments" applied to a given
template just prior to printing which compensates for
anomalies unique and peculiar to a given printer (to which the
profile is assigned).</para>
<itemizedlist>
<listitem>
<para>Before picking a profile try printing some sample
labels so that you can easily define a profile that is
right for your printer/template combination.</para>
</listitem>
<listitem>
<para>After finding any anomalies in the printed document,
<link linkend="addlabelprofile">create a profile</link>
and assign it to the template.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>After saving, your templates will appear on the 'Manage
Templates' page.</para>
<screenshot>
<screeninfo>List of label templates</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/labeltemplates.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="labelprofiles">
<title>Profiles</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Label
Creator > Profiles</para>
</listitem>
</itemizedlist>
<para>A profile is a set of "adjustments" applied to a given <link
linkend="addlabeltemplate">template</link> just prior to printing
which compensates for anomalies unique and peculiar to a given
printer (to which the profile is assigned). This means if you set a
template up and then print a sample set of data and find that the
items are not all aligned the same on each label, you need to set up
a profile for each printer to make up for the differences in
printing styles, such as the shifting of text to the left, right,
top or bottom.</para>
<para>If your labels are printing just the way you want, you will
not need a profile.</para>
<section id="addlabelprofile">
<title>Add a Profile</title>
<para>To add a new profile, you want to click on the 'Profiles'
button at the top of your page and choose 'New Profile'</para>
<screenshot>
<screeninfo>New Profile Button</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/newprofile.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Using the form that appears you can create a profile to fix
any problems with your template.</para>
<screenshot>
<screeninfo>Create a Printer Profile</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/newprofileform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>The Printer Name and Paper Bin do not have to match your
printer exactly, they are for your reference so you can
remember what printer you have set the profile for. So if you
want to use the Printer model number in printer name or you
can call it 'the printer on my desk'</para>
</listitem>
<listitem>
<para>Template will be filled in once you have chosen which
template to apply the profile to on the <link
linkend="addlabeltemplate">template edit form</link></para>
</listitem>
<listitem>
<para>The Units pull down is used to define what measurement
scale you're going to be using for your profile.</para>
<screenshot>
<screeninfo>Units of Measurement</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/patroncards/units.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Offset describes what happens when the entire image is
off center either vertically or horizontally and creep
describes a condition where the distance between the labels
changes across the page or up and down the page</para>
<itemizedlist>
<listitem>
<para>For these values, negative numbers move the error up
and to the left and positive numbers move the error down
and to the right</para>
</listitem>
<listitem>
<para>Example: the text is .25" from the left edge of the
first label, .28" from the left edge of the second label
and .31" from the left edge of the third label. This means
the horizontal creep should be set to .03" to make up for
this difference.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>After saving, your profiles will appear on the 'Manage
Profiles' page.</para>
<screenshot>
<screeninfo>List of Profiles</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/profiles.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you have saved your new profile, you can return to the
list of templates and choose to edit the template that this
profile is for.</para>
</section>
</section>
<section id="labellayouts">
<title>Layouts</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Label
Creator > Layouts</para>
</listitem>
</itemizedlist>
<para>A layout is used to define the fields you want to appear on
your labels.</para>
<section id="addlabellayout">
<title>Add a Layout</title>
<para>To add a new layout, you want to click on the 'Layouts'
button at the top of your page and choose 'New Layout'</para>
<screenshot>
<screeninfo>New Layout Button</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/newlayout.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Using the form that appears you can create a profile to fix
any problems with your template.</para>
<screenshot>
<screeninfo>Add New Layout</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/layoutform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>The name of your layout can be anything you'd like to
help you identify it later.</para>
</listitem>
<listitem>
<para>If this is a barcode label you'll want to choose the
encoding (Code 39 is the most common)</para>
</listitem>
<listitem>
<para>The layout type can be any combination of bibliographic
information and/or barcode. For example a spine label would
just be Biblio whereas a label for your circulation staff to
use to checkout the book would probably be
Biblio/Barcode.</para>
</listitem>
<listitem>
<para>The Bibliographic Data to Print includes any of the data
fields that may be mapped to your MARC frameworks. You can
choose from the preset list of fields or you can click on
'List Fields' and enter your own data. In 'List Fields', you
can specify MARC subfields as a 4-character tag-subfield
string: (ie. 254a for the title field), You can also enclose a
whitespace-separated list of fields to concatenate on one line
in double quotes. (ie. "099a 099b" or "itemcallnumber
barcode"). The fields available are from the database tables
list below. Finally you could add in static text strings in
single-quote (ie. 'Some static text here.')</para>
<itemizedlist>
<listitem>
<para>You can use the schema viewer (<ulink
url="http://schema.koha-community.org";>http://schema.koha-community.org</ulink>)
with the following tables to find field names to
use:</para>
<itemizedlist>
<listitem>
<para>Currently all fields in the following tables are
used: items, biblioitems, biblio, branches</para>
<screenshot>
<screeninfo>List fields</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/listlabelfields.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Choose if the label maker should print out the guilde
lines around each label</para>
</listitem>
<listitem>
<para>Choose if you'd like Koha to try to split your call
numbers (usually used on Spine Labels)</para>
</listitem>
<listitem>
<para>Finally choose your text settings such as alignment,
font type and size.</para>
</listitem>
</itemizedlist>
<para>After saving, your layouts will appear on the 'Manage
Layouts' page.</para>
</section>
</section>
<section id="labelbatches">
<title>Batches</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Label
Creator > Batches</para>
</listitem>
</itemizedlist>
<para>Batches are made up of the barcodes you would like to print.
Once in this tool you can search for the item records you would like
to print out labels for.</para>
<section id="addlabelbatch">
<title>Add a Batch</title>
<para>Batches can be created in one of two ways. The first is to
click the 'Create Label Batch' link on the '<link
linkend="managestaged">Staged MARC Management</link>' page:</para>
<screenshot>
<screeninfo>Create Label Batch Link on Staged Records
List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/labelfromstaged.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The other is to choose to create a new batch from the label
creator tool</para>
<screenshot>
<screeninfo>Create New Batch</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/newbatch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You will be brought to an empty batch with an 'Add item(s)'
button at the top of the page and a box to scan barcodes in
to.</para>
<screenshot>
<screeninfo>Add Items</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/addbatchitems.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can either scan barcodes in to the box provided and
click the 'Add item(s)' button or you can click the 'Add item(s)'
button with the barcodes box empty. Clicking 'Add item(s)' with
nothing in the barcodes box will open a search window for you to
find the items you want to add to the batch.</para>
<screenshot>
<screeninfo>Search for items for a Batch</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/searchforbatch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From the search results, click the check box next to the
items you want to add to the batch and click the 'Add checked'
button. You can also add items one by one by clicking the 'Add'
link to the left of each item.</para>
<screenshot>
<screeninfo>Batch search results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/batchsearchresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you have added all of the items click the 'Done'
button. The resulting page will list the items you have
selected.</para>
<screenshot>
<screeninfo>List of items in the batch</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/itemsinbarch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To print your labels, click the 'Export Batch' button. To
print only some of the labels, click the 'Export Item(s)' button.
Either way you will be presented with a confirmation screen where
you can choose your template and layout.</para>
<screenshot>
<screeninfo>Start batch export</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/exportbatch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You will then be presented with three download options: PDF,
Excel, and CSV.</para>
<screenshot>
<screeninfo>Batch save options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/labelcreator/savebatch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>After saving your file, simply print to the blank labels you
have in your library.</para>
</section>
</section>
</section>
<section id="quicklabelcreator">
<title>Quick Spine Label Creator</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Catalog
> Quick Spine Label Creator</para>
</listitem>
</itemizedlist>
<tip>
<para>This tool does not use the label layouts or templates, it
simply prints a spine label in the first spot on the label
sheet.</para>
<itemizedlist>
<listitem>
<para>Define the fields you want to print on the spine label in
the <link linkend="SpineLabelFormat">SpineLabelFormat</link>
system preference</para>
</listitem>
<listitem>
<para>Format your label printing by editing spinelabel.css found
in koha-tmpl/intranet-tmpl/prog/en/css/</para>
</listitem>
</itemizedlist>
</tip>
<para>To use this tool you simply need the barcode for the book you'd
like to print the spine label for.</para>
<screenshot>
<screeninfo>Quick Spine Label Creator</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/quickspinelable.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="stagemarc">
<title>Stage MARC Records for Import</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Catalog
> Stage MARC records for import</para>
</listitem>
</itemizedlist>
<para>Importing records into Koha includes two steps. The first is to
stage records for import.</para>
<itemizedlist>
<listitem>
<para>First find the MARC file on your computer</para>
<screenshot>
<screeninfo>Stage MARC Records for Import</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/marcimport/stagemarc-pt1.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Next you will be presented with options for record matching
and item imports</para>
<screenshot>
<screeninfo>Upload options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/marcimport/stagemarc-pt2.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Enter 'Comments about this file' to identify your upload
when going to the '<link linkend="managestaged">Manage Staged
MARC Records</link>' tool</para>
</listitem>
<listitem>
<para>Choose the character encoding</para>
</listitem>
<listitem>
<para>Choose whether or not you want to look for matching
records</para>
<itemizedlist>
<listitem>
<para>You can set up <link
linkend="recordmatchingrules">record matching rules</link>
through the administration area</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Next choose what to do with matching records if they are
found</para>
</listitem>
<listitem>
<para>Finally choose what to do with records that are
unique</para>
</listitem>
<listitem>
<para>Next you can choose whether or not to import the item
data found in the MARC records</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Click 'Stage for import'</para>
</listitem>
<listitem>
<para>You will be presented with a confirmation of your MARC
import</para>
<screenshot>
<screeninfo>MARC Import Confirmation</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/marcimport/stagemarc-results.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>To complete the process continue to the <link
linkend="managestaged">Managed Staged MARC Records
Tool</link></para>
</listitem>
</itemizedlist>
</section>
<section id="managestaged">
<title>Staged MARC Record Management</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Catalog
> Staged MARC Record Management</para>
</listitem>
</itemizedlist>
<para>Once you have <link linkend="stagemarc">staged</link> your
records for import you can complete the import using this tool.</para>
<screenshot>
<screeninfo>List of Staged MARC Records</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/marcimport/managestaged.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>From the list of staged records, click on the file name that
you want to finish importing</para>
<itemizedlist>
<listitem>
<para>You will note that records that have already been
imported will say so under 'Status'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>A summary of your import will appear along with the option
to change your matching rules</para>
<screenshot>
<screeninfo>Manage Staged Records Batch</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/marcimport/managestagedrecords.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Below the summary is the option to import the batch of bib
records using a specific framework</para>
<screenshot>
<screeninfo>Choose Framework to Import Into</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/marcimport/importframework.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Choosing a framework other than 'Default' isn't
necessary, but it's helpful for running reports and having the
right bib level item type selected on import.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Below the framework selection there will be a list of the
records that will be imported</para>
<screenshot>
<screeninfo>List of Staged Records</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/marcimport/stagedrecords.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Review your summary before completing your import to
make sure that your matching rule worked and that the records
appear as you expect them to</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Click 'Import into catalog' to complete the import</para>
<screenshot>
<screeninfo>Import summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/marcimport/importedrecords.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Once your import is complete a link to the new bib records
will appear to the right of each title that was imported</para>
</listitem>
<listitem>
<para>You can also undo your import by clicking the 'Undo import
into catalog' button</para>
</listitem>
</itemizedlist>
<para>Records imported using this tool remain in the 'reservoir' until
they are cleaned. These items will appear when searching the catalog
from the <link linkend="cataloging">Cataloging</link> tool:</para>
<screenshot>
<screeninfo>Reservoir Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/marcimport/reservoirresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To clean items out of the 'reservoir':</para>
<itemizedlist>
<listitem>
<para>Visit the main screen of the Manage Staged MARC Records
tool</para>
<screenshot>
<screeninfo>List of Staged MARC Records</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/marcimport/managestaged.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>To clean a batch, click the 'Clean' button to the
right</para>
</listitem>
<listitem>
<para>You will be presented with a confirmation message</para>
<screenshot>
<screeninfo>Clean MARC Records Confirmation</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/marcimport/cleanbatch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Accept the deletion and the records will be removed from
the reservoir and the status will be changed to
'cleaned'</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="uploadlocalimages">
<title>Upload Local Cover Image</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools > Catalog
> Upload Local Cover Image</para>
</listitem>
</itemizedlist>
<para>This tool will allow you to upload cover images for the
materials in your catalog. To access this tool, staff will need the
<link linkend="toolspermissions">upload_local_cover_images
permission</link>. In order for images to show in the staff client
and/or OPAC you will need to set your <link
linkend="LocalCoverImages">LocalCoverImages</link> and/or <link
linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> preferences
to 'Display.' Images can be uploaded in batches or one by one.</para>
<para>If uploading a single image:</para>
<itemizedlist>
<listitem>
<para>Visit the tool and click the 'Browse' button to browse to
the image on your local machine.</para>
<screenshot>
<screeninfo>Upload single cover image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/uploadlocalimg/uploadsingle.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Click 'Upload file'</para>
</listitem>
<listitem>
<para>Choose 'Image file' under the 'File type' section</para>
</listitem>
<listitem>
<para>Enter the biblionumber for the record you're attaching this
image to. This is not the same as the barcode, this is the system
generated number assigned by Koha.</para>
<itemizedlist>
<listitem>
<para>Find the biblionumber by looking at the end of the URL
in the address bar when on the detail page</para>
<screenshot>
<screeninfo>Biblionumber in URL</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/uploadlocalimg/bibnumurl.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>or by clicking on the MARC tab on the detail page in the
staff client</para>
<screenshot>
<screeninfo>Biblionumber on MARC Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/uploadlocalimg/bibnummarc.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If you would like to replace any other cover images you may
have uploaded in the past, check the 'Replace existing covers' box
under the 'Options' section</para>
</listitem>
<listitem>
<para>Click 'Process images'</para>
</listitem>
<listitem>
<para>You will be presented with a summary of the upload and a
link to the record you have just added the image to</para>
</listitem>
</itemizedlist>
<para>If uploading a batch of images at once you will need to prepare
a ZIP file first.</para>
<itemizedlist>
<listitem>
<para>Enter in to the ZIP file all the images you are
uploading</para>
</listitem>
<listitem>
<para>Also include a text file (*.TXT) named either datalink.txt
or idlink.txt listing the biblionumber followed by the image name
for each image one per line</para>
<itemizedlist>
<listitem>
<para>ex. 4091,image4091.jpg</para>
<screenshot>
<screeninfo>ZIP File Contents</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/uploadlocalimg/zipfiles.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Browse your local computer to the ZIP file</para>
</listitem>
<listitem>
<para>Click 'Upload file'</para>
</listitem>
<listitem>
<para>Choose 'Zip file' under the 'File type' section</para>
</listitem>
<listitem>
<para>If you would like to replace any other cover images you may
have uploaded in the past, check the 'Replace existing covers' box
under the 'Options' section</para>
</listitem>
<listitem>
<para>Click 'Process images'</para>
</listitem>
<listitem>
<para>You will be presented with a summary of the upload</para>
<screenshot>
<screeninfo>Upload Summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/uploadlocalimg/uploadsummary.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<para>You will be able to see your cover images in the staff client on
the detail page under the 'Image' tab in the holdings table at the
bottom</para>
<screenshot>
<screeninfo>Cover images in the staff client</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>In the OPAC the cover images will also appear in the images tab,
as well as next to the title and on the search results.</para>
</section>
</section>
<section id="additionaltools">
<title>Additional Tools</title>
<para/>
<section id="calholidays">
<title>Calendar</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools >
Additional Tools > Calendar</para>
</listitem>
</itemizedlist>
<para>Libraries can define library closings and holidays to be used
when calculating due dates. You can make use of the Calendar by
turning on the proper system preferences:</para>
<itemizedlist>
<listitem>
<para><emphasis>Get there: </emphasis>More > Administration
> Global System Preferences > Circulation > <link
linkend="useDaysMode">useDaysMode</link></para>
<itemizedlist>
<listitem>
<para>Choose the method for calculating due date - either
include days the library is closed in the calculation or don't
include them.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><emphasis>Get there:</emphasis> More > Administration
> Global System Preferences > Circulation > <link
linkend="finesCalendar">finescalendar</link></para>
<itemizedlist>
<listitem>
<para>This will check the holiday calendar before charging
fines</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>Calendar & Holidays Tools</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/calendar/calendar.png"/>
</imageobject>
</mediaobject>
</screenshot>
<section id="addevents">
<title>Adding Events</title>
<para>Before adding events, choose the library you would like to
apply the closings to. When adding events you will be asked if you
would like to apply the event to one branch or all branches. To add
events, simply</para>
<itemizedlist>
<listitem>
<para>Click on the date on the calendar that you would like to
apply the closing to</para>
<screenshot>
<screeninfo>Calendar Add Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/calendar/calendaradd.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>In the form that appears above the calendar, enter the
closing information (for more info on each option click the
question mark [?] to the right of the option)</para>
<itemizedlist>
<listitem>
<para>Library will be filled in automatically based on the
library you chose from the pull down at the top of the
page</para>
</listitem>
<listitem>
<para>The day information will also be filled in
automatically based on the date you clicked on the
calendar</para>
</listitem>
<listitem>
<para>In the description enter the reason the library is
closed</para>
</listitem>
<listitem>
<para>Next you can choose if this event is a one time event
or if it is repeatable.</para>
<itemizedlist>
<listitem>
<para>If this is a one day holiday choose 'Holiday only
on this day'</para>
</listitem>
<listitem>
<para>If this is a weekly closing (like a weekend day)
then you can choose 'Holiday repeated every same day of
the week'</para>
</listitem>
<listitem>
<para>If this is an annual holiday closing choose
'Holiday repeated yearly on the same date'</para>
</listitem>
<listitem>
<para>If the library is going to be closed for the week
or a range of time choose 'Holiday on a range' and enter
a 'To Date' at the top</para>
</listitem>
<listitem>
<para>If the library is going to be closed for a range
of time each year (such as summer holidays for schools)
choose 'Holiday repeated yearly on a range' and enter a
'To Date' at the top</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Finally decide if this event should be applied to all
libraries or just the one you have originally
selected</para>
<itemizedlist>
<listitem>
<para>If you'd rather enter all the holidays and then
copy them all to another branch all at once you can use
the copy menu below the calendar</para>
<screenshot>
<screeninfo>Copy holidays</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/calendar/copyholidays.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>After saving you will see the event listed in the summary
to the right the calendar</para>
<screenshot>
<screeninfo>Calendar Summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/calendar/calendarsummary.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="editevents">
<title>Editing Events</title>
<para>To edit events</para>
<itemizedlist>
<listitem>
<para>Click on the event on the calendar that you want to change
(do this by clicking on the date on the calendar, not the event
listed in the summary)</para>
<screenshot>
<screeninfo>Edit holiday form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/calendar/calendaredit.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>From this form you can make edits to the holiday or delete
the holiday completely. Both actions require that you click
'Save' before the change will be made.</para>
</listitem>
<listitem>
<para>Clicking on repeatable events will offer slightly
different options</para>
<screenshot>
<screeninfo>Edit repeatable event</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/calendar/calendarexception.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>In the form above you will note that there is now an
option to 'Generate an exception for this repeated holiday,'
choosing this option will allow you to make it so that this
date is not closed even though the library is usually closed
on this date.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="calendarhelp">
<title>Additional Help</title>
<para>When adding or editing events you can get additional help by
clicking on the question mark next to various different options on
the form</para>
<screenshot>
<screeninfo>Additional Calendar Help Buttons</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/calendar/calendarhelp.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="csvprofiles">
<title>CSV Profiles</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools >
Additional Tools > CSV Profiles</para>
</listitem>
</itemizedlist>
<para>CSV Profiles are created to define how you would like your cart
or list to export.</para>
<section id="addcsvprofile">
<title>Add CSV Profiles</title>
<para>To add a CSV Profile</para>
<itemizedlist>
<listitem>
<para>Click 'CSV Profiles' from the Tools menu</para>
<screenshot>
<screeninfo>Add CSV Profile</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/csvprofiles/addcsv.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>The 'Profile name' will appear on the export pull down
list when choosing 'Download' from your cart or list</para>
</listitem>
<listitem>
<para>The 'Profile description' is for your own
benefit</para>
</listitem>
<listitem>
<para>The 'CSV separator' is the character used to separate
values and value groups</para>
</listitem>
<listitem>
<para>The 'Field separator' is the character used to
separate duplicate fields</para>
<itemizedlist>
<listitem>
<para>Example: You may have multiple 650 fields</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>The 'Subfield separator' is the character used to
separate duplicate subfields</para>
<itemizedlist>
<listitem>
<para>Example: You may have multiple $a subfields in a
field</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>The 'Encoding' field lets you define the encoding used
when saving the file</para>
</listitem>
<listitem>
<para>Finally format your CSV file using the 'Profile
marcfields' fields</para>
<itemizedlist>
<listitem>
<para>Define which fields or subfields you want to
export, separated by pipes. Example :
200|210$a|301</para>
</listitem>
<listitem>
<tip>
<para>You can also use your own headers (instead of
the ones from Koha) by prefixing the field number with
an header, followed by the equal sign. Example :
Personal name=200|Entry element=210$a|300|009</para>
</tip>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="editcsvprofile">
<title>Modify CSV Profiles</title>
<para>Once you have created at least one CSV Profile an 'Edit
profile' tab will appear next to the 'New profile' button.</para>
<screenshot>
<screeninfo>Modify CSV Profiles</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/csvprofiles/modifycsv.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Choose the profile you would like to edit and alter the
necessary fields.</para>
</listitem>
<listitem>
<para>To delete a profile, check the 'Delete selected profile'
option before clicking 'Submit Query'</para>
<screenshot>
<screeninfo>Delete an existing CSV Profile</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/csvprofiles/deletecsv.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="usecsvprofiles">
<title>Using CSV Profiles</title>
<para>Your CSV Profiles will appear on the export list or cart menu
under the 'Download' button</para>
<screenshot>
<screeninfo>CSV Profiles on Download Menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/csvprofiles/exportlist.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="logviewer">
<title>Log Viewer</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools >
Additional Tools > Log Viewer</para>
</listitem>
</itemizedlist>
<para>Actions within the Koha system are tracked in log files. Your
<link linkend="logs">system preferences</link> can be changed to
prevent the logging of different actions. These logs can be viewed
using the Log Viewer Tool.</para>
<screenshot>
<screeninfo>Log Viewer</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/logs/logviewer.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Choosing different combinations of menu options will produce the
log file for that query.</para>
<screenshot>
<screeninfo>A query for all logs related to the Circulation module
produces a result like this</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/logs/logresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You will note that real names do not appear on the log, only
identifying numbers. You need to use the identifying numbers when
searching the logs as well.</para>
</section>
<section id="newstool">
<title>News</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools >
Additional Tools > News</para>
</listitem>
</itemizedlist>
<para>Koha's news module allows librarians to post news to the OPAC,
staff interface and circulation receipts.</para>
<screenshot>
<screeninfo>Koha News Module</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/news/news.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To add news to either the OPAC, the Staff Client or a
Circulation receipt:</para>
<itemizedlist>
<listitem>
<para>Click 'New Entry'</para>
<screenshot>
<screeninfo>Add Koha News Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/news/addnews.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Under 'Display Location' choose whether to put the news
on the OPAC, Slip (circulation receipt) or the Librarian
(Staff) Interface.</para>
</listitem>
<listitem>
<para>Choose a title for your entry</para>
</listitem>
<listitem>
<para>Using the publication and expiration date fields you can
control how long your item appears</para>
</listitem>
<listitem>
<para>'Appear in position' lets you decide what order your
news items appear in</para>
</listitem>
<listitem>
<para>The 'News' box allows for the use of HTML for formatting
of your news item</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>After filling in all of the fields, click 'Submit'</para>
</listitem>
<listitem>
<para>News in the OPAC will appear above the <link
linkend="OpacMainUserBlock">OpacMainUserBlock</link></para>
<screenshot>
<screeninfo>News in the OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/news/opacnews.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>News in the Staff Client will appear on the far left of the
screen</para>
<screenshot>
<screeninfo>News in the Staff Client</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/news/librariannews.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>News on the circulation receipts will appear below the items
that are checked out</para>
<screenshot>
<screeninfo>News at the bottom of the circulation
receipt</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/news/slipnews.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="taskscheduler">
<title>Task Scheduler</title>
<itemizedlist>
<listitem>
<para><emphasis>Get there:</emphasis> More > Tools >
Additional Tools > Task Scheduler</para>
</listitem>
</itemizedlist>
<para>The task scheduler is a way to schedule reports to run whenever
you want.</para>
<para>To schedule a task, visit the Task Scheduler and fill in the
form</para>
<screenshot>
<screeninfo>Task Scheduler</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/tasksched/taskscheduler.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Current Server Time shows the time on your server (schedule
all of your reports to run based on that time - not on your local
time)</para>
</listitem>
<listitem>
<para>Time should be entered as hh:mm (2 digit hour, 2 digit
minute)</para>
</listitem>
<listitem>
<para>Date should be entered using the calendar pop up</para>
</listitem>
<listitem>
<para>From Report choose the report you want to schedule</para>
</listitem>
<listitem>
<para>Choose whether to receive the text of or a link to the
results</para>
</listitem>
<listitem>
<para>In the Email filed enter the email of the person you want to
receive your report</para>
</listitem>
</itemizedlist>
<para>Below the task scheduler form, there is a list of scheduled
reports</para>
<screenshot>
<screeninfo>Scheduled Tasks</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/tasksched/scheduledreports.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also schedule reports directly from the list of saved
reports by clicking the 'Schedule' link</para>
<screenshot>
<screeninfo>Saved Reports List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/tools/tasksched/savedreports.png"/>
</imageobject>
</mediaobject>
</screenshot>
<section id="taskscedtroubleshoot">
<title>Troubleshooting</title>
<para>Task scheduler will not work if the user the web server runs
as doesn't have the permission to use it. To find out if the right
user has the permissions necessary, check /etc/at.allow to see what
users are in it. If you don't have that file, check etc/at.deny. If
at.deny exists but is blank, then every user can use it. Talk to
your system admin about adding the user to the right place to make
the task scheduler work.</para>
</section>
</section>
</section>
</chapter>
<chapter id="patrons">
<title>Patrons</title>
<para>Before importing and/or adding patrons be sure to set up your <link
linkend="patcats">patron categories</link>.</para>
<section id="addnewpatron">
<title>Add a new patron</title>
<para>Patrons are added by going to the 'Patrons' module.</para>
<itemizedlist>
<listitem>
<para>Click 'New'</para>
<screenshot>
<screeninfo>Choose patron type</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/newpatron.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>The fields that appear on the patron add form can be
controlled by editing the <link
linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> system
preference.</para>
</listitem>
<listitem>
<para>First enter the identifying information regarding your
patron</para>
<screenshot>
<screeninfo>Add Patron Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/addpatronform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Required fields are defined in the <link
linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
system preference</para>
</listitem>
<listitem>
<para>Salutation is populated by the <link
linkend="BorrowersTitles">BorrowersTitles</link> system
preference</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Next enter the contact information</para>
<screenshot>
<screeninfo>Patron Contact Information</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/addcontact.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>For contact information, note that the primary phone and
email addresses are the ones that appear on notices and slips
printed during circulation (reciepts, transfer slips and hold
slips). The primary email is also the one that overdue notices
and other messages go to.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If this patron is a child, you will be asked to attach the
child patron to an adult patron</para>
<screenshot>
<screeninfo>Guarantor Linking</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/addGuarantor.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Click 'Set to Patron' to search your system for an
existing patron</para>
</listitem>
<listitem>
<para>If the Guarantor is not in the system, you can enter the
first and last name in the fields available</para>
</listitem>
<listitem>
<para>The relationships are set using the <link
linkend="borrowerRelationship">borrowerRelationship</link>
system preference</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If this patron is a professional, you will be asked to attach
the patron to an organizational patron</para>
<screenshot>
<screeninfo>Organization Linking</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/addOrg.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Click 'Set to Patron to search your system for an existing
patron</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Each patron can have an alternate contact</para>
<screenshot>
<screeninfo>Alternate Contact</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/addaltcontact.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>An alternate contact could be a parent or guardian. It can
also be used in academic settings to store the patron's home
address.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>The library management section includes values that are used
within the library</para>
<screenshot>
<screeninfo>Library Management</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/addlibmanagement.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>The card number field is automatically calculated if you
have the <link linkend="autoMemberNum">autoMemberNum</link>
system preference set that way</para>
<itemizedlist>
<listitem>
<note>
<para>For a newly installed system this preference will
start at 1 and increment by 1 each time after. To have it
start with the starting number of your barcodes, enter the
first barcode by hand in the patron record and save the
patron. After that the field will increment that number by
1.</para>
</note>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If you accidentally chose the wrong patron category at the
beginning you can fix that here</para>
</listitem>
<listitem>
<para>Sort 1 and 2 are used for statistical purposes within your
library</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Next, the Library Setup section includes additional library
settings</para>
<screenshot>
<screeninfo>Library set-up options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/addlibsetup.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>The registration date will automatically be filled in with
today's date</para>
</listitem>
<listitem>
<para>If your patron cards expire (based on your <link
linkend="patcats">patron category settings</link>) the Expiry
date will automatically be calculated</para>
</listitem>
<listitem>
<para>The OPAC Note is a note for the patron - it will appear in
the OPAC on the patron's record</para>
</listitem>
<listitem>
<para>The Circulation Note is meant solely for your library
staff and will appear when the circulation staff goes to check
an item out to the patron</para>
<screenshot>
<screeninfo>Sample Circulation Note</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/circnote.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>The Staff/OPAC asks for the username and password to be
used by the patron (and/or staff member) to log into their
account in the OPAC and for staff to log in to the staff
client.</para>
<itemizedlist>
<listitem>
<para>Staff will only be able to use this log in info to log
in to the staff client if they have the <link
linkend="patronpermissions">necessary
permissions</link>.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If you have set <link
linkend="patronattributetypes">additional patron attributes</link>
up, these will appear next</para>
<screenshot>
<screeninfo>Additional Patron Attributes</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/addattributes.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para id="setpatronmessaging">Finally, if you have <link
linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
set to 'allow,' you can choose the messaging preferences for this
patron.</para>
<screenshot>
<screeninfo>Patron Messaging Settings</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/addpatronmsg.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<important>
<para>These preferences will override any you set via the
<link linkend="addingpatroncat">patron
categories</link></para>
</important>
</listitem>
<listitem>
<important>
<para>These preference can be altered by the patron via the
OPAC</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Once finished, click 'Save'</para>
</listitem>
</itemizedlist>
<para>If the system suspects this patron is a duplicate of another it
will warn you.</para>
<screenshot>
<screeninfo>Patron Duplicate Suspected</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/duplicatewarn.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="addstaffpatron">
<title>Add a Staff Patron</title>
<para>All staff members must be entered into Koha as patrons of the
'Staff' type. Follow the steps in <link linkend="addnewpatron">Add a
Patron</link> to add a staff member. To give the staff member
permissions to access the staff client, follow the steps in <link
linkend="patronpermissions">Patron Permissions</link></para>
<important>
<para>Remember to assign your staff secure usernames and passwords
since these will be used to log into the staff client.</para>
</important>
</section>
<section id="addstatspatron">
<title>Add a Statistical Patron</title>
<para>To track in house use of items you will need a patron of the
Statistical type. First you will need a <link linkend="patcats">patron
category</link> set up for your Statistical patron.</para>
<screenshot>
<screeninfo>In House Patron Category</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/statspatcat.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Next, you will need to create a new patron of the statistical
type</para>
<screenshot>
<screeninfo>New In House Patron</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/newinhouse.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Next, follow the steps put forth in the '<link
linkend="addnewpatron">Add a new Patron</link>' section of this manual.
Since this patron is not a real person, simply fill in the required
fields, the correct library and nothing else.</para>
</section>
<section id="duplicatepatron">
<title>Duplicate a Patron</title>
<para>Sometimes when you're adding a new family to your system you don't
want to type the contact information over and over. Koha allows for you
to duplicate a patron and change only the parts you want to (or need to)
change.</para>
<itemizedlist>
<listitem>
<para>Open the patron you want to use as your base (the patron you
want to duplicate information from)</para>
</listitem>
<listitem>
<para>Click the 'Duplicate' button at the top of their record</para>
<screenshot>
<screeninfo>The Duplicate Button is the 3rd one in</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/duplicatepatron.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>All of the fields with the exception of first name, card
number, username and password have been duplicated. Fill in the
missing pieces and click 'Save'</para>
<screenshot>
<screeninfo>Duplicating Patron Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/duplicatedpatron.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<tip>
<para>Clicking in a field that is already populated with data
will clear that field of all information (making it easier for
you to type in something different)</para>
</tip>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>You will be brought to your new patron</para>
<screenshot>
<screeninfo>Newly created patron</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/duplicatedpatronfinal.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="editpatrons">
<title>Editing Patrons</title>
<para>Patrons in Koha can be edited using one of many edit
buttons.</para>
<itemizedlist>
<listitem>
<para>To edit the entire patron record simply click the 'Edit'
button at the top of the patron record.</para>
<screenshot>
<screeninfo>Main Patron Edit Menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/patronedit.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Patron passwords are not recoverable. The stars show on the
patron detail next to the Password label are always there even if a
password isn't set. If a patron forgets their password the only
option is to reset their password. To change the patron's password,
click the 'Change Password' button</para>
<screenshot>
<screeninfo>Patron Password Change Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/patronpassword.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Koha cannot display existing passwords. Leave the field
blank to leave password unchanged.</para>
</listitem>
<listitem>
<para>This form can automatically generate a random password if
you click the link labeled "Click to fill with a randomly
generated suggestion. Passwords will be displayed as
text."</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>To edit a specific section of the patron record (for example
the Library Use section) click the 'Edit' link below the
section</para>
<screenshot>
<screeninfo>Library Use Section of Patron Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/patroneditsection.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>A patron image can be added by browsing for the image on your
machine from the 'Manage Patron Image' section</para>
<screenshot>
<screeninfo>Manage Patron Image Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/patronaddimage.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>This form will not appear if you have the <link
linkend="patronimages">patronimages</link> system preference to
not allow patron images</para>
</listitem>
<listitem>
<para>To add patron images in bulk, use the <link
linkend="uploadpatronimages">Upload Patron Images</link>
Tool</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para id="patronflags">Patrons can also be blocked from checking
items out by setting Patron Flags</para>
<screenshot>
<screeninfo>Patron Warning Flags</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/patronflags.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>If you would like your circulation staff to confirm a
patron's address before checking items out to the patron, you
can see the 'Gone no Address' flag</para>
<screenshot>
<screeninfo>Patron's address in doubt</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/patronaddress.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>If you would like to bar a patron from the library you can
set the 'Restricted' flag</para>
<itemizedlist>
<listitem>
<para>This flag can automatically be set with the <link
linkend="noticetriggers">Overdue/Notice Status
Triggers</link></para>
<screenshot>
<screeninfo>Patron restricted</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/patronrestricted.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If you enter in a date and/or note related to the
restriction you will see that in the restricted message as
well</para>
<screenshot>
<screeninfo>Restricted until message</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/restricteduntil.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>If the patron reports that they have lost their card you
can set the 'Lost Card' flag to prevent someone else from using
that card to check items out</para>
<screenshot>
<screeninfo>Patron lost card</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/patroncardlost.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Children patrons do not become adults automatically in Koha.
To upgrade a child patron to and adult patron category click on the
'More' menu and choose 'Update Child to Adult Patron'</para>
<screenshot>
<screeninfo>Update Child to Adult Patron</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/updatetoadult.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>You will then be presented with a pop up window asking
which one of your adult patron categories this Child should be
updated to</para>
<screenshot>
<screeninfo>Choose Adult Category to Update To</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/choosadulttype.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="patronpermissions">
<title>Patron Permissions</title>
<para>Patron Permissions are used to allow staff members access to the
staff client.</para>
<important>
<para>In order for a staff member to log into the staff interface they
must have (at the very least) 'catalogue' permissions which allow them
to view the staff interface.</para>
</important>
<section id="setpatronperms">
<title>Setting Patron Permissions</title>
<para>To set patron permissions, you must first <link
linkend="addstaffpatron">have a patron of the 'Staff' type</link>
open</para>
<itemizedlist>
<listitem>
<para>On the patron record click More and choose Set Permissions
to alter patron permissions</para>
<screenshot>
<screeninfo>Set Patron Permissions</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/editpatronpermissions.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>You will be presented with a list of preferences, some of
which can be expanded by clicking the plus sign to the left of the
section title.</para>
<screenshot>
<screeninfo>Patron Permissions</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/GranularPermissions.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="patronpermsdefined">
<title>Patron Permissions Defined</title>
<para/>
<itemizedlist>
<listitem>
<para>superlibrarian</para>
<itemizedlist>
<listitem>
<para>Access to all functions within the staff client</para>
<itemizedlist>
<listitem>
<tip>
<para>With this selected there is no need to choose any
other permissions</para>
</tip>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>circulate</para>
<itemizedlist>
<listitem>
<para>Ability to check (issue) books out and in and access the
'Circulation' page in the staff client</para>
</listitem>
<listitem>
<para>This section can be expanded (<link
linkend="circpermissions">Learn more</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>catalogue</para>
<itemizedlist>
<listitem>
<para>Allows staff members to search the catalog via the staff
client</para>
</listitem>
<listitem>
<para>Must be given to all staff members to allow them to
login to the staff client</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>parameters</para>
<itemizedlist>
<listitem>
<para>Provides access to all areas of the Administration
menu</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>borrowers</para>
<itemizedlist>
<listitem>
<para>Allows staff members to add or modify patrons (with the
exception of setting permissions)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>permissions</para>
<itemizedlist>
<listitem>
<para>Ability to set patron permissions</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>reserveforothers</para>
<itemizedlist>
<listitem>
<para>Ability to place holds on books for patrons via the
staff interface</para>
</listitem>
<listitem>
<para>This section can be expanded (<link
linkend="reservepermissions">Learn more</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>borrow</para>
<itemizedlist>
<listitem>
<para>Grants staff members the rights to borrow books from the
library</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>editcatalogue</para>
<itemizedlist>
<listitem>
<para>Ability to catalog items (add and edit bibliographic and
holdings data)</para>
</listitem>
<listitem>
<para>This section can be expanded (<link
linkend="catpermissions">Learn more</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>updatecharges</para>
<itemizedlist>
<listitem>
<para>Manage patron accounts (including paying fines, adding
credits, and creating invoices)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>acquisition</para>
<itemizedlist>
<listitem>
<para>Provides access to the acquisitions and patron purchase
suggestion modules</para>
</listitem>
<listitem>
<para>This section can be expanded (<link
linkend="acqpermissions">Learn more</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>management</para>
<itemizedlist>
<listitem>
<para>No longer in use</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>tools</para>
<itemizedlist>
<listitem>
<para>Access to all items in the Tools section of the staff
client</para>
</listitem>
<listitem>
<para>This section can be expanded (<link
linkend="toolspermissions">Learn more</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>editauthorities</para>
<itemizedlist>
<listitem>
<para>Provides access to edit the authority record</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>serials</para>
<itemizedlist>
<listitem>
<para>Allows access to the serials module</para>
</listitem>
<listitem>
<para>This section can be expanded (<link
linkend="serpermissions">Learn more</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>reports</para>
<itemizedlist>
<listitem>
<para>Allow access to the Reports module (ability to create,
edit and run all reports)</para>
</listitem>
<listitem>
<para>Reports found on the Circulation page are not controlled
by this permission</para>
</listitem>
<listitem>
<para>This section can be expanded (<link
linkend="reportpermissions">Learn more</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>staffaccess</para>
<itemizedlist>
<listitem>
<para>Provides the ability to modify login / permissions for
staff users</para>
</listitem>
<listitem>
<important>
<para>Requires the borrowers permission above</para>
</important>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<section id="circpermissions">
<title>Granular Circulate Permissions</title>
<para>If the staff member has 'circulate' permissions they have the
ability to perform all of these actions. If you would like to
control circulation permissions on a more granular level choose from
these options:</para>
<itemizedlist>
<listitem>
<para>circulate_remaining_permissions</para>
<itemizedlist>
<listitem>
<para>All circulation rights except the ability to override
renewals</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>override_renewals</para>
<itemizedlist>
<listitem>
<para>Override blocked renewals</para>
</listitem>
<listitem>
<para>Requires that the staff member also has
circulate_remaining_permissions</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="reservepermissions">
<title>Granular Holds Permissions</title>
<para>If the staff member has 'reserveforothers' permissions they
have the ability to perform all of these actions. If you would like
to control holds permissions on a more granular level choose from
these options:</para>
<itemizedlist>
<listitem>
<para>modify_holds_priority</para>
<itemizedlist>
<listitem>
<para>Allow staff members to alter the holds priority
(moving patrons up and down the queue)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>place_holds</para>
<itemizedlist>
<listitem>
<para>Allows staff members to place holds for patrons via
the staff interface</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="catpermissions">
<title>Granular Cataloging Permissions</title>
<para>If the staff member has 'editcatalogue' permissions they have
the ability to perform all of these actions. If you would like to
control cataloging permissions on a more granular level choose from
these options:</para>
<itemizedlist>
<listitem>
<para>edit_catalogue</para>
<itemizedlist>
<listitem>
<para>Ability to access all cataloging functions via the
<link linkend="cataloging">Cataloging</link> page</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>edit_items</para>
<itemizedlist>
<listitem>
<para>Ability to make <link linkend="editingitems">edits to
item records</link>, but not bib records</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para id="fastaddpermissions">fast_cataloging</para>
<itemizedlist>
<listitem>
<para>The ability to catalog using only the <link
linkend="fastaddcat">Fast Add Framework</link> found on the
<link linkend="circulation">Circulation</link> page</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="acqpermissions">
<title>Granular Acquisitions Permissions</title>
<para>If the staff member has 'acquisition' permissions they have
the ability to perform all of these actions. If you would like to
control acquisitions permissions on a more granular level choose
from these options:</para>
<itemizedlist>
<listitem>
<para>budget_add_del</para>
<itemizedlist>
<listitem>
<para>Ability to add and delete budgets (not modify)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>budget_manage</para>
<itemizedlist>
<listitem>
<para>Manage budgets</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>budget_modify</para>
<itemizedlist>
<listitem>
<para>Ability to edit existing budgets (not to add or
delete)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>contracts_manage</para>
<itemizedlist>
<listitem>
<para>Manage contracts</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>group_manage</para>
<itemizedlist>
<listitem>
<para>Manage orders and basket groups</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>order_manage</para>
<itemizedlist>
<listitem>
<para>Manage orders and baskets</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>order_receive</para>
<itemizedlist>
<listitem>
<para>Manage orders and baskets</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>period_manage</para>
<itemizedlist>
<listitem>
<para>Manage periods</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>planning_manage</para>
<itemizedlist>
<listitem>
<para>Manage budget planning</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>vendors_manage</para>
<itemizedlist>
<listitem>
<para>Manage vendors</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="serpermissions">
<title>Granular Serials Permissions</title>
<para>If the staff member has 'serials' permissions they have the
ability to perform all of these actions. If you would like to
control serials permissions on a more granular level choose from
these options:</para>
<itemizedlist>
<listitem>
<para>check_expiration</para>
<itemizedlist>
<listitem>
<para>Check the expiration of a serial</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>claim_serials</para>
<itemizedlist>
<listitem>
<para>Claim missing serials</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>create_subscription</para>
<itemizedlist>
<listitem>
<para>Create a new subscription</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>delete_subscription</para>
<itemizedlist>
<listitem>
<para>Delete an existing subscription</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>edit_subscription</para>
<itemizedlist>
<listitem>
<para>Edit (but not delete or create) an existing
subscription</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>receive_serials</para>
<itemizedlist>
<listitem>
<para>Receive serials on existing subscriptions</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>renew_subscription</para>
<itemizedlist>
<listitem>
<para>Renew an existing subscription</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>routing</para>
<itemizedlist>
<listitem>
<para>Manage routing lists</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="toolspermissions">
<title>Granular Tools Permissions</title>
<para>If the staff member has 'tools' permissions they have the
ability to access and use all items under the Tools menu. If you
would like to control which tools staff members have access to on a
more granular level choose from these options:</para>
<itemizedlist>
<listitem>
<para>batch_upload_patron_images</para>
<itemizedlist>
<listitem>
<para>Upload patron images in batch or one at a time (Access
to the <link linkend="uploadpatronimages">Image Upload
Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>delete_anonymize_patrons</para>
<itemizedlist>
<listitem>
<para>Delete old borrowers and anonymize circulation/reading
history (Access to the <link linkend="anonpatrons">Anonymize
Patron Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>edit_calendar</para>
<itemizedlist>
<listitem>
<para>Define days when the library is closed (Access to the
<link linkend="calholidays">Calendar/Holidays
Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>edit_news</para>
<itemizedlist>
<listitem>
<para>Write news for the OPAC and staff interfaces (Access
to the <link linkend="newstool">News Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>edit_notice_status_triggers</para>
<itemizedlist>
<listitem>
<para>Set notice/status triggers for overdue items (Access
to the <link linkend="noticetriggers">Overdue Notice
Status/Triggers Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>edit_notices</para>
<itemizedlist>
<listitem>
<para>Define notices (Access to the <link
linkend="notices">Notices Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>export_catalog</para>
<itemizedlist>
<listitem>
<para>Export bibliographic and holdings data (Access to the
<link linkend="exportbibs">Export Bibliographic &
Holdings Data Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>import_patrons</para>
<itemizedlist>
<listitem>
<para>Import patron data (Access to the <link
linkend="patronimport">Import Patrons Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>inventory</para>
<itemizedlist>
<listitem>
<para>Perform inventory (stocktaking) of your catalog
(Access to the <link linkend="inventory">Inventory
Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>items_batchdel</para>
<itemizedlist>
<listitem>
<para>Perform batch deletion of items (Access to the <link
linkend="batchdeleteitems">Delete a queryset of items
Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>items_batchmod</para>
<itemizedlist>
<listitem>
<para>Perform batch modification of items (Access to the
<link linkend="batchmodifyitems">Modify a queryset of items
Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>label_creator</para>
<itemizedlist>
<listitem>
<para>Create printable labels and barcodes from catalog and
patron data (Access to the <link
linkend="labelcreator">Label Creator</link> and <link
linkend="quicklabelcreator">Quick Label Creator</link>
Tools)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>manage_csv_profiles</para>
<itemizedlist>
<listitem>
<para>Create and edit CSV profiles (Access to the <link
linkend="csvprofiles">CSV Profiles Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>manage_staged_marc</para>
<itemizedlist>
<listitem>
<para>Managed staged MARC records, including completing and
reversing imports (Access to the <link
linkend="managestaged">Manage Staged MARC Records
Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>moderate_comments</para>
<itemizedlist>
<listitem>
<para>Moderate patron comments (Access to the <link
linkend="comments">Comments</link> and <link
linkend="tagsmoderation">Tags</link> Tools)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>schedule_tasks</para>
<itemizedlist>
<listitem>
<para>Schedule tasks to run (Access to the <link
linkend="taskscheduler">Task Scheduler Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>stage_marc_import</para>
<itemizedlist>
<listitem>
<para>Stage MARC records into the reservoir (Access to the
<link linkend="stagemarc">Stage MARC Records
Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>upload_local_cover_images</para>
<itemizedlist>
<listitem>
<para>Upload local cover images (Access to the <link
linkend="uploadlocalimages">Upload Local Cover Image
Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>view_system_logs</para>
<itemizedlist>
<listitem>
<para>Browse the system logs (Access to the <link
linkend="logviewer">Log Viewer Tool</link>)</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="reportpermissions">
<title>Granular Reports Permissions</title>
<para>If the staff member has 'reports' permissions they have the
ability to perform all of these actions. If you would like to
control reports permissions on a more granular level choose from
these options:</para>
<itemizedlist>
<listitem>
<para>create_reports</para>
<itemizedlist>
<listitem>
<para>The ability to create and edit but not run SQL
reports</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>execute_reports</para>
<itemizedlist>
<listitem>
<para>The ability to run but not create or edit SQL
reports</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
</section>
</section>
<section id="patroninformation">
<title>Patron Information</title>
<para>When viewing a patron record you have the option to view
information from one of many tabs found on the left hand side of the
record.</para>
<section id="patcheckout">
<title>Check Out</title>
<para>For instruction on checking items out, view the <link
linkend="checkingout">Checking Out</link> section of this
manual.</para>
</section>
<section id="patrondetails">
<title>Details</title>
<para>All patron information will appear on the Details tab. This
includes all the contact information, notes, custom patron attributes,
messaging preferences, etc entered when adding the patron.</para>
<para>In the case of patrons who are marked as 'Child' or
'Professional' and their Guarantors additional information will appear
on their record.</para>
<itemizedlist>
<listitem>
<para>A child patron will list their Guarantor</para>
<screenshot>
<screeninfo>Guarantor listed and linked from the child
record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/child.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>On the Guarantor's record, all children and/or professionals
will be listed</para>
<screenshot>
<screeninfo>Guarantees listed on the Guarantor's
profile</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/parent.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<section id="patcircsummary">
<title>Circulation Summary</title>
<para>Below the patron's information on the details screen is a
tabbed display of the items they have checked out, overdue, and on
hold.</para>
<screenshot>
<screeninfo>Checkout summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/checkoutsummary.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If they have family at the library staff can see what the
other family members have checked out.</para>
<screenshot>
<screeninfo>Relative checkouts</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/relativecheckouts.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="patronfines">
<title>Fines</title>
<para>The patron's complete accounting history will appear on the
Fines tab. Contrary to its name, the Fines tab does not just show fine
data, it also shows membership fees, rental fees, reserve fees and any
other charge you may have for patrons.</para>
<screenshot>
<screeninfo>Patron Accounting Summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/patronaccount.png"/>
</imageobject>
</mediaobject>
</screenshot>
<section id="chargefines">
<title>Charging Fines/Fees</title>
<para>Most fees and fines will be charged automatically if the <link
linkend="finescronjob">fines cron job</link> is running:</para>
<itemizedlist>
<listitem>
<para>Fines will be charged based on your <link
linkend="circfinerules">Circulation & Fines
Rules</link></para>
</listitem>
<listitem>
<para>Hold fees will be charged based on the rules you set in
the <link linkend="patcats">Patron Types & Categories</link>
administration area</para>
</listitem>
<listitem>
<para>Rental fees will be charged based on the settings in your
<link linkend="itemtypeadmin">Item Types</link> administration
area</para>
</listitem>
<listitem>
<para>Marking an item 'Lost' via the cataloging module will
automatically charge the patron the replacement cost for that
item</para>
</listitem>
</itemizedlist>
</section>
<section id="payfines">
<title>Pay/Reverse Fines</title>
<para>Each line item can be paid in full (or written off) using the
'Pay Fines' tab.</para>
<screenshot>
<screeninfo>Paying Fines</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/makepayment.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Each line item can be paid in full, partially paid, or
written off.</para>
</listitem>
<listitem>
<para>Pay a fine in full</para>
<itemizedlist>
<listitem>
<para>Click "Pay" next to the fine you want to pay in
full</para>
</listitem>
<listitem>
<para>The full amount of the fine will be populated for you
in the "Collect From Patron" box</para>
<screenshot>
<screeninfo>Pay fine</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/payfine.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Click "Confirm"</para>
</listitem>
<listitem>
<para>The fine will be removed from outstanding fines, and
displayed as fully paid.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Pay a partial fine</para>
<itemizedlist>
<listitem>
<para>Click "Pay" next to the fine you want to partially
pay</para>
</listitem>
<listitem>
<para>Enter the amount you are collecting from the patron in
the "Collect From Patron" box</para>
<screenshot>
<screeninfo>Pay partial fine</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/paypartial.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Click "Confirm"</para>
</listitem>
<listitem>
<para>The fine will be updated to show the original Amount,
and the current Amount Outstanding</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Pay an amount towards all fines</para>
<itemizedlist>
<listitem>
<para>Click the "Pay Amount" button</para>
</listitem>
<listitem>
<para>Enter the amount you are collecting from the patron in
"Collect from Patron." The sum of all fines is shown in
"Total Amount Outstanding"</para>
<screenshot>
<screeninfo>Pay Amount</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/payamount.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Click "Confirm"</para>
</listitem>
<listitem>
<para>The fine totals will be updated with the payment
applied to oldest fines first.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Pay Selected fines</para>
<itemizedlist>
<listitem>
<para>Check the selection boxes next to the fines you wish
to pay, click "Pay Selected"</para>
<screenshot>
<screeninfo>Select lines to pay</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/payselected-select.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Enter an amount to pay towards the fines.</para>
<screenshot>
<screeninfo>Pay Selected</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/payselected.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Click "Confirm"</para>
</listitem>
<listitem>
<para>The fine totals will be updated with the payment
applied to the oldest selected fines first.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Writeoff a single fine</para>
<itemizedlist>
<listitem>
<para>Click "Writeoff" next to the fine you wish to
writeoff.</para>
</listitem>
<listitem>
<para>The fine will be removed from outstanding fines, and
displayed as written off.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Writeoff All fines</para>
<itemizedlist>
<listitem>
<para>Click the "Writeoff All" button</para>
</listitem>
<listitem>
<para>All fines will be removed from outstanding fines, and
displayed as written off.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If you accidentally mark and item as paid, you can reverse
that line item by clicking 'Reverse' to the right of the
line</para>
<screenshot>
<screeninfo>Reverse Link</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/reverselink.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Once clicked a new line item will be added to the
account, showing the payment as reversed</para>
<screenshot>
<screeninfo>Reversed Payment</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/reversed.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="manualinvoice">
<title>Creating Manual Invoices</title>
<para>For fees that are not automatically charged, librarians can
create a manual invoice</para>
<screenshot>
<screeninfo>Create Manual Invoice</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/manualinvoice.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>First choose the type of invoice you would like to
create</para>
<itemizedlist>
<listitem>
<para>To add additional values to the manual invoice type
pull down menu, add them to the <link
linkend="manualinvvals">MANUAL_INV</link> Authorized
Value</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If the fee is associated with an item you can enter its
barcode so that the line item shows a link to that item</para>
</listitem>
<listitem>
<para>The description field is where you will enter the
description of the charge</para>
</listitem>
<listitem>
<para>In the amount field, do not enter currency symbols, only
numbers and decimals</para>
</listitem>
</itemizedlist>
</section>
<section id="manualcredit">
<title>Creating Manual Credits</title>
<para>Manual credits can be used to pay off parts of fines, or to
forgive a fine amount.</para>
<screenshot>
<screeninfo>Create Manual Credit</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/manualcredit.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>First choose the type of credit you'd like to apply</para>
</listitem>
<listitem>
<para>If this credit is associated with an item you can enter
that item's barcode so that the line item links to the right
item</para>
</listitem>
<listitem>
<para>The description field is where you will enter the
description of the credit</para>
</listitem>
<listitem>
<para>In the amount field, do not enter currency symbols, only
numbers and decimals</para>
</listitem>
</itemizedlist>
</section>
<section id="printinglineitems">
<title>Printing Invoices</title>
<para>To the right of each account line there is a print link.
Clicking that link will print an invoice for the line item that
includes the date and description of the line item along with the
total outstanding on the account.</para>
<screenshot>
<screeninfo>Sample Invoice</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/patroninvoice.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="circhistory">
<title>Circulation History</title>
<para>The circulation history tab will appear if you have set the
<link linkend="intranetreadinghistory">intranetreadinghistory</link>
preference to allow it to appear. If you have the <link
linkend="OPACPrivacy">OPACPrivacy</link> system preference set to
'Allow' and the patron has decided that the library cannot keep this
information this tab will only show currently checked out
items.</para>
<screenshot>
<screeninfo>Patron Circulation History</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/readinghistory.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you would like to export a list of barcodes for the items
checked in today you can find that option under the More menu on the
top right of the page.</para>
<screenshot>
<screeninfo>Export today's checkins</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/readinghistory-export.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>This will generate a text file with one barcode per line.</para>
</section>
<section id="patmodlog">
<title>Modification Log</title>
<para>If you have set your <link
linkend="BorrowersLog">BorrowersLog</link> to track changes to patron
records, then this tab will appear. The Modification Log will show all
changes made to the patron record.</para>
<screenshot>
<screeninfo>Changes to Patron #51</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/borrowerlog.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>The Librarian field shows the patron number for the
librarian who made the changes</para>
</listitem>
<listitem>
<para>The Object field lists the patron that is being modified (in
the example above, it was my changing my own record)</para>
</listitem>
</itemizedlist>
</section>
<section id="patnotices">
<title>Notices</title>
<para>The <link linkend="setpatronmessaging">patron's messaging
preferences</link> are set when <link
linkend="addnewpatron">adding</link> or <link
linkend="editpatrons">editing</link> the patron. This tab will show
the messages that have been sent and those that are queued to be
sent:</para>
<screenshot>
<screeninfo>Patron Notices Tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/patnoticestab.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking on the message title will expand the view to show you
the full text of the message that was sent.</para>
<screenshot>
<screeninfo>Full message text</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/patnoticestab-full.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="patronsearch">
<title>Patron Search</title>
<para>Clicking on the link to the Patron module will bring you to a
search/browse screen for patrons. From here you can search for a
patron.</para>
<screenshot>
<screeninfo>Patron Search</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/patronsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Depending on what you have chosen for the 'Search fields' you can
search for patrons in various different ways.</para>
<screenshot>
<screeninfo>Patron Search Fields</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/patronfieldsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Standard:</para>
<itemizedlist>
<listitem>
<para>Enter any part of their name, username, email address or
barcode</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Email:</para>
<itemizedlist>
<listitem>
<para>Enter any part of their email address.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Borrower number:</para>
<itemizedlist>
<listitem>
<para>Enter the Koha borrower number</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Phone number:</para>
<itemizedlist>
<listitem>
<para>Enter the phone number exactly as it is in the system or
by using spaces between each batch of numbers.</para>
</listitem>
<listitem>
<para>Example: To find (212) 555-1212 you can search for it
exactly as it was entered or by searching for 212 555
1212</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>If you want to filter your results to a specific branch or
category, you can click the plus sign [+] to the right of the search
box.</para>
<screenshot>
<screeninfo>Advanced Patron Search</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/patronfilter.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also browse through the patron records by clicking on the
linked letters across the top.</para>
<screenshot>
<screeninfo>Patron Browse</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/patrons/patronbrowse.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</chapter>
<chapter id="circulation">
<title>Circulation</title>
<para>Circulation functions can be accessed in several different ways. On
the main page of the staff client there are some quick links in the center
of the page to check items out, in or transfer them. For a complete
listing of Circulation functions you can visit the Circulation page which
is linked from the top left of every page or from the center of the main
page.</para>
<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>
<para>While in Circulation you can jump between the tabs on the quick
search box at the top of the screen by using the following hot
keys:</para>
<itemizedlist>
<listitem>
<para>jump to the catalog search with Alt+Q</para>
</listitem>
<listitem>
<para>jump to the checkout with Alt+U</para>
<itemizedlist>
<listitem>
<para>this will not work for Mac users</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>jump to the checkin with Alt+R</para>
</listitem>
</itemizedlist>
<para><tip>
<para>Mac users use the OPTION button in place of ALT</para>
</tip></para>
<section id="checkingout">
<title>Check Out (Issuing)</title>
<para>To begin the checkout process you must enter the patron barcode or
part of their name. The checkout option appears in three main
places:</para>
<itemizedlist>
<listitem>
<para>Check out option on the top of the main staff client</para>
<screenshot>
<screeninfo>Check out box on main Koha Staff Client
page</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/checkoutmain.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Check out option on the patron record</para>
<screenshot>
<screeninfo>Check out tab on a patron record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/checkoutpatron.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Check out option on the quick search bar on the circulation
page</para>
<screenshot>
<screeninfo>Check out tab on quick search bar</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/circquickbox.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<section id="checkitemout">
<title>Checking Items Out</title>
<para>To check an item out to a patron, first search for that patron
using one of the many options listed above.</para>
<screenshot>
<screeninfo>Check Out Screen</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/checkingout.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>At the top of the Check Out screen is a box for you to type or
scan the item's barcode into.</para>
<itemizedlist>
<listitem>
<important>
<para>Many modern barcode scanners will send a 'return' to the
browser, making it so that the 'Check Out' button is
automatically clicked</para>
</important>
</listitem>
<listitem>
<para>If the barcode is not found you will be prompted to use fast
cataloging to add the item. Learn more about <link
linkend="fastaddcat">fast cataloging</link> later in this
manual.</para>
</listitem>
</itemizedlist>
<para>Below the box for the barcode there may be options for you to
override the default due date for the item.</para>
<itemizedlist>
<listitem>
<para>This option will only appear if you have set the <link
linkend="SpecifyDueDate">SpecifyDueDate</link> system preference
to allow staff to override the due date</para>
</listitem>
</itemizedlist>
<para>At the bottom of the page there is a summary of the patron's
current checked out items along with the due date (and time if the
item is an hourly loan), items checked out today will appear at the
top.</para>
<tip>
<para>If the checked out time is listed as 00:00 then the item is a
daily loan item. The due time for daily checkouts will show 23:59
which is the last minute of the day.</para>
</tip>
<screenshot>
<screeninfo>Patron's checkout summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/checkoutsummary.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Also at the bottom of the page is the list of items the patron
has on hold</para>
<screenshot>
<screeninfo>Holds summary on check out screen</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdssummary.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From the holds list you can suspend or resume patrons holds
using the options at the bottom of the list if you have the <link
linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link> preference
set to 'allow.'</para>
<note>
<para>If you have your <link
linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
preference set to "Don't allow" then you will not have the option to
put an end date on the hold suspension</para>
</note>
<para>If there are notes on the patron record these will appear to the
right of the checkout box</para>
<screenshot>
<screeninfo>Patron notes on check out screen</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/patronnotes.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If the patron has a hold waiting at the library that too will
appear to the right of the check out box making it easy for the
circulation librarian to see that there is another item to give the
patron</para>
<screenshot>
<screeninfo>Hold waiting message on check out screen</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdwaiting.png"/>
</imageobject>
</mediaobject>
</screenshot>
<section id="printcircreceipt">
<title>Printing Receipts</title>
<para>Once you have checked out all of the items for the patron you
can print them a receipt by choosing one of two methods.</para>
<para>If you have the <link
linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
preference set to 'open a print quick slip window' you can simply
hit enter on your keyboard or scan a blank piece of paper with your
barcode scanner. The idea being that you're "checking out" a blank
barcode which triggers Koha to print the 'Quick slip.'</para>
<para>You can also click the Print button at the top of the screen
and choose 'Print slip' or 'Print quick slip'.</para>
<screenshot>
<screeninfo>Print receipt to slip printer</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/printslip.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you choose 'Print slip' it will print all of the items the
patron has checked out, including those they checked out at an
earlier date. Choosing 'Print quick slip' will print only the items
that were checked out today.</para>
<para>What prints on the slips can be customized by altering the
slip templates under the <link linkend="notices">Notices &
Slips</link> tool.</para>
</section>
<section id="clearpatroninfo">
<title>Clear Patron Information</title>
<para>When you're done checking an item out if you have the <link
linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
preference set to 'Show' you can clear the current patron by
clicking the X in the top right of the patron's info to remove the
current patron from the screen and start over.</para>
<screenshot>
<screeninfo>Clear Screen Button</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you have the <link
linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
preference set to 'clear the screen' then you simply need to hit
enter or scan a blank barcode and the screen will be cleared of the
current patron.</para>
</section>
</section>
<section id="checkoutmsg">
<title>Check Out Messages</title>
<para>If you check out an item that has multiple pieces and you have
cataloged that information in subfield 3 of the item record (in
MARC21) a message will pop up when you check out that item telling you
how many pieces should be there.</para>
<screenshot>
<screeninfo>Materials in the checked out item</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/materialspecified.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>There are times when Koha will prevent the librarian from being
able to check out items to a patron. When this happens a warning will
appear notifying the librarian of why the patron cannot check items
out.</para>
<itemizedlist>
<listitem>
<para>Patron owes too much in fines</para>
<screenshot>
<screeninfo>Patron owes too much in fines</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/fineswarning.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>You can set the amount at which patron checkouts are
blocked with the <link
linkend="noissuescharge">noissuescharge</link> system
preference</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Patron has been barred from the library</para>
<screenshot>
<screeninfo>Patron account barred</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/debarwarning.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>This can be set by the librarian editing a patron record
and adding a <link linkend="patronflags">flag</link> or by the
<link linkend="noticetriggers">Overdue/Notice Status
Triggers</link></para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Patron needs to confirm their address</para>
<screenshot>
<screeninfo>Patron's address warning</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/addresswarning.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>This can be set by the librarian editing a patron record
and adding a <link linkend="patronflags">flag</link></para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Patrons has lost their library card</para>
<screenshot>
<screeninfo>Lost patron card warning</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/lostcardwarning.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>This can be set by the librarian editing a patron record
and adding a <link linkend="patronflags">flag</link></para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="checkoutwarn">
<title>Check Out Warnings</title>
<para>Sometimes checkouts will trigger warning messages that will
appear in a yellow box above the check out field. These warnings need
to be acknowledged before you will be able to continue checking items
out.</para>
<itemizedlist>
<listitem>
<para>Patron has outstanding fines</para>
<screenshot>
<screeninfo>Patron has a debt</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/warnings/patrondebt.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Item on hold for someone else</para>
<screenshot>
<screeninfo>Item is on hold for someone else</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/warnings/onhold.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Item should be on the hold shelf waiting for someone
else</para>
<screenshot>
<screeninfo>Item is on hold shelf waiting for someone
else</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/warnings/holdwaiting.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Item already checked out to this patron</para>
<screenshot>
<screeninfo>Item is currently checked out to this
patron</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/warnings/alreadycheckedout.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Item checked out to another patron</para>
<screenshot>
<screeninfo>Item checked out to another patron</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/warnings/checkedoutelse.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Item not for loan</para>
<screenshot>
<screeninfo>Item is not normally for loan</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/warnings/notforloan.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Patron has too many things checked out</para>
<screenshot>
<screeninfo>Too many checkouts</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/warnings/toomanycheckouts.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Item cannot be renewed</para>
<screenshot>
<screeninfo>No more renewals</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/warnings/norenewals.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>This can be overridden with the <link
linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
system preference</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Barcode not found</para>
<screenshot>
<screeninfo>Barcode not found</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/barcodefastadd.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Learn more about <link linkend="fastaddcat">fast
cataloging</link> later in this manual.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
</section>
<section id="circrenew">
<title>Renewing</title>
<para>Checked out items can be renewed (checked out for another period
of time) based on your <link linkend="circfinerules">circulation
rules</link> and <link linkend="RenewalPeriodBase">renewal
preferences</link>. If you allow it, patrons can renew their own items
via the OPAC, but sometimes you'll need to help them by renewing their
items via the staff client. To renew items checked out to a patron,
visit their details page or checkout page and review their checkout
summary at the bottom.</para>
<screenshot>
<screeninfo>Circulation Summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/circsummary.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>In the Renew column you will see how many times each item has been
renewed and a checkbox to renew the item for the patron. Check the boxed
of the items you would like to renew and click the 'Renew or Return
checked items' button, or to renew all items checked out to the patron
simply click the 'Renew all' button.</para>
<screenshot>
<screeninfo>Renew buttons</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/renewbutton.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Sometimes renewals will be blocked based on your circulation
rules, to override this block you must have your <link
linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
preference set to 'Allow'. If you allow renewal limit overrides, you
will see a checkbox at the bottom left of the circulation summary. Check
that box and then choose the items you would like to renew.</para>
<screenshot>
<screeninfo>Override renewal limit</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/overriderenew.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Checking that box will add checkboxes in the renew column above
where before the item was not renewable.</para>
</section>
<section id="checkingin">
<title>Check In (Returning)</title>
<para>Checking in items can be performed from various different
locations</para>
<itemizedlist>
<listitem>
<para>The check in box on the top of the main staff client</para>
<screenshot>
<screeninfo>Check out box on main Koha Staff Client
page</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/checkinmain.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>The check in option on the quick search bar on the Circulation
page<screenshot>
<screeninfo>Check in tab on quick search bar</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/checkinquickbox.png"/>
</imageobject>
</mediaobject>
</screenshot></para>
</listitem>
<listitem>
<para>The check in link on the patron's checkout summary (and on the
checkout summary page)</para>
<screenshot>
<screeninfo>Patron checkout summary includes 'Check In'
link</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/checkinlink.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>The Check in page under the Circulation menu</para>
<screenshot>
<screeninfo>Check in link on Circulation Module</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/checkincirc.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<section id="checkitemin">
<title>Checking Items In</title>
<para>To check an item in scan the barcode for the item into the box
provided. A summary of all items checked in will appear below the
checkin box</para>
<screenshot>
<screeninfo>Check In Summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/checkin.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you are checking items in that were put in the dropbox while
the library was closed you can check the 'Dropbox mode' box before
scanning items. This will effectively roll back the returned date to
the last date the library was open.</para>
<itemizedlist>
<listitem>
<para>This requires that you have your closings added to the <link
linkend="calholidays">Holidays & Calendar Tool </link></para>
</listitem>
</itemizedlist>
<para>You can also choose to forgive all overdue charges for items you
are checking in by checking the 'Forgive overdue charges' box before
scanning items.</para>
</section>
<section id="checkinmsg">
<title>Check In Messages</title>
<para>There are several messages that can appear when checking items
in:</para>
<itemizedlist>
<listitem>
<para>If you are checking an item in at a library other than the
home branch, a message will appear asking you to transfer the book
to the home library</para>
<screenshot>
<screeninfo>Check in Transfer Message</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/checkintransfer.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>After this item is checked in the status of the item
will be changed in the catalog to 'in transit'</para>
<screenshot>
<screeninfo>In Transit Status</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/transferstatus.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>To mark an item as back at the home branch, check the
item in at the home branch</para>
<screenshot>
<screeninfo>Check In Transferred Item</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/transfercheckin.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>A message will appear tell you that the item is not
checked out, but the status will now say available in the
catalog. This step is necessary to mark items as received
by the home branch.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If you are checking in an item that should have multiple
parts or pieces a message will appear warning you about the number
of pieces you should have in your hand</para>
<screenshot>
<screeninfo>Materials Specified</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/materialspecified.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>If you're checking an item in that has a hold on it, you
will be prompted to confirm the hold</para>
<screenshot>
<screeninfo>Hold Found Check In Message</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdfound.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Clicking the Confirm hold button will mark the item as
waiting for pickup from the library</para>
<screenshot>
<screeninfo>Hold waiting at the library</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/waitingstatus.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Clicking the Print Slip and Confirm button will mark the
item as waiting for pickup at the library and present the
library with a receipt to print and place on the book with the
patron's information</para>
</listitem>
<listitem>
<para>Ignoring the hold will leave the item on hold, but leave
its status as Available (it will not cancel the hold)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If you're checking in an item that has a hold on it at
another branch you will be prompted to confirm and transfer the
item</para>
<screenshot>
<screeninfo>Hold found for another branch</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdconfirmtransfer.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Clicking the Confirm hold and Transfer button will mark
the item as in transit to the library where the hold was
placed</para>
<screenshot>
<screeninfo>In transit hold status</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/intransithold.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Clicking the Print Slip, Transfer and Confirm button
will mark the item as in transit to the library where the hold
was placed and present the library with a receipt to print and
place on the book with the patron's information</para>
</listitem>
<listitem>
<para>Ignoring the hold will leave the item on hold, but leave
its status as Available (it will not cancel the hold)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If you have the system showing you fines at the time of
checkin (<link
linkend="FineNotifyAtCheckin">FineNotifyAtCheckin</link>) you will
see a message telling you about the fine and providing you a link
to the payment page for that patron</para>
<screenshot>
<screeninfo>FineNotifyAtCheckin</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
</section>
<section id="circmessages">
<title>Circulation Messages</title>
<para>Circulation messages are short messages that librarians can leave
for their patrons or their colleagues that will appear at the time of
circulation.</para>
<section id="setcircmsg">
<title>Setting up Messages</title>
<para>Circulation messages are set up as <link
linkend="authorizedvalues">Authorized Values</link>. To add or edit
Circulation Messages you want to work with the <link
linkend="bornotes">BOR_NOTES</link> value.</para>
<screenshot>
<screeninfo>BOR_NOTES Authorized Values</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/bor_notes.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The 'Description' field can hold a canned message that you would
like to appear on the patron's record. <important>
<para>The 'Description' field is limited to 80 characters, but the
patron message field can hold more than that. Enter 80 characters
in the 'Description' field and then type the rest on the patron
record.</para>
</important></para>
</section>
<section id="addcircmsg">
<title>Adding a Message</title>
<para>When on the patron's check out tab you will see a link to 'Add a
new message' to the right of the check out box.</para>
<screenshot>
<screeninfo>Circulation Message in Staff Client</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/staffmessages.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When you click 'Add a new message' you will be asked to choose
if the message is for the librarians or the patron and the message you
would like to leave.</para>
<screenshot>
<screeninfo>Leave a Circulation Message</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/leavecircmsg.png"/>
</imageobject>
</mediaobject>
</screenshot>
<note>
<para>A message for the patron will also show to the library
staff.</para>
</note>
</section>
<section id="viewcircmsg">
<title>Viewing Messages</title>
<para>Circulation messages meant for the staff and/or the patron will
appear on the patron's checkout screen to the right of the checkout
box. Messages in bold and red are meant for the library staff only,
whereas messages in regular italics font are meant for the patron and
the librarian.</para>
<screenshot>
<screeninfo>Circulation Message in Staff Client</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/staffmessages.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Circulation messages meant for the patron will also appear when
they log into the OPAC.</para>
<screenshot>
<screeninfo>Circulation Message in OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/opacmsg.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="holds">
<title>Holds</title>
<para/>
<section id="holdsinstaff">
<title>Placing Holds in Staff Client</title>
<para>There are several ways to place holds from the staff client. The
most obvious is using the 'Place Hold' button at the top of any
bibliographic record.</para>
<screenshot>
<screeninfo>Place Hold Button on Bib Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/placeholdbib.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also click the smaller 'Place Hold' link found at the
top of your catalog search results, or the 'Holds' link found below
each result.</para>
<screenshot>
<screeninfo>Hold options on search results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/placeholdsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You will be asked to search for a patron by barcode or any part
of their name to start the hold process.</para>
<screenshot>
<screeninfo>Find Patron For Hold</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/placeholdfindpatron.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you'd like to search for the patron first and then the bib
record for the hold, you can open the patron record and click on the
'Search to Hold' button at the top of the patron record.</para>
<screenshot>
<screeninfo>Search to Hold on Patron Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/searchtohold.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>After clicking the button you will be brought to the catalog
search page where you can find the book(s) you want to place a hold
on. Under each title on the results you'll see an option to 'Hold for
Patron Name.'</para>
<screenshot>
<screeninfo>Hold for Patron links on Search Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you want to place a hold on multiple items, simply check the
boxes to the left of them and click the arrow to the right of the
'Place Hold' button.</para>
<screenshot>
<screeninfo>Hold Multiple Items for Patron</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdmultiresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Depending on how many items you choose to place a hold on at
once you will see a different place hold form. If you are placing a
hold on one bibliographic record you will see a list of all of the
items you can place a hold on.</para>
<screenshot>
<screeninfo>Place Hold Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/placeholdsingle.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Enter any notes that might apply to this hold</para>
</listitem>
<listitem>
<para>Choose the library where the patron will pick up the
item</para>
</listitem>
<listitem>
<para>If the patron wants the hold to start on a date other than
today, enter that in the 'Hold starts on date' field</para>
<itemizedlist>
<listitem>
<para>This option will only appear if the <link
linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
system preference is set to 'Allow'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If the patron has specified that they don't want the item
after a certain date, or if you have limits on hold lengths, you
can enter an expiration date for the hold in the 'Hold expires on
date'</para>
<itemizedlist>
<listitem>
<para>To have expired holds canceled automatically you will
need to have the <link linkend="expiredholdscron">Expired
Holds</link> cron job set to run on a regular basis.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Next choose if you want to place a hold on the next
available item or a specific item by clicking the radio button
next to an individual item.</para>
</listitem>
</itemizedlist>
<para>If you're placing a hold on multiple items you will be presented
with the next available option for all titles. If no items are
available for hold it will say so on the confirmation screen.</para>
<screenshot>
<screeninfo>Place multiple items on hold</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/placeholdmultiple.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once your hold is placed, if you'd like to have Koha forget that
you used the 'Search to Hold' function, you can choose to have Koha
'forget' the patron's name by clicking the arrow to the right of the
'Place Hold' button on the search results and choosing the 'Forget'
option.</para>
<screenshot>
<screeninfo>Forget Search to Hold Option</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/forgethold.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="manageholds">
<title>Managing Holds</title>
<para>Holds can be altered and canceled from the Holds tab found on
the left of the bibliographic record.</para>
<screenshot>
<screeninfo>Bibliographic Record Tabs</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdtab.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From the list of holds you can change the order of the holds,
the pickup location, suspend and/or cancel the hold.</para>
<screenshot>
<screeninfo>Lists of Holds</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdslist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<note>
<para>If you have your <link
linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
preference set to "Don't allow" then you will not have the option to
put an end date on the hold suspension</para>
</note>
<note>
<para>Depending on how you have your <link
linkend="HidePatronName">HidePatronName</link> system preference set
the list may show card numbers instead of names in the Patron column
like in the image above.</para>
</note>
<para>To rearrange or delete holds, simply make a selection from the
'Priority' pull down or click the arrows to the right of the priority
pull down.</para>
<screenshot>
<screeninfo>Hold Priority Menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdpriority.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To delete or cancel a hold, choose 'del' from the menu or click
the red 'X' to the right of the hold line.</para>
<para>If you use the priority pull down to rearrange or delete holds
you will need to click the 'Update hold(s)' button to save your
changes.</para>
<para>Clicking the down arrow to the right of the hold will stick the
hold at the bottom of the list even if more requests are made.</para>
<para>For example, your library has home-bound patrons that are
allowed to keep books out for months at a time. It would not be fair
to other patrons if a home-bound patron were able to check out a brand
new book and keep it for months. For this reason, the home-bound
patron's hold request would stay at the bottom of the queue until
everyone else who wanted to read that book has already done so.</para>
<screenshot>
<screeninfo>Lowest Priority & Delete Options for
Holds</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/lowestpriority.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If a patron asks to have their hold suspended and you have the
<link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
system preference set to 'allow' you can do so by clicking the Suspend
button to far right. If the patron gives you a date for the items to
become unsuspended you can enter that in the date box and click the
'Update hold(s)' button to save your changes.</para>
<screenshot>
<screeninfo>Hold suspension column</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/suspendholds.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para/>
</section>
<section id="receiveholds">
<title>Receiving Holds</title>
<para>When items that are on hold are checked in or out the system
will remind the circulation librarian that the item is on hold and
offer them options for managing the hold.</para>
<para>When you check in an item that has a hold on it the system will
ask you to either confirm and transfer the item</para>
<screenshot>
<screeninfo>Confirm Hold & Transfer</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdconfirmtransfer.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>or just confirm the hold</para>
<screenshot>
<screeninfo>Confirm Hold</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdconfirm.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking the Confirm button will mark the item as on hold for
the patron. If the item needs to be transferred the item will also be
marked as in transit to the proper branch. Clicking 'Ignore' will
retain the hold, but allow you to check the item out to another
patron. Choosing to confirm and print will present you with a
printable page that you can slip inside the book with the necessary
hold and/or transfer information.</para>
<para>Once confirmed the hold will show on the patron record and on
the checkout screen under the 'Hold' tab.</para>
<screenshot>
<screeninfo>Hold on Patron Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdpatronrec.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The item record will also show that the item is on hold.</para>
<screenshot>
<screeninfo>Hold on Item Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holditem.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>In some cases a patron may come in to pick up a hold for their
partner (or someone else in their household). In this case you want to
make sure that the hold is cancelled when you check the item out to
someone else. When trying to check out an item that is already waiting
for someone else you will be presented with a warning message.</para>
<screenshot>
<screeninfo>Hold waiting for someone else</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdwaitingwarn.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From here you can check the item out to the patron at the desk
and cancel the hold for the patron.</para>
</section>
</section>
<section id="transfers">
<title>Transfers</title>
<para>If you work in a multi-branch system you can transfer items from
one library to another by using the Transfer tool. To transfer an
item</para>
<itemizedlist>
<listitem>
<para>Click 'Transfer' on the Circulation page</para>
<screenshot>
<screeninfo>Transfer Tool</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/transfer.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Enter the library you would like to transfer the item
to</para>
</listitem>
<listitem>
<para>Scan or type the barcode on the item you would like to
transfer</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Click 'Submit'</para>
<screenshot>
<screeninfo>Transfer Summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/itemtransferred.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>The item will now say that it is in transit</para>
<screenshot>
<screeninfo>Item in Transit</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/itemintransit.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>When the item arrives at the other branch the librarian must
check the item in to acknowledge that it is no longer in
transit</para>
</listitem>
<listitem>
<para>The item will not be permanently moved to the new
library</para>
<screenshot>
<screeninfo>Item record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/itemlocations.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>The item shows the same 'Home Library' but has updated the
'Current Location' to note where it resides at this time</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="setlibrary">
<title>Set Library</title>
<para>By default you will enter the staff client as if you are at your
home library. This library will appear in the top right of the Staff
Client.</para>
<screenshot>
<screeninfo>My Library</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/mylibrary.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>This is the library that all circulation transactions will take
place at. If you are at another library (or on a bookmobile) you will
want to set your library before you start circulating items. To do this
you can click 'Set' at the top right or on the Circulation page.</para>
<screenshot>
<screeninfo>Set Library Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/setlibrary.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you have saved your changes you new library will appear in
the top right.</para>
</section>
<section id="fastaddcat">
<title>Fast Add Cataloging</title>
<para>Sometimes circulation librarians need to quickly add a record to
the system for an item they are about to check out. This is called 'Fast
Add.' To allow circulation librarians access to the Fast Add Cataloging
tool, simply make sure they have the <link
linkend="fastaddpermissions">fast_cataloging</link> permissions. There
are two ways to add titles via fast add. If you know that you're about
to check out an item that isn't in you catalog you can go to the
Circulation module and click 'Fast cataloging.'</para>
<screenshot>
<screeninfo>Circulation Menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/circmenu.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The cataloging interface will open up with the short cataloging
record:</para>
<screenshot>
<screeninfo>Fast Add Framework</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/fastadd.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>After adding your cataloging data you will be asked to enter item
data. Enter the items barcode, collection code, etc and save the item
before checking it out.</para>
<para>The other way to fast catalog is from the checkout screen. When
you enter a barcode at checkout that Koha can't find, it will prompt you
to use fast cataloging to add the item to Koha and check it out.</para>
<screenshot>
<screeninfo>Barcode not found</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/barcodefastadd.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking 'Fast cataloging' will bring you to the fast cataloging
form where you can enter the title information</para>
<screenshot>
<screeninfo>Fast cataloging</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/fastaddbarcode.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>After clicking 'Save' you will be brought to the item record where
the barcode will already be filled in with the barcode you're trying to
check out.</para>
<screenshot>
<screeninfo>Fast cataloging item record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/fastadditem.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>After clicking the 'Add item' button the item will automatically
be checked out the patron you were trying to check the book out to
originally.</para>
<screenshot>
<screeninfo>Checked out item</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/fastaddcheckedout.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="circreports">
<title>Circulation Reports</title>
<para/>
<section id="holdsqueue">
<title>Holds Queue</title>
<para>This report will show you all of the holds at your library. To
generate this report, you must have the <link
linkend="buildholdscron">Build Holds Queue cron job</link>
running.</para>
<screenshot>
<screeninfo>Sample Holds Queue</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdsqueue.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="holdspull">
<title>Holds to pull</title>
<para>This report will show you all of the items that have holds on
them that are available at the library for pulling.</para>
<screenshot>
<screeninfo>Holds to Pull</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdstopull.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>This report will be generated based on a few system
preferences:</para>
<itemizedlist>
<listitem>
<para><link
linkend="holdqueueweight">StaticHoldsQueueWeight</link></para>
<itemizedlist>
<listitem>
<para>Allows the library to specify a list of library location
codes -- if used alone, it will rank the list statically,
selecting the top-ranking available location to be added to
the picklist.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link
linkend="holdqueueweight">RandomizeHoldsQueueWeight</link></para>
<itemizedlist>
<listitem>
<para>If 'RandomizeHoldsQueueWeight' and
'StaticHoldsQueueWeight' are set, the list of library codes in
the 'StaticHoldsQueueWeight' system preference are randomized
rather than statically ranked. If RandomizeHoldsQueueWeight
alone is set, the list of all available library codes is used
to randomize the weight.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>If neither 'RandomizeHoldsQueueWeight' or
'StaticHoldsQueueWeight' is set, the holds queue is statically ranked
according to how they are pulled out of the system database.</para>
<para>You can limit the results you see by using the Refine box on the
left side of the page:</para>
<screenshot>
<screeninfo>Refine Holds to Pull Report</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/refineholdstopull.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="holdspickup">
<title>Holds awaiting pickup</title>
<para>This report will show all of the holds that are waiting for
patrons to pick them up.</para>
<screenshot>
<screeninfo>Holds Awaiting Pickup</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdspickup.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Items that have been on the hold shelf longer than you normally
allow (based on the <link
linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
preference value) will appear on the 'Holds Over' tab, they will not
automatically be cancelled unless you have set the <link
linkend="expiredholdscron">cron job</link> to do that for you, but you
can cancel all holds using the button at the top of the list.</para>
<screenshot>
<screeninfo>Items waiting on the hold shelf too long</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdspickupover.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="holdratios">
<title>Hold ratios</title>
<para>Hold ratios help with collection development. Using this report
you will be able to see how many of your patrons have holds on items
and whether you should buy more. By default it will be set to the
library needing 3 items per hold that has been placed. The report will
tell you how many additional items need to be purchased to meet this
quota.</para>
<screenshot>
<screeninfo>Hold Ratios</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/holdratio.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="transferstoreceive">
<title>Transfers to receive</title>
<para>This report will list all of the items that Koha thinks are in
transit to your library.</para>
<screenshot>
<screeninfo>Transfers to Receive</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/transitreceive.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If your transfers are late in arriving at your library you will
see a message stating how late your items are.</para>
<screenshot>
<screeninfo>Late transfers include warning messages</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/transferlate.png"/>
</imageobject>
</mediaobject>
</screenshot>
<important>
<para>An item is considered late based on the number of days you
have entered in the <link
linkend="TransfersMaxDaysWarning">TransfersMaxDaysWarning</link>
system preference.</para>
</important>
</section>
<section id="overduesreport">
<title>Overdues</title>
<important>
<para>For libraries with a large patron base, this report may take a
significant amount of time to run.</para>
</important>
<tip>
<para>Large libraries can choose to filter the report before it runs
by setting the <link
linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
system preference to 'Require'.</para>
</tip>
<para>This report will list all items that are overdue at your
library.</para>
<screenshot>
<screeninfo>Overdues List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/overdues.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The report can be filtered using the menu options found on the
left of the report.</para>
</section>
<section id="overduesfines">
<title>Overdues with fines</title>
<para>This report will show you any overdues at your library that have
accrued fines on them.</para>
<screenshot>
<screeninfo>Overdues with fines</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/overduewfines.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you would like to limit the report you can use the pull down
menu at the top to limit to a specific shelving location at your
branch. To see overdues with fines at other branches you will have to
<link linkend="setlibrary">change your branch</link> or log in at that
branch.<important>
<para>If you do not charge fines and/or don't have the <link
linkend="finescronjob">fines cron job</link> running you will see
no data on this report.</para>
</important></para>
</section>
</section>
<section id="trackinhouse">
<title>Tracking Inhouse Use</title>
<para>Many libraries track the use of items within the library. This can
be done in Koha one of two ways. The first is to create one or more
<link linkend="addstatspatron">Statistical Patrons</link>. When
collecting items that have been used within the library, you will want
to check them out to your statistical patron:</para>
<screenshot>
<screeninfo>Check Out Items to Stats Patron</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/checkoutinhouse.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Instead of marking the item as 'checked out' the system will
record that the item was used in house:</para>
<screenshot>
<screeninfo>Local Use Recorded</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/localuserecorded.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Repeat these steps for all items that have been used within the
library to keep accurate statistics for item use.</para>
<para>The other way to record local use of items is to set your <link
linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link>
preference to 'Record.' Then whenever you check an item in that is not
checked out and not on hold a local use will be recorded.</para>
<screenshot>
<screeninfo>Local Use Recorded</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/localusecheckin.png"/>
</imageobject>
</mediaobject>
</screenshot>
<tip>
<para>If you have <link
linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link> set to
'Record' you can still use your statistical patrons to record local
use as well.</para>
</tip>
</section>
<section id="processinglocations">
<title>In Processing / Book Cart Locations</title>
<para>Koha allows for handling temporary locations like the processing
center and/or book carts throughout the library. For this feature to
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)
and CART (Book Cart).</para>
<screenshot>
<screeninfo>CART & PROC values in LOC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/LOCvalues.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Next you need to set the <link
linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link> system
preference to PROC. This will set the new items to the Processing Center
as their default location.</para>
<para>Create items with their desired final shelving location.</para>
<itemizedlist>
<listitem>
<para>These newly cataloged items will be temporarily set to the
PROC location and will display with whatever description PROC has.
The original location code entered at item creation is stored in the
new items column 'permanent_location', for future use. Items will
stay in the PROC location until they are checked in. To have those
items then move to the shelving cart:</para>
<orderedlist>
<listitem>
<para>Turn on the <link
linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>
system preference</para>
</listitem>
<listitem>
<para>Check in those newly-created items and they will be moved
to the location code of CART and display with whatever
description CART has.</para>
</listitem>
<listitem>
<para>A <link linkend="proccartcron">cron job</link> runs at
specified intervals to age items from CART to the permanent
shelving location. (For example, an hourly cron entry of
cart_to_shelf.pl --hours 3 where --hours is the amount of time
an item should spend on the cart before aging to its permanent
location.)</para>
<itemizedlist>
<listitem>
<tip>
<para>If the <link
linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
system preference is turned on, any newly checked-in item
is also automatically put into the shelving cart, to be
covered by the same script run.</para>
</tip>
</listitem>
<listitem>
<important>
<para>Checkins with confirmed holds will not go into the
shelving cart. If items on the shelving cart are checked
out, the cart location will be cleared.</para>
</important>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
</listitem>
</itemizedlist>
</section>
<section id="selfcheckout">
<title>Self Checkout</title>
<para>Koha comes with a very basic self checkout module. To enable this
module you need to set the <link
linkend="WebBasedSelfCheck">WebBasedSelfCheck</link> preference to
'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>
<tip>
<para>Create a <link linkend="addstaffpatron">staff patron</link>
specifically for this action so that you don't leave a real staff
client logged into a computer all day</para>
</tip>
<para>There is no link to the Self Checkout module, but a simple
addition to the <link linkend="intranetuserjs">intranetuserjs</link>
system preference can add one.</para>
<programlisting>$(document).ready(function(){ $("#login
#submit").parent().after("<p><a
href=\"http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl\";
target=\"_blank\">Self-Checkout</a></p>"); }); </programlisting>
<para>The link will then appear at the bottom of the log in page:</para>
<screenshot>
<screeninfo>Self Checkout Link on Staff Login</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/selfcheckoutlink.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also access this module by going to :
http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl</para>
<para>When on the self checkout page depending on your value in the
<link linkend="SelfCheckoutByLogin">SelfCheckoutByLogin</link>
preference you will be asked to enter you cardnumber</para>
<screenshot>
<screeninfo>Self Checkout Patron Card Number</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/selfcheckout.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>or your username and password:</para>
<screenshot>
<screeninfo>Shelf checkout by login</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you're logged in to the self check module you will be asked
to scan the items you are checking out</para>
<screenshot>
<screeninfo>Self Checkout</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/selfcheckoutuser.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>As you scan items they will appear below the barcode box</para>
<screenshot>
<screeninfo>Self Checkout Summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/selfcheckoutsummary.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When you are finished scanning items it is important to click the
'Click here if done' button to log the patron out and prepare for the
next patron.</para>
<para>When attempting to check items out there are some instances where
error messages will appear and the patron will be directed to the
librarian. This will happen even if you are allowing overrides on
circulation functions. Only a librarian can override a circulation block
and so patrons must go to the librarian for help in these
situations.</para>
<screenshot>
<screeninfo>Self Checkout Error Message</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/selfcheckoutfines.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="offlinecirc">
<title>Offline Circulation Utility</title>
<section id="firefoxofflinecirc">
<sectioninfo>
<author>
<firstname>Franois</firstname>
<surname>Charbonnier</surname>
</author>
<affiliation>
<orgname>BibLibre</orgname>
</affiliation>
<othercredit role="copyeditor">
<firstname>Nicole C.</firstname>
<surname>Engard</surname>
<contrib>Changed content where necessary.</contrib>
</othercredit>
<pubdate>2012</pubdate>
</sectioninfo>
<title>Firefox Plugin</title>
<para>There is an offline circulation tool that you can add to your
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>
page and click on the "install now" button. You may have to confirm
the installation, just click on "install now" and then restart Firefox
to complete the installation.</para>
<para>Once you have installed the plugin and restarted Firefox, you
will see the Koha logo in the add-on bar at the bottom right of
Firefox.</para>
<screenshot>
<screeninfo>Koha Icon on Add-on Bar</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/koctstatusbar.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>A click on the logo will open the tool in its own window.</para>
<screenshot>
<screeninfo>Koha Offline Circ Tool</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/koct.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The plugin consists of four tabs:</para>
<itemizedlist>
<listitem>
<para>The Check Out tab is where you check out items</para>
</listitem>
<listitem>
<para>The Check In tab is where you check in items</para>
</listitem>
<listitem>
<para>The Log tab keeps track of every transaction done while in
offline mode</para>
<itemizedlist>
<listitem>
<para>The log will keep information until you empty it. Each
time you open the plugin and it contains data in the log it
will warn you</para>
<screenshot>
<screeninfo>Koha Offline Circ Warning</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/koctwarn.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you'd like to clear the log, check the 'I want to
delete rows' box before hitting the 'OK' button. Otherwise
clicking 'OK' will keep the items in the log and let you
continue working with the tool.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>The Param tab is to set up the plugin</para>
</listitem>
</itemizedlist>
<para>The first thing you want to do then is to set up the plugin. Go
to the Param tab to set up the plugin</para>
<screenshot>
<screeninfo>Koha Offline CIrc Params</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/koctparam.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Answer the 4 questions presented:</para>
<itemizedlist>
<listitem>
<para>Server = the URL of the librarian interface</para>
</listitem>
<listitem>
<para>Branch Code = the code for the branch where you are
located</para>
</listitem>
<listitem>
<para>Username = your staff account login</para>
</listitem>
<listitem>
<para>Password = your staff account password</para>
</listitem>
</itemizedlist>
<para><important>
<para>To save the settings, you will have to close the plugin
window and re-open it by clicking again on the Koha logo in the
add-on bar.</para>
</important><tip>
<para>You can create a staff account dedicated to the offline
circulation. So that, no matter who is at the circulation desk,
they can all use the same login. Along those lines, you can use a
group login that you already have in place for circulation as
well.</para>
</tip>Once you have everything set up you can start checking items
in and out.</para>
<para>Checking out:</para>
<screenshot>
<screeninfo>Koha Offline Circulation Check Out</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/koct.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Go to the Check Out tab</para>
</listitem>
<listitem>
<para>Scan the patron barcode</para>
</listitem>
<listitem>
<para>Scan the item barcode</para>
</listitem>
<listitem>
<para>Click 'Save'</para>
</listitem>
</itemizedlist>
<para>Checking in:</para>
<screenshot>
<screeninfo>Koha Offline Circulation Check In</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/koctcheckin.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Go to the Check In tab</para>
</listitem>
<listitem>
<para>Scan the item barcode</para>
</listitem>
<listitem>
<para>Click Save</para>
</listitem>
</itemizedlist>
<para>Each time, you check out or check in an item, a new transaction
is recorded in the local plugin database and you will see, at the
bottom of the plugin how many transactions has been made during the
offline circulation. For example, "10 Row(s) Added" means you did 10
transactions.</para>
<screenshot>
<screeninfo>Koha Offline Circulation Tool Count</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/koctcount.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Then, if you want an overview of every transaction, go to the
Log tab. This tab will show you the transactions in the plugin
database</para>
<screenshot>
<screeninfo>Koha Offline Circulation Log</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/koctlog.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para><tip>
<para>The status will be "Local." as long as you are offline and
don't process the transactions into Koha.</para>
</tip>When your Internet connection comes back up you will want to
get these transactions in to Koha. Before processing these
transactions you should be aware of a few issues.</para>
<para>Because you are not connected to your Koha database when using
this plugin holds will need additional processing. If an item you
check in while offline has a hold, the hold is kept on the item.
Since, you can't confirm holds found during the processing of every
check in, the holds stay on the item and will need to be managed
later. If you only checked in a few items you can just keep a record
of them all. If you checked in a lot of items you can use the Holds
Queue once it rebuilds to see what holds made it to the shelf
erroneously.</para>
<para>Similarly, if an patron card was expired, the offline
circulation tool won't know about it, so the checkout will be recorded
regardless of the patron's account being blocked normally.</para>
<para>You have two options for adding this data to Koha</para>
<itemizedlist>
<listitem>
<para>Commit to Koha</para>
<itemizedlist>
<listitem>
<para>If you checked in/out on more than one computer at the
same time, what you want is to process every transaction
consistently. Let's say for instance that one patron checked a
book out on one computer and then checked the same book in on
another computer. To be consistent, you need to record the
check out first and then the check in. Not the opposite! To do
so, you need to group every transaction in one place, sort
them all and then, process everything. So, you need to use the
"Commit to Koha" option from every plugin/computer you worked
with. This way, the log will go to Koha and be accessible from
the Offline Circulation page.</para>
<screenshot>
<screeninfo>Circulation Menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/offlinecirclink.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para><emphasis>Get there:</emphasis> Circulation > Offline
Circulation (Firefox add-on)</para>
<screenshot>
<screeninfo>Offline Circulation</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/offlinecirclog.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Once all of the logs from all of the circulation
computers are loaded you will be able to check them all or
select just those you want to process into Koha.</para>
</listitem>
<listitem>
<para>Click on the Process button and Koha will record every
sorted transaction one by one. For each transaction, the
status will change to:</para>
<itemizedlist>
<listitem>
<para>"Success." if the transaction was processed
correctly</para>
</listitem>
<listitem>
<para>"Borrower not found." if the borrower card number is
incorrect</para>
</listitem>
<listitem>
<para>"Item not found." if the item barcode is
wrong</para>
</listitem>
<listitem>
<para>"Item not issued." if you checked in an available
item</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Once finished you will have a summary of all of your
transactions</para>
<screenshot>
<screeninfo>Offline Circulation Summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/offlinecircsuccess.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Apply directly</para>
<itemizedlist>
<listitem>
<para>If you performed all of the circulation actions on one
computer then everything is sorted already so you can choose
to "Apply directly"</para>
</listitem>
<listitem>
<para>The status column will be updated to let you know if the
transactions were applied</para>
<itemizedlist>
<listitem>
<para>"Success." if the transaction was processed
correctly</para>
</listitem>
<listitem>
<para>"Borrower not found." if the borrower card number is
incorrect</para>
</listitem>
<listitem>
<para>"Item not found." if the item barcode is
wrong</para>
</listitem>
<listitem>
<para>"Item not issued." if you checked in an available
item</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Once you're finished you can review all of the items
right in the Log tab</para>
<screenshot>
<screeninfo>Koha Offlince Circulation Apply
Directly</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/koctdirectly.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Once you are done you can clear the log by clicking Clear. If
you don't you will be warned the next time you open the Offline
Circulation tool.</para>
<screenshot>
<screeninfo>Koha Offlince Circulation Tool Warning</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/koctwarn.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="windowsofflinecirc">
<title>Offline Circ Tool for Windows</title>
<para>The Offline Circulation Utility can be downloaded at: <ulink
url="http://millruntech.com/koha/koha-offline-circulation";>http://millruntech.com/koha/koha-offline-circulation</ulink></para>
</section>
<section id="uploadofflinecirc">
<title>Upload Offline Circ File</title>
<para>The <link linkend="windowsofflinecirc">offline circulation tool
for Windows</link> will generate a KOC file that you can upload into
Koha once your system comes back up.</para>
<para>On the Circulation menu click 'Offline Circulation File (.koc)
Uploader'</para>
<screenshot>
<screeninfo>Circulation menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/offlinecirclink.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Browse your computer for the *.koc file</para>
<screenshot>
<screeninfo>Upload KOC File</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/uploadofflinecirc.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once the file is uploaded, click the process the file</para>
<screenshot>
<screeninfo>Process offline circulation file</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/processoffline.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When this is complete you'll see the summary of actions from
when you were offline (including any errors).</para>
<screenshot>
<screeninfo>Summary of offline actions</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/circ/offlinesummary.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
</chapter>
<chapter id="cataloging">
<title>Cataloging</title>
<para>Before you start cataloging in Koha you're going to want to do some
basic setup. Refer to the <link linkend="implementation">Implementation
Checklist</link> for a full list of these things. Most importantly you're
going to want to make sure that your <link
linkend="marcbibframeworks">Frameworks</link> are all defined the way you
want. Once in the cataloging module you will not be able to add or remove
fields and subfields so your frameworks must be ready before you start
cataloging.</para>
<section id="catbibs">
<title>Bibliographic Records</title>
<para/>
<section id="addbibrec">
<title>Adding Records</title>
<para>Records can be added to Koha via original or copy cataloging. If
you would like to catalog a record using a blank template</para>
<itemizedlist>
<listitem>
<para>Click 'New Record'</para>
<screenshot>
<screeninfo>New Record Menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/newfromframework.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Choose the framework you would like to base your record
off of</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>If you want to catalog a record based on an existing record at
another library</para>
<itemizedlist>
<listitem>
<para>Click 'z39.50 Search'</para>
<screenshot>
<screeninfo>Z39.50 Search</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/zsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Search for the item you would like to catalog</para>
<itemizedlist>
<listitem>
<tip>
<para>If no results are found, try searching for fewer
fields, not all Z39.50 targets can search all of the
fields above.</para>
</tip>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Search targets can be altered by using the <link
linkend="z3950admin">Z39.50 Admin</link> area.</para>
</listitem>
<listitem>
<para>From the results you can view the MARC or Card view for
the records or choose to Import them into Koha</para>
<screenshot>
<screeninfo>Z39.50 Search Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/zsearchresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>In addition to the Import link to the right of each
title, you can click on the title you're interested in and
a menu will pop up with links to preview the record and
import it</para>
<screenshot>
<screeninfo>Import Link Popup on Z39.50 Search
Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/importz39.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>If you don't find the title you need in your Z39.50
search results you can click the 'Try Another Search'
button at the bottom left of your results</para>
<screenshot>
<screeninfo>Try another search</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/tryanotherzsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Once you've opened a blank framework or imported a record via
Z39.50 you will be presented with the form to continue
cataloging</para>
<screenshot>
<screeninfo>Add MARC Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/addmarc.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>To expand a collapsed tag click on the tag
description</para>
</listitem>
<listitem>
<para>To get help from the Library of Congress on a Marc tag click
the question mark (?) to the right of each field number</para>
<itemizedlist>
<listitem>
<para>If you feel that this clutters the screen you can hide
the question marks by unchecking the box next to the 'Show
MARC tag documentation links' note at the top right of the
editor</para>
<screenshot>
<screeninfo>Show MARC tag documentation links
checkbox</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/marcdoclinks.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Sometimes fields may not be editable due to the value in
your <link
linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
system preference. If you have this preference set to not allow
catalogers to type in fields controlled by authorities you may see
a lock symbol to the left of the field.</para>
<screenshot>
<screeninfo>Authority fields locked against editing</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/lockedauthority.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>If this icon appears you must click the icon to the
right of the field to search for an existing authority.</para>
<screenshot>
<screeninfo>Search for authority</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/catauthoritysearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>From the results list click 'Choose authority' to bring
that into your catalog record</para>
<screenshot>
<screeninfo>Authority search results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/catauthoritysearchresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>To duplicate a field click on the 'repeat this tag' icon to
the right of the tag</para>
<screenshot>
<screeninfo>Duplicate a Field</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/dupfield.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>To move subfields in to the right order, click the up
arrow to the left of the field</para>
</listitem>
<listitem>
<para>To duplicate a subfield click on the clone icon (to
remove a copied field, click the delete clone icon) to the
right of the field</para>
<screenshot>
<screeninfo>Clone Subfield</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/clonesubfield.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>To remove a subfield (if there is more than one of the
same type), click the - (minus sign) to the right of the
field</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>To use a plugin click on the icon to the right of the
filed</para>
<screenshot>
<screeninfo>Leader Builder Plugin</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/leaderbuilder.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Some fixed fields have editors that will change based on
the material type you're cataloging (for example the 006 and
the 008 fields)</para>
<screenshot>
<screeninfo>008 Plugin</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/008plugin.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Once you've finished, click the 'Save' button at the top and
choose whether you want to save and view the bib record you have
created or continue on to add/edit items attached to the
record</para>
<screenshot>
<screeninfo>Record save options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/savecataloging.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>If you are about to add a duplicate record to the system
you will be warned before saving</para>
<screenshot>
<screeninfo>Duplicate Record Warning</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/duprecordwarn.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="cataloganalytics">
<title>Adding Analytic Records</title>
<para>Libraries sometimes make journal articles and articles within
monographs and serials accessible to library patrons through analytics
cataloging. Analytics cataloging creates separate bibliographic
records for these articles, chapters, sections, etc. found within a
larger resource such as a book, an article within a journal, newspaper
or serial. In analytics cataloging, although a separate bib record is
created for the title, it is not physically separated from the host
item. Learn more about Analytics in Chapter 13 of AACR2.</para>
<para>If you would like to catalog analytic records in Koha you first
need to update the <link
linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link>
preference to 'Display.'</para>
<para>After cataloging your analytic record (see <link
linkend="addbibrec">Adding Records</link> for more on creating
records) click 'Edit' from the normal view and choose to 'Link to Host
Item'</para>
<screenshot>
<screeninfo>Link to Host Item</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/analyticslink.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>This will prompt you to enter the barcode for the item this
record should be linked to.</para>
<screenshot>
<screeninfo>Barcode for Analytic Linking</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/analyticsbarcode.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>After entering the item's barcode and clicking 'Select' you will
receive a confirmation message.</para>
<screenshot>
<screeninfo>Analytic Link Success</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/analyticlinksuccess.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The record will now have the 773 field filled in properly to
complete the link.</para>
<screenshot>
<screeninfo>773</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/analytics773.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you have linked an analytic record incorrectly you can remove
that link by editing the item on the analytic record (not the host
record). To do this, go to the analytic record and click the 'Edit'
button and choose to 'Edit items'. To the left of each item you will
see two options.</para>
<screenshot>
<screeninfo>Edit Analytic Item Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/analyticdelink.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Clicking 'Edit in Host' will allow you to edit the item on
the host record.</para>
</listitem>
<listitem>
<para>Clicking 'Delink' will remove the 773 field and the link
between the analytic and the host.</para>
</listitem>
</itemizedlist>
<para>To view all of the items tied to the host record, do a search
for the record, click the Analytics tab on the left and the analytics
tied to each barcode will be shown under the "Used in" column.</para>
<screenshot>
<screeninfo>Analytics Tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/analyticstab.png"/>
</imageobject>
</mediaobject>
</screenshot>
<tip>
<para>It is also possible to create analytic records from this
screen by clicking on "Create Analytics"</para>
</tip>
<para>You can also see the analytics attached to this record by
clicking the 'Show Analytic' link towards the top of the record in the
normal view.</para>
<screenshot>
<screeninfo>Show Analytics on Bib Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/anayticbib.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="editbibrec">
<title>Editing Records</title>
<para>To edit a record you can click 'Edit Biblio' from the search
results on the cataloging page</para>
<screenshot>
<screeninfo>Edit Biblio Option on Search Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/catalogsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>or by clicking the Edit button on the Bibliographic Record and
choosing 'Edit Record'</para>
<screenshot>
<screeninfo>Edit Record Option on Bibliographic Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/editrecord.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The record will open in the MARC editor</para>
<screenshot>
<screeninfo>Editing MARC Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/editingrecord.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The alternative is to search via Z39.50 to overlay your record
with a fuller record found at another library. You can do this by
choosing 'Replace Record via Z39.50' from the Edit menu.</para>
<screenshot>
<screeninfo>Replace via Z39.50</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/replaceviaz39.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you choose that you will be brought to a Z39.50 search
window to search other libraries for the record in question.</para>
<para>Once you have made your edits (via either method) you can click
'Save' at the top left of the editor.</para>
<para>You can also use the edit menu to add your own custom cover
image if you have either <link
linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> and/or
<link linkend="LocalCoverImages">LocalCoverImages</link> set to
'Display' by choosing 'Upload Image' from the menu.</para>
<screenshot>
<screeninfo>Upload Image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/uploadimage.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Choosing to 'Upload Image' will take you to the <link
linkend="uploadlocalimages">Upload Local Cover Image
Tool</link>.</para>
</section>
<section id="dupbibrec">
<title>Duplicating Records</title>
<para>Sometimes a copy of the record you need to catalog can't be
found via Z39.50. In these cases you can create a duplicate of similar
record and edit the necessary pieces to create a new record. To
duplicate an existing record click 'Edit as New (Duplicate)' from the
Edit menu on the Bibliographic Record</para>
<screenshot>
<screeninfo>Edit as New (Duplicate) Bibliographic
Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/createduplicate.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>This will open a new MARC record with the fields filled in with
the values from the original Bibliographic Record.</para>
<screenshot>
<screeninfo>New Duplicate Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/newduprecord.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="mergebibs">
<title>Merging Records</title>
<para>If you would like to merge together multiple records you can do
that via the <link linkend="lists">Lists</link> tool. <link
linkend="mergebibrecs">Learn more here</link>.</para>
</section>
</section>
<section id="catitems">
<title>Item Records</title>
<para/>
<section id="addingitems">
<title>Adding Items</title>
<para>After saving a new bibliographic record, you will be redirected
to a blank item record so that you can attach an item to the
bibliographic record. You can also click 'Add Holdings' from the
cataloging search results</para>
<screenshot>
<screeninfo>Add Holdings Option on Search Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/catalogsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>or you can add new item at any time by clicking 'New' on the
bibliographic record and choosing 'New Item'</para>
<screenshot>
<screeninfo>New Item Button</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/newitem.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The item edit form will appear:</para>
<screenshot>
<screeninfo>Add item form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/additem.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>At the very least, if you plan on circulating the item, the
following fields should be entered for new items:</para>
<itemizedlist>
<listitem>
<para>2 - Source of classification</para>
</listitem>
<listitem>
<para>a - Permanent location</para>
</listitem>
<listitem>
<para>b - Current location</para>
</listitem>
<listitem>
<para>o - Full call number</para>
</listitem>
<listitem>
<para>p - Barcode</para>
</listitem>
<listitem>
<para>v - Cost, replacement price</para>
<itemizedlist>
<listitem>
<para>This value will be charged to patrons when you mark an
item they have checked out as 'Lost'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>y - Koha item type</para>
</listitem>
</itemizedlist>
<para>To make sure that these values are filled in you can mark them
as mandatory in the <link linkend="marcbibframeworks">framework</link>
you're using and then they will appear in red with a 'required' label.
The item will not save until the required fields are filled in.</para>
<screenshot>
<screeninfo>Required Item Subfield</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/requireditemfields.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<tip>
<para>To make item subfields required in a framework you'll want
to edit the 952 field in the <link
linkend="marcbibframeworks">framework editor</link>.</para>
</tip>
</listitem>
</itemizedlist>
<para>Below the add form there are 3 buttons for adding the
item</para>
<screenshot>
<screeninfo>Add Item Buttons</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/additembuttons.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Add Item will add just the one item</para>
</listitem>
<listitem>
<para>Add & Duplicate will add the item and fill in a new form
with the same values for your to alter</para>
</listitem>
<listitem>
<para>Add Multiple Copies will ask how many copies and will then
add that number of copies adding +1 to the barcode so each barcode
is unique</para>
</listitem>
</itemizedlist>
<para>Your added items will appear above the add form once
submitted</para>
<screenshot>
<screeninfo>Items</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/items.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Your items will also appear below the bibliographic details on
the bib record display.</para>
<screenshot>
<screeninfo>List of Items on the Bib Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/items-withoutlabelprint.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you have SpineLabelShowPrintOnBibDetails set to 'Display'
then there will also be a link to print a quick spine label next to
each item.</para>
<screenshot>
<screeninfo>List of Items on the Bib Record with a Print Label
link</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/items-withlabelprint.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="editingitems">
<title>Editing Items</title>
<para>Items can be edited in several ways.</para>
<itemizedlist>
<listitem>
<para>Clicking 'Edit' and 'Edit Items' from the bibliographic
record</para>
<screenshot>
<screeninfo>Edit Items Menu Option</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/edititem.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Clicking 'Edit Items' beside the item on the 'Items'
tab</para>
<screenshot>
<screeninfo>Items Tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/itemstab.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<para>The edit menu is also where items can be deleted from:</para>
<screenshot>
<screeninfo>Edit and Delete links for Items</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/edititemlink.png"/>
</imageobject>
</mediaobject>
</screenshot>
<section id="itemquickedit">
<title>Quick Item Status Updates</title>
<para>Often circulation staff need to change the status of an item
to Lost or Damaged. This doesn't require you to edit the entire item
record. Instead clicking on the item barcode on the checkout summary
or checkin history will bring you to an item summary. You can also
get to the item summary by clicking on the Items tab to the left of
the bib detail page.</para>
<screenshot>
<screeninfo>Item Edit</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/quickitemedit.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From this view you can mark an item lost by choosing a lost
status from the pull down and clicking the 'Set Status'
button.</para>
<screenshot>
<screeninfo>Edit Lost Status</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/editloststatus.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also mark an item as damaged by choosing a damaged
status from the pull down and clicking the 'Set Status'
button.</para>
<screenshot>
<screeninfo>Edit Damaged Status</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/editdamagedstatus.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="iteminfo">
<title>Item Information</title>
<para>To the left of every bibliographic record there is a tab to view
the items.</para>
<screenshot>
<screeninfo>Items Tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/itemstab-long.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking that tab will give you basic information about the
items. If you ordered the item via the acquisitions module then the
History section will include information about the order.</para>
<screenshot>
<screeninfo>History with order info</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/itemorderinfo.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If the Order or Accession date is linked, clicking it will bring
you to the acquisitions information for that item.</para>
</section>
<section id="moveitemrec">
<title>Moving Items</title>
<para>Items can be moved from one bibliographic record to another
using the Attach Item option</para>
<screenshot>
<screeninfo>Attach Item Option</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/attachitem.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Visit the bibliographic record you want to attach the item to
and choose 'Attach Item' from the 'Edit' menu.</para>
<screenshot>
<screeninfo>Attach Item Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/attachitemform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Simply enter the barcode for the item you want to move and click
'Select'</para>
<para>If you want to move all items to a new record creating only one
bibliographic record you can use the <link
linkend="mergebibrecs">Merge Records tool</link> instead.</para>
</section>
<section id="deleteitems">
<title>Deleting Items</title>
<para>There are many ways to delete item records. If you only need to
delete one item you can do this by opening up the detail page for the
bib record and clicking the 'Edit' button at the top. From there you
can choose to 'Edit items'.</para>
<screenshot>
<screeninfo>'Edit Items' menu option</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/edititemstodelete.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You will be presented with a list of items and next to each one
will be a link labeled 'Delete'. Click that link and if the item is
not checked out it will delete that item.</para>
<screenshot>
<screeninfo>Delete link on the left</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/deleteitemlink.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you know that all of the items attached to your record are
not currently checked out you can use the 'Delete all items' option
under the 'Edit menu' and it will remove all items from the
record.</para>
<para>Finally you can use the <link linkend="batchdeleteitems">batch
delete tool</link> to delete a batch of items.</para>
</section>
<section id="itemcirchistory">
<title>Item Specific Circulation History</title>
<para>Each bibliographic record keeps a circulation history (with or
without the patron information depending on your settings), but each
item also has its own circulation history page. To see this, click on
the 'Items' tab to the left of the record you are viewing.</para>
<screenshot>
<screeninfo>Items tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/itemstab-long.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Below the 'History' heading is a link to 'View item's checkout
history,' clicking that will open up the item's history which will
look slightly different from the bibliographic record's history
page.</para>
<screenshot>
<screeninfo>Item Specific Circulation History</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/itemspecifichistory.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="catauthorities">
<title>Authorities</title>
<para>Authority records are a way of controlling fields in your MARC
records. Using authority records will provide you with control over
subject headings, personal names and places.</para>
<section id="addauthorities">
<title>Adding Authorities</title>
<para>To add a new authority record, choose the authority type from
the 'New Authority' button.</para>
<screenshot>
<screeninfo>New Authority Record Options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/newauthtypes.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The form that appears will allow you to enter all of the
necessary details regarding your authority record.</para>
<screenshot>
<screeninfo>New Authority Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/newauthrec.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To expand collapsed values simply click on the title and the
subfields will appear.</para>
</section>
<section id="searchauthorities">
<title>Searching Authorities</title>
<para>From the authorities page you can search for existing terms and
the bibliographic records they are attached to.</para>
<screenshot>
<screeninfo>Authority Search</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/authoritysearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From the results you will see the authority record, how many
bibliographic records it is attached to, and a delete link (if there
are not bibliographic records attached).</para>
<screenshot>
<screeninfo>Authority Search Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/authorityresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking on the authority record summary will open the full
record and the option to edit the record.</para>
<screenshot>
<screeninfo>Authority Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/authrecord.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="editauthorities">
<title>Editing Authorities</title>
<para>Authorities can be edited by clicking on the authority summary
from the search results and then clicking the 'Edit' button above the
record.</para>
<screenshot>
<screeninfo>Edit Authority Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/editauthority.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you've made the necessary edits, simply click 'Save' and if
you have the <link linkend="dontmerge">dontmerge</link> system
preference set to 'Do' the next time the <link
linkend="mergeauthcron">merge_authorities.pl cronjob</link> runs it
will update all of the bib records that use that authority.</para>
<para>To delete an authority record you first must make sure it's not
linked to any bibliographic records. If it is not used by any
bibliographic records a 'Delete' link will appear to the right of the
record on the search results and as a button that appears after
clicking on the summary of the authority record.</para>
</section>
</section>
<section id="catguides">
<title>Cataloging Guides</title>
<para/>
<section id="bibcatcheatsheet">
<sectioninfo>
<author>
<firstname>Jared</firstname>
<surname>Camins-Esakov</surname>
</author>
<affiliation>
<orgname>American Numismatic Society</orgname>
</affiliation>
<othercredit role="copyeditor">
<firstname>Nicole C.</firstname>
<surname>Engard</surname>
<contrib>Changed content where necessary.</contrib>
</othercredit>
<pubdate>2010</pubdate>
</sectioninfo>
<title>Bibliographic Record Cataloging Cheat Sheet</title>
<table cellpadding="4" cellspacing="4" frame="all">
<title>Cataloging Guide</title>
<tgroup align="left" cols="4" colsep="1" rowsep="1">
<thead>
<row>
<entry><para>Tag</para></entry>
<entry><para>Label</para></entry>
<entry><para>Description</para></entry>
<entry><para>Instructions</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>000</para></entry>
<entry><para>LEADER</para></entry>
<entry><para>Describes the record(i.e. surrogate) -- is it a
record for a monograph? A serial?</para></entry>
<entry><para>Click in this field to fill it in. Then set
"Bibliographic level" to 'a' for articles or 's' for serials.
Otherwise, leave everything as is.</para></entry>
</row>
<row>
<entry><para>001</para></entry>
<entry><para>CONTROL NUMBER</para></entry>
<entry><para>Accession number.</para></entry>
<entry><para>Enter the accession number written inside the
item here. For articles and items which do not have accession
numbers, leave blank.</para></entry>
</row>
<row>
<entry><para>003</para></entry>
<entry><para>CONTROL NUMBER IDENTIFIER</para></entry>
<entry><para>Your MARC Organizational Code</para></entry>
<entry><para>Click in this field to fill it in (will auto fill
if you have your <link
linkend="MARCOrgCode">MARCOrgCode</link> preference
set).</para></entry>
</row>
<row>
<entry><para>005</para></entry>
<entry><para>D & T LATEST TRANSACTION</para></entry>
<entry><para>Current date and time.</para></entry>
<entry><para>Click in this field to fill it in.</para></entry>
</row>
<row>
<entry><para>008</para></entry>
<entry><para>FIXED-LENGTH DATA ELEMENTS</para></entry>
<entry><para>Field containing computer-readable
representations of a number of things.</para></entry>
<entry><para>Generally you will only use 's' (single) or 'm'
(multiple) options for position 06- use the former when the
item was published in a single year, the latter when it was
published over the course of several. If there is a single
date, only enter a date in the first date field (positions
07-10). Enter the three-digit country code in positions 15-17,
being sure to add spaces if the country code is fewer than
three characters long. If there is an index, note that fact in
position 31. Enter the three-letter language code in positions
35-37.</para></entry>
</row>
<row>
<entry><para>010</para></entry>
<entry><para>LCCN</para></entry>
<entry><para>A number assigned by the Library of Congress to
uniquely identify the work.</para></entry>
<entry><para>Check on the copyright page of the book (if it
was published in the US) or the LC catalog for this number. If
you can't find it, don't worry about it.</para></entry>
</row>
<row>
<entry><para>020</para></entry>
<entry><para>ISBN</para></entry>
<entry><para>Unique number used by publishers to identify
books.</para></entry>
<entry><para>If this number isn't listed on the book, there
probably isn't one.</para></entry>
</row>
<row>
<entry><para>022</para></entry>
<entry><para>ISSN</para></entry>
<entry><para>Unique number used by publishers to identify
serials.</para></entry>
<entry><para>If this number isn't listed on the book, there
probably isn't one.</para></entry>
</row>
<row>
<entry><para>033</para></entry>
<entry><para>DATE/TIME OF EVENT</para></entry>
<entry><para>Used for auction dates. Required for auction
catalogs.</para></entry>
<entry><para>For auctions that took place on only one day,
enter the date of the auction in the format YYYYMMDD in the
subfield 'a' and a '0' in the first indicator. For auctions
that took place over two consecutive days or any number of
non-consecutive days, create a subfield 'a' for each day with
the date in the format YYYYMMDD, and put a '1' in the first
indicator. For auctions that took place over more than two
consecutive days, create a subfield 'a' (in format YYYYMMDD)
for the first day and a subfield 'a' (also in format YYYYMMDD)
for the last day, and put a '2' in the first
indicator.</para></entry>
</row>
<row>
<entry><para>040</para></entry>
<entry><para>CATALOGING SOURCE</para></entry>
<entry><para>Identifies which libraries created and modified
the record.</para></entry>
<entry><para>For imported records, add a subfield 'd' with
your OCLC code as the value. For new records, make sure that
the subfield 'c' with your OCLC code as the
value.</para></entry>
</row>
<row>
<entry><para>041</para></entry>
<entry><para>LANGUAGE CODE</para></entry>
<entry><para>Identifies all the languages used in an item,
when two or more languages are present.</para></entry>
<entry><para>For significant portions of a text in a given
language, there should be a subfield 'a' with that language
code. If there are only summaries or abstracts in a specific
language, create a subfield 'b' with that language
code.</para></entry>
</row>
<row>
<entry><para>100</para></entry>
<entry><para>MAIN ENTRY--PERSONAL</para></entry>
<entry><para>Authorized form of the main author's
name</para></entry>
<entry><para>See Authorized headings sheet and AACR2. The
first indicator should generally be a '1', to indicate that
the entry is surname first. If the name consists only of a
forename, however, the first indicator should be
'0'.</para></entry>
</row>
<row>
<entry><para>110</para></entry>
<entry><para>MAIN ENTRY--CORPORATE</para></entry>
<entry><para>Authorized form of the name of the main corporate
author. Required for auction catalogs.</para></entry>
<entry><para>Auction catalogs should use a 110 field rather
than a 100 field. See Authorized headings sheet and AACR2. Set
the first indicator to '2'.</para></entry>
</row>
<row>
<entry><para>111</para></entry>
<entry><para>MAIN ENTRY--MEETING</para></entry>
<entry><para>Authorized form of the name of a meeting which
acted as a main offer (e.g. conference
proceedings)</para></entry>
<entry><para>See Authorized headings sheet and AACR2. Set the
first indicator to '2'.</para></entry>
</row>
<row>
<entry><para>245</para></entry>
<entry><para>TITLE STATEMENT</para></entry>
<entry><para>Transcription of the title statement from the
title page (or chief source of information)</para></entry>
<entry><para>Enter the title in subfield 'a', the subtitle in
subfield 'b', and the statement of responsibility in subfield
'c'. If you are creating a record for a single volume or part
of a multi-part item, you should put the part number in
subfield 'n' and the part title in subfield 'p.' For auction
catalogs, the date (in 'MM/DD/YYYY' format) should be listed
in square brackets in subfield 'f'. See ISBD punctuation
sheet. Set the first indicator to '0' if there is no author,
otherwise set it to '1'. Set the second indicator to the
number of non-filing characters (i.e. characters in an initial
articles plus the space... for "The " set the second indicator
to '4').</para></entry>
</row>
<row>
<entry><para>246</para></entry>
<entry><para>VARYING FORM OF TITLE</para></entry>
<entry><para>Alternate form of title for searching and filing
purposes</para></entry>
<entry><para>If the patron might look for the work under a
different title, enter it here. Do not include initial
articles. The first indicator should be '3', unless the title
is merely a variant spelling, in which case the first
indicator should be '1'.</para></entry>
</row>
<row>
<entry><para>250</para></entry>
<entry><para>EDITION STATEMENT</para></entry>
<entry><para>Transcription of the edition statement from the
title page (or chief source of information)</para></entry>
<entry><para>Transcribe the edition statement exactly as it
appears on the title-page. You may abbreviate if the edition
statement is very long.</para></entry>
</row>
<row>
<entry><para>260</para></entry>
<entry><para>PUBLICATION (IMPRINT)</para></entry>
<entry><para>Publication information.</para></entry>
<entry><para>Put the location of publication in subfield 'a',
the publisher in subfield 'b', and the year (or probable year)
in subfield 'c'. See ISBD punctuation sheet.</para></entry>
</row>
<row>
<entry><para>300</para></entry>
<entry><para>PHYSICAL DESCRIPTION</para></entry>
<entry><para>Physical description</para></entry>
<entry><para>Enter the pagination statement in subfield 'a', a
brief description of "special" contents such as illustrations
or maps in subfield 'b' (see AACR2), and the size of the item
in subfield 'c'. See ISBD punctuation sheet.</para></entry>
</row>
<row>
<entry><para>490</para></entry>
<entry><para>SERIES STATEMENT</para></entry>
<entry><para>Shows the series statement exactly as it appears
on the item.</para></entry>
<entry><para>Transcribe the series statement into subfield 'a'
with the volume number in subfield 'v'. See ISBD punctuation
sheet. Set the first indicator to '1' if you are using an 830.
As a general rule, you should do so.</para></entry>
</row>
<row>
<entry><para>500</para></entry>
<entry><para>GENERAL NOTE</para></entry>
<entry><para>Notes that don't fit anywhere
else.</para></entry>
<entry><para>Enter notes as full sentences, with a separate
500 field for each distinct topic.</para></entry>
</row>
<row>
<entry><para>501</para></entry>
<entry><para>WITH NOTE</para></entry>
<entry><para>Notes whether the work is bound with the works
described by other records.</para></entry>
<entry><para>Put description of relationship in subfield
'a'.</para></entry>
</row>
<row>
<entry><para>504</para></entry>
<entry><para>BIBLIOGRAPHY, ETC. NOTE</para></entry>
<entry><para>Indicates whether the work includes a
bibliography.</para></entry>
<entry><para>If the work includes a bibliography and index,
put the text "Includes bibliographical references (p. XXX-XXX)
and index." in subfield 'a'. If the work does not include an
index, remove that part of the sentence. If the references are
scattered throughout the work and not gathered into a distinct
sentence, remove the parenthetical statement.</para></entry>
</row>
<row>
<entry><para>505</para></entry>
<entry><para>FORMATTED CONTENTS</para></entry>
<entry><para>List of contents in a standard format.
Unformatted contents can be listed in a 500 (General Note)
field.</para></entry>
<entry><para>See ISBD punctuation sheet. Set the first
indicator to '0'. If you are separately coding authors and
titles, set the second indicator to '0'. Otherwise, leave the
second indicator blank.</para></entry>
</row>
<row>
<entry><para>518</para></entry>
<entry><para>DATE/TIME OF EVENT NOTE</para></entry>
<entry><para>Used for auction dates.</para></entry>
<entry><para>For auction catalogs, enter the date of the
auction in the format 'January 2, 1984' in the subfield
'a'</para></entry>
</row>
<row>
<entry><para>520</para></entry>
<entry><para>SUMMARY, ETC.</para></entry>
<entry><para>A brief summary or abstract of the book or
article.</para></entry>
<entry><para>In general you do not need to write a summary. A
summary might be called for, however, with items that cannot
be easily reviewed by a patron, such as books with highly
acidic paper or CD-ROMs.</para></entry>
</row>
<row>
<entry><para>546</para></entry>
<entry><para>LANGUAGE NOTE</para></entry>
<entry><para>Note describing the languages used in the
work</para></entry>
<entry><para>Only needed for works in multiple languages. See
ISBD punctuation sheet.</para></entry>
</row>
<row>
<entry><para>561</para></entry>
<entry><para>PROVENANCE INFORMATION</para></entry>
<entry><para>Describes the previous ownership of the
item.</para></entry>
<entry><para>Used only for rare books.</para></entry>
</row>
<row>
<entry><para>563</para></entry>
<entry><para>BINDING INFORMATION</para></entry>
<entry><para>Describes the binding of the item.</para></entry>
<entry><para>Used only for rare books.</para></entry>
</row>
<row>
<entry><para>590</para></entry>
<entry><para>LOCAL NOTE</para></entry>
<entry><para>Local notes. Required for auction
catalogs.</para></entry>
<entry><para>Used for auction catalogs to indicate what types
of coins are sold in the auction- Roman, Greek,
etc.</para></entry>
</row>
<row>
<entry><para>600</para></entry>
<entry><para>SUBJECT ADDED--PERSONAL</para></entry>
<entry><para>Authorized form of personal names for people
discussed in the work</para></entry>
<entry><para>See Authorized headings sheet and AACR2. The
first indicator should generally be a '1', to indicate that
the entry is surname first. If the name consists only of a
forename, however, the first indicator should be '0'. If you
found the name in the LC authority file, set the second
indicator to '0'. Otherwise set the second indicator to
'4'.</para></entry>
</row>
<row>
<entry><para>610</para></entry>
<entry><para>SUBJECT ADDED--CORPORATE</para></entry>
<entry><para>Authorized form of corporate names for
organizations discussed in the work</para></entry>
<entry><para>See Authorized headings sheet and AACR2. Set the
first indicator to '2'. If you found the name in the LC
authority file, set the second indicator to '0'. Otherwise set
the second indicator to '4'.</para></entry>
</row>
<row>
<entry><para>611</para></entry>
<entry><para>SUBJECT ADDED--MEETING</para></entry>
<entry><para>Authorized form of meeting names for meetings
discussed in the work</para></entry>
<entry><para>See Authorized headings sheet and AACR2. Set the
first indicator to '2'. If you found the name in the LC
authority file, set the second indicator to '0'. Otherwise set
the second indicator to '4'.</para></entry>
</row>
<row>
<entry><para>630</para></entry>
<entry><para>SUBJECT ADDED--UNIFORM TITLE</para></entry>
<entry><para>Authorized form of titles for other works
discussed in the work</para></entry>
<entry><para>See Authorized headings sheet and AACR2. Set the
first indicator to the number of non-filing characters (i.e.
characters in an initial articles plus the space... for "The "
set the first indicator to '4'). If you found the name in the
LC authority file, set the second indicator to '0'. Otherwise
set the second indicator to '4'.</para></entry>
</row>
<row>
<entry><para>650</para></entry>
<entry><para>SUBJECT ADDED--TOPICAL</para></entry>
<entry><para>Library of Congress Subject Heading terms
describing the subject of the work</para></entry>
<entry><para>See Authorized headings sheet and AACR2. If you
found the name in the LC authority file, set the second
indicator to '0'. Otherwise set the second indicator to
'4'.</para></entry>
</row>
<row>
<entry><para>651</para></entry>
<entry><para>SUBJECT ADDED--GEOGRAPHICAL</para></entry>
<entry><para>Library of Congress Subject Heading geographical
terms describing the subject of the work</para></entry>
<entry><para>See Authorized headings sheet and AACR2. If you
found the name in the LC authority file, set the second
indicator to '0'. Otherwise set the second indicator to
'4'.</para></entry>
</row>
<row>
<entry><para>655</para></entry>
<entry><para>INDEX TERM--GENRE/FORM</para></entry>
<entry><para>Describes what an item is as opposed to what the
item is about.</para></entry>
<entry><para>Generally used only for auction catalogs, which
should have the genre heading "Auction catalogs." (make sure
to find the authorized heading!) If you found the name in the
LC authority file, set the second indicator to '0'. If you are
using a term from a specific thesaurus, set the second
indicator to '7' and put the code for the thesaurus in
subfield '2'. Otherwise set the second indicator to
'4'.</para></entry>
</row>
<row>
<entry><para>690</para></entry>
<entry><para>LOCAL SUBJECT ADDED--TOPICAL</para></entry>
<entry><para>Used for headings from any custom subject
authority file.</para></entry>
<entry><para>If there is no appropriate LCSH term, you can use
a 690 with subject headings you find on other items in the
catalog.</para></entry>
</row>
<row>
<entry><para>691</para></entry>
<entry><para>LOCAL SUBJECT ADDED--GEOGRAPHICAL</para></entry>
<entry><para>Used for headings from any custom subject
authority file.</para></entry>
<entry><para>If there is no appropriate LCSH term, you can use
a 691 with subject headings you find on other items in the
catalog.</para></entry>
</row>
<row>
<entry><para>700</para></entry>
<entry><para>ADDED ENTRY--PERSONAL</para></entry>
<entry><para>Used for second authors and other persons related
to the production of the work.</para></entry>
<entry><para>See Authorized headings sheet and AACR2. The
first indicator should generally be a '1', to indicate that
the entry is surname first. If the name consists only of a
forename, however, the first indicator should be
'0'.</para></entry>
</row>
<row>
<entry><para>710</para></entry>
<entry><para>ADDED ENTRY--CORPORATE</para></entry>
<entry><para>Used for corporate bodies related to the
production of the work (e.g. publishers).</para></entry>
<entry><para>See Authorized headings sheet and AACR2. Set the
first indicator to '2'.</para></entry>
</row>
<row>
<entry><para>711</para></entry>
<entry><para>ADDED ENTRY--MEETING</para></entry>
<entry><para>Used for meetings related to the production of
the work (e.g. symposia that contributed to the
work).</para></entry>
<entry><para>See Authorized headings sheet and AACR2. Set the
first indicator to '2'.</para></entry>
</row>
<row>
<entry><para>730</para></entry>
<entry><para>ADDED ENTRY--UNIFORM TITLE</para></entry>
<entry><para>Used for uniform titles related to the production
of the work (e.g. a work that inspired the present
work)</para></entry>
<entry><para>See Authorized headings sheet and AACR2. Set the
first indicator to the number of non-filing characters (i.e.
characters in an initial articles plus the space... for "The "
set the first indicator to '4').</para></entry>
</row>
<row>
<entry><para>773</para></entry>
<entry><para>HOST ITEM ENTRY</para></entry>
<entry><para>Describes the larger bibliographic unit that
contains the work (e.g. book or journal containing the article
being described in the current record)</para></entry>
<entry><para>If the host publication is author main entry,
enter the authorized form of the author's name in subfield
'a'. Put the title in subfield 't'. If the host publication is
an independent work, put publication information in subfield
'd'. When available, ISSN and ISBN should always be used in,
in subfields 'x' and 'z' respectively. Relationship
information (e.g. volume number, page number, etc.) goes in
subfield 'g'. Subfield 'q' contains an encoded representation
of the location of the item: volume, issue, and section
numbers are separated by colons, and the first page is entered
following a '<' at the end of the subfield. See ISBD
punctuation sheet. Set the first indicator to '0'. If you want
the label "In:" to be generated, leave the second indicator
blank. If you want something else displayed before the 773
text, set the second indicator to '8' and add a subfield 'i'
with the label you want at the beginning of the field (e.g.
"$iOffprint from:").</para></entry>
</row>
<row>
<entry><para>830</para></entry>
<entry><para>SERIES ENTRY--UNIFORM TITLE</para></entry>
<entry><para>Authorized form of the series name transcribed in
the 490 field. Often this will just be the same as the
490.</para></entry>
<entry><para>See Authorized headings sheet and AACR2. Set the
second indicator to the number of non-filing characters (i.e.
characters in an initial articles plus the space... for "The "
set the second indicator to '4').</para></entry>
</row>
<row>
<entry><para>852</para></entry>
<entry><para>LOCATION/CALL NUMBER</para></entry>
<entry><para>Provides the section name for pre-barcode books,
pamphlets, and some articles and serials.</para></entry>
<entry><para>Do not put anything in this field if you are
cataloging a volume which gets only one record and a barcode.
If the item does not get a barcode, or you are currently
creating a record for an article in a volume, put the section
in subfield 'a' (see ANS cataloging documentation), and the
call number in subfield 'i'. Set the first indicator to
'8'.</para></entry>
</row>
<row>
<entry><para>856</para></entry>
<entry><para>ELECTRONIC ACCESS</para></entry>
<entry><para>Links to material available
online.</para></entry>
<entry><para>Put the URL of any electronic copies or
summaries, etc. in subfield 'u' and a link title in subfield
'y'. Set the first indicator to '4'.</para></entry>
</row>
<row>
<entry><para>942</para></entry>
<entry><para>ADDED ENTRY ELEMENTS (KOHA)</para></entry>
<entry><para>Used for Koha-specific data.</para></entry>
<entry><para>Set the subfield 'c' to the appropriate item
type.</para></entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section id="itemcatguide">
<title>Item/Holdings Record Cataloging Guide</title>
<para>This table represents the default embedded holdings data in Koha
3.4. This information can be used for migration or importing data
purposes</para>
<table cellpadding="4" cellspacing="4" frame="all">
<title>Koha Embedded Holdings Data</title>
<tgroup align="left" cols="4" colsep="1" rowsep="1">
<colspec colname="tag" colnum="1"/>
<colspec colname="data" colnum="2"/>
<colspec colname="desc" colnum="3"/>
<colspec colname="note" colnum="4"/>
<thead>
<row>
<entry><para>MARC21 Tag/subfield</para></entry>
<entry><para>Data Element</para></entry>
<entry><para>Description</para></entry>
<entry><para>Notes</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>952$0</para></entry>
<entry><para>Withdrawn status</para></entry>
<entry><para>Default values: </para><itemizedlist>
<listitem>
<para>0 = Not withdrawn</para>
</listitem>
<listitem>
<para>1 = Withdrawn</para>
</listitem>
</itemizedlist></entry>
<entry><para>Coded value, matching <link
linkend="authorizedvalues">Authorized Value</link> category
('WITHDRAWN' in default installation)</para></entry>
</row>
<row>
<entry><para>952$1</para></entry>
<entry><para>Lost status</para></entry>
<entry><para>Default values:</para><itemizedlist>
<listitem>
<para>0 = Available</para>
</listitem>
<listitem>
<para>1 = Lost</para>
</listitem>
<listitem>
<para>2 = Long Overdue (Lost)</para>
</listitem>
<listitem>
<para>3 = Lost and Paid For</para>
</listitem>
<listitem>
<para>4 = Missing in Inventory</para>
</listitem>
<listitem>
<para>5 = Missing in Hold Queue</para>
</listitem>
</itemizedlist></entry>
<entry><para>It's possible to configure OPAC so that lost
items don't display with the <link
linkend="hidelostitems">hidelostitems</link> system
preference. </para><para>Coded value, matching <link
linkend="authorizedvalues">Authorized Value</link> category
('LOST' in default installation)</para></entry>
</row>
<row>
<entry><para>952$2</para></entry>
<entry><para>Classification</para></entry>
<entry><para>Classification scheme that defines filing rules
used for sorting call numbers.</para></entry>
<entry><para>A choice of <link
linkend="classificationsources">classification sources</link>
as they are defined in administration. If no classification
scheme is entered, the system will use the value entered in
the <link
linkend="DefaultClassificationSource">DefaultClassificationSource</link>
preference.</para></entry>
</row>
<row>
<entry><para>952$3</para></entry>
<entry><para>Materials specified</para></entry>
<entry><para>Specific issues of serials or multi-part
items.</para></entry>
<entry><para>Displayed when items are checked out and in to
tell the staff how many pieces the item has. Copy/volume data
is stored in 952$h and $t for display in Normal
views.</para></entry>
</row>
<row>
<entry><para>952$4</para></entry>
<entry><para>Damaged status</para></entry>
<entry><para>Default values: </para><itemizedlist>
<listitem>
<para>0 = Not damaged</para>
</listitem>
<listitem>
<para>1 = Damaged</para>
</listitem>
</itemizedlist></entry>
<entry><para>Coded value, matching <link
linkend="authorizedvalues">Authorized Value</link> category
('DAMAGE' in default installation)</para></entry>
</row>
<row>
<entry><para>952$5</para></entry>
<entry><para>Use restrictions</para></entry>
<entry><para>Default values:</para><itemizedlist>
<listitem>
<para>0 = No use restrictions</para>
</listitem>
<listitem>
<para>1 = Restricted Access</para>
</listitem>
</itemizedlist></entry>
<entry><para>Coded value, matching <link
linkend="authorizedvalues">Authorized Value</link> category
('RESTRICT' in default installation). This value has no effect
on circulation.</para></entry>
</row>
<row>
<entry><para>952$7</para></entry>
<entry><para>Not for loan</para></entry>
<entry><para>Default values:</para><itemizedlist>
<listitem>
<para>-1 = Ordered</para>
</listitem>
<listitem>
<para>0 = Available for loans</para>
</listitem>
<listitem>
<para>1 = Not for Loan</para>
</listitem>
<listitem>
<para>2 = Staff Collection</para>
</listitem>
</itemizedlist></entry>
<entry><para>Coded value, matching <link
linkend="authorizedvalues">Authorized Value</link> category
('NOT_LOAN' in default installation). Negative number values
can still be placed on hold.</para></entry>
</row>
<row>
<entry><para>952$8</para></entry>
<entry><para>Collection code</para></entry>
<entry><para>Coded value</para></entry>
<entry><para>Coded value, matching <link
linkend="authorizedvalues">Authorized Value</link> category
('CCODE' in default installation)</para></entry>
</row>
<row>
<entry><para>952$9</para></entry>
<entry><para>Item number</para></entry>
<entry><para>System-generated item number.</para></entry>
<entry><para>Does not display in the item
record.</para></entry>
</row>
<row>
<entry><para>952$a</para></entry>
<entry><para>Owning Library **</para></entry>
<entry><para>Branch code</para></entry>
<entry><para><emphasis role="bold">Required</emphasis>. Code
must be defined in <link linkend="libsgroups">Libraries,
Branches and Groups</link></para></entry>
</row>
<row>
<entry><para>952$b</para></entry>
<entry><para>Holding library ** (usually the same as 952$a
)</para></entry>
<entry><para>Branch code</para></entry>
<entry><para><emphasis role="bold">Required</emphasis>. Code
must be defined in <link linkend="libsgroups">Libraries,
Branches and Groups</link></para></entry>
</row>
<row>
<entry><para>952$c</para></entry>
<entry><para>Shelving location code</para></entry>
<entry><para/></entry>
<entry><para>Coded value, matching <link
linkend="authorizedvalues">Authorized Value</link> category
('LOC' in default installation)</para></entry>
</row>
<row>
<entry><para>952$d</para></entry>
<entry><para>Date acquired</para></entry>
<entry><para>YYYY-MM-DD</para></entry>
<entry><para>Date formats in the 952 subfields are required to
be in the system internal format for data loading and
subsequent item editing: YYYY-MM-DD</para></entry>
</row>
<row>
<entry><para>952$e</para></entry>
<entry><para>Source of acquisition</para></entry>
<entry><para>Coded value or vendor string</para></entry>
<entry><para>Filled in automatically with the Koha assigned
vendor id by Aquisitions when an item is
received.</para></entry>
</row>
<row>
<entry><para>952$g</para></entry>
<entry><para>Purchase price</para></entry>
<entry><para>Decimal number, no currency symbol (ex.
10.00)</para></entry>
<entry><para>Filled in automatically by Acquisitions when an
item is received.</para></entry>
</row>
<row>
<entry><para>952$h</para></entry>
<entry><para>Serial enumeration</para></entry>
<entry><para/></entry>
<entry><para>Filled in automatically by Serials if the issue
is received there.</para></entry>
</row>
<row>
<entry><para>952$o</para></entry>
<entry><para>Koha full call number</para></entry>
<entry><para/></entry>
<entry><para>Can be filled in automatically based on the <link
linkend="itemcallnumber">itemcallnumber</link> system
preference.</para></entry>
</row>
<row>
<entry><para>952$p</para></entry>
<entry><para>Barcode *</para></entry>
<entry><para>Max 20 characters</para></entry>
<entry><para/></entry>
</row>
<row>
<entry><para>952$t</para></entry>
<entry><para>Copy number</para></entry>
<entry><para>Max 32 characters</para></entry>
<entry><para/></entry>
</row>
<row>
<entry><para>952$v</para></entry>
<entry><para>Replacement price</para></entry>
<entry><para>Decimal number, no currency symbol (ex.
10.00)</para></entry>
<entry><para>Filled in automatically by Acquisitions when an
item is received.</para></entry>
</row>
<row>
<entry><para>952$w</para></entry>
<entry><para>Price effective from</para></entry>
<entry><para>YYYY-MM-DD</para></entry>
<entry>Date formats in the 952 subfields are required to be in
the system internal format for data loading and subsequent
item editing: YYYY-MM-DD. Filled in automatically by
Acquisitions when an item is received.</entry>
</row>
<row>
<entry><para>952$y</para></entry>
<entry><para>Koha item type **</para></entry>
<entry><para>Coded value, required field for
circulation</para></entry>
<entry><para><emphasis role="bold">Required</emphasis>. Coded
value, must be defined in <link linkend="itemtypeadmin">Item
types</link></para></entry>
</row>
<row>
<entry><para>952$z</para></entry>
<entry><para>Public note</para></entry>
<entry><para/></entry>
<entry><para/></entry>
</row>
</tbody>
</tgroup>
</table>
<para>* - required for circulation</para>
<para>** - required by Koha</para>
</section>
<section id="onorderitemholds">
<sectioninfo>
<corpauthor>VOKAL</corpauthor>
<editor>
<firstname>Nicole C.</firstname>
<surname>Engard</surname>
</editor>
<pubdate>2010</pubdate>
<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>
</sectioninfo>
<title>Handling On Order Items and Holds</title>
<para>If you tend to import your MARC records when you have ordered
the book (as opposed to when you receive the books), and allow patrons
to place holds on those books, you may need to add item records to the
*.mrc file before importing.</para>
<para>The easiest way to import your latest order is to first run your
records through <ulink
url="http://people.oregonstate.edu/~reeset/marcedit/html/index.php";>MARCEdit</ulink>.
Download your MARC records, saving them to your desktop or some other
location you use/will remember. If you have MARCEdit already installed
you should simply have to double click on your MARC records, and they
will automatically open in MARCEdit.<important>
<para>This tutorial was written with MARCEdit version
5.2.3769.41641 on Windows XP, instructions may be different if
your version or operating system is different.</para>
</important></para>
<itemizedlist>
<listitem>
<para>Your original file will automatically be in the input;
ensure MarcBreaker is chosen, and then click "Execute"</para>
<screenshot>
<screeninfo>MarcBreaker</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-onorder/marcbreaker.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>You will be presented with a summary of the records
processed at the bottom of the screen</para>
<screenshot>
<screeninfo>MarcBreaker Summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-onorder/marcbreaker-summary.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Click 'Edit Records' to continue on to adding item
records</para>
</listitem>
<listitem>
<para>Your screen will be replaced with a larger screen containing
the MARC records</para>
<screenshot>
<screeninfo>MARC file for editing</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-onorder/editrecords.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Click on Tools > Add/Edit Field</para>
<screenshot>
<screeninfo>Add/Delete Field</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-onorder/addfield.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Enter in the Koha specific item info</para>
<screenshot>
<screeninfo>Add 942 Field</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-onorder/add942.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>In the Field box, type 942</para>
</listitem>
<listitem>
<para>In the Field Data box, type \\$c and the item type code
(\\$cBOOK in this example)</para>
</listitem>
<listitem>
<para>Check the 'Insert last' option</para>
</listitem>
<listitem>
<para>Click 'Add Field'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Enter in the item record data</para>
<screenshot>
<screeninfo>Add 952 Field</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-onorder/add952.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>In the Field box, type 952</para>
</listitem>
<listitem>
<para>In the Field Data box, type
$7ORDERED_STATUS$aPERM_LOC$bCURR_LOC$cSHELVING_LOCATION$eSOURCE_OF_ACQ$yITEM_TYPE</para>
<itemizedlist>
<listitem>
<para>ex. $7-1$aCPL$bCPL$cNEW$eBrodart$yBOOK</para>
<itemizedlist>
<listitem>
<para>In a default install of Koha -1 is the value for
the Ordered status</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>You may want to look at other subfields you would
like data in -- for example, changing the collection code
to put all the items in the same collection (8),
automatically fill in the acquisition date (d), or put in
a public note (z).</para>
</listitem>
<listitem>
<para>Be sure you use the $ to separate subfields; adding
each subfield on a separate line will cause that many
items to be imported with your MARC record (in the example
above, four items, each with one of those subfields
corrected)</para>
</listitem>
<listitem>
<para>Make sure you look at the Administration >
Authorized Values in Koha to put the correct code into the
field</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Check the 'Insert last' option</para>
</listitem>
<listitem>
<para>Click 'Add Field'</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Close the field editor window</para>
</listitem>
<listitem>
<para>Click on File > Compile into MARC</para>
<screenshot>
<screeninfo>Compile into MARC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-onorder/compile.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Choose where to save your file</para>
</listitem>
</itemizedlist>
<para>Now you want to go into your Koha system and follow the
instructions for <link linkend="stagemarc">importing MARC
records</link>.</para>
<para>Once the item has come in, you will need to go to the item
record and individually change the item to have the correct barcode,
and manually change the status from Ordered to the blank line in the
Not for Loan field.</para>
<tip>
<para>If you purchase your cataloged item records, you may want to
request your vendor put in the information you need into the MARC
records for you; that way, you could import the edited-by-the-vendor
file, overwriting the current record, automatically replacing the
data with what you need.</para>
</tip>
</section>
</section>
</chapter>
<chapter id="serials">
<title>Serials</title>
<para>Serials actions can be accessed by going to the More menu at the top
of your screen and choosing Serials or by clicking Serials on the main
Koha staff client page. The Serials module in Koha is used for keeping
track of journals, newspapers and other items that come on a regular
schedule. As with all modules, make sure you go through the related <link
linkend="impserials">Implementation Checklist</link> before using the
Serials module.</para>
<section id="newsubscription">
<title>Add a subscription</title>
<para>Subscriptions can be added by clicking the 'New' button on any
bibliographic record</para>
<screenshot>
<screeninfo>New Subscription Button</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/newsubfrombib.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Or by visiting the Serials module and clicking 'New
Subscription'</para>
<screenshot>
<screeninfo>New Subscription Button</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/newsubbutton.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you are entering a new subscription from the Serials module you
will be presented with a blank form (if creating new from a
bibliographic record the form will include the bib info).</para>
<screenshot>
<screeninfo>Add a new Subscription Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/addsub.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>'Librarian' field will show the logged in librarian's
username</para>
</listitem>
<listitem>
<para>'Vendor' can be found by either searching vendors entered via
the <link linkend="acqmodule">Acquisitions module</link> or entering
the vendor ID number</para>
<itemizedlist>
<listitem>
<para>Vendor information is not required</para>
</listitem>
<listitem>
<para>In order to claim missing and late issues you need to
enter vendor information</para>
<screenshot>
<screeninfo>Vendor Missing Warning</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/vendorwarning.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>'Biblio' is the MARC record you'd like to link this
subscription to</para>
<itemizedlist>
<listitem>
<para>This can be done by searching for an existing record by
clicking on the 'Search for Biblio' link below the boxes or by
entering the bib number for a record in the first box. Only if
you search with the field between the parenthesis.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Next you can choose whether a new item is created when
receiving an issue</para>
</listitem>
<listitem>
<para>'Location' is for the shelving location</para>
</listitem>
<listitem>
<para>'Call Number' is for your item's call number prefix</para>
</listitem>
<listitem>
<para>'Library' is the branch that owns this subscription.</para>
<itemizedlist>
<listitem>
<para>If more than one library subscribes to this serial you
will need to create a subscription for each library</para>
</listitem>
<listitem>
<para>This can be done easily by using the 'Edit as New
(Duplicate)' option found on the subscription information page
and changing only the 'Library' field</para>
<screenshot>
<screeninfo>New Duplicate Subscription</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/newasdup.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>The 'Grace Period' is the number of days before an issue is
automatically moved from 'expected' status to 'waiting' and how many
days before an issue is automatically moved from 'waiting' status to
'late'</para>
</listitem>
<listitem>
<para>Use the 'Public Note' for any notes you would like to appear
in the OPAC for the patrons</para>
</listitem>
<listitem>
<para>'Nonpublic Note' should be used for notes that are only
visible to the librarians via the staff client</para>
</listitem>
<listitem>
<para>To set up a routing list for serials, choose 'Routing List'
from the 'Patron notification' field.</para>
<itemizedlist>
<listitem>
<para>For this option to appear you need to make sure that you
have a Routing List notice set up in the <link
linkend="notices">Notices Tool</link></para>
</listitem>
<listitem>
<para>Learn more about <link linkend="routinglist">Routing
Lists</link> later in this manual</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>The Staff and OPAC Display options allow you to control how
many issues appear by default on bibliographic records in the Staff
Client and the OPAC</para>
<itemizedlist>
<listitem>
<para>If no values are entered in these fields, they will use
the <link
linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
and <link
linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
system preference values</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>In 'First issue publication date' you want to enter the date
of the issue you have in your hand, the date from which the
prediction pattern will start</para>
</listitem>
<listitem>
<para>There are several pre-defined options for the 'Frequency' of
publication</para>
<itemizedlist>
<listitem>
<para>Without periodicy: some very specific (usually high level
science journals) don't have a true periodicity. When you
subscribe to the title, you subscribe for 6 issues, which can
arrive in 1 year... or 2... There is no regularity or known
schedule.</para>
</listitem>
<listitem>
<para>Unknown select this if none of the other choices are
relevant</para>
</listitem>
<listitem>
<para>Irregular: The journal is not "regular" but has a
periodicity. You know that it comes out on January, then in
October and December, it is irregular, but you know when it's
going to arrive.</para>
</listitem>
<listitem>
<para>2/day: Twice daily</para>
</listitem>
<listitem>
<para>1/day: Daily</para>
</listitem>
<listitem>
<para>3/week: Three times a week</para>
</listitem>
<listitem>
<para>1/week: Weekly</para>
</listitem>
<listitem>
<para>1/ 2 weeks: Twice monthly (fortnightly)</para>
</listitem>
<listitem>
<para>1/ 3 weeks: Tri-weekly</para>
</listitem>
<listitem>
<para>1/month: Monthly</para>
</listitem>
<listitem>
<para>1/ 2 months (6/year): Bi-monthly</para>
</listitem>
<listitem>
<para>1/ 3 months (1/quarter): Quarterly</para>
</listitem>
<listitem>
<para>1/quarter (seasonal) : Quarterly related to seasons (ie.
Summer, Autumn, Winter, Spring)</para>
</listitem>
<listitem>
<para>2/year: Half yearly</para>
</listitem>
<listitem>
<para>1/year: Annual</para>
</listitem>
<listitem>
<para>1/ 2 years: Bi-annual</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Checking the 'Manual history' box will allow you to enter
serials outside the prediction pattern.</para>
</listitem>
<listitem>
<para>'Numbering pattern' will help you determine how the numbers
are printed for each issue</para>
<itemizedlist>
<listitem>
<para>Start with the numbering on the issue you have in hand,
the numbering that matches the date you entered in the 'First
issue publication' field</para>
</listitem>
<listitem>
<para>If you have chosen any 'Numbering Format' other than
'Number' in the 'Rollover at' field, enter the last issue number
before the volume number changes</para>
<itemizedlist>
<listitem>
<para>If you chose the 'Number' Numbering Format you will
see 'issues expected' in which you will enter the total
number of issues you expect to receive.</para>
<screenshot>
<screeninfo>Number as Numbering Pattern</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/numberonly.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>You can choose to create your own numbering pattern by
choosing 'None of the above' and clicking the 'Show/Hide
Advanced Pattern' button at the bottom of the form</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>'Subscription start date' is the date at which the
subscription begins. This is used for setting up renewal
alerts</para>
</listitem>
<listitem>
<para>'Subscription length' is the number of issues or months in the
subscription. This is also used for setting up renewal alerts</para>
</listitem>
<listitem>
<para>'Subscription end date' should only be entered for
subscriptions that have ended (if you're entering in a backlog of
serials)</para>
</listitem>
<listitem>
<para>The 'Numbering formula' is editable to match the way you'd
like your numbering to print on the item record and subscription
information pages</para>
</listitem>
</itemizedlist>
<para>Click 'Save Subscription' to save the information you have
entered. <link linkend="sampleserialsapp">Find sample serial examples in
the appendix</link>.</para>
</section>
<section id="receiveissues">
<title>Receive Issues</title>
<para>Issues can be marked as received from several locations. To find a
subscription, use the search box at the top of the Serials page to
search for the serial you'd like to receive issues for:</para>
<screenshot>
<screeninfo>Subscription Search</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/subsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From the search results you can click the 'Serial Receive' link or
you can click on the subscription title and then click the 'Receive'
button.</para>
<screenshot>
<screeninfo>Subscription Buttons</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/subbuttons.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The final way to receive serials is from the 'Serial Collection'
page. To the left of the Subscription summary page there is a menu with
a link to 'Serial Collection'</para>
<screenshot>
<screeninfo>Serial Subscription Menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/serialcolllink.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From the page that opens up you can click 'Edit Serial' with the
issue you want to receive checked.</para>
<screenshot>
<screeninfo>Edit Issues</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/editissue.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>All three of these options will open up the issue receive
form:</para>
<screenshot>
<screeninfo>Receive Serials</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/receiveissue.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Choose 'Arrived' from the status pull down to mark a serial as
received.</para>
</listitem>
<listitem>
<para>If you have decided to have an item record created for each
issue an <link linkend="addingitems">item add form</link> will
appear</para>
</listitem>
<listitem>
<para>If your issue has a supplemental issue with it, fill in the
Supplemental Issue information.</para>
</listitem>
<listitem>
<para>If you have decided to have an item record created for each
issue an <link linkend="addingitems">item add form</link> will
appear for your supplement and for the issue itself</para>
</listitem>
<listitem>
<para>Once you have entered your info you can click 'Save'</para>
</listitem>
</itemizedlist>
<para>If you are receiving multiple issues at once, or have marked an
issue as 'Late' or 'Missing' there you can click the 'Generate Next'
button below the list of issues.</para>
<screenshot>
<screeninfo>Generate Next Button</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/editissue.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking this button will generate the next issue for you and mark
the previously expected issue as 'Late' automatically. You can then
check the 'Edit' box to the right of each issue and edit the status on
multiple issues at once.</para>
</section>
<section id="routinglist">
<title>Create a Routing List</title>
<para>A routing list is a list of people who receive the serial before
it goes to the shelf. When setting up your serial subscription you want
to be sure to pick 'Routing List' from the 'Patron Notification' pull
down.</para>
<screenshot>
<screeninfo>Patron Notification Option</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/serialnotification.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When on the subscription page you will see a link to the left that
reads 'Create Routing List' or 'Edit Routing List'</para>
<screenshot>
<screeninfo>Subscription Routing List Link</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/createroutinglink.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking that link will bring you to the menu to add a new routing
list.</para>
<screenshot>
<screeninfo>Routing List Creation</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/createroutinglist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From here you want to click 'Add recipients' in order to add
people to the routing list. In the menu that appears you can filter
patrons by part of their name, their library and/or patron
category.</para>
<screenshot>
<screeninfo>Add Members to Routing List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/addtorouting.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking 'Add' to the right of each name will add them to the
routing list. When you have chosen all of the people for the list, click
the 'Close' link to be redirected to the routing list.</para>
<screenshot>
<screeninfo>Routing List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/editroutinglist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If the list looks the way you expect it to, then click 'Save'.
Next you will be brought to a preview of the routing list. To print the
list click 'Save and preview routing slip.' This will open a printable
version of the list.</para>
<screenshot>
<screeninfo>Preview Routing List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/previewroutinglist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If <link
linkend="RoutingListAddReserves">RoutingListAddReserves</link> is set to
on then patrons listed in the routing list will automatically be added
to the holds list for the issue.</para>
</section>
<section id="serialsubinstaff">
<title>Subscriptions in Staff Client</title>
<para>Subscription information will appear on bibliographic records
under the 'Subscriptions' tab</para>
<screenshot>
<screeninfo>Subscription Tab on Bibliographic Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/subinfoonbib.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking the 'Subscription Details' link will take you to the
Subscription summary page in the staff client.</para>
<screenshot>
<screeninfo>Subscription Detail</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/subscriptiondetail.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="serialsubinopac">
<title>Subscriptions in OPAC</title>
<para>When viewing the subscription in the OPAC there will be several
options.</para>
<para>Like in the staff client, there will be a Subscriptions tab on the
bibliographic record.</para>
<screenshot>
<screeninfo>Subscriptions Tab in OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/subopac.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Under this tab will appear the number of issues you chose when
setting up the subscription or in your <link
linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
system preference. Clicking the 'More details' link will provide you
with additional information about the serial history. You can set the
default view of a serial in the OPAC with the <link
linkend="SubscriptionHistory">SubscriptionHistory</link> system
preference.</para>
<para>There are two views, compact and full. The compact serial
subscription will show basic information regarding the
subscription</para>
<screenshot>
<screeninfo>Compact Serial View</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/compactopac.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From this compact display patrons can subscribe to routing lists
by clicking the subscribe link that appears below subscriptions that
offer a routing list.</para>
<screenshot>
<screeninfo>Subscribe link in the OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/opacroutingsubscribe.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Whereas the full view shows extensive details, broken out by year,
regarding the subscription</para>
<screenshot>
<screeninfo>Full Serial View</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/fullopac.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="serialclaims">
<title>Claim Late Serials</title>
<para>Koha can send email messages to your serial vendors if you have
late issues. To the left of the main serials page there is a link to
'Claims'</para>
<screenshot>
<screeninfo>Link to Claims on Serials Menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/serialclaimmenu.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The links to claims also appears to the left of the subscription
detail page</para>
<screenshot>
<screeninfo>Link to Claims on the Serials Menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/serialclaimmenu1.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you don't have a claim notice defined yet you will see a
warning message that you need to first define a notice.</para>
<screenshot>
<screeninfo>Missing Claims Notice Warning</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/noserialclaim.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking 'Claims' will open a report that will ask you to choose
from your various serial vendors to generate claims for late
issues.</para>
<screenshot>
<screeninfo>Serial Claims</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/serialclaims.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From the list of late issues you can choose which ones you want to
send a claim email to by clicking the checkbox to the left of late
issue, choosing the notice template to use and clicking the 'Send
notification' button.</para>
</section>
<section id="serialexpiration">
<title>Check Serial Expiration</title>
<para>When adding serials you enter a subscription length, using the
check expiration tool you can see when your subscriptions are about to
expire. To use the tool click the link to 'Check expiration' on the
serials menu.</para>
<screenshot>
<screeninfo>Check Serial Expiration</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/serialexpiresearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>In the form that appears you need to enter at least a date to
search by.</para>
<para>In your results you will see all subscriptions that will expire
before the date you entered. From there you can choose to view the
subscription further or renew it in one click.</para>
<screenshot>
<screeninfo>Serial Expiration Search Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/serialexpire.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="serialrenew">
<title>Renewing Serials</title>
<para>If your serial subscription has expired you won't be able to
receive issues. To renew your subscription you can click the 'Renew'
button at the top of your subscription detail page.</para>
<screenshot>
<screeninfo>Renew option on subscription detail</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/renewsubscription.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Another option is to click the 'Renew' link to the right of the
subscription on the Serial Collection page.</para>
<screenshot>
<screeninfo>Renew option on serial collection</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/collectionrenew.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you click the 'Renew' link or button you will be presenting
with renewal options.</para>
<screenshot>
<screeninfo>Subscription renewal form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serials/serialrenew.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>The start date should be the date your subscription period
starts.</para>
</listitem>
<listitem>
<para>For the subscription length you'll want to fill in one of the
three fields presented: Number of num (issues), Number of months or
Number of weeks.</para>
</listitem>
<listitem>
<para>Finally enter any notes you might have about this
renewal.</para>
</listitem>
</itemizedlist>
</section>
</chapter>
<chapter id="acqmodule">
<title>Acquisitions</title>
<para/>
<section id="acqsetup">
<title>Setup</title>
<para>Before using the Acquisitions Module you will want to make sure
that you have completed all of the set up.</para>
<para>First, set your <link linkend="acqprefs">Acquisitions System
Preferences</link> and <link linkend="acqadmin">Acquisitions
Administration</link> to match your library's workflow.</para>
<para>On the main acquisitions page you will see your library's funds
listed.</para>
<screenshot>
<screeninfo>Acquisitions Funds Summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/acqfunds.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para><tip>
<para>If the total line is confusing for the funds you have set up
you can hide it by adding <programlisting>#funds_total {display:none;}</programlisting></para>
<para>to the <link linkend="IntranetUserCSS">IntranetUserCSS</link>
preference.</para>
</tip></para>
<para>To see all active funds you can click the checkbox next to 'Show
all' below the funds table.</para>
<para>To see a history of all orders in a fund you can click on the
linked amount and it will run a search for you.</para>
<screenshot>
<screeninfo>Breakdown of orders against the FIC Fund</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/fundbreakdown.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Learn more in the <link linkend="fundtracking">Budget/Fund
Tracking</link> section of this manual.</para>
</section>
<section id="acqvendors">
<title>Vendors</title>
<para>Before any orders can be places you must first enter at least one
vendor.</para>
<section id="addacqvendor">
<title>Add a Vendor</title>
<para>To add a vendor click the 'New Vendor' button on the
Acquisitions page</para>
<screenshot>
<screeninfo>New Vendor Button on Acquisitions</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/newvendbutton.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The vendor add form is broken into three pieces</para>
<itemizedlist>
<listitem>
<para>The first section is for basic information about the
Vendor</para>
<screenshot>
<screeninfo>Basic Vendor Information</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/newvendor1.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Of these fields, only the Vendor name is required, the
rest of the information should be added to help with
generating claim letters and invoices</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>The second section is for information regarding your contact
at the Vendor's office</para>
<screenshot>
<screeninfo>Vendor Contact Details</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/newvendor2.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>None of these fields are required, they should only be
entered if you want to keep track of your contact's
information within Koha</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>The final section is for billing information</para>
<screenshot>
<screeninfo>Vendor Ordering/Billing Information</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/newvendor3.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>To be able to order from a vendor you must make them
'Active'</para>
</listitem>
<listitem>
<para>For List Prices and Invoice Prices choose the
currency</para>
<itemizedlist>
<listitem>
<para>Currencies are assigned in the <link
linkend="currexchangeadmin">Currencies & Exchange
Rates</link> admin area</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If your library is charged tax mark your Tax Number as
registered</para>
</listitem>
<listitem>
<para>Note if you list prices and/or invoice prices include
tax</para>
</listitem>
<listitem>
<para>If the vendor offers a consistent blank discount, enter
that in the 'Discount' field</para>
<itemizedlist>
<listitem>
<para>You can enter item specific discounts when placing
an order</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Enter your tax rate if your library is charged taxes on
orders</para>
</listitem>
<listitem>
<para>If you know about how long it usually takes orders to
arrive from this vendor you can enter a delivery time. This
will allow Koha to estimate when orders will arrive at your
library on the late orders report.</para>
</listitem>
<listitem>
<para>Notes are for internal use</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="editacqvendor">
<title>View/Edit a Vendor</title>
<para>To view a vendor's information page you must search for the
vendor from the Acquisitions home page. Your search can be for any
part of the Vendor's name:</para>
<screenshot>
<screeninfo>Vendor Search Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/vendorsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From the results, click on the name of the vendor you want to
view or edit</para>
<screenshot>
<screeninfo>Vendor Information Page</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/vendorpage.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To make changes to the vendor, simply click the 'Edit'
button.</para>
<para>If the vendor has no baskets attached to it then a 'Delete'
button will also be visible and the vendor can be deleted.</para>
<screenshot>
<screeninfo>Delete Vendor Button</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/deletevendor.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="vendorcontracts">
<title>Vendor Contracts</title>
<para>You can define contracts (with a start and end date) and attach
it to a vendor. This is used so that at the end of the year you can
see how much you spent on a specific contract with a vendor. In some
places, contracts are set up with a minimum and maximum yearly
amount.</para>
<section id="addvendorcontract">
<title>Add a Contract</title>
<para>At the top of a vendor search results page with only result or
at the top of a vendor information page you will see a 'New
Contract' button.</para>
<screenshot>
<screeninfo>New Contract Button</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/newcontract.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The contract form will ask for some very basic information
about the contract</para>
<screenshot>
<screeninfo>New Contract Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/newcontractform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<important>
<para>You will not be able to enter a contract retrospectively,
the end date must not be before today's date.</para>
</important>
<para>Once the contract is saved it will appear below the vendor
information.</para>
<screenshot>
<screeninfo>Vendor with contracts</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/contractdisplay.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>It will also be an option when creating a basket</para>
<screenshot>
<screeninfo>Contract Pull Down on New Basket Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/contractonbasket.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
</section>
<section id="managesuggest">
<title>Managing Suggestions</title>
<para>Depending on your settings in the <link
linkend="suggestionspref">suggestion</link> system preference, patrons
may be able to make purchase suggestions via the OPAC. When a suggestion
is waiting for library review, it will appear on the Acquisitions home
page under the vendor search.</para>
<screenshot>
<screeninfo>Pending suggestions on Acquisitions</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/suggestonacq.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>It will also appear on the main staff dashboard under the module
labels:</para>
<screenshot>
<screeninfo>Pending suggestions on main page</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/pendingsuggestions.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking 'Manage suggestions' will take you to the suggestion
management tool. If there are no pending suggestions you can access the
suggestion management tool by clicking the 'Manage suggestions' link on
the menu on the left of the Acquisitions page.</para>
<screenshot>
<screeninfo>Suggestion Management</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/suggestmanage.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Your suggestions will be sorted into several tabs: Accepted,
Pending, Checked, Ordered and/or Rejected. Each accepted or rejected
suggestion will show the name of the librarian who managed the
suggestion and the reason they gave for accepting or rejecting it (found
under 'Status').</para>
<para>For libraries with lots of suggestions, there are filters on the
left hand side of the Manage Suggestions page to assist in limiting the
number of titles displayed on the screen.</para>
<screenshot>
<screeninfo>Suggestion Filtering</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/suggestionsfilters.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking on the blue headings will expand the filtering options
and clicking '[clear]' will clear all filters and show all
suggestions.<tip>
<para>The suggestions page will automatically be limited to
suggestions for your library. To see information for all (or any
other) libraries click on the 'Acquisition information' filter and
change the library.</para>
<screenshot>
<screeninfo>Branch filter</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/suggestbranchfilter.png"/>
</imageobject>
</mediaobject>
</screenshot>
</tip></para>
<para>When reviewing 'Pending' suggestions you can choose to check the
box next to the item(s) you want to approve/reject and then choose the
status and reason for your selection. You can also choose to completely
delete the suggestion by checking the 'Delete selected' box.</para>
<screenshot>
<screeninfo>Pending Suggestions</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/suggestpending.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Another option for libraries with long lists of suggestions is to
approve or reject suggestions one by one by clicking on the title of the
suggestion to open a summary of the suggestion, including information if
the item was purchased.</para>
<screenshot>
<screeninfo>Suggestion Information</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/suggestiondetails.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking 'edit' to the right of the suggested title will open a
suggestion editing page.</para>
<screenshot>
<screeninfo>Edit Purchase Suggestion</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/editsuggestion.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From this form you can make edits to the suggestion (adding more
details or updating incorrect information provided by the patron). You
can also choose to accept or reject the suggestion on an individual
basis.</para>
<itemizedlist>
<listitem>
<para>Choosing to mark a request as 'Pending' will move the request
back to the 'Pending' tab.</para>
</listitem>
</itemizedlist>
<para>Reasons for accepting and rejecting suggestions are defined by the
<link linkend="suggestauthorized">SUGGEST</link> authorized
value.</para>
<screenshot>
<screeninfo>Reasons for approving or rejecting
suggestions</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/suggestreasons.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you choose 'Others...' as your reason you will be prompted to
enter your reason in a text box. Clicking 'Cancel' to the right of the
box will bring back the pull down menu with authorized reasons.</para>
<screenshot>
<screeninfo>Enter reason for 'Others...'</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/suggestothers.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you have clicked 'Submit' the suggestion will be moved to the
matching tab. The status will also be updated on the patron's account in
the OPAC and an <link linkend="notices">email notice</link> will be sent
to the patron using the template that matches the status you have
chosen.</para>
<screenshot>
<screeninfo>Purchase suggestions in the OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/mysuggestions.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="placingacqorder">
<title>Placing Orders</title>
<para>To place an order you must first search for the vendor or
bookseller you want to send the order to.</para>
<section id="createacqbasket">
<title>Create a basket</title>
<para>To create a basket you must first search for the vendor you're
ordering from:</para>
<screenshot>
<screeninfo>New Basket / Add Basket Options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/addbasketbutton.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Next to the vendor name you will see a 'New Basket'
button</para>
<screenshot>
<screeninfo>Add Basket Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/addbasket.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When adding a basket you want to give it a name that will help
you identify it later. The notes fields are optional and can contain
any type of information.</para>
<para>If you have <link linkend="addvendorcontract">added
contracts</link> to the vendor you're ordering from, you will also
have an option to choose which contract you're ordering these items
under.</para>
<screenshot>
<screeninfo>Basket with contract options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/basketwithcontracts.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When finished, click 'Save'</para>
<screenshot>
<screeninfo>New Empty Basket</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/basket.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once your basket is created you are presented with several
options for adding items to the order.</para>
<itemizedlist>
<listitem>
<para>If you are ordering another copy of an existing item, you
can simply search for the record in your system</para>
<screenshot>
<screeninfo>Search for existing records</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/orderfromexisting.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>From the results, simply click 'Order' to be brought to
the order form</para>
<screenshot>
<screeninfo>Order form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/existingitemorder.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>All of the details associated with the item will
already be listed under 'Catalog details'</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If you allow patrons to make purchase suggestions (learn
more in the <link linkend="managesuggest">Managing
Suggestions</link> section of this manual) then you can place
orders from those suggestions</para>
<screenshot>
<screeninfo>Approved Suggestions to Order From</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/orderfromsuggest.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>From the results, click 'Order' next to the item you
want to order and you will be presented with the order form
including a link to the suggestion</para>
<screenshot>
<screeninfo>Order from a Suggestion</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/orderfromsuggestform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>From this form you can make changes to the Catalog
Details if necessary</para>
</listitem>
<listitem>
<para>When the item appears in your basket it will include
a link to the suggestion</para>
<screenshot>
<screeninfo>Suggestion Link in basket</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/ordersuggestlink.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>To order from a record that can't be found anywhere else,
choose the 'From a new (empty) record'</para>
<screenshot>
<screeninfo>Order a new record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/fromnewemptyrecord.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>You will be presented with an empty form to fill in all
of the necessary details about the item you are
ordering</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If you want to search other libraries for an item to
purchase you can use the 'From an external source' option which
will allow you to order from a MARC record found via a Z39.50
search</para>
<screenshot>
<screeninfo>Search for record to add</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/orderz39.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>From the results click the Order link next to the item
you want to purchase</para>
<screenshot>
<screeninfo>Search Results to Order From</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/orderz39results.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>If the item you're ordering from an external source
looks like it might be a duplicate, Koha will warn you and
give you options on how to proceed</para>
<screenshot>
<screeninfo>Duplicate order warning</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/dupwarning.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>From the warning you can choose to just order
another copy on the existing bib record, create a new bib
record, or cancel your order of this item.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>In the order form that pops up you will not be able to
edit the catalog details</para>
<screenshot>
<screeninfo>New order from Z39.50 Search</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/orderz39form.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>The final option for ordering is to order from a staged
record (<link linkend="stagemarc">learn more about staging
records</link>)</para>
<screenshot>
<screeninfo>Staged Files to Order From</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/stagedfiles.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>From the list of files you are presented with, choose
the 'Add orders' link</para>
<screenshot>
<screeninfo>Records in the staged file</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/stagedrecords.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>From the list of records, click 'Add order' next to
the item you want to add to your order</para>
<screenshot>
<screeninfo>New order from Staged Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/stagedorder.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>From the order form you will not be able to edit
the catalog details.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>The other option is to import all records from the
staged file by scrolling below the list of records in the
staged file and filling in the item information.</para>
<screenshot>
<screeninfo>Import All</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/importallstaged.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>If you choose this option the Koha will look in
the 020$c and grab the pricing information from that
field and put that on each order line.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>After bringing in the bib information, if your <link
linkend="AcqCreateItem">AcqCreateItem</link> system preference is set
to add an item when ordering you will enter the item info next. You
need to fill out at least one item record and then click the 'Add'
button at the bottom left of the item form.</para>
<screenshot>
<screeninfo>Item order</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/itemonorder.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>After clicking add the item will appear above the form and then
you can enter your next item the same way (if ordering more than one
item).</para>
<screenshot>
<screeninfo>Item ordered</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/itemonorderadded.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you have entered the info about the item you need to enter
the Accounting information.</para>
<screenshot>
<screeninfo>Accounting Details</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/accounting.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Quantity is populated by the number of items you've added to
the order above</para>
</listitem>
<listitem>
<para>The list of funds is populated by the <link
linkend="funds">funds</link> you have assigned in the <link
linkend="acqadmin">Acquisitions Administration</link> area</para>
</listitem>
<listitem>
<para>The currency pull down will have the <link
linkend="currexchangeadmin">currencies</link> you set up in the
<link linkend="acqadmin">Acquisitions Administration</link>
area</para>
</listitem>
<listitem>
<para>The vendor price will be used to calculate the rest of the
amount fields below</para>
</listitem>
<listitem>
<para>If the price is uncertain, check the uncertain price
box.</para>
<itemizedlist>
<listitem>
<para>A basket with at least one uncertain price can't be
closed</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If you added Planning Values when <link
linkend="addbudgetfund">creating the Fund</link> those values will
appear in the two planning value fields</para>
</listitem>
</itemizedlist>
<para>Once an item is added to the basket you will be presented with a
basket summary</para>
<screenshot>
<screeninfo>Basket with item info</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/finalbasket.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From here you can edit or remove the items you have
added.</para>
<itemizedlist>
<listitem>
<para>Choosing to 'Delete the order' will just delete the order
line, but leave the record in the catalog</para>
</listitem>
<listitem>
<para>Choosing to 'Delete order and catalog record' remove both
the order line and the record in the catalog</para>
<itemizedlist>
<listitem>
<para>The catalog record cannot always be deleted, you might
see notes as to why</para>
<screenshot>
<screeninfo>Can't delete order line</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/cantdeleteorderline.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Also on the summary page you have the option to edit the
information you entered about the basket by clicking the 'Edit basket
header information' button, deleting the basket altogether by clicking
the 'Delete this basket' button, or exporting your basket as a CSV
file by clicking the 'Export this basket as CSV' button.</para>
<screenshot>
<screeninfo>Basket Buttons</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/basketbuttons.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you're sure your basket is complete you can click 'Close
this basket' button to indicate that this basket is complete and has
been sent to the vendor. If you have your <link
linkend="BasketConfirmations">BasketConfirmations</link> preference
set to show a confirmation you will be asked if you're sure about
closing the basket.</para>
<screenshot>
<screeninfo>Basket Closure Confirmation</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/BasketConfirmations.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When closing the basket you can choose to add the basket to a
group for easy printing and retrieval. If you check the box to 'Attach
this basket to a new basket group' you will be brought to the group
list where you can print a PDF of the order.</para>
<screenshot>
<screeninfo>Closed Baskets</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/basketgroup.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para><important>
<para>A basket with at least one items marked as 'uncertain price'
will not be able to be closed</para>
<screenshot>
<screeninfo>A basket with items where the price is
uncertain</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/basketuncertain.png"/>
</imageobject>
</mediaobject>
</screenshot>
</important></para>
<para>Clicking the 'Uncertain Prices' button will pull up a list of
items that you have marked as uncertain for this vendor. From that
list you can quickly edit the items by entering new prices and
quantities.</para>
<screenshot>
<screeninfo>Uncertain Prices</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/uncertainprices.png"/>
</imageobject>
</mediaobject>
</screenshot>
<important>
<para>The Uncertain Prices page is independent of the basket, it is
linked to the vendor, so you will see all items on order for this
vendor with uncertain prices.</para>
</important>
<para/>
</section>
<section id="acqbasketgroup">
<title>Create a basket group</title>
<para>A basket group is simply a group of baskets. In some libraries,
you have several staff members that create baskets, and, at the end of
a period of time, someone then groups them together to send to the
vendor in bulk. That said, it is possible to have one basket in a
basket group if that's the workflow used in your library.</para>
</section>
<section id="printacqbasket">
<title>Printing baskets</title>
<para>When you are finished adding items to your basket you want to
click 'Close this Basket'</para>
<screenshot>
<screeninfo>Close Basket</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/closebasket.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You will be asked if you want to create a purchase order at this
time.</para>
<screenshot>
<screeninfo>Create Purchase Order</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/createpurchaseorder.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Your completed order will be listed on the Basket Grouping page
for the printing or further modification.</para>
<screenshot>
<screeninfo>Basket Grouping</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/grouping.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking 'Print' below your order will generate a PDF for
printing. The PDF will have all of your library information followed
by the items in your order.</para>
<screenshot>
<screeninfo>Order found on PDF</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/pdforder.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="receiveacqorder">
<title>Receiving Orders</title>
<para>Orders can be received from the vendor information page</para>
<screenshot>
<screeninfo>Receive from Vendor Information</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/receivefromvendor.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>or the vendor search results page</para>
<screenshot>
<screeninfo>Vendor Search Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/receivefromsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>After clicking 'Receive shipment' you will be asked to enter a
vendor invoice number and a shipment received date.</para>
<screenshot>
<screeninfo>Receive Shipment</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/receive.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The receive page will list all items still on order with the
vendor regardless of the basket the item is from.</para>
<screenshot>
<screeninfo>Receipt Summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/receiptsummary.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To receive a specific item, click the 'Receive' link to the right
of the item.</para>
<screenshot>
<screeninfo>Receive Item Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/receiveitem.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From this form you can alter the cost information. You can also
choose to mark only part of the order as received if the vendor didn't
send your entire order by entering in the 'Quantity received'. The
values you enter in the 'Replacement cost' and 'Actual cost' will
automatically populate the item record by filling in subfield v (Cost,
replacement price) and subfield g (Cost, normal purchase price) on the
item record after saving.</para>
<screenshot>
<screeninfo>Item record after receipt</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/receiveditem.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you have made any changes necessary, click 'Save' to mark the
item as received.</para>
<screenshot>
<screeninfo>Already Received Items</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/received.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When you're finished receiving items you can navigate away from
this page or click the 'Finish receiving' button at the bottom of the
screen.</para>
<para>You will also see that the item is received and/or cancelled if
you view the basket.</para>
<screenshot>
<screeninfo>One item marked (rcvd) in basket</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/basketwithreceived.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="acqclaims">
<title>Claims & Late Orders</title>
<para>If you have entered in an email address for the vendors in your
system you can send them claim emails when an order is late. Before you
can send claims you will need to set up an <link
linkend="ACQCLAIM">acquisitions claim notice</link>.</para>
<para>Upon clicking on the link to 'Late Orders' from the Acquisitions
page you will be presented with a series of filter options on the left
hand side. These filters will be applied only closed baskets.</para>
<screenshot>
<screeninfo>Acquisitions Late Order Filters</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/acqclaimfilter.png"/>
</imageobject>
</mediaobject>
</screenshot>
<note>
<para>The vendor pull down only shows vendors with closed baskets that
are late.</para>
</note>
<para>Once you filter your orders to show you the things you consider to
be late you will be presented with a list of these items.</para>
<screenshot>
<screeninfo>Late Orders</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/lateorders.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To the right of each late title you will be see a checkbox. Check
off the ones you want a claim letter sent to and click 'Claim Order' at
the bottom right of the list. This will automatically send an email to
the vendor at the email address you have on file.<note>
<para>The Estimated Delivery Date is based on the Delivery time
value entered on the vendor record.</para>
</note></para>
<para>If you would rather use a different acquisition claim letter
(other than the default) you can <link linkend="addnotices">create that
in the notices module</link> and choose it from the menu above the list
of late items.</para>
<screenshot>
<screeninfo>Choose a Claim Letter</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/claimletter.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="acqsearch">
<title>Acquisition Searches</title>
<para>At the top of the various Acquisition pages there is a quick
search box where you can perform either a Vendor Search or an Order
Search.</para>
<screenshot>
<screeninfo>Acquisition Searches</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/acqsearches.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>In the Vendor Search you can enter any part of the vendor name to
get results.</para>
<screenshot>
<screeninfo>Vendor Search Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/vendorquicksearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Using the Orders Search you can search for items that have been
ordered with or without the vendor.</para>
<screenshot>
<screeninfo>Order Search Box</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/ordersearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can enter info in one or both fields and you can enter any
part of the title and/or vendor name.</para>
<screenshot>
<screeninfo>Order Search Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/ordersearchresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking the plus sign to the right of the Vendor search box will
expand the search and allow you to search for additional fields.</para>
<screenshot>
<screeninfo>Expanded Orders Search</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/ordersearchexpand.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking Advanced Search to the right of the search button will
give you all of the order search options available.</para>
<screenshot>
<screeninfo>Full Order Search</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/ordersearchfull.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="fundtracking">
<title>Budget/Fund Tracking</title>
<para>On the main acquisitions page there will be a table on the right
showing you all of your active funds and a breakdown of what has been
ordered or spent against them.</para>
<screenshot>
<screeninfo>Fund Table</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/budgettable.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking on the linked amounts under spent or ordered will show
you a summary of the titles ordered on that budget.</para>
<screenshot>
<screeninfo>Titles Spent</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/acquisitions/spent.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</chapter>
<chapter id="stafflists">
<title>Lists & Cart</title>
<para>Lists are a way to save a collection of content on a specific topic
or for a specific purpose. The Cart is a session specific storage
space.</para>
<section id="lists">
<title>Lists</title>
<para/>
<section id="createlist">
<title>Create a List</title>
<para>A list can be created by visiting the Lists page and clicking
'New List'</para>
<screenshot>
<screeninfo>New List Button</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/newlistbutton.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The new list form offers several options for creating your
list:</para>
<screenshot>
<screeninfo>New List Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/newlistform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>The name is what will appear on the list of Lists</para>
</listitem>
<listitem>
<para>You can also choose how to sort the list</para>
</listitem>
<listitem>
<para>Finally there are three types of lists you can choose
from</para>
<itemizedlist>
<listitem>
<para>A Private List is managed by you and can be seen only by
you</para>
</listitem>
<listitem>
<para>A Public List can be seen by everybody, but managed only
by you</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>A list can also be created from the catalog search
results</para>
<screenshot>
<screeninfo>New list from catalog search</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/newlistsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Check the box to the left of the titles you want to add to
the new list</para>
</listitem>
<listitem>
<para>Choose [New List] from the 'Add to:' pull down menu</para>
<screenshot>
<screeninfo>New List from Search Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/newlistfromsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Name the list and choose what type of list this
is</para>
<itemizedlist>
<listitem>
<para>A Private List is managed by you and can be seen
only by you</para>
</listitem>
<listitem>
<para>A Public List can be seen by everybody, but managed
only by you</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Once the list is saved it will accessible from the Lists page
and from the 'Add to' menu at the top of the search results.</para>
</section>
<section id="addtolist">
<title>Add to a List</title>
<para>To add titles to an existing list click on the list name from
the page of lists</para>
<screenshot>
<screeninfo>List of Lists</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/listslist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From the List page you can add titles by scanning barcodes into
the box at the bottom of the page</para>
<screenshot>
<screeninfo>Content of a List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/listcontents.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>A title can also be added to a list by selecting titles on the
search results page and choosing the list from the 'Add to'
menu</para>
<screenshot>
<screeninfo>Add to List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/addtolist.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="viewlist">
<title>Viewing Lists</title>
<para>To see the contents of a list, visit the Lists page on the staff
client</para>
<screenshot>
<screeninfo>List of Lists</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/listslist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking on the 'List Name' will show the contents of the
list</para>
<screenshot>
<screeninfo>Content of a List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/listcontents.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="mergebibrecs">
<title>Merging Bibliographic Records Via Lists</title>
<important>
<para>Merging will only work with two items that use the same
bibliographic framework.</para>
</important>
<para>The easiest way to merge together duplicate bibliographic
records is to add them to a list and use the Merge Tool from
there.</para>
<screenshot>
<screeninfo>List of Duplicate Records</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/listofdups.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From the list, check the two items you want to merge. If you
choose more than or fewer than 2, you will be presented with an
error:</para>
<screenshot>
<screeninfo>Merge Items Error</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/merge2rec.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you have selected the records you want to merge, click the
'Merge selected items' button. You will be asked which of the two
records you would like to keep as your primary record and which will
be deleted after the merge. If the records were created using
different frameworks, Koha will also ask you what Framework you would
like the newly merged record to use.</para>
<screenshot>
<screeninfo>Choose Primary Record for Merge</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/mergeprimary.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You will be presented with the MARC for both of the records
(each accessible by tabs labeled with the bib numbers for those
records). By default the entire first record will be selected, uncheck
the fields you don't want in the final (destination) record and then
move on to the second tab to choose which fields should be in the
final (destination) record.</para>
<screenshot>
<screeninfo>Merging Records</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/mergerecs.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Should you try to add a field that is not repeatable two times
(like choosing the 245 field from both record #1 and #2) you will be
presented with an error</para>
<screenshot>
<screeninfo>Non-repeatable Error</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/nondupfield.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once you have completed your selections click the 'merge'
button. The primary record will now show the data you chose for it as
well as all of the items/holdings from both bib records, and the
second record will be deleted.<important>
<para>It is important to rebuild your zebra index immediately
after merging records. If a search is performed for a record which
has been deleted Koha will present the patrons with an error in
the OPAC.</para>
</important></para>
</section>
</section>
<section id="cart">
<title>Cart</title>
<para>The cart is a temporary holding place for items in the OPAC and/or
staff client. The cart will be emptied once the session is ended (by
closing the browser or logging out). The cart is best used for
performing batch operations (holds, printing, emailing) or for getting a
list of items to be printed or emailed to yourself or a patron.</para>
<para>If you would like to enable the cart in the staff client, you need
to set the <link linkend="intranetbookbag">intranetbookbag</link> system
preference to 'Show.' To add things to the cart, search the catalog and
select the items you would like added to your cart and choose 'Cart'
from the 'Add to' menu</para>
<screenshot>
<screeninfo>Add to Cart</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/addtocart.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>A confirmation will appear below the cart button at the top of the
staff client</para>
<screenshot>
<screeninfo>Items added to Cart</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/itemsaddedcart.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking on the Cart icon will provide you with the contents of
the cart</para>
<screenshot>
<screeninfo>Cart Contents</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/lists/cart.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>From this list of items you can perform several actions</para>
</listitem>
<listitem>
<para>'Send' will send the list to the email address you
enter</para>
</listitem>
<listitem>
<para>'Download' will allow you to download the cart using one of 3
default formats or your <link linkend="csvprofiles">CSV
Profiles</link></para>
</listitem>
<listitem>
<para>'Print' will present you with a printable version of the
cart</para>
</listitem>
<listitem>
<para>'Empty and Close' will empty the list and close the
window</para>
</listitem>
<listitem>
<para>'Hide Window' will close the window</para>
</listitem>
</itemizedlist>
</section>
</chapter>
<chapter id="reports">
<title>Reports</title>
<para/>
<section id="customreports">
<title>Custom Reports</title>
<para>Koha's data is stored in a MySQL database which means that
librarians can generate nearly any report they would like by either
using the <link linkend="quidedreportwizard">Guided Reports
Wizard</link> or writing their own <link linkend="reportfromsql">SQL
query</link>.</para>
<section id="customreport">
<title>Add Custom Report</title>
<para/>
<section id="quidedreportwizard">
<title>Guided Report Wizard</title>
<para>The guided report wizard will walk you through a six step
process to generate a report.</para>
<para>Step 1: Choose the module you want to report on. This will
determine what tables and fields are available for you to
query.</para>
<screenshot>
<screeninfo>Chose Module for Report</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/report1.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Step 2: Choose a report type. For now, Tabular is the only
option available.</para>
<screenshot>
<screeninfo>Report Type</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/report2.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Step 3: Choose the fields you want in your report. You can
select multiple fields and add them all at once by using CTRL+Click
on each item you want to add before clicking the Add button.</para>
<screenshot>
<screeninfo>Select database fields to query</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/report3.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Step 4: Choose any limits you might want to apply to your
report (such as item types or branches). If you don't want to apply
any limits, simply click Next instead of making an option.</para>
<screenshot>
<screeninfo>Choose limits</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/report4.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Step 5: Perform math functions. If you don't want to do any
calculations, simply click Next instead of making an option.</para>
<screenshot>
<screeninfo>Choose math functions</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/report5.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Step 6: Choose data order. If you want the data to print out
in the order it's found in the database, simply click Finish.</para>
<screenshot>
<screeninfo>Choose ordering</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/report6.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When you are finished you will be presented with the SQL
generated by the report wizard. From here you can choose to save the
report by clicking 'Save' or copy the SQL and make edits to it by
hand.</para>
<screenshot>
<screeninfo>Custom Report Confirmation</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/reportconfirm.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you choose to save the report you will be asked to name
your report and enter any notes regarding it.</para>
<screenshot>
<screeninfo>Save custom report</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/reportsave.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once your report is saved it will appear on the 'Use Saved'
page with all other saved reports.</para>
<screenshot>
<screeninfo>Saved Reports list</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/savedreports.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From here you can make edits, run the report, or schedule a
time to have the report run. To find the report you created you can
sort by any of the columns by clicking the on the column header
(creation date is the best bet for finding the report you just
added). You can also filter your results using the filter menu on
the left.</para>
</section>
<section id="reportfromsql">
<title>Report from SQL</title>
<para>In addition to the report wizard, you have the option to write
your own queries using SQL. To find reports written by other Koha
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>.
You can also find your database structure in
/installer/data/mysql/kohastructure.sql or online at: <ulink
url="http://schema.koha-community.org/";>http://schema.koha-community.org</ulink>.</para>
<para>To add your query, click the link to 'Create from SQL' on the
main reports module or the New button at the top of the Saved
Reports page.</para>
<screenshot>
<screeninfo>New SQL Report</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/newsql.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Fill in the form presented</para>
<screenshot>
<screeninfo>Create Report from SQL</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/reportfromsql.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>The name is what will appear on the Saved Reports page to
help you identify the report later. It will also be searchable
using the filters found the left of the Saved Reports
page.</para>
</listitem>
<listitem>
<para>Notes will also appear on the Saved Reports page, this can
be used to provide more details about the report or tips on how
to enter values when it runs</para>
</listitem>
<listitem>
<para>The type should always be 'Tabular' at this time since the
other formats have not been implemented</para>
</listitem>
<listitem>
<para>In the SQL box you will type or paste the SQL for the
report</para>
</listitem>
<listitem>
<para>If you feel that your report might be too resource
intensive you might want to consider using runtime parameters to
your query. Runtime parameters basically make a filter appear
before the report is run to save your system resources.</para>
<para>There is a specific syntax that Koha will understand as
'ask for values when running the report'. The syntax is
<<Question to ask|authorized_value>>.</para>
<itemizedlist>
<listitem>
<para>The << and >> are just delimiters. You
must put << at the beginning and >> at the end
of your parameter</para>
</listitem>
<listitem>
<para>The 'Question to ask' will be displayed on the left of
the string to enter.</para>
</listitem>
<listitem>
<para>The authorized_value can be omitted if not applicable.
If it contains an authorized value category, or branches or
itemtype or categorycode, a list with the Koha authorized
values will be displayed instead of a free field Note that
you can have more than one parameter in a given SQL Note
that entering nothing at run time won't probably work as you
expect. It will be considered as "value empty" not as
"ignore this parameter". For example entering nothing for :
"title=<<Enter title>>" will display results
with title='' (no title). If you want to have to have
something not mandatory, use "title like <<Enter
title>>" and enter a % at run time instead of
nothing</para>
</listitem>
</itemizedlist>
<para>Examples:</para>
<itemizedlist>
<listitem>
<para>SELECT surname,firstname FROM borrowers WHERE
branchcode=<<Enter patrons library|branches>>
AND surname like <<Enter filter for patron surname (%
if none)>></para>
</listitem>
<listitem>
<para>SELECT * FROM items WHERE homebranch = <<Pick
your branch|branches>> and barcode like
<<Partial barcode value here>></para>
</listitem>
</itemizedlist>
<tip>
<para>To generate a date picker calendar to the right of the
field when running a report you can use the 'date' keyword
like this: <<Enter Date|date>></para>
<screenshot>
<screeninfo>Date Picker</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/datepicker.png"/>
</imageobject>
</mediaobject>
</screenshot>
</tip>
<tip>
<para>You have to put "%" in a text box to 'leave it blank'.
Otherwise, it literally looks for "" (empty string) as the
value for the field.</para>
</tip>
<para><important>
<para>In addition to using any authorized value code to
generate a dropdown, you can use the following values as
well: Branches (branches), Item Types (itemtypes) and Patron
Categories (categorycode). For example a branch pull down
would be generated like this
<<Branch|branches>></para>
<screenshot>
<screeninfo>Branch pull down</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/branchpulldown.png"/>
</imageobject>
</mediaobject>
</screenshot>
</important></para>
</listitem>
</itemizedlist>
<note>
<para>There is a limit of 10,000 records put on SQL statements
entered in Koha. To get around this you want to add 'LIMIT 100000'
to the end of your SQL statement (or any other number above
10,000.</para>
</note>
<para>Once everything is entered click the 'Save Report' button and
you'll be presented with options to run it. Once a report is saved
you do not have to recreate it you can simply find it on the Saved
Reports page and <link linkend="runcustomreport">run</link> or <link
linkend="editcustomreports">edit</link> it.</para>
</section>
</section>
<section id="editcustomreports">
<title>Edit Custom Reports</title>
<para>Every report can be edited from the reports lists. To see the
list of reports already stored in Koha, click 'Use Saved.'</para>
<screenshot>
<screeninfo>Saved Reports</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/savedreports.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To find the report you'd like to edit you can sort by any of the
columns by clicking the on the column header. You can also filter your
results using the filter menu on the left.</para>
<para>From this list you can edit any custom report by clicking 'Edit
SQL'</para>
<screenshot>
<screeninfo>Edit SQL Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/editreport.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="runcustomreport">
<title>Running Custom Reports</title>
<para>Once custom reports are saved to Koha, you can run them by going
to the Saved Reports page and clicking the Run link to the right of
the report.</para>
<screenshot>
<screeninfo>Run Report</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/runreport.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When you report runs you will either be asked for some
values</para>
<screenshot>
<screeninfo>Enter report parameters</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/reportparameters.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>or you will see the results right away</para>
<screenshot>
<screeninfo>Report results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/reportresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From the results you can choose to rerun the report by clicking
'Run rpeort' at the top, edit the report by clicking the 'Edit' button
or starting over and creating a new report by using the 'New' button.
You can also download your results by choosing a file type at the
bottom of the results next to the 'Download the report' label and
clicking 'Download.'<tip>
<para>A Comma Separated Text file is a CSV file and it can be
opened by any spreadsheet application.</para>
</tip></para>
</section>
</section>
<section id="statsreports">
<title>Statistics Reports</title>
<para>Statistic reports will show you counts and sums. These reports are
all about numbers and statistics, for reports that return more detailed
data, use the <link linkend="quidedreportwizard">Guided Report
Wizard</link>. These reports are limited in what data they can look at,
so it's often recommended to use <link linkend="customreports">custom
reports</link> for official end of the year statistics.</para>
<section id="acqstats">
<title>Acquisitions Statistics</title>
<note>
<para>These reports are limited in what data they can look at, so
it's often recommended to use <link linkend="customreports">custom
reports</link> for official end of the year statistics.</para>
</note>
<para>Using the form provided, choose which value you would like to
appear in the Column and which will appear in the Row.</para>
<screenshot>
<screeninfo>Acquisitions Statistics</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/acqform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you choose to output to the browser your results will print
to the screen.</para>
<screenshot>
<screeninfo>Acquisitions Statistics Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/acqnumbers.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also choose to export to a file that you can manipulate
to your needs.</para>
<para>When generating your report, note that you get to choose between
counting or summing the values.</para>
<screenshot>
<screeninfo>Acquisitions Stats Options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/acqtotal.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Choosing amount will change your results to appear as the sum of
the amounts spent.</para>
<screenshot>
<screeninfo>Acquisitions statistics with totals</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/acqamounts.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="patstats">
<title>Patron Statistics</title>
<note>
<para>These reports are limited in what data they can look at, so
it's often recommended to use <link linkend="customreports">custom
reports</link> for official end of the year statistics.</para>
</note>
<para>Using the form provided, choose which value you would like to
appear in the Column and which will appear in the Row.</para>
<screenshot>
<screeninfo>Patron Statistics Options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/patronform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you choose to output to the browser your results will print
to the screen.</para>
<screenshot>
<screeninfo>Patron Statistics Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/patronresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Based on your selections, you may see some query information
above your results table. You can also choose to export to a file that
you can manipulate to your needs.</para>
</section>
<section id="catstats">
<title>Catalog Statistics</title>
<note>
<para>These reports are limited in what data they can look at, so
it's often recommended to use <link linkend="customreports">custom
reports</link> for official end of the year statistics.</para>
</note>
<para>Using the form provided, choose which value you would like to
appear in the Column and which will appear in the Row.</para>
<screenshot>
<screeninfo>Catalog Statistics Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/catalogform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you choose to output to the browser your results will print
to the screen.</para>
<screenshot>
<screeninfo>Catalog Statistic Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/catalogresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also choose to export to a file that you can manipulate
to your needs.</para>
</section>
<section id="circstats">
<title>Circulation Statistics</title>
<note>
<para>These reports are limited in what data they can look at, so
it's often recommended to use <link linkend="customreports">custom
reports</link> for official end of the year statistics.</para>
</note>
<para>Using the form provided, choose which value you would like to
appear in the Column and which will appear in the Row.</para>
<screenshot>
<screeninfo>Circulation Statistics</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/circform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you choose to output to the browser your results will print
to the screen.</para>
<screenshot>
<screeninfo>Circulation Statistic Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/circresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also choose to export to a file that you can manipulate
to your needs.<tip>
<para>To get a complete picture of your monthly or daily
circulation, you can run the report twice, once for 'Type' of
'Checkout' and again for 'Renewal.'</para>
<para>This report uses 'Period,' or date, filtering that allows
you to limit to a month by simply selecting the first day of the
first month through the first day of the next month. For example,
10/1 to 11/1 to find statistics for the month of October.</para>
<itemizedlist>
<listitem>
<para>To find daily statistics, set your date
range.</br> Example: "I want circulation data starting
with date XXX up to, but not including, date XXX."</para>
</listitem>
<listitem>
<para>For a whole month, an example range would be: 11/01/2009
to 12/01/2009</para>
</listitem>
<listitem>
<para>For a whole year, an example range would be: 01/01/2009
to 01/01/2010</para>
</listitem>
<listitem>
<para>For a single day, an example would be: 11/15/2009 to
11/16/2009 to find what circulated on the 15th</para>
</listitem>
</itemizedlist>
</tip></para>
<section id="inhouseuse">
<title>Tracking in house use</title>
<para>Using the Circulation statistics reporting wizard you can run
reports on in house usage of items simply by choosing 'Local Use'
from the 'Type' pull down:</para>
<screenshot>
<screeninfo>In House Use Stats</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/inhouse.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="serialstats">
<title>Serials Statistics</title>
<note>
<para>These reports are limited in what data they can look at, so
it's often recommended to use <link linkend="customreports">custom
reports</link> for official end of the year statistics.</para>
</note>
<para>Using the form provided, choose how you would like to list the
serials in your system.</para>
<screenshot>
<screeninfo>Serials Statistics</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/serialsform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you choose to output to the browser your results will print
to the screen.</para>
<screenshot>
<screeninfo>Serials Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/serialsresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also choose to export to a file that you can manipulate
to your needs.</para>
</section>
<section id="holdstats">
<title>Holds Statistics</title>
<note>
<para>These reports are limited in what data they can look at, so
it's often recommended to use <link linkend="customreports">custom
reports</link> for official end of the year statistics.</para>
</note>
<para>Using the form provided you can see statistics for holds placed,
filled, cancelled and more at your library. From the form choose what
value you want to display in the column and what value to show in the
row. You can also choose from the filters on the far right of the
form.</para>
<screenshot>
<screeninfo>Hold Statistics Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/holdstatsform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you choose to output to the browser your results will print
to the screen.</para>
<screenshot>
<screeninfo>Hold Stats Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/holdstatsresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also choose to export to a file that you can manipulate
to your needs.</para>
</section>
<section id="mostcheckouts">
<title>Patrons with the most checkouts</title>
<para>This report will simply list the patrons who have the most
checkouts.</para>
<screenshot>
<screeninfo>Patrons with the most checkouts form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/topcheckoutsform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you choose to output to the browser your results will print
to the screen.</para>
<screenshot>
<screeninfo>Top checkouts results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/topcheckoutsresult.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also choose to export to a file that you can manipulate
to your needs.</para>
</section>
<section id="mostcirculated">
<title>Most Circulated Items</title>
<para>This report will simply list the items that have the been
checked out the most.</para>
<screenshot>
<screeninfo>Most Circulation Items Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/topcircform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you choose to output to the browser your results will print
to the screen.</para>
<screenshot>
<screeninfo>Top Circulation Items Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/topcircresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also choose to export to a file that you can manipulate
to your needs.</para>
</section>
<section id="patnocheckouts">
<title>Patrons with no checkouts</title>
<para>This report will list for you the patrons in your system who
haven't checked any items out.</para>
<screenshot>
<screeninfo>Patrons with no Checkouts</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/patnocheckout.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you choose to output to the browser your results will print
to the screen.</para>
<screenshot>
<screeninfo>Results for Patrons with no Checkouts</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/patnocheckout-results.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also choose to export to a file that you can manipulate
to your needs.</para>
</section>
<section id="itemnocheckouts">
<title>Items with no checkouts</title>
<para>This report will list items in your collection that have never
been checked out.</para>
<screenshot>
<screeninfo>Items with No Checkouts</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/nocheckoutsform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you choose to output to the browser your results will print
to the screen.</para>
<screenshot>
<screeninfo>Items with no checkouts results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/nocheckoutsresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also choose to export to a file that you can manipulate
to your needs.</para>
</section>
<section id="catbyitem">
<title>Catalog by Item Type</title>
<para>This report will list the total number of items of each item
type per branch.</para>
<screenshot>
<screeninfo>Catalog by Item Type</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/itemtotals.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you choose to output to the browser your results will print
to the screen.</para>
<screenshot>
<screeninfo>Total of Items by Type and Branch</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/itemtotalsresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also choose to export to a file that you can manipulate
to your needs.</para>
</section>
<section id="lostreport">
<title>Lost Items</title>
<para>This report will allow you to generate a list of items that have
been marked as Lost within the system</para>
<screenshot>
<screeninfo>Lost Items Report</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/lostitems.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="avloantime">
<title>Average Loan Time</title>
<para>This report will list the average time items are out on loan
based on the criteria you enter:</para>
<screenshot>
<screeninfo>Average Checkout Period Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/averloanform.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you choose to output to the browser your results will print
to the screen.</para>
<screenshot>
<screeninfo>Average Checkout Period Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/avercheckout.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also choose to export to a file that you can manipulate
to your needs.</para>
</section>
</section>
<section id="reportdic">
<title>Report Dictionary</title>
<para>The report dictionary is a way to pre-define common filters you'd
like to apply to your reports. This is a good way to add in filters that
the report wizard doesn't include by default. To add a new definition,
or filter, click 'New Definition' on the Reports Dictionary page and
follow the 4 step process.</para>
<para>Step 1: Name the definition and provide a description if
necessary</para>
<screenshot>
<screeninfo>Create a Definition</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/dict1.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Step 2: Choose the module that the will be queried.</para>
<screenshot>
<screeninfo>Select Koha Module</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/dict2.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Step 3: Choose columns to query from the tables presented.</para>
<screenshot>
<screeninfo>Choose columns</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/dict3.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Step 4: Choose the value(s) from the field(s). These will be
automatically populated with options available in your database.</para>
<screenshot>
<screeninfo>Choose fields and values</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/dict4.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Confirm your selections to save the definition.</para>
<screenshot>
<screeninfo>Confirm Definition</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/dictconfirm.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Your definitions will all appear on the Reports Dictionary
page</para>
<screenshot>
<screeninfo>Reports Dictionary Listing</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/dictlist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Then when generating reports on the module you created the value
for you will see an option to limit by the definition at the bottom of
the usual filters.</para>
<screenshot>
<screeninfo>Dictionary Limit Option</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/dictionarylimit.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</chapter>
<chapter id="opac">
<title>OPAC</title>
<para>This chapter assumes that you have the following preferences set as
follows:</para>
<itemizedlist>
<listitem>
<para><link
linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> =
default</para>
</listitem>
<listitem>
<para><link
linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
default</para>
</listitem>
<listitem>
<para><link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
= show</para>
</listitem>
<listitem>
<para><link linkend="TagsEnabled">TagsEnabled</link> = Allow</para>
</listitem>
<listitem>
<para><link linkend="TagsInputOnDetail">TagsInputOnDetail</link>
=Allow</para>
</listitem>
<listitem>
<para><link linkend="TagsInputOnList">TagsInputOnList</link> =
Allow</para>
</listitem>
<listitem>
<para><link linkend="reviewson">reviewson</link> = Allow</para>
</listitem>
<listitem>
<para><link linkend="ShowReviewer">ShowReviewer</link> = Allow</para>
</listitem>
<listitem>
<para><link linkend="ShowReviewerPhoto">ShowReviewerPhoto</link>
=Allow</para>
</listitem>
<listitem>
<para><link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> =
Show</para>
</listitem>
<listitem>
<para><link linkend="OPACAmazonEnabled">OPACAmazonEnabled</link> =
Use</para>
</listitem>
<listitem>
<para><link
linkend="OPACAmazonCoverImages">OPACAmazonCoverImages</link> =
Show</para>
</listitem>
<listitem>
<para><link linkend="XISBN">XISBN</link> = Use</para>
</listitem>
<listitem>
<para><link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
= Default set of links</para>
</listitem>
<listitem>
<para><link linkend="OPACShowCheckoutName">OPACShowCheckoutName</link>
= Don't show</para>
</listitem>
<listitem>
<para><link linkend="RequestOnOpac">RequestOnOpac</link> =
Allow</para>
</listitem>
<listitem>
<para><link
linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link> =
Allow</para>
</listitem>
<listitem>
<para><link linkend="OpacBrowseResults">OpacBrowseResults</link> =
Enable</para>
</listitem>
<listitem>
<para><link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> =
Allow</para>
</listitem>
</itemizedlist>
<para>If your system preferences are set differently your displays may
differ.</para>
<section id="opacsearchresults">
<title>Search Results</title>
<para>To search the OPAC you can either choose to enter your search
words in the box at the top of the OPAC or click on the 'Advanced
Search' link to perform a more detailed search.</para>
<screenshot>
<screeninfo>OPAC Search Box</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/searchbox.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>For more on searching check the '<link
linkend="searching">Searching</link>' chapter in this manual.</para>
<section id="opacresultsoverview">
<title>Results Overview</title>
<para>After performing a search the number of results found for your
search will appear above the results</para>
<screenshot>
<screeninfo>Total Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/totalresults-rss.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>By default your search results will be sorted based on your
<link linkend="opacdefaultsort">OPACdefaultSortField and
OPACdefaultSortOrder</link> system preference values. To change this
you can choose another sorting method from the pull down on the
right.</para>
<screenshot>
<screeninfo>Results Sorting Options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/sortingresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Under each title on your results list a series of values from
your leader will appear. It is important to note that this has nothing
to do with the item types or collection codes you have applied to your
records, this data is all pulled from your leader.</para>
<screenshot>
<screeninfo>Leader Visualization</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/leader.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Below each title you will see the availability for the items
attached to the record. Note that even if you filtered on one library
location all locations that hold the item will appear on the search
results.</para>
<screenshot>
<screeninfo>Holdings Information</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/holdings-results.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you have turned on <link linkend="enhancedcontent">Enhanced
Content</link> preferences you may have book jackets on your search
results.</para>
<screenshot>
<screeninfo>Book Jacket on Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/coverresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="opacfilter">
<title>Filters</title>
<para>To filter your results click on the links below the 'Refine Your
Search' menu on the left of your screen</para>
<screenshot>
<screeninfo>Refine Your Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/refineresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="searchrss">
<title>Search RSS Feeds</title>
<para>You will be able to subscribe to your search results as an RSS
feed by clicking the RSS icon in your address bar or next to the
number of results. To learn more about what RSS feeds are check out
<ulink url="http://www.youtube.com/watch?v=0klgLsSxGsU";>this tutorial
video</ulink>.</para>
<screenshot>
<screeninfo>RSS Feed Icon</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/totalresults-rss.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Subscribing to search results as RSS feeds will allow you to see
when a new item is added to the catalog in your area of
interest.</para>
</section>
</section>
<section id="opacbibrec">
<title>Bibliographic Record</title>
<para>When you click on a title from the search results, you're brought
to the bibliographic detail of the record. This page is broken down in
several different areas.</para>
<para>At the top of your screen will be the title and the GMD:</para>
<screenshot>
<screeninfo>Title</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/bibtitle.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Below the title the authors will be listed. These come from your
1xx and 7xx fields:</para>
<screenshot>
<screeninfo>Author Display</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/bibauthor.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you have your <link
linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> preference
set to 'show' you will see a material type that is determined by values
in your fixed fields (learn more in the <link linkend="XSLTiTypes">XSLT
Item Types</link> Appendix).</para>
<screenshot>
<screeninfo>XSLT Item Type</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/bibleader.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Next you'll see the description of the record you're
viewing:</para>
<screenshot>
<screeninfo>Basic Details</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/bibdetails.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Following that information you'll find the subject headings which
can be clicked to search for other titles on similar topics</para>
<screenshot>
<screeninfo>Bibliographic Subjects</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/bibsubjects.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If your record has a table of contents or summary it will appear
next to the 'Summary' or 'Table of Contents' label</para>
<screenshot>
<screeninfo>Summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/bibsummary.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If your record has data in the 856 fields you'll see the links to
the right of the 'Online Resources' label</para>
<screenshot>
<screeninfo>Online Resources</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/biblinks.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If the title you're viewing is in a public list then you'll see a
list of those to the right of the 'List(s) this item appears in' label
and if it has tags they will appear below the 'Tags from this library'
label</para>
<screenshot>
<screeninfo>Tags</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/bibtags.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>In the tabs below the details you will find your holdings
data</para>
<screenshot>
<screeninfo/>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/bibholdings.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Any notes (5xx fields) that have been cataloged will appear under
'Title Notes'</para>
<screenshot>
<screeninfo>Title notes</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/bibtitlenotes.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you're allowing comments they will appear in the next
tab</para>
<screenshot>
<screeninfo>Comments</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/bibcomments.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>And finally if you have enabled FRBR and you have other editions
of the title in your collection you will see the 'Editions' tab.</para>
<screenshot>
<screeninfo>Editions</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/bibeditions.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To the right of the details you'll find a series of boxes. The
first box is a list of buttons to help navigate the search results. From
there you can see the next or previous result from your search or return
to the results.</para>
<screenshot>
<screeninfo>Search Options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/bibsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking Browse Results at the top of the right column will open
up your search results on the detail page</para>
<screenshot>
<screeninfo>Search Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/bibbrowseresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Below the search buttons you'll find the links to place a hold,
print the record, save the record to your lists, or add it to your
cart</para>
<screenshot>
<screeninfo>More options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/biboptions.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking 'More Searches' will show the list of libraries you
entered in your <link
linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
preference</para>
<screenshot>
<screeninfo>More Searches</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/bibmoresearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Under the 'Save Record' label you will find a series of file
formats you can save the record as. This list can be customized by
altering the <link linkend="OpacExportOptions">OpacExportOptions</link>
system preference.</para>
<screenshot>
<screeninfo>Save Record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/bibsave.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If at any time you want to change the view from the 'Normal' view
to see the Marc or the ISBD you can click the tabs across the top of the
record</para>
<screenshot>
<screeninfo>Record Views</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/bibdetail/bibviews.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="opaclistscart">
<title>Lists & Cart</title>
<para>A cart is a temporary holding place for records you're interested
in finding during this session. That means that once you log out of the
OPAC or close the browser you lose the items in your cart. A list is a
more permanent location for saving items. To learn more about lists,
check the <link linkend="stafflists">Lists in the Staff Client</link>
chapter of this manual.</para>
<section id="opaclists">
<title>Lists</title>
<para>Patrons can manage their own private lists by visiting the 'my
lists' section of their account.</para>
<screenshot>
<screeninfo>Lists Management</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/nolists.png"/>
</imageobject>
</mediaobject>
</screenshot>
<section id="opacaddlists">
<title>Creating Lists</title>
<para>Lists can also be created by choosing the 'New List' option in
the 'Add to' menu on the search results</para>
<screenshot>
<screeninfo>Add to New List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/addtonewlist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To create a list the patron simply needs to click the 'New
List' link and populate the form that appears</para>
<screenshot>
<screeninfo>Create a new list</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/newlist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The only field required is the 'List Name,' but the patron can
also choose how they want the list sorted and if the list is public
or private.<important>
<para>If you aren't allowing patrons to create public lists with
the <link
linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link>
preference then patrons will only be able to create private
lists.</para>
</important></para>
</section>
<section id="opacaddtolists">
<title>Adding titles to Lists</title>
<para>Titles can be added to lists from the search results and/or
from the bibliographic record. On the search results options to add
items to the list appear below each result and across the top of the
results page</para>
<screenshot>
<screeninfo>Add to Lists from Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/addtolistcart.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To add a single title to a list, click the 'Save to Lists'
option and then choose the list you'd like to add the title to. To
add multiple titles to a list check the boxes on the left of the
titles you want to add and then choose the list you want to add the
titles to from the 'Add too' pull down at the top of the
screen.</para>
</section>
<section id="listscontent">
<title>Viewing Lists Contents</title>
<para>To view the contents of a list, click on the list name under
the Lists button.</para>
<screenshot>
<screeninfo>Lists</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/chooselist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The contents of the list will look similar to your search
results pages except that there will be different menu options
across the top of the list.</para>
<screenshot>
<screeninfo>List View</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/listview.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Using the menu options above the list you can place multiple
items on hold, download the list contents, email the list or print
the list out.</para>
<itemizedlist>
<listitem>
<para>To place a hold on one or more list items check the box to
the left of the item and click the 'Place Hold' link at the
top</para>
</listitem>
<listitem>
<para>To download the list contents click the 'Download List'
link and choose the format you'd like to download the list
in</para>
<itemizedlist>
<listitem>
<tip>
<para>iso2079 is MARC format</para>
</tip>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>To email the list contents to someone, click the 'Send
List' link and enter in your email details in the form that pops
up</para>
<screenshot>
<screeninfo>Email List Contents</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/emailist.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>To print the contents of your list out click the 'Print
List' link</para>
</listitem>
</itemizedlist>
</section>
<section id="opacmanagelists">
<title>Managing Lists</title>
<para>Once the list is saved patrons can begin adding items to it.
From the 'my lists' tab on the patron record the patron can edit and
delete the lists they have created by clicking the appropriate link
to the right of the list name.</para>
<screenshot>
<screeninfo>My Lists</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/mylists.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To edit the list's title or sorting patrons click the 'Edit'
link to the right of the list description.</para>
<screenshot>
<screeninfo>Editing List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/editlist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When clicking 'Delete' next to a list you will be asked to
confirm that you want to delete the list.</para>
<screenshot>
<screeninfo>Delete list confirmation</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/deletelist.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The list will not be deleted until the 'Confirm' button is
clicked to the right of the list you'd like to delete.</para>
<para/>
</section>
</section>
<section id="opaccart">
<title>Cart</title>
<para/>
<section id="opacaddtocart">
<title>Adding titles to the Cart</title>
<para>Titles can be added to the cart from the search results and/or
from the bibliographic record. On the search results options to add
items to the cart appear below each result and across the top of the
results page</para>
<screenshot>
<screeninfo>Add to Cart on Search Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/addtolistcart.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking the 'Add to Cart' button will add the one title to
your cart. To add multiple titles at once, check the box to the left
of each result and then choose 'Cart' from the 'Add to' pull down at
the top of the screen. Once titles are added to the cart you will be
presented with a confirmation</para>
<screenshot>
<screeninfo>Items added to Cart</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/addedtocart.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="manageopaccart">
<title>Managing the Cart</title>
<para>Once you have titles in your cart you can manage the contents
by clicking on the 'Cart' button usually found at the top of the
screen to the right of the search box. Your cart will open in a new
window.</para>
<screenshot>
<screeninfo>Contents of your cart</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/cartcontents.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From this window you are presented with several options.
Across the top of the cart are several buttons.</para>
<para>First is the 'More details' button. Clicking this will show
you additional information about the titles in your cart (ISBNs,
Subjects, Publisher Info, Notes and more).</para>
<para>Next is the option to send the contents of your cart to an
email address. This is handy if you want to send the resources you
found at the library to your home email account to refer to later or
to send to a patron researching a specific topic. Clicking this link
will open up a new window that asks for the email address and
message to send.</para>
<screenshot>
<screeninfo>Email Cart</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/emailcart.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>In addition to sending your cart you can download the contents
of your cart in several pre-defined formats or using a <link
linkend="csvprofiles">CSV Profile</link> that you defined in the
Tools module.</para>
<screenshot>
<screeninfo>Download Cart</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/downloadcart.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Finally you can print out the contents of your cart by
choosing the 'Print' link.</para>
<para>In addition to the various different ways to save the contents
of your cart, there are ways to add value to the data in your cart.
By selecting one or more titles from the cart you can add them to a
list (click 'Add to a List'), place hold(s) (click 'Place hold'), or
tag them (click 'Tag'). All of these operations follow the same
procedure as they do when performing them in the OPAC.</para>
</section>
</section>
</section>
<section id="opacplacehold">
<title>Placing Holds</title>
<para>Patrons can place holds on items via the OPAC if they're logged in
and you have the <link linkend="RequestOnOpac">RequestOnOpac</link>
preference set to 'Allow'. If the item can be placed on hold the option
to place it on hold will appear in several different places.</para>
<itemizedlist>
<listitem>
<para>When viewing a list or search results page you'll see the
option to place hold on multiple items by checking the boxes to the
left of the results and clicking 'Place Hold' at the top</para>
<screenshot>
<screeninfo>Place Hold from Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/opacplaceholdresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>When viewing a list or search results page you'll see the
option to place the item on hold below the basic information about
the title</para>
<screenshot>
<screeninfo>Place Hold</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/opacplaceholdsindiv.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>When viewing an individual title you'll see the option to
place a hold in the box on the right side of the screen</para>
<screenshot>
<screeninfo>Place Hold</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/opacplaceholdsdetail.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<para>No matter which of the above links you click to place your hold
you'll be brought to the same hold screen.</para>
<screenshot>
<screeninfo>Place Hold Form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/opacplacehold.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Check the box to the left of the items you'd like to place on
hold</para>
</listitem>
<listitem>
<para>The title includes a link back to the detail page for the
record</para>
</listitem>
<listitem>
<para>The priority shows where in the holds queue this hold will
fall</para>
</listitem>
<listitem>
<para>If allowed by your <link
linkend="OPACAllowHoldDateInFuture">OPACAllowHoldDateInFuture</link>
preference, the 'Hold Starts on Date' column will show. This field
allows the patron to have their hold start on a future date.</para>
</listitem>
<listitem>
<para>By default holds placed in the system remain until canceled,
but if the patron fills in a 'Hold Not Needed After' date then the
hold has an expiration date.</para>
<itemizedlist>
<listitem>
<important>
<para>Expired holds are removed by the <link
linkend="expiredholdscron">Expired Holds Cron Job</link>, this
is not an automatic process and must be set up by your system
administrator</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If allowed by your <link
linkend="OPACItemHolds">OPACItemHolds</link> preference the patron
will be allowed to choose whether to place the hold on the next
available copy or a specific copy</para>
<screenshot>
<screeninfo>Specific Copy Hold</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/opacplaceholdspecific.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>If allowed by your <link
linkend="OPACAllowUserToChooseBranch">OPACAllowUserToChooseBranch</link>
preference the patron can choose where they'd like to pick up their
hold</para>
</listitem>
</itemizedlist>
<para>After clicking the Place Hold button the patron will be brought to
their account page where they'll see all of the items they have on
hold.</para>
</section>
<section id="opacenhancedcontent">
<title>Enhanced Content</title>
<para/>
<section id="opactagging">
<title>Tagging</title>
<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
may be able to add tags to bibliographic records from the search
results and/or bibliographic records. If you are allowing patrons to
add tags from the search results screen you will see an input box
below each result and a 'Tag' option at the top of the screen.</para>
<screenshot>
<screeninfo>Tagging Options on Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/tags-results.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To add a tag to one item, type the tabs (separated by commas) in
the 'New tag' box and click 'Add'. You will be presented with a
confirmation of your tags being added.</para>
<screenshot>
<screeninfo>Tags Added on Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/tagsadded-results.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From the results you can also tag items in bulk by clicking the
checkboxes on the left and then clicking the 'Tag' button at the top.
After clicking the button it will change into an input box for you to
add tags to all of the items you have selected.</para>
<screenshot>
<screeninfo>Add Tags to Multiple Items</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/tagaddmultiple-results.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="opaccomments">
<title>Comments</title>
<para>Patrons can leave comments in the OPAC if you have the <link
linkend="reviewson">reviewson</link> preference set to allow this.
Each bibliographic record has a comments tab below the bibliographic
information.</para>
<screenshot>
<screeninfo>Comments Tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/commentstab.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If the patron is logged in they will see a link to add a comment
to the item. Clicking this link will open a pop up window with a box
for their comments.</para>
<screenshot>
<screeninfo>Add a Comment</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/addcomment.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once the comment has been typed and the 'Submit' button clicked,
the patron will see their comment as pending and other patrons will
simply see that there are no comments on the item.</para>
<screenshot>
<screeninfo>Pending Comment</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/commentpending.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Once the comment is approved the patron will see the number of
comments on the 'Comments' tab and the comment highlighted in yellow
as their comment.</para>
<screenshot>
<screeninfo>Your Comments</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/yourcomment.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Other patrons will see the comment with the name of the patron
who left the comment (unless you have set the <link
linkend="ShowReviewer">ShowReviewer</link> preference to not show
patron names).</para>
<screenshot>
<screeninfo>Comment by other patron</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/commentby.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you'd like to link to a page of recent comments added to your
catalog you simply need to add a link to
http://YOURCATALOG/cgi-bin/koha/opac-showreviews.pl to anywhere on
your OPAC:</para>
<screenshot>
<screeninfo>Recent Comments List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/recentcomments.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="zotero">
<title>Zotero</title>
<para>Zotero is a Firefox add on that allows for the saving and
generating of a bibliography. Learn more about and download Zotero at
<ulink url="http://zotero.org";>http://zotero.org</ulink>.</para>
<para>When on the search results in the Koha OPAC, if you have Zotero
installed, you will see a folder icon in the address bar to the right
of the URL. Clicking that folder will open up a list of titles on the
page for you to pick from to add to Zotero.</para>
<screenshot>
<screeninfo>Zotero pop up</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/zoteroaddressbar.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Select the titles you want to add to Zotero and then click the
'OK' button. This will add the title to Zotero. You can see the title
by opening your Zotero library.</para>
<screenshot>
<screeninfo>Title in the Zotero Library</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/zoterotitle.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="customrss">
<title>Custom RSS Feeds</title>
<para>Using misc/cronjobs/rss/rss.pl you can generate an RSS feed for
any SQL query (for example a new acquisitions RSS feed). rss.pl is run
on the command line to produce an RSS XML document.</para>
<para>The output should be placed in a directory accessible to the
OPAC (or staff) web interface so that users can download the RSS
feed.</para>
<para>An example of usage can be found at: misc/cronjobs/rss.pl
lastAcquired.conf</para>
<para>Normally rss.pl should be run periodically (e.g., daily) to keep
the feed up-to-date.</para>
<para>The configuration file (e.g., lastAcquired.conf) lists</para>
<itemizedlist>
<listitem>
<para>name of the template file to use</para>
</listitem>
<listitem>
<para>path of output file</para>
</listitem>
<listitem>
<para>SQL query</para>
</listitem>
</itemizedlist>
<para>rss.pl runs the SQL query, then feeds the output of the query
through the template to produce the output file.</para>
<para><important>
<para>To use custom RSS feeds you need to turn on the cron
job.</para>
</important></para>
</section>
</section>
<section id="opacmyaccount">
<title>My Account</title>
<para>From the OPAC patrons can log in and access their account if you
have set the <link linkend="opacuserlogin">opacuserlogin</link>
preference to 'Allow'. Once logged in patrons are brought to their
account summary. If you would like to get to your account in the OPAC,
you can click on your name in the top right of any page in the
OPAC.</para>
<section id="opacmysummary">
<title>My Summary</title>
<screenshot>
<screeninfo>My Summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/myaccount.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>From the 'my summary' tab, patrons will see all of the items
they have checked out with the overdue items highlighted in red. If
you have <link linkend="OpacRenewalAllowed">OpacRenewalAllowed</link>
set to 'Allow' then your patrons will be able to renew their books
right from the OPAC. If you have HTML entered in the <link
linkend="OPACMySummaryHTML">OPACMySummaryHTML</link> preference then
you will see that to the right of the 'Fines' column.</para>
<screenshot>
<screeninfo>Checked out tab with OPACMySummaryHTML set</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/opacsummary-wlinks.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If your patrons would like to see the items barcodes on their
list of checked out items you can set up a <link
linkend="patronattributetypes">patron attribute</link> with the value
of SHOW_BCODE and <link linkend="authorizedvalues">authorized
value</link> of YES_NO.</para>
<screenshot>
<screeninfo>Add SHOW_BCODE patron attribute</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/SHOW_BCODEadd.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Then on the <link linkend="editpatrons">patron's record set the
value</link> for SHOW_BCODE to yes.</para>
<screenshot>
<screeninfo>Setting value for SHOW_BCODE on patron
record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/SHOW_BCODEattribute.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>This will add a column to the check out summary in the OPAC that
shows the patrons the barcodes of the items they have checked
out.</para>
<screenshot>
<screeninfo>Barcode number on checkout list in OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/barcodeoncheckouts.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking on the 'Overdue' tab will show only the items that are
overdue.</para>
<screenshot>
<screeninfo>Overdue Items</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/myoverdues.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The 'Fines' tab will show just a total of what the patron owes.
Clicking on the total will take them to the 'my fines' tab where they
will see a complete breakdown of their fines and bills. If you don't
charge fines at your library you can turn the display of these tabs
off by setting the <link linkend="OPACFinesTab">OPACFinesTab</link>
preference to 'Don't Allow.'</para>
<screenshot>
<screeninfo>Patron Fines</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/myfines.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Finally, clicking on the 'Holds' tab will show the patron the
status of all of the items they have on hold. Items that are ready for
pickup will be highlighted in yellow.</para>
<screenshot>
<screeninfo>Patron holds status</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/myholds.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Patrons can cancel their own holds if they are not in transit or
already waiting for them. They can also suspend all of their holds
(depending on the value of your <link
linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> system preference)
indefinitely or until a specific date if they choose by filling in the
suspend options at the bottom of the page.</para>
<note>
<para>If you have your <link
linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
preference set to "Don't allow" then you will not have the option to
put an end date on the hold suspension</para>
</note>
</section>
<section id="opacmyaccount-flags">
<title>Patron Flags</title>
<para>If you have <link linkend="patronflags">flagged your patron's
account</link> they may see one of the following error messages at the
top of their account.</para>
<itemizedlist>
<listitem>
<para>Card marked as lost</para>
<screenshot>
<screeninfo>Library card lost</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/nocard.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Patron address in question</para>
<screenshot>
<screeninfo>Patron address in question</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/noaddress.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<note>
<para>this error message will not include a link to the
update form if you have <link
linkend="OPACPatronDetails">OPACPatronDetails</link> set to
'Don't allow'</para>
</note>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Patron marked restricted</para>
<screenshot>
<screeninfo>Patron restricted</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/debarred.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="opacmyfines">
<title>My Fines</title>
<para>If your library charges fines the next tab on the left is 'my
fines.' Opening this tab will show the patron an entire history of
their accounting at the library.</para>
<screenshot>
<screeninfo>Library Fines & Charges</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/mybilling.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="opacmydetails">
<title>My Details</title>
<para>If you have your <link
linkend="OPACPatronDetails">OPACPatronDetails</link> preference set to
'Allow', your patrons will see a form filled in with their contacting
information by clicking on the 'my personal details' tab.</para>
<screenshot>
<screeninfo>Patron's personal details</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/myprofile.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Patrons can edit their details in this form and click 'Submit
Changes' to have their edits sent to the library for review before
their record is updated. The email with the changes is sent to the
library administration email address and lines that the patron changed
will start with the field name in all caps.</para>
<para>If the <link
linkend="OPACPatronDetails">OPACPatronDetails</link> preference is set
to 'Don't allow' then patrons will simply see their details in plain
text.</para>
<screenshot>
<screeninfo>Patron's personal details with no edits</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/myprofile-noedit.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="opacmytags">
<title>My Tags</title>
<para>If your library has <link
linkend="TagsEnabled">TagsEnabled</link> set to 'Allowed' then the
next tab on the left will be 'my tags.' This tab will show patrons all
of the tags in the system as a cloud and then all of the tags they
have applied in a list format. From here patrons have the ability to
remove tags that they have added if they want.</para>
<screenshot>
<screeninfo>Patron's tags</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/mytags.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="opacmypassword">
<title>Change My Password</title>
<para>Next, if you have <link
linkend="OpacPasswordChange">OpacPasswordChange</link> set to 'Allow'
the next tab will be 'change my password,' where patrons can change
their password for logging into the OPAC. Patrons will be presented
with a standard form asking them to enter their old password and then
their new password twice.</para>
<screenshot>
<screeninfo>Change my password</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/mypassword.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="opacmysearchistory">
<title>My Search History</title>
<para>If you have your <link
linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
preference set to 'Allow' then your patrons can access their search
history via the 'my search history' tab.</para>
<screenshot>
<screeninfo>my search history tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/mysearchhistory.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The search history is a record of all searches run by the
patron. Clicking on any of the search phrases will re-run the search
for the patron. The search history can be deleted by the patron at any
time by clicking the 'Delete your search history' link found at the
top of this tab or by clicking the little red 'x' next to the 'Search
history' link at the top right of the OPAC.</para>
<screenshot>
<screeninfo>Search history link at the top right of the
OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/searchistory.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="opacmyhistory">
<title>My Reading History</title>
<para>Depending on your library's setting for <link
linkend="opacreadinghistory">opacreadinghistory</link> your patrons
may see the 'my reading history' tab next. This will show the patron
their entire reading history unless they have asked the library to not
keep that information via the 'my privacy' tab which will appear if
you have the <link linkend="OPACPrivacy">OPACPrivacy</link> preference
set to 'Allow.'</para>
<screenshot>
<screeninfo>Patron reading history</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/myhistory.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="opacmyprivacy">
<title>My Privacy</title>
<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.'
This tab will allow the patrons to decide how the library keeps their
circulation history data.</para>
<screenshot>
<screeninfo>my privacy tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/myprivacy.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The patron can choose from three options:</para>
<itemizedlist>
<listitem>
<para>Forever: keep my reading history without limit. This is the
option for users who want to keep track of what they are
reading.</para>
</listitem>
<listitem>
<para>Default: keep my reading history according to local laws.
This is the default option : the library will keep your reading
history for the duration permitted by local laws.</para>
</listitem>
<listitem>
<para>Never: Delete my reading history immediately. This will
delete all record of the item that was checked-out upon
check-in.</para>
</listitem>
</itemizedlist>
<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
client may change.</para>
<para>Regardless of the patron's choice they can delete their reading
history in bulk at any time by clicking the 'Immediate deletion'
button.</para>
<screenshot>
<screeninfo>Delete Circulation History</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/deletecirchistory.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking this button will not delete items that are currently
checked out, but will clear the patron's past reading history.</para>
</section>
<section id="opacmysuggestions">
<title>My Purchase Suggestions</title>
<para>If your library allows patrons to make purchase suggestions the
next tab will show all suggestions that the patron made to the library
and their statuses. To disable this tab and the suggestion
functionality set the <link
linkend="suggestionspref">suggestion</link> preference to 'Don't
allow.'</para>
<screenshot>
<screeninfo>Patron purchase suggestions</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/mysuggestions.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="opacmymsgs">
<title>My Messaging</title>
<para>If your library has the <link
linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
preference set to 'Allow' then your patrons will be able to choose
which messages they receive from the library (with the exception of
overdue notices which the library controls).</para>
<screenshot>
<screeninfo>Patron messaging preferences</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/mymessages.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>If you also allow SMS messages with the <link
linkend="SMSSendDriver">SMSSendDriver</link> preference, you will see
an additional column to receive these messages as SMS (or text
messages) and a field for a cell (or SMS) number.</para>
<screenshot>
<screeninfo>SMSSendDriver in the OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/OPACSMSSendDriver.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="opacmylists">
<title>My Lists</title>
<para>Finally, if your library has the <link
linkend="virtualshelves">virtualshelves</link> set to 'Allow' then the
last tab will by 'my lists.' From here your patrons can review public
lists and create or edit their own private lists.</para>
<screenshot>
<screeninfo>Patron lists</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/mylists.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="purchasesuggest">
<title>Purchase Suggestions</title>
<para>If your library has the <link
linkend="suggestionspref">suggestion</link> preference set to 'Allow'
then patrons will have the option to make purchase suggestions in
several areas in the OPAC.</para>
<para>There will be a link at the top of your OPAC under the search
box.</para>
<screenshot>
<screeninfo>Purchase Suggestions Link on Search Box</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/suggestfromsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>There will be a link when the patron finds nothing for their
search.</para>
<screenshot>
<screeninfo>Purchase Suggestion Link from Search Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/suggestfromnoresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>And there will be a link on the patron's <link
linkend="opacmysuggestions">My Purchase Suggestions</link> tab.</para>
<screenshot>
<screeninfo>Purchase Suggestion from My Purchase Suggestions
Tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/suggestfrommyaccount.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking any one of these links will open the purchase suggestion
form.</para>
<screenshot>
<screeninfo>New Purchase Suggestion</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/newsuggestion.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>From the form on the 'Title' is required by the
library.</para>
</listitem>
<listitem>
<para>If you would like the 'Reason for suggestion' menu shown in
the screenshot above to appear on your suggestions list you need to
add an <link linkend="authorizedvalues">authorized value</link>
category titled 'OPAC_SUG' and include reasons as values in that
list.</para>
</listitem>
<listitem>
<para>If you would like the patron to be able to choose which branch
they are making a suggestion for you need to set the <link
linkend="AllowPurchaseSuggestionBranchChoice">AllowPurchaseSuggestionBranchChoice</link>
preference to 'Allow'</para>
</listitem>
</itemizedlist>
<para>Once the form is submitted the data will be saved to the <link
linkend="managesuggest">Acquisitions</link> module for the librarians to
manage.</para>
</section>
</chapter>
<chapter id="searching">
<title>Searching</title>
<para/>
<section id="searchprefixes">
<title>Advanced Search Prefixes</title>
<para>The following prefixes can be added to search terms in the keyword
search box to limit items returned</para>
<itemizedlist>
<listitem>
<para>ti: title search</para>
<itemizedlist>
<listitem>
<para>ex. ti:hamlet</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>su: subject search</para>
<itemizedlist>
<listitem>
<para>ex. su:cookery</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>pb: publisher search</para>
<itemizedlist>
<listitem>
<para>ex. pb:penguin</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>au: author search</para>
<itemizedlist>
<listitem>
<para>ex. au:rowling</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>su-geo: geographic subjects</para>
<itemizedlist>
<listitem>
<para>ex. su-geo:wales and kw:description and kw:travel</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>bc: barcode</para>
<itemizedlist>
<listitem>
<para>ex. bc:502326000912</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>lex: lexile</para>
<itemizedlist>
<listitem>
<para>levels lex:510</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para/>
</section>
<section id="searchguide">
<sectioninfo>
<author>
<firstname>Becky</firstname>
<surname>Bell</surname>
<affiliation>
<orgname>WALDO</orgname>
</affiliation>
</author>
<pubdate>October 2008</pubdate>
<othercredit role="copyeditor">
<firstname>Nicole C.</firstname>
<surname>Engard</surname>
<contrib>Fixed typos, changed content where necessary and added new
screenshots.</contrib>
</othercredit>
</sectioninfo>
<title>Guide to Searching</title>
<para>This brief guide will explain a chart that shows a sample of how a
MARC21 database can be configured, as well as a brief introductory
searching guide. The indexing fields described in this document relate
to the bibliographic data and does not address authority database
indexing.</para>
<section id="searchguide-indexing">
<title>Indexing and Searching Description</title>
<para>Koha's databases are indexed by the Zebra open-source software.
The overview to the documentation describes Zebra as:</para>
<blockquote>
<para>"...Zebra is a high-performance, general-purpose structured
text indexing and retrieval engine. It reads records in a variety of
input formats (eg. email, XML, MARC) and provides access to them
through a powerful combination of Boolean search expressions and
relevance-ranked free-text queries.</para>
<para>Zebra supports large databases (tens of millions of records,
tens of gigabytes of data). It allows safe, incremental database
updates on live systems. Because Zebra supports the
industry-standard information retrieval protocol, Z39.50, you can
search Zebra databases using an enormous variety of programs and
toolkits, both commercial and free, which understands this
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>
</blockquote>
<para>This brief guide will explain a chart that shows a sample of how
a MARC21 database can be configured, as well as a brief introductory
searching guide. The indexing fields described in this document relate
to the bibliographic data and does not address authority database
indexing.</para>
<note>
<para>The indexing described in this document is the set used by
SouthEastern University. Your local indexing may vary.</para>
</note>
</section>
<section id="searchguide-indexconfig">
<title>Indexing Configuration</title>
<para>There are three configuration files that Koha uses while
indexing.</para>
<para>The first configuration file (etc/zebradb/biblios/etc/bib1.att)
contains the Z39.50 bib-1 attribute list, plus the Koha local use
attributes for Biblio Indexes, Items Index, and Fixed Fields and other
special indexes. The Z39.50 Bib-1 profile is made up of several
different types of attributes: Use, Relation, Position, Structure,
Truncation, and Completeness. The bib-1 'Use' attribute is represented
on the chart; the other attributes are used primarily when doing
searches. While there are over 150+ use attributes that could be used
to define your indexing set, it's unlikely that you will choose to use
them all. The attributes you elect to use are those that become the
indexing rules for your database. The other five attribute sets define
the various ways that a search can be further defined, and will not
specifically be addressed in this document. For a complete list of the
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>
<para>The second file
(etc/zebradb/marc_defs/[marc21|unimarc]/biblios/record.abs) contains
the abstract syntax which maps the MARC21 tags to the set of Use
Attributes you choose to use. The rules established in this file
provides a passable Bath level 0 and 1 service, which includes author,
title, subject, keyword and exact services such as standard
identifiers (LCCN, ISBN, ISSN, etc.)</para>
<para>The third file (etc/zebradb/ccl.properties) is the Common
Command Language (CCL) field mappings. This file combines the bib-1
attribute set file and the abstract file and adds the qualifiers,
usually known as index names. The qualifiers, or indexes, for this
database are: pn, cpn, cfn, ti, se, ut, nb, ns, sn, lcn, callnum, su,
su-to, su-geo, su-ut, yr,pubdate, acqdate, ln, pl, ab, nt, rtype,
mc-rtype, mus, au, su-na, kw, pb, ctype, and an.</para>
<para>The Koha Indexing Chart summarizes the contents of all three of
these files in a more readable format. The first two columns labeled
Z39.50 attribute and Z39.50 name matches the Z39.50 bib-1 attributes
file. The third column labeled MARC tags indexed is where you find
which MARC tags are mapped to an attribute. The fourth column labeled
Qualifiers identifies the search abbreviations used in the internal
CCL query. The following description provides a definition for the
word 'qualifiers'.</para>
<para><emphasis>Qualifiers are used to direct the search to a
particular searchable index, such as title (ti) and author indexes
(au). The CCL standard itself doesn't specify a particular set of
qualifiers, but it does suggest a few shorthand notations. You can
customize the CCL parser to support a particular set of qualifiers to
reflect the current target profile. Traditionally, a qualifier would
map to a particular use-attribute within the BIB-1attribute set. It is
also possible to set other attributes, such as the structure
attribute.</emphasis></para>
<para>In the MARC tags indexed column, there are some conventions used
that have specific meanings. They are:</para>
<itemizedlist>
<listitem>
<para>A three digit tag (100) means that all subfields in the tag
can be used in a search query. So, if you enter a search for
'Jackson' as an author, you will retrieve records where Jackson
could be the last name or the first name.</para>
</listitem>
<listitem>
<para>A three digit tag that has a '$' followed by a letter
(600$a) means that a search query will only search the 'a'
subfield.</para>
</listitem>
<listitem>
<para>A three digit tag that is followed by a ':' and a letter
(240:w) means that a search query can be further qualified. The
letter following the ':' identifies how to conduct the search. The
most common values you'll see are 'w' (word), 'p' (phrase), 's'
(sort), and 'n' (numeric).</para>
</listitem>
</itemizedlist>
<para>The contents of the MARC tags, subfields, and/or fixed field
elements that are listed in this chart are all indexed. You'll see
that every attribute line is not mapped to a specific qualifier
(index)-LC card number, line 9 is one example. However, every indexed
word (a string of characters preceded and succeeded by a space) can be
searched using a keyword (kw) search. So, although an LC card number
specific index doesn't exist, you can still search by the LCCN since
tag 010 is assigned to the LC-card-number attribute. To verify this,
enter 72180055 in the persistent search box. You should retrieve The
gods themselves, by Isaac Asimov.</para>
<para>Examples of fixed field elements indexing can be seen on the
chart between Attribute 8822 and Attribute 8703. These attributes are
most commonly used for limiting. The fixed field attributes currently
represent the BK codes. Other format codes, if needed, could be
defined.</para>
</section>
<section id="searchguide-basics">
<title>Basic Searching</title>
<para>The search box that library staff and library patrons will see
most often is the persistent search box at the top of the page. Koha
interprets the searches as keyword searches.</para>
<screenshot>
<screeninfo>Koha search box</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/searchbox.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>To start a search, you enter a word or multiple words in the
search box. When a single word is entered, a keyword search is
performed. You can check this out by typing one word into the form and
note the number of results located. Then, repeat the search with a
minor change. In front of the search word, type 'kw=' followed by the
same search term. The results will be identical.</para>
<para>When you have more than one word in the search box, Koha will
still do a keyword search, but a bit differently. Each word will be
searched on its own, then the Boolean connector 'and' will narrow your
search to those items with all words contained in matching
records.</para>
<para>Suppose you want to find material about how libraries are using
mashups. You'll select the major words and enter them into the
persistent search box.</para>
<screenshot>
<screeninfo>Keyword Search</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/searchterms.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The response to this search is:</para>
<screenshot>
<screeninfo>Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/resultssummary.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The order of the words does not affect the retrieval results, so
you could also enter the search as "mashups library". The response to
this search is results</para>
<screenshot>
<screeninfo>Results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/resultssummary2.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Too many words in the search box will find very few matches, as
the following example illustrates:</para>
<screenshot>
<screeninfo>No results found</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/noresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="searchguide-advanced">
<title>Advanced Searching</title>
<para>When you can't find the most appropriate material with a general
search, you can move to the Advanced Search page by clicking on the
Search option on the persistent toolbar.</para>
<screenshot>
<screeninfo>Koha Menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/menubar.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The Advanced Search page offers many ways to limit the results
of your search. You can search using the Boolean operators AND, OR,
and NOT; limit by item type; limit by year and language; limit by
subtypes audience, content, format, or additional content types; by
location and by availability.</para>
<para>The first limiting section on the Advanced Search page provides
a quick and simple way to use the Boolean operators in your search.
Note that this display depends on a system preference setting. This
option can be found on the Administration > System Preferences >
Searching page. The option called <link
linkend="expandedSearchOption">expandedSearchOption</link> must be set
to 'show' to see the following display.</para>
<screenshot>
<screeninfo>Advanced Search Options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/searchoptions.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>In this section you can choose among the many indexes by
clicking on the arrow in the first box. The blank box that follows is
where you enter your first search term or terms. On the second line,
you can choose the Boolean operator you want to use in your search.
The options are 'and', 'or', and 'not'. Then, you would again choose
the index to search, followed by the second term or terms. If you have
more concepts you want to include in your search, you can click the
[+] to add another line for your search.</para>
<para>A sample search is shown next, followed by its results:</para>
<screenshot>
<screeninfo>Advanced Search</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/advsearch.png"/>
</imageobject>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>Results from Advanced Search</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/numresults.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When you use the Boolean operators to broaden or narrow a
search, remember the action of each operator. The 'and' operator
narrows the results you'll retrieve because the search will retrieve
the records that include all your search terms. The 'or' operator
expands the results because the search will look for occurrences of
all of your search terms. The 'not' operator excludes records with the
term that follows the operator.</para>
<para>Note: If you leave this <link
linkend="expandedSearchOption">expandedSearchOption</link> set to
'don't show', this is the display you will see:</para>
<screenshot>
<screeninfo>Fewer Search Options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/feweropts.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The Advanced Search page then shows the multiple kinds of limits
that can be applied to your search results. Either check a box or
select from the drop down menus to narrow your search. You will type
the year, year range, or a 'greater than (>)' or 'less than (<)'
year.</para>
<screenshot>
<screeninfo>Other Advanced Search Options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/advoptions.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Finally, you can choose how the results will be sorted. The
pre-defined sort options are in the final area of the Advanced Search
screen.</para>
<screenshot>
<screeninfo>Sort Results By</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/advsortby.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The default sort is by relevance, although you can choose to
sort by author, by title, by call number, by dates, or by popularity.
If you would prefer a different default sort, you can set <link
linkend="defaultSortField">defaultSortField</link> to one of the other
choices in Administration > System Preferences >
Searching.</para>
</section>
<section id="searchguide-ccl">
<title>Common Command Language Searching</title>
<para>Koha uses the Common Command Language (CCL) (ISO 8777) as its
internal search protocol. Searches initiated in the graphical
interface use this protocol as well, although the searcher doesn't
know which indexes, operators and limiters are available and being
used to conduct their search. The searcher can use the Advanced Search
when more precise results set are desired and where the search indexes
are somewhat known. However, some library users and many library staff
prefer using a command based structure. This part of the document will
present and explain the use of the Koha command based structure. The
indexes, operators, and limiters used are identical to those used in
the graphical interface.</para>
<section id="searchguide-indexes">
<title>Indexes</title>
<para>The CCL standard itself doesn't specify a particular set of
qualifiers (indexes), but it does suggest a few short-hand notations
such as 'ti', 'au', and 'su'. Koha has a default set of indexes;
it's possible to customize that set by adding needed indexes based
on local requirements. A qualifier (index) maps to a particular
use-attribute within the Z39.50 BIB-1 attribute set. The complete
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>
<para>The standard Koha set of indexes is a fairly common example of
MARC21 indexing rules. The indexes that are defined in Koha are
indexes typically used by other integrated library systems. The
defined Z39.50 Bib-1 Attribute mapped to the indexes include:</para>
<table cellpadding="4" cellspacing="4" frame="all">
<title>Attributes</title>
<tgroup align="left" cols="2" colsep="1" rowsep="1">
<thead>
<row>
<entry>Bib-1 Attribute</entry>
<entry>Qualifier (index)</entry>
</row>
</thead>
<tbody>
<row>
<entry>Personal-name</entry>
<entry>pn</entry>
</row>
<row>
<entry>Corporate-name</entry>
<entry>cpn</entry>
</row>
<row>
<entry>Conference-name</entry>
<entry>cfn</entry>
</row>
<row>
<entry>Title</entry>
<entry>ti</entry>
</row>
<row>
<entry>Title-series</entry>
<entry>se</entry>
</row>
<row>
<entry>Title-uniform</entry>
<entry>ut</entry>
</row>
<row>
<entry>ISBN</entry>
<entry>nb</entry>
</row>
<row>
<entry>ISSN</entry>
<entry>ns</entry>
</row>
<row>
<entry>Local number</entry>
<entry>sn</entry>
</row>
<row>
<entry>Local-classification</entry>
<entry>lcn and callnum</entry>
</row>
<row>
<entry>Subject</entry>
<entry>su, su-to, su-geo, su-ut</entry>
</row>
<row>
<entry>Pubdate</entry>
<entry>yr,pubdate</entry>
</row>
<row>
<entry>Date-of-Acquisition</entry>
<entry>acqdate</entry>
</row>
<row>
<entry>Language</entry>
<entry>ln</entry>
</row>
<row>
<entry>Place-of-publication</entry>
<entry>pl</entry>
</row>
<row>
<entry>Abstract</entry>
<entry>ab</entry>
</row>
<row>
<entry>Notes</entry>
<entry>nt</entry>
</row>
<row>
<entry>Record-type</entry>
<entry>rtype, mc-rtype, mus</entry>
</row>
<row>
<entry>Author</entry>
<entry>au, aut</entry>
</row>
<row>
<entry>Subject-person-name</entry>
<entry>su-na</entry>
</row>
<row>
<entry>Any (keyword)</entry>
<entry>kw</entry>
</row>
<row>
<entry>Publisher</entry>
<entry>pb</entry>
</row>
<row>
<entry>Content-type</entry>
<entry>ctype</entry>
</row>
<row>
<entry>Koha-Auth-Number</entry>
<entry>an</entry>
</row>
<row>
<entry>Author-personal-bibliography</entry>
<entry>aub</entry>
</row>
<row>
<entry>Author-in-order</entry>
<entry>auo</entry>
</row>
</tbody>
</tgroup>
</table>
<para>Refer to the Koha Indexing Chart for the MARC21 tags mapped to
each Bib-1 Attribute and index combination.</para>
<section id="search-audexamp">
<title>Audience Examples</title>
<itemizedlist>
<listitem>
<para>aud:a Easy</para>
</listitem>
<listitem>
<para>aud:cc Juvenile</para>
</listitem>
<listitem>
<para>aud:d Young adult</para>
</listitem>
<listitem>
<para>aud:e Adult</para>
</listitem>
</itemizedlist>
</section>
<section id="search-contentsexamp">
<title>Contents Examples</title>
<itemizedlist>
<listitem>
<para>fic:1 Fiction</para>
</listitem>
<listitem>
<para>fic:0 Non Fiction</para>
</listitem>
<listitem>
<para>bio:b Biography</para>
</listitem>
<listitem>
<para>mus:j Musical recording</para>
</listitem>
<listitem>
<para>mus:I Non musical record</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="searchguide-syntax">
<title>Search Syntax</title>
<para>In the persistent search box, single words generally retrieve
large sets. To narrow a search, you can use multiple words. Koha
automatically uses the 'and' Boolean operator to create a set of
records matching your input. When you want to narrow the search to
an author or a title or a subject or some other specific field or
use a Boolean operator, there isn't an obvious way to accomplish
that specificity. The library user can, of course, go to the
Advanced Search page; however, if you know how to construct a CCL
search, you can achieve more specificity while using the persistent
search box on any page.</para>
<para>There is a specific order to the CCL search syntax. Although
it can be used for simple searches, it is an especially effective
way to perform complex searches, as it affords you a great deal of
control over your search results. To construct a CCL search, first
enter a desired index code, then an equal sign, followed by your
search word(s). Following are examples of simple CCL
searches.</para>
<itemizedlist>
<listitem>
<para>ti=principles of accounting</para>
</listitem>
<listitem>
<para>au=brown joseph</para>
</listitem>
<listitem>
<para>su=poetry</para>
</listitem>
<listitem>
<para>su-na=Shakespeare</para>
</listitem>
<listitem>
<para>kw=marlin</para>
</listitem>
</itemizedlist>
<para>You can refine your search by combining search terms with
Boolean operators 'and', 'or', or 'not'. Following are examples of
searches using Boolean operators.</para>
<itemizedlist>
<listitem>
<para>ti=principles of accounting and au=brown joseph</para>
</listitem>
<listitem>
<para>su=poetry not su-na=Shakespeare</para>
</listitem>
<listitem>
<para>kw=communication and su=debate</para>
</listitem>
</itemizedlist>
<para>You can also choose to search for things that start with a
character or series of characters</para>
<itemizedlist>
<listitem>
<para>ti,first-in-subfield=C (will show you all titles that
start with the letter 'C')</para>
</listitem>
</itemizedlist>
<para>Other string location searches can be performed with the
following keywords:</para>
<itemizedlist>
<listitem>
<para>rtrn : right truncation</para>
</listitem>
<listitem>
<para>ltrn : left truncation</para>
</listitem>
<listitem>
<para>lrtrn : left and right truncation</para>
</listitem>
<listitem>
<para>st-date : type date</para>
</listitem>
<listitem>
<para>st-numeric : type number (integer)</para>
</listitem>
<listitem>
<para>ext : exact search on whole subfield (does not work with
icu)</para>
</listitem>
<listitem>
<para>phr : search on expression anywhere in the subfield</para>
</listitem>
<listitem>
<para>startswithnt : subfield starts with</para>
</listitem>
</itemizedlist>
<para>Using specific indexes and Boolean operators are not the only
way a search can be refined. You can also refine your search as a
phrase when looking for a title, author, or subject. The syntax for
this search is <emphasis>index,phr=search words</emphasis>.</para>
<para>To illustrate the results of various search types, a search
was done for the words 'supreme court'. The results illustrate that
the search index and the word order make a difference in search
results. Only the results count and the search itself is in these
examples. The search executed will always be between the single
quotes.</para>
<screenshot>
<screeninfo>Sample Search 1</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/ex1.png"/>
</imageobject>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>Sample Search 2</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/ex2.png"/>
</imageobject>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>Sample Search 3</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/ex3.png"/>
</imageobject>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>Sample Search 4</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/ex4.png"/>
</imageobject>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>Sample Search 5</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/ex5.png"/>
</imageobject>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>Sample Search 6</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/ex6.png"/>
</imageobject>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>Sample Search 7</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/ex7.png"/>
</imageobject>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>Sample Search 8</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/ex8.png"/>
</imageobject>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>Sample Search 9</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/ex9.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also choose to use limiters in your search query. Some
common limiters include dates, languages, record types, and item
types. In the Advance Search, you can either click a box or key in
data to limit your search. You can also apply the same limits with
CCL by using the syntax in the following examples. In all</para>
<para><emphasis>By Date: su=supreme court and
yr,st-numeric=>2000</emphasis></para>
<screenshot>
<screeninfo>Sample Search 10</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/ex10.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When you limit by date, you can use the '>' (greater than),
'<' (less than), '=' (equal), or 'yyyy-yyyy' (range)
symbols.</para>
<para><emphasis>By Item Type: su=nursing and
itype:BK</emphasis></para>
<screenshot>
<screeninfo>Sample Search 11</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/ex11.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Each library will have a different set of item types defined
in their circulation configuration. When you set up item types, you
define a code and a name for each one. The name will appear on the
Advance Search page. The code you assigned is used as a CCL search
limit, formatted as 'itype:x', where 'x' is the assigned code. The
initial set of item types in Koha will usually be edited to reflect
your collections, so your item type limiters may be different than
the initial ones. The initial item type limiters follow.</para>
<itemizedlist>
<listitem>
<para>itype:BKS Books, Booklets, Workbooks</para>
</listitem>
<listitem>
<para>itype:SR Audio Cassettes, CDs</para>
</listitem>
<listitem>
<para>itype:IR Binders</para>
</listitem>
<listitem>
<para>itype:CF CD-ROMs, DVD-ROMs, General Online
Resources</para>
</listitem>
<listitem>
<para>itype:VR DVDs, VHS</para>
</listitem>
<listitem>
<para>itype:KT Kit</para>
</listitem>
<listitem>
<para>itype:AR Models</para>
</listitem>
<listitem>
<para>itype:SER Serials</para>
</listitem>
</itemizedlist>
<para><emphasis>By format: su=supreme court not
l-format:sr</emphasis></para>
<screenshot>
<screeninfo>Sample Search 12</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/ex12.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The format limiters are derived from a combination of LDR, 006
and 007 positions. The formats that are currently defined are the
following.</para>
<itemizedlist>
<listitem>
<para>l-format:ta Regular print</para>
</listitem>
<listitem>
<para>l-format:tb Large print</para>
</listitem>
<listitem>
<para>l-format:fk Braille</para>
</listitem>
<listitem>
<para>l-format:sd CD audio</para>
</listitem>
<listitem>
<para>l-format:ss Cassette recording</para>
</listitem>
<listitem>
<para>l-format:vf VHS tape</para>
</listitem>
<listitem>
<para>l-format:vd DVD video</para>
</listitem>
<listitem>
<para>l-format:co CD software</para>
</listitem>
<listitem>
<para>l-format:cr Website</para>
</listitem>
</itemizedlist>
<para><emphasis>By content type: su=supreme court not
ctype:l</emphasis></para>
<screenshot>
<screeninfo>Sample Search 13</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/searching/ex13.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The content types are taken from the 008 MARC tag, positions
24-27.</para>
<para>There are two other limiter types that are not described in
this document. They are: Audience and Content. The only difference
in the syntax of the CCL is the actual limiter. They are reproduced
here just in case you would like to use these limiters.</para>
</section>
</section>
</section>
<section id="kohasearchindexes">
<title>Koha Search Indexes</title>
<para>By default, not all fields are indexed in the Zebra search engine,
but many are. Below are the MARC21 fields that are indexed in
Zebra.</para>
<table cellpadding="4" cellspacing="4" frame="all">
<title>Indexes</title>
<tgroup align="left" cols="2" colsep="1" rowsep="1">
<thead>
<row>
<entry><para>Field</para></entry>
<entry><para>Description</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>001</para></entry>
<entry><para>Control-number</para></entry>
</row>
<row>
<entry><para>005</para></entry>
<entry><para>Date/time-last-modified</para></entry>
</row>
<row>
<entry><para>007</para></entry>
<entry><para>Microform-generation:n:range(data,11,1),
Material-type,ff7-00:w:range(data,0,1),
ff7-01:w:range(data,1,1), ff7-02:w:range(data,2,1),
ff7-01-02:w:range(data,0,2)</para></entry>
</row>
<row>
<entry><para>008</para></entry>
<entry><para>date-entered-on-file:n:range(data,0,5),
date-entered-on-file:s:range(data,0,5),
pubdate:w:range(data,7,4), pubdate:n:range(data,7,4),
pubdate:y:range(data,7,4), pubdate:s:range(data,7,4),
pl:w:range(data,15,3), ta:w:range(data,22,1),
ff8-23:w:range(data,23,1), ff8-29:w:range(data,29,1),
lf:w:range(data,33,1), bio:w:range(data,34,1),
ln:n:range(data,35,3), ctype:w:range(data,24,4),
Record-source:w:range(data,39,0)</para></entry>
</row>
<row>
<entry><para>010</para></entry>
<entry><para>LC-card-number, Identifier-standard</para></entry>
</row>
<row>
<entry><para>011</para></entry>
<entry><para>LC-card-number, Identifier-standard</para></entry>
</row>
<row>
<entry><para>015</para></entry>
<entry><para>BNB-card-number, BGF-number, Number-db,
Number-natl-biblio, Identifier-standard</para></entry>
</row>
<row>
<entry><para>017</para></entry>
<entry><para>Number-legal-deposit,
Identifier-standard</para></entry>
</row>
<row>
<entry><para>018</para></entry>
<entry><para>Identifier-standard</para></entry>
</row>
<row>
<entry><para>020$a</para></entry>
<entry><para>ISBN:w, Identifier-standard:w</para></entry>
</row>
<row>
<entry><para>020</para></entry>
<entry><para>Identifier-standard</para></entry>
</row>
<row>
<entry><para>022$a</para></entry>
<entry><para>ISSN:w, Identifier-standard:w</para></entry>
</row>
<row>
<entry><para>022</para></entry>
<entry><para>Identifier-standard</para></entry>
</row>
<row>
<entry><para>023</para></entry>
<entry><para>Identifier-standard</para></entry>
</row>
<row>
<entry><para>024$a</para></entry>
<entry><para>Identifier-other</para></entry>
</row>
<row>
<entry><para>024</para></entry>
<entry><para>Identifier-standard</para></entry>
</row>
<row>
<entry><para>025</para></entry>
<entry><para>Identifier-standard</para></entry>
</row>
<row>
<entry><para>027</para></entry>
<entry><para>Report-number, Identifier-standard</para></entry>
</row>
<row>
<entry><para>028</para></entry>
<entry><para>Number-music-publisher,
Identifier-standard</para></entry>
</row>
<row>
<entry><para>030</para></entry>
<entry><para>CODEN, Identifier-standard</para></entry>
</row>
<row>
<entry><para>034</para></entry>
<entry><para>Map-scale</para></entry>
</row>
<row>
<entry><para>037</para></entry>
<entry><para>Identifier-standard, Stock-number</para></entry>
</row>
<row>
<entry><para>040</para></entry>
<entry><para>Code-institution, Record-source</para></entry>
</row>
<row>
<entry><para>041</para></entry>
<entry><para>ln</para></entry>
</row>
<row>
<entry><para>043</para></entry>
<entry><para>Code-geographic</para></entry>
</row>
<row>
<entry><para>050$b</para></entry>
<entry><para>LC-call-number:w, LC-call-number:p,
LC-call-number:s</para></entry>
</row>
<row>
<entry><para>050</para></entry>
<entry><para>LC-call-number:w, LC-call-number:p,
LC-call-number:s</para></entry>
</row>
<row>
<entry><para>052</para></entry>
<entry><para>Geographic-class</para></entry>
</row>
<row>
<entry><para>060</para></entry>
<entry><para>NLM-call-number</para></entry>
</row>
<row>
<entry><para>070</para></entry>
<entry><para>NAL-call-number</para></entry>
</row>
<row>
<entry><para>080</para></entry>
<entry><para>UDC-classification</para></entry>
</row>
<row>
<entry><para>082</para></entry>
<entry><para>Dewey-classification:w,
Dewey-classification:s</para></entry>
</row>
<row>
<entry><para>086</para></entry>
<entry><para>Number-govt-pub</para></entry>
</row>
<row>
<entry><para>100$9</para></entry>
<entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>100$a</para></entry>
<entry><para>Author,Author:p, Author:s, Editor,
Author-personal-bibliography, Author-personal-bibliography:p,
Author-personal-bibliography:s</para></entry>
</row>
<row>
<entry><para>100</para></entry>
<entry><para>Author, Author-title, Author-name-personal, Name,
Name-and-title, Personal-name</para></entry>
</row>
<row>
<entry><para>110$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>110</para></entry>
<entry><para>Author, Author-title, Author-name-corporate, Name,
Name-and-title, Corporate-name</para></entry>
</row>
<row>
<entry><para>111$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>111</para></entry>
<entry><para>Author, Author-title, Author-name-corporate, Name,
Name-and-title, Conference-name</para></entry>
</row>
<row>
<entry><para>130$n</para></entry>
<entry><para>Thematic-number</para></entry>
</row>
<row>
<entry><para>130$r</para></entry>
<entry><para>Music-key</para></entry>
</row>
<row>
<entry><para>130$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>130</para></entry>
<entry><para>Title, Title-uniform</para></entry>
</row>
<row>
<entry><para>210</para></entry>
<entry><para>Title, Title-abbreviated</para></entry>
</row>
<row>
<entry><para>211</para></entry>
<entry><para>Title, Title-abbreviated</para></entry>
</row>
<row>
<entry><para>212</para></entry>
<entry><para>Title, Title-other-variant</para></entry>
</row>
<row>
<entry><para>214</para></entry>
<entry><para>Title, Title-expanded</para></entry>
</row>
<row>
<entry><para>222</para></entry>
<entry><para>Title, Title-key</para></entry>
</row>
<row>
<entry><para>240$r</para></entry>
<entry><para>Music-key</para></entry>
</row>
<row>
<entry><para>240$n</para></entry>
<entry><para>Thematic-number</para></entry>
</row>
<row>
<entry><para>240</para></entry>
<entry><para>Title:w, Title:p, Title-uniform</para></entry>
</row>
<row>
<entry><para>243$n</para></entry>
<entry><para>Thematic-number</para></entry>
</row>
<row>
<entry><para>243$r</para></entry>
<entry><para>Music-key</para></entry>
</row>
<row>
<entry><para>243</para></entry>
<entry><para>Title:w, Title:p, Title-collective</para></entry>
</row>
<row>
<entry><para>245$a</para></entry>
<entry><para>Title-cover:w, Title-cover:p, Title-cover:s,
Title:w, Title:p, Title:s</para></entry>
</row>
<row>
<entry><para>245$c</para></entry>
<entry><para>Author, Author-in-order:w, Author-in-order:p,
Author-in-order:s</para></entry>
</row>
<row>
<entry><para>245$9</para></entry>
<entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>245</para></entry>
<entry><para>Title:w, Title:p</para></entry>
</row>
<row>
<entry><para>246</para></entry>
<entry><para>Title, Title:p, Title-abbreviated, Title-expanded,
Title-former</para></entry>
</row>
<row>
<entry><para>247</para></entry>
<entry><para>Title, Title:p, Title-former, Title-other-variant,
Related-periodical</para></entry>
</row>
<row>
<entry><para>260$a</para></entry>
<entry><para>pl:w, pl:p</para></entry>
</row>
<row>
<entry><para>260$b</para></entry>
<entry><para>Publisher:w, Publisher:p</para></entry>
</row>
<row>
<entry><para>260$c</para></entry>
<entry><para>copydate, copydate:s</para></entry>
</row>
<row>
<entry><para>260</para></entry>
<entry><para>pl</para></entry>
</row>
<row>
<entry><para>300</para></entry>
<entry><para>Extent:w, Extent:p</para></entry>
</row>
<row>
<entry><para>400$a</para></entry>
<entry><para>Name-and-title</para></entry>
</row>
<row>
<entry><para>400$t</para></entry>
<entry><para>Author-title, Name-and-title, Title,
Title-series</para></entry>
</row>
<row>
<entry><para>400$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>400</para></entry>
<entry><para>Author, Author-name-personal, Name,
Personal-name</para></entry>
</row>
<row>
<entry><para>410</para></entry>
<entry><para>Author, Corporate-name</para></entry>
</row>
<row>
<entry><para>410$a</para></entry>
<entry><para>Name-and-title</para></entry>
</row>
<row>
<entry><para>410$t</para></entry>
<entry><para>Author-title, Title, Title-series</para></entry>
</row>
<row>
<entry><para>410$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>410</para></entry>
<entry><para>Author-name-corporate, Name</para></entry>
</row>
<row>
<entry><para>411</para></entry>
<entry><para>Author, Conference-name</para></entry>
</row>
<row>
<entry><para>411$a</para></entry>
<entry><para>Name-and-title</para></entry>
</row>
<row>
<entry><para>411$t</para></entry>
<entry><para>Author-title, Title-series</para></entry>
</row>
<row>
<entry><para>411</para></entry>
<entry><para>Author-name-corporate, Name</para></entry>
</row>
<row>
<entry><para>440$a</para></entry>
<entry><para>Title-series:w, Title-series:p</para></entry>
</row>
<row>
<entry><para>440$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>440</para></entry>
<entry><para>Title-series:w, Title-series:p, Title,
Title-series</para></entry>
</row>
<row>
<entry><para>490$a</para></entry>
<entry><para>Title-series:w, Title-series:p</para></entry>
</row>
<row>
<entry><para>490</para></entry>
<entry><para>Title, Title-series</para></entry>
</row>
<row>
<entry><para>490$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>500</para></entry>
<entry><para>Note:w, Note:p</para></entry>
</row>
<row>
<entry><para>502</para></entry>
<entry><para>Material-type</para></entry>
</row>
<row>
<entry><para>505$r</para></entry>
<entry><para>Author</para></entry>
</row>
<row>
<entry><para>505$t</para></entry>
<entry><para>Title</para></entry>
</row>
<row>
<entry><para>505</para></entry>
<entry><para>Note:w, Note:p</para></entry>
</row>
<row>
<entry><para>510</para></entry>
<entry><para>Indexed-by</para></entry>
</row>
<row>
<entry><para>520</para></entry>
<entry><para>Abstract:w, Abstract:p</para></entry>
</row>
<row>
<entry><para>521$a</para></entry>
<entry><para>lex:n</para></entry>
</row>
<row>
<entry><para>526$c</para></entry>
<entry><para>arl, arl:n</para></entry>
</row>
<row>
<entry><para>526$d</para></entry>
<entry><para>arp, arp:n</para></entry>
</row>
<row>
<entry><para>590</para></entry>
<entry><para>Note:w, Note:p</para></entry>
</row>
<row>
<entry><para>600$a</para></entry>
<entry><para>Name-and-title, Name, Personal-name,
Subject-name-personal, Subject</para></entry>
</row>
<row>
<entry><para>600$t</para></entry>
<entry><para>Name-and-title, Title, Subject</para></entry>
</row>
<row>
<entry><para>600$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>600</para></entry>
<entry><para>Name, Personal-name, Subject-name-personal,
Subject</para></entry>
</row>
<row>
<entry><para>610$a</para></entry>
<entry><para>Name-and-title</para></entry>
</row>
<row>
<entry><para>610$t</para></entry>
<entry><para>Name-and-title, Title</para></entry>
</row>
<row>
<entry><para>610$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>610</para></entry>
<entry><para>Name, Subject, Corporate-name</para></entry>
</row>
<row>
<entry><para>611</para></entry>
<entry><para>Conference-name</para></entry>
</row>
<row>
<entry><para>611$a</para></entry>
<entry><para>Name-and-title</para></entry>
</row>
<row>
<entry><para>611$t</para></entry>
<entry><para>Name-and-title, Title</para></entry>
</row>
<row>
<entry><para>611$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>611</para></entry>
<entry><para>Name, Subject</para></entry>
</row>
<row>
<entry><para>630$n</para></entry>
<entry><para>Thematic-number</para></entry>
</row>
<row>
<entry><para>630$r</para></entry>
<entry><para>Music-key</para></entry>
</row>
<row>
<entry><para>630$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>630</para></entry>
<entry><para>Subject</para></entry>
</row>
<row>
<entry><para>650$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>650</para></entry>
<entry><para>Subject, Subject:p</para></entry>
</row>
<row>
<entry><para>651$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>651</para></entry>
<entry><para>Name-geographic, Subject,Subject:p</para></entry>
</row>
<row>
<entry><para>652$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>653$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>653</para></entry>
<entry><para>Subject, Subject:p</para></entry>
</row>
<row>
<entry><para>654$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>654</para></entry>
<entry><para>Subject</para></entry>
</row>
<row>
<entry><para>655$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>655</para></entry>
<entry><para>Subject</para></entry>
</row>
<row>
<entry><para>656$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>656</para></entry>
<entry><para>Subject</para></entry>
</row>
<row>
<entry><para>657$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>657</para></entry>
<entry><para>Subject</para></entry>
</row>
<row>
<entry><para>690$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>690</para></entry>
<entry><para>Subject, Subject:p</para></entry>
</row>
<row>
<entry><para>700$9</para></entry>
<entry><para>Cross-Reference, Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>700$a</para></entry>
<entry><para>Author, Author:p</para></entry>
</row>
<row>
<entry><para>700$n</para></entry>
<entry><para>Thematic-number</para></entry>
</row>
<row>
<entry><para>700$r</para></entry>
<entry><para>Music-key</para></entry>
</row>
<row>
<entry><para>700$t</para></entry>
<entry><para>Author-title, Name-and-title, Title,
Title-uniform</para></entry>
</row>
<row>
<entry><para>700</para></entry>
<entry><para>Author, Author-name-corporate,
Author-name-personal, Name, Editor, Personal-name</para></entry>
</row>
<row>
<entry><para>710</para></entry>
<entry><para>Author, Corporate-name</para></entry>
</row>
<row>
<entry><para>710$t</para></entry>
<entry><para>Author-title, Name-and-title, Title,
Title-uniform</para></entry>
</row>
<row>
<entry><para>710$a</para></entry>
<entry><para>Name-and-title</para></entry>
</row>
<row>
<entry><para>710$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>710</para></entry>
<entry><para>Author, Name</para></entry>
</row>
<row>
<entry><para>711$a</para></entry>
<entry><para>Name-and-title</para></entry>
</row>
<row>
<entry><para>711$t</para></entry>
<entry><para>Author-title, Title, Title-uniform</para></entry>
</row>
<row>
<entry><para>711$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>711</para></entry>
<entry><para>Author-name-corporate, Name,
Conference-name</para></entry>
</row>
<row>
<entry><para>730$n</para></entry>
<entry><para>Thematic-number</para></entry>
</row>
<row>
<entry><para>730$r</para></entry>
<entry><para>Music-key</para></entry>
</row>
<row>
<entry><para>730$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>730</para></entry>
<entry><para>Title, Title-uniform</para></entry>
</row>
<row>
<entry><para>740</para></entry>
<entry><para>Title, Title-other-variant</para></entry>
</row>
<row>
<entry><para>773$t</para></entry>
<entry><para>Host-item</para></entry>
</row>
<row>
<entry><para>780$t</para></entry>
<entry><para>Title</para></entry>
</row>
<row>
<entry><para>780</para></entry>
<entry><para>Title, Title-former,
Related-periodical</para></entry>
</row>
<row>
<entry><para>785</para></entry>
<entry><para>Related-periodical</para></entry>
</row>
<row>
<entry><para>800$a</para></entry>
<entry><para>Name-and-title</para></entry>
</row>
<row>
<entry><para>800$t</para></entry>
<entry><para>Author-title, Name-and-title, Title,
Title-series</para></entry>
</row>
<row>
<entry><para>800$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>800</para></entry>
<entry><para>Author, Author-name-personal, Name,
Personal-name</para></entry>
</row>
<row>
<entry><para>810$a</para></entry>
<entry><para>Name-and-title</para></entry>
</row>
<row>
<entry><para>810$t</para></entry>
<entry><para>Author-title, Name-and-title, Title,
Title-series</para></entry>
</row>
<row>
<entry><para>810$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>810</para></entry>
<entry><para>Author, Corporate-name, Author-name-corporate,
Name</para></entry>
</row>
<row>
<entry><para>811$a</para></entry>
<entry><para>Name-and-title</para></entry>
</row>
<row>
<entry><para>811$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>811$t</para></entry>
<entry><para>Author-title, Name-and-title, Title,
Title-series</para></entry>
</row>
<row>
<entry><para>811</para></entry>
<entry><para>Author, Author-name-corporate, Name,
Conference-name</para></entry>
</row>
<row>
<entry><para>830$9</para></entry>
<entry><para>Koha-Auth-Number</para></entry>
</row>
<row>
<entry><para>830</para></entry>
<entry><para>Title, Title-series</para></entry>
</row>
<row>
<entry><para>840</para></entry>
<entry><para>Title, Title-series</para></entry>
</row>
<row>
<entry><para>999$c</para></entry>
<entry><para>Local-Number:n, Local-Number:w,
Local-Number:s</para></entry>
</row>
<row>
<entry><para>999$d</para></entry>
<entry><para>biblioitemnumber:n, biblioitemnumber:w,
biblioitemnumber:s</para></entry>
</row>
<row>
<entry><para>942$0</para></entry>
<entry><para>totalissues:n, totalissues:s</para></entry>
</row>
<row>
<entry><para>942$2</para></entry>
<entry><para>cn-bib-source</para></entry>
</row>
<row>
<entry><para>942$6</para></entry>
<entry><para>cn-bib-sort:n, cn-bib-sort:s</para></entry>
</row>
<row>
<entry><para>942$c</para></entry>
<entry><para>itemtype:w</para></entry>
</row>
<row>
<entry><para>942$n</para></entry>
<entry><para>Suppress:w, Suppress:n</para></entry>
</row>
<row>
<entry><para>942$h</para></entry>
<entry><para>cn-class</para></entry>
</row>
<row>
<entry><para>942$i</para></entry>
<entry><para>cn-item</para></entry>
</row>
<row>
<entry><para>942$k</para></entry>
<entry><para>cn-prefix</para></entry>
</row>
<row>
<entry><para>942$m</para></entry>
<entry><para>cn-suffix</para></entry>
</row>
<row>
<entry><para>952$0</para></entry>
<entry><para>withdrawn:n, withdrawn:w</para></entry>
</row>
<row>
<entry><para>952$1</para></entry>
<entry><para>lost, lost:n</para></entry>
</row>
<row>
<entry><para>952$2</para></entry>
<entry><para>classification-source</para></entry>
</row>
<row>
<entry><para>952$3</para></entry>
<entry><para>materials-specified</para></entry>
</row>
<row>
<entry><para>952$4</para></entry>
<entry><para>damaged:n, damaged:w</para></entry>
</row>
<row>
<entry><para>952$5</para></entry>
<entry><para>restricted:n, restricted:w</para></entry>
</row>
<row>
<entry><para>952$6</para></entry>
<entry><para>cn-sort:n, cn-sort:s</para></entry>
</row>
<row>
<entry><para>952$7</para></entry>
<entry><para>notforloan:n, notforloan:w</para></entry>
</row>
<row>
<entry><para>952$8</para></entry>
<entry><para>ccode</para></entry>
</row>
<row>
<entry><para>952$9</para></entry>
<entry><para>itemnumber:n, itemnumber:s</para></entry>
</row>
<row>
<entry><para>952$a</para></entry>
<entry><para>homebranch</para></entry>
</row>
<row>
<entry><para>952$b</para></entry>
<entry><para>holdingbranch</para></entry>
</row>
<row>
<entry><para>952$c</para></entry>
<entry><para>location</para></entry>
</row>
<row>
<entry><para>952$d</para></entry>
<entry><para>Date-of-acquisition, Date-of-acquisition:d,
Date-of-acquisition:s</para></entry>
</row>
<row>
<entry><para>952$e</para></entry>
<entry><para>acqsource</para></entry>
</row>
<row>
<entry><para>952$f</para></entry>
<entry><para>coded-location-qualifier</para></entry>
</row>
<row>
<entry><para>952$g</para></entry>
<entry><para>price</para></entry>
</row>
<row>
<entry><para>952$j</para></entry>
<entry><para>stack:n, stack:w</para></entry>
</row>
<row>
<entry><para>952$l</para></entry>
<entry><para>issues:n, issues:w, issues:s</para></entry>
</row>
<row>
<entry><para>952$m</para></entry>
<entry><para>renewals:n, renewals:w</para></entry>
</row>
<row>
<entry><para>952$n</para></entry>
<entry><para>reserves:n, reserves:w</para></entry>
</row>
<row>
<entry><para>952$o</para></entry>
<entry><para>Local-classification:w, Local-classification:p,
Local-classification:s</para></entry>
</row>
<row>
<entry><para>952$p</para></entry>
<entry><para>barcode, barcode:n</para></entry>
</row>
<row>
<entry><para>952$q</para></entry>
<entry><para>onloan:n, onloan:w</para></entry>
</row>
<row>
<entry><para>952$r</para></entry>
<entry><para>datelastseen</para></entry>
</row>
<row>
<entry><para>952$s</para></entry>
<entry><para>datelastborrowed</para></entry>
</row>
<row>
<entry><para>952$t</para></entry>
<entry><para>copynumber</para></entry>
</row>
<row>
<entry><para>952$u</para></entry>
<entry><para>uri:u</para></entry>
</row>
<row>
<entry><para>952$v</para></entry>
<entry><para>replacementprice</para></entry>
</row>
<row>
<entry><para>952$w</para></entry>
<entry><para>replacementpricedate</para></entry>
</row>
<row>
<entry><para>952$y</para></entry>
<entry><para>itype:w</para></entry>
</row>
<row>
<entry><para>952$z</para></entry>
<entry><para>Note:w, Note:p</para></entry>
</row>
</tbody>
</tgroup>
</table>
</section>
</chapter>
<chapter id="aboutkoha">
<title>About Koha</title>
<para>The 'About Koha' area will give you important server information as
well as general information about Koha.</para>
<section id="aboutserver">
<title>Server Information</title>
<para>Under the 'Server Information' tab you will find information about
the Koha version and the machine you have installed Koha on. This
information is very important for debugging problems. When reporting
issues to your support provider or to the various other support avenues
(mailing lists, chat room, etc), it's always good to give the
information from this screen.</para>
<screenshot>
<screeninfo>Server Information on Koha</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/about/aboutserver.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="aboutserverperl">
<title>Perl Modules</title>
<para>In order to take advantage of all of the functionalities of Koha,
you will need to keep your Perl modules up to date. The 'Perl Modules'
tab will show you all of the modules required by Koha, the version you
have installed and whether you need to upgrade certain modules.</para>
<screenshot>
<screeninfo>Perl Modules</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/about/aboutperlmodules.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Items listed in bold are required by Koha, items highlighed in red
are missing completely and items highlighted in yellow simply need to be
upgraded.</para>
</section>
</chapter>
<chapter id="implementation">
<title>Implementation Checklist</title>
<para>The following guide will walk you through the areas of Koha you need
to look at in order to prepare to start using the system.</para>
<section id="imp-migration">
<title>Data Migration</title>
<para>Before you can start using Koha you'll need to have some data.
This can be done by entering it all by hand, but most people already
have their data in electronic format of some sort and just need to
reformat it a bit for importing into Koha.</para>
<itemizedlist>
<listitem>
<para>Create a list of libraries and enter their info and codes into
<link linkend="libsgroups">Libraries & Groups</link></para>
</listitem>
<listitem>
<para>Define your list of <link linkend="itemtypeadmin">Item
Types</link></para>
</listitem>
<listitem>
<para>Define you patron categories and enter the categories and
their codes into <link linkend="patcats">Patron
Categories</link></para>
</listitem>
<listitem>
<para>Enter any additional patron information fields you use in your
library in the <link linkend="patronattributetypes">Patron
Attributes</link></para>
<itemizedlist>
<listitem>
<para>Requires that you first set the <link
linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
system preference if you have custom fields</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Define all of your <link linkend="authorizedvalues">Authorized
Values</link></para>
<itemizedlist>
<listitem>
<para><link linkend="ccode">Collection codes</link></para>
</listitem>
<listitem>
<para><link linkend="shelvelocvals">Shelving
locations</link></para>
</listitem>
<listitem>
<para>Item statuses (<link linkend="lost">lost</link>, <link
linkend="notforloan">not for loan</link>, <link
linkend="restricted">use restrictions</link>)</para>
</listitem>
<listitem>
<para>Plus any others that are needed in your library</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Optionally define <link linkend="citytowns">City/Postal
Code</link> combos and <link linkend="roadtypes">Road Types</link>
for patron entry</para>
</listitem>
<listitem>
<para><link linkend="kohamarcmapping">Map your bibliographic
data</link> from your legacy system to Koha fields and migrate
(remembering to use the collection, shelving, item type and library
codes you entered in the above setting areas)</para>
</listitem>
<listitem>
<para><link linkend="patronimport">Map your patron data</link> from
your legacy system to the Koha fields and migrate (remembering to
use the patron and library codes you defined above)</para>
</listitem>
<listitem>
<para>Test your migrated data to be sure that everything is as you
expect it to be, some things to test include:</para>
<itemizedlist>
<listitem>
<para>Check some of your titles with diacritics and make sure
that they migrated properly.</para>
</listitem>
<listitem>
<para>Check titles in a series and make sure that series
information migrated properly.</para>
</listitem>
<listitem>
<para>Make sure that your patrons have their contact information
in the right fields.</para>
</listitem>
<listitem>
<para>If your serials data was migrated search for these records
in the catalog and confirm that they look right.</para>
</listitem>
<listitem>
<para>If your serials data was migrated search for these records
in the serials module and confirm that they look right.</para>
</listitem>
<listitem>
<para>Check marc records to verify a variety of items are
cataloged correctly</para>
</listitem>
<listitem>
<para>Check cataloging process to see if all necessary fields
are available</para>
</listitem>
<listitem>
<para>If fines are migrated, check to see that they are applied
correctly</para>
</listitem>
<listitem>
<para>If holds are migrated, check to see they are accurate in
catalog and patron record</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="impadmin">
<title>Admin Configuration</title>
<para>Most of these preferences won't need to be changed to use your
Koha system, but there are a few that you might want to
customize.</para>
<itemizedlist>
<listitem>
<para>If your library uses CAS Authentication, you'll want to set
the various <link linkend="casauthentication">CAS system
preferences</link></para>
</listitem>
<listitem>
<para>Administration System Preferences</para>
<itemizedlist>
<listitem>
<para><link
linkend="KohaAdminEmailAddress">KohaAdminEmailAddress</link> :
This is the email address that will be used by the system in
'from' lines and to send errors to if there is no email set for
the branch</para>
</listitem>
<listitem>
<para><link linkend="noItemTypeImages">noItemTypeImages</link> :
Decide if you want to show item type icons in the staff client
and opac</para>
</listitem>
<listitem>
<para><link linkend="delimiter">delimiter</link> : This value
will be put in between fields when exporting data from
Koha</para>
</listitem>
<listitem>
<para><link linkend="virtualshelves">virtualshelves</link> :
Decide if you want the staff and/or patrons to use lists in
Koha</para>
</listitem>
<listitem>
<para><link linkend="insecure">insecure</link> : If your system
is behind a local firewall, you can set it to no require log in
for the staff client</para>
</listitem>
<listitem>
<para><link linkend="AutoLocation">AutoLocation</link> : Require
staff to log in to the staff client from a specific IP
range</para>
</listitem>
<listitem>
<para><link
linkend="IndependantBranches">IndependantBranches</link> :
Prevent librarians from editing content that belongs to other
branches</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Go through the <link linkend="logs">Log System
Preferences</link> and decide which actions you want to keep track
of in the logs</para>
</listitem>
</itemizedlist>
</section>
<section id="implocal">
<title>Localization Configuration</title>
<para>Koha is used worldwide and so you need to make sure you set your
localization preferences so that options throughout Koha appear properly
for your location/language.</para>
<itemizedlist>
<listitem>
<para>Localization/Internationalization System Preferences</para>
<itemizedlist>
<listitem>
<para><link linkend="dateformat">dateformat</link> : Decide how
dates are displayed throughout Koha</para>
</listitem>
<listitem>
<para><link
linkend="opaclanguagesdisplay">opaclanguagesdisplay</link> :
Decide if patrons can choose what language the OPAC appears
in</para>
<itemizedlist>
<listitem>
<para><link linkend="opaclanguages">opaclanguages</link> :
Decide which languages the patrons can choose from</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link linkend="languagepref">language</link> : Decide
which languages appear in the staff client</para>
</listitem>
<listitem>
<para><link
linkend="CalendarFirstDayOfWeek">CalendarFirstDayOfWeek</link> :
Define your first day of the week</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="impcirc">
<title>Circulation Configuration</title>
<para>Before you start circulating your collection you'll need to set up
your rules and preferences for circulation.</para>
<itemizedlist>
<listitem>
<para>Define you <link linkend="circfinerules">Circulation/Fine
rules</link></para>
</listitem>
<listitem>
<para>Enter the <link linkend="calholidays">days your library is
closed</link> for fines and due date calculations</para>
</listitem>
<listitem>
<para>Circulation System Preferences</para>
<itemizedlist>
<listitem>
<para><link linkend="CircControl">CircControl</link> : Define
whether circ rules are based on item's location, patron's
location or transaction location</para>
</listitem>
<listitem>
<para><link linkend="useDaysMode">useDaysMode</link> : Define
how due dates are calculated</para>
</listitem>
<listitem>
<para><link linkend="finesCalendar">finesCalendar</link> :
Define how fines are calculated (for every late date or only for
days the library is open)</para>
</listitem>
<listitem>
<para><link linkend="SpecifyDueDate">SpecifyDueDate</link> :
Decide if staff are allowed to override due dates on
checkout</para>
</listitem>
<listitem>
<para><link
linkend="AutomaticItemReturn">AutomaticItemReturn</link> :
Decide if items are sent back to the owning branch when checked
in</para>
</listitem>
<listitem>
<para><link
linkend="todaysIssuesDefaultSortOrder">todaysIssuesDefaultSortOrder</link>
: Decide how items checked out today display on the patron
record</para>
</listitem>
<listitem>
<para><link
linkend="previousIssuesDefaultSortOrder">previousIssuesDefaultSortOrder</link>
: Decide how items checked out prior to today display on the
patron record</para>
</listitem>
<listitem>
<para><link linkend="noissuescharge">noissuescharge</link> :
Define the maximum amount a patron can owe before checkouts are
blocked</para>
</listitem>
<listitem>
<para><link
linkend="ReturnBeforeExpiry">ReturnBeforeExpiry</link> : Decide
if patrons need to return items before their accounts
expire</para>
</listitem>
<listitem>
<para><link linkend="AllowOnShelfHolds">AllowOnShelfHolds</link>
: Decide if patrons can place holds on items that are marked as
being available</para>
<itemizedlist>
<listitem>
<para><link
linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
: Decide if you want the staff to be able to override the
setting for the above at checkout</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link
linkend="AllowHoldsOnDamagedItems">AllowHoldsOnDamagedItems</link>
: Decide if patrons can place holds on items that are marked as
damaged</para>
<itemizedlist>
<listitem>
<para><link
linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
: Decide if you want the staff to be able to override the
setting for the above at checkout</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link linkend="maxreserves">maxreserves</link> : Decide
how many items a patron can have on hold at once</para>
<itemizedlist>
<listitem>
<para><link
linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
: Decide if you want the staff to be able to override the
setting for the above at checkout</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link linkend="maxoutstanding">maxoutstanding</link> :
Define the maximum amount a patron can owe before holds are
blocked</para>
<itemizedlist>
<listitem>
<para><link
linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
: Decide if you want the staff to be able to override the
setting for the above at checkout</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link
linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link> :
Define the number of days before a hold expires</para>
</listitem>
<listitem>
<para><link linkend="WebBasedSelfCheck">WebBasedSelfCheck</link>
: Decide if you want to use the built in web-based self-checkout
system</para>
<itemizedlist>
<listitem>
<para><link
linkend="AutoSelfCheckAllowed">AutoSelfCheckAllowed</link> :
Decide if the self-checkout system requires login</para>
</listitem>
<listitem>
<para><link
linkend="ShowPatronImageInWebBasedSelfCheck">ShowPatronImageInWebBasedSelfCheck</link>
: Decide if you want patron images to show on the self
checkout screen</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link
linkend="AllowNotForLoanOverride">AllowNotForLoanOverride</link>
: Decide if you want the staff to be able to checkout items
marked as ‘not for loan'</para>
</listitem>
<listitem>
<para><link
linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
: Decide if you want staff to override the limit put on
renewals</para>
</listitem>
<listitem>
<para><link linkend="AllowFineOverride">AllowFineOverride</link>
: Decide if you want staff to be able to override fine
limits</para>
</listitem>
<listitem>
<para><link linkend="RenewalPeriodBase">RenewalPeriodBase</link>
: Decide what date renewals are based on</para>
</listitem>
<listitem>
<para><link linkend="finesMode">finesMode</link> : Switch to
‘Calculate and Charge' before go live if you charge
fines</para>
</listitem>
<listitem>
<para><link linkend="OverdueNoticeBcc">OverdueNoticeBcc</link> :
If you want to receive a copy of every overdue notice sent out,
enter your email address here</para>
</listitem>
<listitem>
<para><link
linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
: Decide if you want an email every time a hold is placed</para>
</listitem>
<listitem>
<para><link
linkend="ReservesControlBranch">ReservesControlBranch</link> :
Decide which branch's hold rules are considered first</para>
</listitem>
<listitem>
<para><link linkend="soundon">soundon</link> : Decide if you
want to have sounds on for circulation actions</para>
</listitem>
<listitem>
<para><link
linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
: If you have a large amount of overdues, you might want to turn
this preference on so as to allow you to filter before results
appear</para>
</listitem>
<listitem>
<para><link
linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
: If you have a lot of staff members sharing one circ computer
you might want to enable this so that staff can clear the screen
in between checkouts to protect patron's privacy</para>
</listitem>
<listitem>
<para><link
linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link> :
Decide how you want Koha to react if you scan in a blank barcode
on the checkout screen</para>
</listitem>
<listitem>
<para><link
linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
and/or <link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link>
: Decide if you want patrons and/or staff to be able to suspend
holds</para>
<itemizedlist>
<listitem>
<para><link
linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
: If you allow holds to be suspended decide if you want them
to automaticalluy resume on the date entered by the staff
and/or patron</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Customize your <link linkend="notices">Notices &
Slips</link></para>
</listitem>
<listitem>
<para>Define your <link linkend="noticetriggers">Overdue Notice
Triggers</link></para>
</listitem>
<listitem>
<para>Set up your <link linkend="cronjobs">cron jobs</link></para>
<itemizedlist>
<listitem>
<para>Populate <link linkend="buildholdscron">your holds
queue</link> (every 1-4 hours)</para>
</listitem>
<listitem>
<para>Decide <link linkend="expiredholdscron">when holds
expire</link> (daily)</para>
</listitem>
<listitem>
<para><link linkend="finescronjob">Calculate fines due</link>
(daily)</para>
<itemizedlist>
<listitem>
<para>Fines on hourly loans will calculate when you check
the items in</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link linkend="longoverduecron">Mark long overdue items as
lost</link> (daily)</para>
</listitem>
<listitem>
<para>Decide when the system <link linkend="msgqueuecron">sends
out messages</link> (1-4 hours)</para>
</listitem>
<listitem>
<para>Decide when the system <link
linkend="overduenoticecron">queues overdue notices</link>
(daily)</para>
</listitem>
<listitem>
<para>Set up <link linkend="printholdcron">hold notices that
didn't send for printing</link> (daily after overdues and
message queue)</para>
</listitem>
<listitem>
<para>Decide when the system <link
linkend="advnoticecron">queues the advanced notice of items
due</link> (daily)</para>
</listitem>
<listitem>
<para>Find holds that need to be <link
linkend="unsuspendholdcron">resumed and remove suspension</link>
(daily)</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="imppratrons">
<title>Patron Configuration</title>
<para>You have already imported patron data from your old system, but
there are plenty of options available to you regarding patrons and their
accounts.</para>
<itemizedlist>
<listitem>
<para>Enter your <link linkend="addstaffpatron">staff members as
patrons</link></para>
<itemizedlist>
<listitem>
<para>Define <link linkend="patronpermissions">staff members
access permissions</link></para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Patron System Preferences</para>
<itemizedlist>
<listitem>
<para><link linkend="AddPatronLists">AddPatronLists</link> :
Decide how patron categories appear when creating a new
patron</para>
</listitem>
<listitem>
<para><link linkend="autoMemberNum">autoMemberNum</link> :
Decide if the patrons barcodes are auto-generated or if you
enter them yourself</para>
</listitem>
<listitem>
<para><link linkend="MaxFine">MaxFine</link> : Determine the
maximum amount that people can owe in fines</para>
</listitem>
<listitem>
<para><link
linkend="NotifyBorrowerDeparture">NotifyBorrowerDeparture</link>
: Decide when to warn staff that the patron account is about to
expire</para>
</listitem>
<listitem>
<para><link
linkend="intranetreadinghistory">intranetreadinghistory</link> :
Decide if the staff can see the patron's reading/checkout
history</para>
</listitem>
<listitem>
<para><link
linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> :
List fields that you want to appear as mandatory on the patron
add/edit form</para>
</listitem>
<listitem>
<para><link linkend="BorrowersTitles">BorrowersTitles</link> :
Add or change the titles for your patrons</para>
</listitem>
<listitem>
<para><link
linkend="borrowerRelationship">borrowerRelationship</link> : Add
or change borrower relationships (child to adult and
professional to organization)</para>
</listitem>
<listitem>
<para><link
linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
: Determine if the patrons get an email confirming the creation
of their account</para>
</listitem>
<listitem>
<para><link
linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
: Decide if patrons can choose from a series of notices (other
than overdues)</para>
</listitem>
<listitem>
<para><link linkend="patronimages">patronimages</link> : Decide
if you want to save patron images in your system</para>
</listitem>
<listitem>
<para><link
linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
: Decide if you want to enable custom patron fields</para>
</listitem>
<listitem>
<para><link linkend="minPasswordLength">minPasswordLength</link>
: Enter the minimum number of characters you want passwords to
have</para>
</listitem>
<listitem>
<para><link
linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> :
Decide whwat fields your library doesn't need to see on the
patron entry form</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="impcatalog">
<title>Cataloging Configuration</title>
<para>Before you start cataloging in Koha you'll want to set up your
preferences and other rules.</para>
<itemizedlist>
<listitem>
<para>Define your cataloging templates aka <link
linkend="marcbibframeworks">MARC Bibliographic
Frameworks</link></para>
<itemizedlist>
<listitem>
<para>Run the <link linkend="marcbibframeworkstest">MARC
Bibliographic Framework Test</link> to be sure your changes are
valid</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Define any <link linkend="authorizedvalues">authorized
values</link> you might want to use in cataloging</para>
</listitem>
<listitem>
<para>Set up <link linkend="classificationsources">custom
classification sources</link> (if you use something other than the
defaults)</para>
</listitem>
<listitem>
<para>Set up <link linkend="recordmatchingrules">MARC matching
rules</link> for importing records from mrc files or z39.50</para>
</listitem>
<listitem>
<para>Set up <link linkend="keywordmapping">Koha to Keyword
mapping</link> for deciding how to display marc fields to the screen
(still in beta - only one field)</para>
</listitem>
<listitem>
<para>Set up the <link linkend="z3950admin">z39.50 targets</link>
you want to search for cataloging (and acquisitions)</para>
</listitem>
<listitem>
<para>Cataloging System Preferences</para>
<itemizedlist>
<listitem>
<para><link linkend="URLLinkText">URLLinkText</link> : Enter
text to display when 856 fields do not have pre-defined
labels</para>
</listitem>
<listitem>
<para><link linkend="hide_marc">hide_marc</link> : If you are
unfamiliar with MARC you can have the MARC fields number
hidden</para>
</listitem>
<listitem>
<para><link linkend="LabelMARCView">LabelMARCView</link> :
Choose how you want duplicate fields to appear on the
editor</para>
</listitem>
<listitem>
<para><link
linkend="DefaultClassificationSource">DefaultClassificationSource</link>
: Choose which classification source is the default in your
library</para>
</listitem>
<listitem>
<para><link
linkend="advancedMARCeditor">advancedMARCeditor</link> : Decide
if you need labels to appear on your MARC editor</para>
</listitem>
<listitem>
<para><link linkend="marcflavour">marcflavour</link> : Choose
your MARC format</para>
</listitem>
<listitem>
<para><link linkend="itemcallnumber">itemcallnumber</link> :
Enter which field and subfields to look into for the call
number</para>
</listitem>
<listitem>
<para><link linkend="MARCOrgCode">MARCOrgCode</link> : Enter
your MARC Organizational Code (not the same as your OCLC
number)</para>
</listitem>
<listitem>
<para><link linkend="autoBarcode">autoBarcode</link> : Decide if
Koha generates item barcodes for you</para>
</listitem>
<listitem>
<para><link linkend="OpacSuppression">OpacSuppression</link> :
Decide if you want to hide items marked as suppressed from the
OPAC search results</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Set up your <link linkend="cronjobs">cron jobs</link></para>
<itemizedlist>
<listitem>
<para>Decide when the system <link linkend="checkurlcron">checks
URLs in catalog records</link> to see if they are still
valid</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="impauthorities">
<title>Authorities Configuration</title>
<para>Koha has the ability to keep track of your authority records and
how they're linked to your bibliographic records. Before using
authorities you should configure several preferences.</para>
<itemizedlist>
<listitem>
<para>Set <link linkend="authoritiesadmin">Authority
Frameworks</link> aka templates</para>
</listitem>
<listitem>
<para>Authority System Preferences</para>
<itemizedlist>
<listitem>
<para><link
linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> :
Decide if Koha creates authorities when cataloging</para>
</listitem>
<listitem>
<para><link linkend="dontmerge">dontmerge</link> : Decide if
updates to authorities trigger updates to the bibliographic
records that link to them</para>
</listitem>
<listitem>
<para><link
linkend="AutoCreateAuthorities">AutoCreateAuthorities</link> :
Decide when authorities are created</para>
</listitem>
<listitem>
<para><link linkend="LinkerModule">LinkerModule</link> : Decide
which match the authority linker should use</para>
</listitem>
<listitem>
<para><link linkend="LinkerOptions">LinkerOptions</link> :
Decide if you want authority linking to be broader or more
specific</para>
</listitem>
<listitem>
<para><link
linkend="CatalogModuleRelink">CatalogModuleRelink</link> :
Decide if you want to enable authority linking while
cataloging</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Set up your <link linkend="cronjobs">cron jobs</link></para>
<itemizedlist>
<listitem>
<para>Choose when the system looks for authorities updates to
<link linkend="mergeauthcron">merge changes into bibliographic
records</link></para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="impsearching">
<title>Searching Configuration</title>
<para>There are several system preferences related to searching, it is
not always recommended to make too many changes to these preferences
since they are set to get you the most relevant results. If you would
like to change the default way that Koha handles searching, view the
<link linkend="searchingprefs">Searching system preferences</link>
tab.</para>
<itemizedlist>
<listitem>
<para>Set up your <link linkend="cronjobs">cron jobs</link></para>
<itemizedlist>
<listitem>
<para>Decide how often your <link
linkend="rebuildsearchcron">system rebuilds the search
index</link> (4-10 min)</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Searching System Preferences</para>
<itemizedlist>
<listitem>
<para><link
linkend="AdvancedSearchTypes">AdvancedSearchTypes</link> :
Decide which authorized value fields you want patrons and staff
to be able to limit their advanced searches by</para>
</listitem>
<listitem>
<para><link
linkend="UseAuthoritiesForTracings">UseAuthoritiesForTracings</link>
: Decide how you want Koha to handle subject searches in the
OPAC</para>
<itemizedlist>
<listitem>
<para><link
linkend="TraceCompleteSubfields">TraceCompleteSubfields</link>
: Decide how you want Koha to handle subject searches in the
OPAC</para>
</listitem>
<listitem>
<para><link
linkend="TraceSubjectSubdivisions">TraceSubjectSubdivisions</link>
: Decide how you want Koha to handle subject searches in the
OPAC</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link linkend="displayFacetCount">displayFacetCount</link>
: Decide whether to show facet counts on search results</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="impopac">
<title>OPAC Configuration</title>
<para>There are a lot of ways you can customize your OPAC in
Koha.</para>
<itemizedlist>
<listitem>
<para>Decide how you want your OPAC to look & what content you
want on the main page</para>
</listitem>
<listitem>
<para>Create a library branded stylesheet using CSS</para>
<itemizedlist>
<listitem>
<important>
<para>Do not edit the default CSS files, instead create a new
one, that way the system can always fall back on the original
CSS.</para>
</important>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Create a custom XSLT stylesheet to change the way search
results and bib records appear in the OPAC</para>
</listitem>
<listitem>
<para>OPAC System preferences</para>
<itemizedlist>
<listitem>
<para><link linkend="opacuserlogin">opacuserlogin</link> :
Decide if you want to allow patrons to login to the OPAC to
access customized functionality (searching will be allowed
without logging in)</para>
<itemizedlist>
<listitem>
<para><link linkend="RequestOnOpac">RequestOnOpac</link> :
Decide if patrons can place holds via the OPAC</para>
</listitem>
<listitem>
<para><link linkend="OPACItemHolds">OPACItemHolds</link> :
Decide if patrons can place holds on specific items (instead
of just the next available item)</para>
</listitem>
<listitem>
<para><link
linkend="OpacPasswordChange">OpacPasswordChange</link> :
Decide if patrons can change their password (don't allow
this if you're using LDAP)</para>
</listitem>
<listitem>
<para><link
linkend="OpacRenewalAllowed">OpacRenewalAllowed</link> :
Decide if patrons can renew their checked out items via the
OPAC</para>
</listitem>
<listitem>
<para><link
linkend="opacreadinghistory">opacreadinghistory</link> :
Decide if patrons can view their reading/checkout history
via the OPAC</para>
</listitem>
<listitem>
<para><link linkend="reviewson">reviewson</link> : Decide if
you want to allow patrons to comment on bib records via the
OPAC</para>
</listitem>
<listitem>
<para><link linkend="OpacStarRatings">OpacStarRatings</link>
: Decide if patrons can leave star ratings</para>
</listitem>
<listitem>
<para><link linkend="virtualshelves">virtualshelves</link> :
Decide if you want patrons to be able to create Lists</para>
</listitem>
<listitem>
<para><link
linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link>
: If patrons can create lists then decide if they are
allowed to create public lists</para>
</listitem>
<listitem>
<para><link linkend="suggestionspref">suggestion</link> :
Decide if you want patrons to be able to submit purchase
suggestions</para>
</listitem>
<listitem>
<para><link
linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link>
: Decide if you want patrons to be able to see purchase
suggestions made by other patrons</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link linkend="opacbookbag">opacbookbag</link> : Decide if
patrons can save items into their cart</para>
</listitem>
<listitem>
<para><link linkend="AnonSuggestions">AnonSuggestions</link> :
Decide if you want non logged in users to be able to make
purchase suggestions</para>
</listitem>
<listitem>
<para><link
linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> :
Decide if you want to use the XSLT stylesheets on the OPAC
search results</para>
</listitem>
<listitem>
<para><link
linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> :
Decide if you want to use the XSLT stylesheets on the bib
records in the OPAC</para>
</listitem>
<listitem>
<para><link linkend="LibraryName">LibraryName</link> : Enter
your library name for display in the <title> tag and on
the top of the OPAC</para>
</listitem>
<listitem>
<para><link linkend="opacsmallimage">opacsmallimage</link> :
Choose a logo to replace the Koha logo</para>
</listitem>
<listitem>
<para><link linkend="opaccredits">opaccredits</link> : Enter
HTML to appear at the bottom of every page in the OPAC</para>
</listitem>
<listitem>
<para><link linkend="OpacMainUserBlock">OpacMainUserBlock</link>
: Enter HTML that will appear in the center of the main OPAC
page</para>
</listitem>
<listitem>
<para><link linkend="OpacNav">OpacNav</link> : Enter HTML that
will appear to the left on the main OPAC page</para>
</listitem>
<listitem>
<para><link linkend="OpacNavBottom">OpacNavBottom</link> : Enter
HTML that will appear below OpacNav</para>
</listitem>
<listitem>
<para><link linkend="opacheader">opacheader</link> : Enter the
HTML that will appear above the search box on the OPAC</para>
</listitem>
<listitem>
<para><link
linkend="OPACNoResultsFound">OPACNoResultsFound</link> : Enter
the HTML that will appear when no results are found</para>
</listitem>
<listitem>
<para><link
linkend="OPACResultsSidebar">OPACResultsSidebar</link> : Enter
the HTML that will appear below the facets on your search
results</para>
</listitem>
<listitem>
<para><link linkend="OPACMySummaryHTML">OPACMySummaryHTML</link>
: Enter the HTML that will appear in the far right of the
circulation summary in the OPAC</para>
</listitem>
<listitem>
<para>Customize your stylesheets:</para>
<itemizedlist>
<listitem>
<para><link linkend="OPACUserCSS">OPACUserCSS</link> : Enter
any additional fields you want to define styles for</para>
</listitem>
<listitem>
<para><link
linkend="opaclayoutstylesheet">opaclayoutstylesheet</link> :
Point to a CSS file on your Koha server</para>
</listitem>
<listitem>
<para><link linkend="opacstylesheet">opacstylesheet</link> :
If you have a custom CSS enter the link to that file</para>
</listitem>
<listitem>
<para><link
linkend="opaccolorstylesheet">opaccolorstylesheet</link> :
Point to a CSS file on your Koha server</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link
linkend="OpacHighlightedWords">OpacHighlightedWords</link> :
Decide if you want search terms to be highlighted on the search
results</para>
</listitem>
<listitem>
<para><link linkend="hidelostitems">hidelostitems</link> :
Decide if you want to show patrons items you have marked as
lost</para>
</listitem>
<listitem>
<para><link linkend="BiblioDefaultView">BiblioDefaultView</link>
: Decide what view is the default for bib records on the
OPAC</para>
</listitem>
<listitem>
<para><link linkend="OPACShelfBrowser">OPACShelfBrowser</link> :
Decide if you want to enable the shelf browse
functionality</para>
</listitem>
<listitem>
<para><link
linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link> :
Decide if URLs clicked in the OPAC are opened in a new
window</para>
</listitem>
<listitem>
<para><link
linkend="SearchMyLibraryFirst">SearchMyLibraryFirst</link> : If
you have a multi-branch system decide if you want patrons to
search their library first</para>
</listitem>
<listitem>
<para><link linkend="OpacAuthorities">OpacAuthorities</link> :
Decide if you want patrons to be able to search your authority
file</para>
</listitem>
<listitem>
<para><link linkend="OpacBrowser">OpacBrowser</link> : Decide if
you want patrons to browse your authority file</para>
</listitem>
<listitem>
<para><link
linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link> :
Choose which libraries you want patrons to be able to re-run
their search in</para>
</listitem>
<listitem>
<para><link
linkend="OpacAddMastheadLibraryPulldown">OpacAddMastheadLibraryPulldown</link>
: If you're a multi-branch system you can add a pull down to the
search bar for patrons to search which library to search</para>
</listitem>
<listitem>
<para><link
linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
: Decide if you want the system to keep a search history</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Set up your <link linkend="cronjobs">cron jobs</link></para>
<itemizedlist>
<listitem>
<para>If you have the <link
linkend="OpacBrowser">OpacBrowser</link> preference set decide
<link linkend="authbrowsercron">when you want the contents to
rebuild</link></para>
</listitem>
<listitem>
<para>If you have <link linkend="customrss">custom RSS
feeds</link>, decide when you want the <link
linkend="customrssfeedcron">feed to be populated</link></para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<section id="editableopac">
<title>Editable OPAC Regions</title>
<para>Using the OPAC system preferences you can customize various
regions, the following graphics will define what preferences update
each regions.</para>
<screenshot>
<screeninfo>OPAC Editable Regions</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-opac/opaccustomregions.jpg"/>
</imageobject>
</mediaobject>
</screenshot>
<para>An example of a way to customize the page is included as
well:</para>
<screenshot>
<screeninfo>Customized Koha OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-opac/opaccustomregions-customized.jpg"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</section>
<section id="impenhanced">
<title>Enhanced Content Configuration</title>
<para>Koha allows you to pull in content from outside sources to enhance
your bib records. All of this content can be toggled on and off using
the enhanced content system preferences.</para>
<itemizedlist>
<listitem>
<para><link linkend="frbrenhancedprefs">FRBR/Editions</link></para>
<itemizedlist>
<listitem>
<para>If you would like to have your OPAC and/or staff client
show an 'Editions' tab on the bib record, you want to enable one
or the other FRBR preferences and then either one or both of the
ISBN services (XISBN and ThingISBN).</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link linkend="amazonprefs">Amazon</link> : This service is
free and just requires that you visit <ulink
url="http://aws.amazon.com";>http://aws.amazon.com</ulink> to sign
up</para>
<itemizedlist>
<listitem>
<para>Using the Amazon preferences you can choose to show
different types of content from Amazon. Before choosing which
types of content you would like to display you will need to
enable Amazon content for the staff client and/or the
OPAC.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link
linkend="Babelthequeprefs">Babelthèque</link></para>
<itemizedlist>
<listitem>
<para>This is a pay service. Contact Babelthèque to learn
how to enable this content in the OPAC.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link linkend="btcontentprefs">Baker and Taylor</link></para>
<itemizedlist>
<listitem>
<para>This is a pay service from Baker & Taylor. Contact
Baker & Taylor for the information to enter into these
preferences.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link linkend="googleprefs">Google</link></para>
<itemizedlist>
<listitem>
<para>This service is free and does not require registration,
simply enable GoogleJackets and you're set to go.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link linkend="librarythingprefs">LibraryThing</link></para>
<itemizedlist>
<listitem>
<para>With the exception of ThingISBN, you will need to contact
LibraryThing for the information to enter into these
preferences</para>
</listitem>
<listitem>
<para>Enabling ThingISBN will help to populate the editions tab
on the bib record display if you have enabled FRBR.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link linkend="novelistselect">Novelist</link></para>
<itemizedlist>
<listitem>
<para>This is a pay service from Ebsco. Contact Ebsco for the
information to enter into these preferences</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link linkend="oclcprefs">OCLC</link></para>
<itemizedlist>
<listitem>
<para>XISBN is used to populate the editions tab on the bib
record display if you have enabled FRBR. This service is free
for up to 999 queries a day.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link linkend="Syndeticsprefs">Syndetics</link></para>
<itemizedlist>
<listitem>
<para>This is a pay service from Syndetics to add content for
your bib records. Contact Syndetics for the information to enter
into these preferences.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><link linkend="taggingprefs">Tagging</link></para>
<itemizedlist>
<listitem>
<para>Choose whether or not you want to allow patrons to add
tags to records in Koha.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="impacq">
<title>Acquisitions Configuration</title>
<para>When using acquisitions in Koha you first need to define some
defaults.</para>
<itemizedlist>
<listitem>
<para>Set up your <link linkend="budgetplanning">funds &
budgets</link></para>
</listitem>
<listitem>
<para>Choose your <link linkend="currexchangeadmin">default
currency</link> and enter others if you order from multiple
countries</para>
</listitem>
<listitem>
<para>Enter in your <link linkend="acqvendors">vendor
information</link></para>
</listitem>
<listitem>
<para>Create an <link linkend="marcbibframeworks">Framework with the
code ACQ</link> (if you're going to enter item records at the time
of ordering or receiving)</para>
</listitem>
<listitem>
<para>Acquisitions System preferences</para>
<itemizedlist>
<listitem>
<para><link linkend="AcqCreateItem">AcqCreateItem</link> :
Decide if an item record is created during acquisition</para>
</listitem>
<listitem>
<para><link linkend="CurrencyFormat">CurrencyFormat</link> :
Decide how you want monetary amounts to display</para>
</listitem>
<listitem>
<para><link linkend="gist">gist</link> : Enter your sales tax
(if you are billed for tax)</para>
</listitem>
<listitem>
<para><link linkend="OrderPdfFormat">OrderPdfFormat</link> :
Decide what format you want your print orders to use</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="impserials">
<title>Serials Configuration</title>
<para>When you use serials there are a few options you can set before
hand.</para>
<itemizedlist>
<listitem>
<para>Serials System Preferences</para>
<itemizedlist>
<listitem>
<para><link
linkend="RenewSerialAddsSuggestion">RenewSerialAddsSuggestion</link>
: Decide if you want renewing serials to add a suggestion for
easy purchasing</para>
</listitem>
<listitem>
<para><link linkend="RoutingSerials">RoutingSerials</link> :
Decide if you want to route serials around your library</para>
</listitem>
<listitem>
<para><link
linkend="RoutingListAddReserves">RoutingListAddReserves</link> :
Decide if holds are placed on serials when there is a routing
list in place</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Cataloging System Preferences</para>
<itemizedlist>
<listitem>
<para><link
linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
: Decide how many of the most recent issues to display in the
staff client</para>
</listitem>
<listitem>
<para><link
linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
: Decide how many of the most recent issues to display in the
OPAC</para>
</listitem>
<listitem>
<para><link
linkend="SubscriptionHistory">SubscriptionHistory</link> :
Decide how you want the subscription information to display in
the OPAC</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="impgolive">
<title>Planning for Go-Live</title>
<para>Once you have all of your settings ready, you need to prepare for
making your system live:</para>
<itemizedlist>
<listitem>
<para>Decide if you need training by an outside service or if your
staff can do the training themselves.</para>
</listitem>
<listitem>
<para>Make sure that there is time for your staff to play with your
test system and get comfortable with it</para>
</listitem>
<listitem>
<para>If this is a migration, work with your previous company to
extract data right before you go live</para>
</listitem>
<listitem>
<para>Come up with URLs for your new Koha OPAC & Staff
Client</para>
</listitem>
<listitem>
<para>Make sure that if you're hosting your own system you have a
backup plan</para>
</listitem>
</itemizedlist>
</section>
</chapter>
<chapter id="sopac">
<title>SOPAC2 Installation</title>
<section id="sopac2">
<sectioninfo>
<author>
<firstname>Jean-André</firstname>
<surname>Santoni</surname>
<affiliation>
<orgname>BibLibre</orgname>
</affiliation>
</author>
<pubdate>August 2009</pubdate>
<othercredit role="translator">
<firstname>Nicole C.</firstname>
<surname>Engard</surname>
<contrib>Translation</contrib>
</othercredit>
</sectioninfo>
<title>SOPAC2 Introduction</title>
<para><note>
<para>The following documentation was translated using Google
Translate from French to English and may have some language
errors.</para>
</note></para>
</section>
<section id="sopacintro">
<title>Introduction</title>
<para>This is an installation guide and the connector SOPAC2 Koha. It
has been tested on Debian Lenny and Ubuntu Jaunty, with 6.12 and Koha
Drupal 3.0.x It does not cover the installation of Koha and Drupal, but
SOPAC, its dependencies and the connector.</para>
</section>
<section id="sopacinstall">
<title>Installation of Locum and Insurge</title>
<para>Locum and Insurge are the two libraries used primarily by SOPAC.
They serve as a layer of abstraction to the data. Insurge manages the
social aspect (tags, reviews, ratings), while Locum manages the
connection to the ILS via the connector. Both libraries use a different
database from that of Drupal.</para>
<section id="sopacdepend">
<title>Dependencies</title>
<para>There are no packages for Debian MDB2 yet, you can install it
via pear:</para>
<programlisting># apt-get install php-pear
# pear install MDB2
# pear install MDB2#mysql</programlisting>
</section>
<section id="sopacdownload">
<title>Download</title>
<para>Download the Locum and Insurge libraries from SVN:</para>
<programlisting># cd /usr/local/lib
# svn co http://dobby.darienlibrary.org/svn/locum/trunk/ locum
# svn co http://dobby.darienlibrary.org/svn/insurge/trunk/ insurge</programlisting>
</section>
<section id="sopaccreatedb">
<title>Creation of the Database</title>
<programlisting>$ mysql -u root
mysql> create database scas;
mysql> grant all privileges on scas.* to scas_user@'localhost' identified by 'scas_pass';
mysql> flush privileges;
mysql> exit</programlisting>
</section>
<section id="sopacdsn">
<title>Sync DSN</title>
<para>This file will provide the connection information to a DB
libraries:</para>
<programlisting># nano /usr/local/etc/locum_insurge_dsn.php</programlisting>
<para>It should contain:</para>
<programlisting><?php
$dsn = 'mysql://scas_user:scas_pass@localhost/scas';</programlisting>
</section>
<section id="sopacinstallinsurge">
<title>Installation of Insurge</title>
<para>If you customize the name of the database, consider editing the
sql file:</para>
<programlisting># nano /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
<para>Import Insurge:</para>
<programlisting>$ mysql -u root -p < /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
<para>Configure Insurge:</para>
<programlisting># nano /usr/local/lib/insurge/config/insurge.ini</programlisting>
<para>The variables in insurge.ini are empty. The default values are
too long and cause MySQL errors.</para>
<para>Here is a sample of insurge.ini</para>
<programlisting>; This is the Locum configuration file
; General configuration options for your installation of Insurge.
[insurge_config]
dsn_file = "/usr/local/etc/locum_insurge_dsn.php"
; This is where you configure your repository membership information.
;
; parent_server is the server name of the repository parent server you have been
; told to use.
; group_id = The group ID you have been given by your repository admin.
; These configuration points are OPTIONAL and are only necessary if you are
; participating in a repository relationship.
[repository_info]
parent_server = ""
group_id = ""
group_key = ""</programlisting>
</section>
<section id="sopacinstallocum">
<title>Installation of Locum</title>
<para>The same procedure applies to Locum</para>
<programlisting># nano /usr/local/lib/locum/sql/scas_locum.sql
# mysql < /usr/local/lib/locum/sql/scas_locum.sql
# nano /usr/local/lib/locum/sql/locum_init.sql
# mysql < /usr/local/lib/locum/sql/locum_init.sql
# nano /usr/local/lib/locum/config/locum.ini
# mkdir /usr/local/var
# mkdir /usr/local/var/log</programlisting>
<para>Configure the DSN:</para>
<programlisting>[locum_config]
dsn_file = "/usr/local/etc/locum_insurge_dsn.php"</programlisting>
<para>And the coordinates of your Koha installation:</para>
<programlisting>[ils_config]
ils = "koha";
ils_version = "30x"
ils_server = "localhost"
ils_harvest_port = "80"</programlisting>
<para>The rest depends on your configuration of Koha.</para>
</section>
</section>
<section id="sopackoha">
<title>Installation of Koha Connector</title>
<para>Enter the connector Koha from SVN:</para>
<programlisting># cd /usr/local/lib/locum/connectors/
# svn co http://dobby.darienlibrary.org/svn/connectors/koha/ locum_koha_30x</programlisting>
</section>
<section id="sopacharvest">
<title>Harvest Records</title>
<para>Now that the connector is in place, we will be able to launch
harvest.php, a tool that will reap Locum DB Koha and fill the
locum.</para>
<para>Start by configuring harvest.php:</para>
<programlisting># nano /usr/local/lib/locum/tools/harvest.php</programlisting>
<para>Here are the variables you must change:</para>
<programlisting>$first_record = 1;
$last_record = 30;</programlisting>
<para>These are the minimum and maximum biblionumbers from your Koha
install.</para>
<para>Then start the harvest:</para>
<programlisting># chmod +x /usr/local/lib/locum/tools/harvest.php
$ /usr/local/lib/locum/tools/harvest.php</programlisting>
</section>
<section id="sopacphinx">
<title>Installation of Sphinx</title>
<para>Sphinx is the indexer for the database used by Locum and
Insurge.</para>
<section id="sphinxdepend">
<title>Dependencies</title>
<para>There is no Debian package for Sphinx so you'll have to compile
the source directly:</para>
<programlisting># apt-get install g++ make libmysql++-dev</programlisting>
</section>
<section id="sphinxdownload">
<title>Download and Compile</title>
<programlisting>$ wget http://sphinxsearch.com/downloads/sphinx-0.9.8.tar.gz
$ tar zxvf sphinx-0.9.8.tar.gz
$ cd sphinx-0.9.8
$ ./configure --prefix=/usr/local/sphinx
$ make
# make install
# mkdir /usr/local/sphinx
# mkdir /usr/local/sphinx/lib
# cp api/sphinxapi.php /usr/local/sphinx/lib/
$ rm -R sphinx-0.9.8*</programlisting>
</section>
<section id="sphinxuser">
<title>Creation of User and Group</title>
<para>Creating a Sphinx user and change the owner:</para>
<programlisting># adduser sphinx
# addgroup sphinx
# usermod -G sphinx sphinx
# mkdir /usr/local/sphinx/var/run
# chown -R sphinx.sphinx /usr/local/sphinx/var</programlisting>
</section>
<section id="demonsphinx">
<title>The demon Sphinx</title>
<para>Download:</para>
<programlisting># cd /etc/init.d
# wget http://www.thesocialopac.net/sites/thesocialopac.net/files/sphinx
# chmod +x /etc/init.d/sphinx</programlisting>
<para>Add Sphinx in the service at boot:</para>
<programlisting># update-rc.d sphinx defaults</programlisting>
</section>
<section id="sphinxconfig">
<title>Configuration</title>
<para>Copy the configuration file supplied with the source of Sphinx
before the change:</para>
<programlisting># cp /usr/local/lib/locum/sphinx/sphinx.conf /usr/local/sphinx/etc/
# sed 's/locum_db_user/scas_user/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile;
mv tmpfile /usr/local/sphinx/etc/sphinx.conf
# sed 's/locum_db_pass/scas_pass/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
<para>And if you personalize the name of the BDD:</para>
<programlisting># sed 's/scas/Ma_BDD/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
</section>
<section id="sphinxindexing">
<title>Indexing documents</title>
<para>Indexing is necessary if you want to use the search features of
SOPAC.</para>
<para>You must first complete the Insurge table index</para>
<programlisting># chmod +x /usr/local/lib/insurge/tools/update-index.php
$ /usr/local/lib/insurge/tools/update-index.php</programlisting>
<para>Then start indexing Sphinx</para>
<programlisting>$ /usr/local/sphinx/bin/indexer --all</programlisting>
<para>Finally, we must start the demon:</para>
<programlisting># /etc/init.d/sphinx start</programlisting>
<para>When the demon is already en route, you can update the index
with:</para>
<programlisting>$ /usr/local/sphinx/bin/indexer --all --rotate</programlisting>
</section>
</section>
<section id="installsopac">
<title>Installation of SOPAC2</title>
<para>Now to the SOPAC software itself:</para>
<section id="downloadsopac">
<title>Download</title>
<para>Download from SVN:</para>
<programlisting>$ cd /chemin/vers/drupal/sites/all/
$ mkdir modules
$ cd modules/
$ svn co http://dobby.darienlibrary.org/svn/sopac/trunk/ sopac</programlisting>
</section>
<section id="sopacinstallation">
<title>Installation</title>
<para>Going in the administration of Drupal to activate the module.
Enable also the dependencies:</para>
<itemizedlist>
<listitem>
<para>Profile</para>
</listitem>
<listitem>
<para>PHP Filter</para>
</listitem>
<listitem>
<para>Path</para>
</listitem>
</itemizedlist>
<para>The Drupal menu should now list these entries.</para>
</section>
<section id="configsopac">
<title>Configuration</title>
<para>Then go into the settings of SOPAC.</para>
<itemizedlist>
<listitem>
<para>Configure the paths to the Locum and Insurge
libraries</para>
</listitem>
<listitem>
<para>Choose a URL prefix SOPAC, in my "catalog". Create a node
with content like:</para>
</listitem>
</itemizedlist>
<programlisting><?php
print sopac_search_form('both');
print theme('pages_catalog');</programlisting>
<itemizedlist>
<listitem>
<para>Check the Input Format "PHP Code"</para>
</listitem>
<listitem>
<para>Check Move to front page</para>
</listitem>
<listitem>
<para>In URL path settings, set the SOPAC URL prefix you have
chosen.</para>
</listitem>
</itemizedlist>
<para>Go to the root of Drupal, a search form will appear.</para>
<para>Thinking to empty the cache of Drupal when something does not
work.</para>
<para>Drupal offers a few blocks, not configured by default. Must
specify on which page they should appear.</para>
</section>
</section>
</chapter>
<chapter id="cronjobsch">
<title>Cron Jobs</title>
<para/>
<section id="cronjobs">
<title>Cron Jobs</title>
<para>The locations below assume a dev install which puts the crons in
misc/, if you have a standard install you may want to look in bin/ for
these files if you cannot find them in misc/</para>
<section id="searchcron">
<title>Search</title>
<para/>
<section id="rebuildsearchcron">
<title>Rebuild Index</title>
<para>Script path: misc/migration_tools/rebuild_zebra.pl</para>
<para>Does: Updates Zebra indexes with recently changed data.</para>
<para>Required by: Zebra</para>
<para>Frequency suggestion: every x minutes, (between 5-15 minutes)
depending on performance needs</para>
</section>
</section>
<section id="circcron">
<title>Circulation</title>
<section id="buildholdscron">
<title>Holds Queue</title>
<para>Script path: misc/cronjobs/holds/build_holds_queue.pl</para>
<para>Does: Updates holds queue report</para>
<para>Required by: <link linkend="holdsqueue">Holds Queue
Report</link></para>
<para>Frequency suggestion: every 1-4 hours</para>
<section id="buildholdscronperl">
<title>Perl Documentation</title>
<para><emphasis
role="bold">GetBibsWithPendingHoldRequests</emphasis></para>
<para>my $biblionumber_aref =
GetBibsWithPendingHoldRequests();</para>
<para>Return an arrayref of the biblionumbers of all bibs that
have one or more unfilled hold requests.</para>
<para><emphasis
role="bold">GetPendingHoldRequestsForBib</emphasis></para>
<para>my $requests =
GetPendingHoldRequestsForBib($biblionumber);</para>
<para>Returns an arrayref of hashrefs to pending, unfilled hold
requests on</para>
<para>the bib identified by $biblionumber. The following keys are
present in each hashref:</para>
<itemizedlist>
<listitem>
<para>biblionumber</para>
</listitem>
<listitem>
<para>borrowernumber</para>
</listitem>
<listitem>
<para>itemnumber</para>
</listitem>
<listitem>
<para>priority</para>
</listitem>
<listitem>
<para>branchcode</para>
</listitem>
<listitem>
<para>reservedate</para>
</listitem>
<listitem>
<para>reservenotes</para>
</listitem>
<listitem>
<para>borrowerbranch</para>
</listitem>
</itemizedlist>
<para>The arrayref is sorted in order of increasing
priority.</para>
<para><emphasis
role="bold">GetItemsAvailableToFillHoldRequestsForBib</emphasis></para>
<para>my $available_items =</para>
<para>GetItemsAvailableToFillHoldRequestsForBib($biblionumber);</para>
<para>Returns an arrayref of items available to fill hold requests
for the bib identified by $biblionumber. An item is available to
fill a hold</para>
<para>request if and only if:</para>
<itemizedlist>
<listitem>
<para>it is not on loan</para>
</listitem>
<listitem>
<para>it is not withdrawn</para>
</listitem>
<listitem>
<para>it is not marked notforloan</para>
</listitem>
<listitem>
<para>it is not currently in transit</para>
</listitem>
<listitem>
<para>it is not lost</para>
</listitem>
<listitem>
<para>it is not sitting on the hold shelf</para>
</listitem>
</itemizedlist>
<para><emphasis
role="bold">MapItemsToHoldRequests</emphasis></para>
<para>MapItemsToHoldRequests($hold_requests,
$available_items);</para>
<para><emphasis
role="bold">CreatePickListFromItemMap</emphasis></para>
<para><emphasis role="bold">AddToHoldTargetMap</emphasis></para>
<para><emphasis
role="bold">_get_branches_to_pull_from</emphasis></para>
<para>Query system preferences to get ordered list of branches to
use to fill hold requests.</para>
</section>
</section>
<section id="expiredholdscron">
<title>Expired Holds</title>
<para>Script path:
misc/cronjobs/holds/cancel_expired_holds.pl</para>
<para>Does: By default, this cron job will only automatically cancel
holds where the user has set an expiration date. If the library is
using the <link
linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>
and <link
linkend="ExpireReservesMaxPickUpDelayCharge">ExpireReservesMaxPickUpDelayCharge</link>
preferences then this script will also cancel holds that have been
sitting on the hold shelf for too long and will (if the library
does) charge the patron for not picking up the hold.</para>
<para>Frequency suggestion: daily</para>
</section>
<section id="unsuspendholdcron">
<title>Unsuspend Holds</title>
<para>Script path:
misc/cronjobs/holds/auto_unsuspend_holds.pl</para>
<para>Does: This script checks to find holds that should no longer
be suspended and removes the suspension if the <link
linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
preference is set to 'allow'. This puts the patron back in to the
queue where they were when the hold was suspended.</para>
<para>Frequency suggestion: daily</para>
</section>
<section id="finescronjob">
<title>Fines</title>
<para>Script path: misc/cronjobs/fines.pl</para>
<para>Required by: <link linkend="finesMode">finesMode</link> system
preference</para>
<para>Frequency suggestion: nightly</para>
</section>
<section id="longoverduecron">
<title>Long Overdues</title>
<para>Script path: misc/cronjobs/longoverdue.pl</para>
<para>Does: allows one to specify delays for changing items to
different lost statuses, and optionally charge for them.</para>
<para>Required by: Frequency suggestion: nightly</para>
<section id="longoverduecronperl">
<title>Perl Documentation</title>
<para><emphasis role="bold">NAME</emphasis></para>
<para>longoverdue.pl cron script to set lost statuses on overdue
materials. Execute without options for help.</para>
</section>
</section>
</section>
<section id="noticescron">
<title>Notices</title>
<para/>
<section id="msgqueuecron">
<title>Message Queue</title>
<para>Script path: misc/cronjobs/process_message_queue.pl</para>
<para>Does: processes the message queue to send emails and SMS
messages to users. sends outgoing emails to patrons.</para>
<para>Frequency suggestion: 1-4 hours</para>
</section>
<section id="advnoticecron">
<title>Advanced Notice</title>
<para>Script path: misc/cronjobs/advance_notices.pl</para>
<para>Does: prepares "pre-due" notices and "item due" notices for
patrons who request them prepares notices for patrons for items just
due or coming due soon. requires <link
linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
to be on</para>
<para>Frequency suggestion: nightly</para>
<note>
<para>This script does not actually send the notices. It queues
them in the <link linkend="msgqueuecron">message queue</link> for
later</para>
</note>
<section id="advnoticecronperl">
<title>Perl Documentation</title>
<para><emphasis role="bold">NAME</emphasis></para>
<para>advance_notices.pl - cron script to put item due reminders
into message queue</para>
<para><emphasis role="bold">SYNOPSIS</emphasis></para>
<para>./advance_notices.pl -c</para>
<para>or, in crontab: 0 1 * * * advance_notices.pl -c</para>
<para><emphasis role="bold">DESCRIPTION</emphasis></para>
<para>This script prepares pre-due and item due reminders to be
sent to patrons. It queues them in the message queue, which is
processed by the process_message_queue.pl cronjob. The type and
timing of the messages can be configured by the patrons in their
"My Alerts" tab in the OPAC.</para>
<para><emphasis role="bold">METHODS</emphasis></para>
<para>parse_letter</para>
</section>
</section>
<section id="overduenoticecron">
<title>Overdue Notice</title>
<para>Script path: misc/cronjobs/overdue_notices.pl</para>
<para>Does: prepares messages to alert patrons of overdue messages
(both via email and print)</para>
<para>Frequency suggestion: nightly</para>
<note>
<para>This script does not actually send the notices. It queues
them in the <link linkend="msgqueuecron">message queue</link> for
later or generates the HTML for later printing</para>
</note>
<section id="overduenoticecronperl">
<title>Perl Documentation</title>
<para><emphasis role="bold">NAME</emphasis></para>
<para>overdue_notices.pl - prepare messages to be sent to patrons
for overdue items</para>
<para><emphasis role="bold">SYNOPSIS</emphasis></para>
<para>overdue_notices.pl [ -n ] [ -library <branchcode> ] [
-library <branchcode>...] [ -max <number of days> ] [
-csv [ <filename> ] ] [-itemscontent <field list>
]</para>
<para>Options:</para>
<para>-help brief help message</para>
<para>-man full documentation</para>
<para>-n No email will be sent</para>
<para>-max <days> maximum days overdue to deal with</para>
<para>-library <branchname> only deal with overdues from
this library (repeatable : several libraries can be given)</para>
<para>-csv <filename> populate CSV file</para>
<para>-html <filename> Output html to file</para>
<para>-itemscontent <list of fields> item information in
templates</para>
<para>-borcat <categorycode> category code that must be
included</para>
<para>-borcatout <categorycode> category code that must be
excluded</para>
<para><emphasis role="bold">OPTIONS</emphasis></para>
<para>-help Print a brief help message and exits.</para>
<para>-man Prints the manual page and exits.</para>
<para>-v Verbose. Without this flag set, only fatal errors are
reported.</para>
<para>-n Do not send any email. Overdue notices that would have
been sent to the patrons or to the admin are printed to standard
out. CSV data (if the -csv flag is set) is written to standard out
or to any csv filename given.</para>
<para>-max Items older than max days are assumed to be handled
somewhere else, probably the longoverdues.pl script. They are
therefore ignored by this program. No notices are sent for them,
and they are not added to any CSV files. Defaults to 90 to match
longoverdues.pl.</para>
<para>-library</para>
<para>select overdues for one specific library. Use the value in
the branches.branchcode table. This option can be repeated in
order to select overdues for a group of libraries.</para>
<para>-csv Produces CSV data. if -n (no mail) flag is set, then
this CSV data is sent to standard out or to a filename if
provided. Otherwise, only overdues that could not be emailed are
sent in CSV format to the admin.</para>
<para>-itemscontent</para>
<para>comma separated list of fields that get substituted into
templates in places of the <<items.content>>
placeholder. This defaults to
issuedate,title,barcode,author</para>
<para>Other possible values come from fields in the biblios,
items, and issues tables.</para>
<para>-borcat Repetable field, that permit to select only few of
patrons categories.</para>
<para>-borcatout</para>
<para>Repetable field, permis to exclude some patrons
categories.</para>
<para>-t | --triggered</para>
<para>This option causes a notice to be generated if and only if
an item is overdue by the number of days defined in a notice
trigger.</para>
<para>By default, a notice is sent each time the script runs,
which is suitable for less frequent run cron script, but requires
syncing notice triggers with the cron schedule to ensure proper
behavior. Add the --triggered option for daily cron, at the risk
of no notice being generated if the cron fails to run on
time.</para>
<para>-list-all</para>
<para>Default items.content lists only those items that fall in
the range of the currently processing notice. Choose list-all to
include all overdue items in the list (limited by -max
setting).</para>
<para><emphasis role="bold">DESCRIPTION</emphasis></para>
<para>This script is designed to alert patrons and administrators
of overdue items.</para>
<para>Configuration</para>
<para>This script pays attention to the overdue notice
configuration performed in the "Overdue notice/status triggers"
section of the "Tools" area of the staff interface to Koha. There,
you can choose which letter templates are sent out after a
configurable number of days to patrons of each library. More
information about the use of this section of Koha is available in
the Koha manual.</para>
<para>The templates used to craft the emails are defined in the
"Tools: Notices" section of the staff interface to Koha.</para>
<para>Outgoing emails</para>
<para>Typically, messages are prepared for each patron with
overdue items. Messages for whom there is no email address on file
are collected and sent as attachments in a single email to each
library administrator, or if that is not set, then to the email
address in the "KohaAdminEmailAddress" system preference.</para>
<para>These emails are staged in the outgoing message queue, as
are messages produced by other features of Koha. This message
queue must be processed regularly by the
misc/cronjobs/process_message_queue.pl program.</para>
<para>In the event that the "-n" flag is passed to this program,
no emails are sent. Instead, messages are sent on standard output
from this program. They may be redirected to a file if
desired.</para>
<para>Templates</para>
<para>Templates can contain variables enclosed in double angle
brackets like <<this>>. Those variables will be
replaced with values specific to the overdue items or relevant
patron. Available variables are:</para>
<para><<bib>></para>
<para>the name of the library</para>
<para><<items.content>></para>
<para>one line for each item, each line containing a tab separated
list of title, author, barcode, issuedate</para>
<para><<borrowers.*>></para>
<para>any field from the borrowers table</para>
<para><<branches.*>></para>
<para>any field from the branches table</para>
<para>CSV output</para>
<para>The "-csv" command line option lets you specify a file to
which overdues data should be output in CSV format.</para>
<para>With the "-n" flag set, data about all overdues is written
to the file. Without that flag, only information about overdues
that were unable to be sent directly to the patrons will be
written. In other words, this CSV file replaces the data that is
typically sent to the administrator email address.</para>
<para><emphasis role="bold">USAGE EXAMPLES</emphasis></para>
<para>"overdue_notices.pl" - In this most basic usage, with no
command line arguments, all libraries are procesed individually,
and notices are prepared for all patrons with overdue items for
whom we have email addresses. Messages for those patrons for whom
we have no email address are sent in a single attachment to the
library administrator's email address, or to the address in the
KohaAdminEmailAddress system preference.</para>
<para>"overdue_notices.pl -n -csv /tmp/overdues.csv" - sends no
email and populates /tmp/overdues.csv with information about all
overdue items.</para>
<para>"overdue_notices.pl -library MAIN max 14" - prepare notices
of overdues in the last 2 weeks for the MAIN library.</para>
<para><emphasis role="bold">SEE ALSO</emphasis></para>
<para>The misc/cronjobs/advance_notices.pl program allows you to
send messages to patrons in advance of their items becoming due,
or to alert them of items that have just become due.</para>
<para><emphasis role="bold">INTERNAL METHODS</emphasis></para>
<para>These methods are internal to the operation of
overdue_notices.pl.</para>
<para>parse_letter</para>
<para>parses the letter template, replacing the placeholders with
data specific to this patron, biblio, or item</para>
<para>named parameters:</para>
<para>letter - required hashref</para>
<para>borrowernumber - required integer</para>
<para>substitute - optional hashref of other key/value pairs that
should be substituted in the letter content</para>
<para>returns the "letter" hashref, with the content updated to
reflect the substituted keys and values.</para>
<para>prepare_letter_for_printing</para>
<para>returns a string of text appropriate for printing in the
event that an overdue notice will not be sent to the patron's
email address. Depending on the desired output format, this may be
a CSV string, or a human-readable representation of the
notice.</para>
<para>required parameters:</para>
<para>letter</para>
<para>borrowernumber</para>
<para>optional parameters:</para>
<para>outputformat</para>
</section>
</section>
<section id="printholdcron">
<title>Print Hold Notices</title>
<para>Script path: misc/cronjobs/gather_print_notices.pl</para>
<para>Does: looks through the message queue for hold notices that
didn't go through because the patron didn't have an email address
and generates a print notice</para>
<para>Frequency suggestion: nightly</para>
</section>
</section>
<section id="proccartcron">
<title>In Processing/Book Cart</title>
<para>Script path: misc/cronjobs/cart_to_shelf.pl</para>
<para>Does: Updates all items with a location of CART to the item's
permanent location.</para>
<para>Required by: <link
linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link>,
<link
linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>,
& <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
system preferences</para>
<para>Frequency suggestion: hourly</para>
<section id="proccartcronperl">
<title>Perl Documentation</title>
<para><emphasis role="bold">NAME</emphasis></para>
<para>cart_to_shelf.pl cron script to set items with location of
CART to original shelving location after X hours. Execute without
options for help.</para>
</section>
</section>
<section id="catalogcron">
<title>Catalog</title>
<para/>
<section id="checkurlcron">
<title>Check URLs</title>
<para>Script path: misc/cronjobs/check-url.pl</para>
<para>Does: checks URLs in 856$u field. Script output can now be
formatted in CSV or HTML. The HTML version links directly to MARC
biblio record editor.</para>
<para>Frequency suggestion: monthly</para>
<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>
<section id="checkurlcronperl">
<title>Perl Documentation</title>
<para><emphasis role="bold">NAME</emphasis></para>
<para>C4::URL::Checker - base object for checking URL stored in
Koha DB</para>
<para><emphasis role="bold">SYNOPSIS</emphasis></para>
<programlisting>use C4::URL::Checker;
my $checker = C4::URL::Checker->new( );
$checker->{ host_default } = 'http://mylib.kohalibrary.com';
my $checked_urls = $checker->check_biblio( 123 );
foreach my $url ( @$checked_urls ) {
print "url: ", $url->{ url A }, "\n",
"is_success: ", $url->{ is_success }, "\n",
"status: ", $url->{ status }, "\n";
} </programlisting>
<para><emphasis role="bold">FUNCTIONS</emphasis></para>
<para>new</para>
<para>Create a URL Checker. The returned object can be used to set
default host variable :</para>
<programlisting>my $checker = C4::URL::Checker->new( );
$checker->{ host_default } = 'http://mylib.kohalibrary.com'; </programlisting>
<para>check_biblio</para>
<para>Check all URL from a biblio record. Returns a pointer to an
array containing all URLs with checking for each of them.</para>
<programlisting> my $checked_urls = $checker->check_biblio( 123 ); </programlisting>
<para>With 2 URLs, the returned array will look like that:</para>
<programlisting> [
{
'url' => 'http://mylib.tamil.fr/img/62265_0055B.JPG',
'is_success' => 1,
'status' => 'ok'
},
{
'url' => 'http://mylib.tamil.fr//img/62265_0055C.JPG',
'is_success' => 0,
'status' => '404 - Page not found'
}
], </programlisting>
<para><emphasis role="bold">NAME</emphasis></para>
<para>check-url.pl - Check URLs from 856$u field.</para>
<para><emphasis role="bold">USAGE</emphasis></para>
<para>check-url.pl [--verbose|--help]
[--host=http://default.tld]</para>
<para>Scan all URLs found in 856$u of bib records and display if
resources are available or not.</para>
<para><emphasis role="bold">PARAMETERS</emphasis></para>
<para>--host=http://default.tld</para>
<para>Server host used when URL doesn't have one, ie doesn't begin
with 'http:'. For example, if --host=http://www.mylib.com, then
when 856$u contains 'img/image.jpg', the url checked is:
http://www.mylib.com/image.jpg'.</para>
<para>--verbose|-v</para>
<para>Outputs both successful and failed URLs.</para>
<para>--html</para>
<para>Formats output in HTML. The result can be redirected to a
file accessible by http. This way, it's possible to link directly
to biblio record in edit mode. With this parameter --host-pro is
required.</para>
<para>--host-pro=http://koha-pro.tld</para>
<para>Server host used to link to biblio record editing
page.</para>
<para>--help|-h</para>
<para>Print this help page.</para>
</section>
</section>
<section id="mergeauthcron">
<title>Merge Authorities</title>
<para>Script path: misc/migration_tools/merge_authorities.pl</para>
<para>Does: Updates biblio data with changes to authorities
records</para>
<para>Required by: <link linkend="dontmerge">dontmerge</link> system
preference</para>
<para>Frequency suggestion: nightly</para>
</section>
<section id="serialscron">
<title>Serials Update</title>
<para>Script path: misc/cronjobs/serialsUpdate.pl</para>
<para>Does: checks if there is a "late" issue on active
subscriptions, and if there is, the script will set it as late, and
add the next one as expected.</para>
<para>Frequency suggestion: nightly</para>
</section>
</section>
<section id="opaccrons">
<title>OPAC</title>
<para/>
<section id="customrssfeedcron">
<title>RSS Feeds</title>
<para>Script path: misc/cronjobs/rss/rss.pl</para>
<para>Does: Produces an RSS XML document for any SQL query (not used
for search results RSS feed). <link linkend="customrss">Learn
more</link>.</para>
<para>Frequency suggestion: hourly</para>
</section>
<section id="authbrowsercron">
<title>Authorities Browser</title>
<para>Script path: misc/cronjobs/build_browser_and_cloud.pl</para>
<para>Does: Generate content for authorities browse in OPAC</para>
<para>Required by: <link linkend="OpacBrowser">OpacBrowser</link>
system preference</para>
</section>
<section id="keywordclouds">
<title>Subject/Author Clouds</title>
<para>Script path: misc/cronjobs/cloud-kw.pl</para>
<para>Does: Generates HTML keywords clouds from Koha Zebra indexes.
misc/cronjobs/cloud-sample.conf has a sample of how this script
operates.</para>
<para>Frequency: This is the type of script you can run once a month
or so, the content generated isn't going to change very much over
time.</para>
<section id="keywordcloudsperl">
<title>Perl Documentation</title>
<para><emphasis role="bold">NAME</emphasis></para>
<para>cloud-kw.pl - Creates HTML keywords clouds from Koha Zebra
Indexes</para>
<para><emphasis role="bold">USAGE</emphasis></para>
<para>cloud-kw.pl [--verbose|--help] --conf=cloud.conf</para>
<para>Creates multiple HTML files containing keywords cloud with
top terms sorted by their logarithmic weight. cloud.conf is a YAML
configuration file driving cloud generation process.</para>
<para><emphasis role="bold">PARAMETERS</emphasis></para>
<para>--conf=configuration file</para>
<para>Specify configuration file name</para>
<para>--verbose|-v</para>
<para>Enable script verbose mode.</para>
<para>--help|-h</para>
<para>Print this help page.</para>
<para><emphasis role="bold">CONFIGURATION</emphasis></para>
<para>Configuration file looks like that:</para>
<para><programlisting> ---
# Koha configuration file for a specific installation
# If not present, defaults to KOHA_CONF
KohaConf: /home/koha/mylibray/etc/koha-conf.xml
# Zebra index to scan
ZebraIndex: Author
# Koha index used to link found kewords with an opac search URL
KohaIndex: au
# Number of top keyword to use for the cloud
Count: 50
# Include CSS style directives with the cloud
# This could be used as a model and then CSS directives are
# put in the appropriate CSS file directly.
Withcss: Yes
# HTML file where to output the cloud
Output: /home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html
---
KohaConf: /home/koha/yourlibray/etc/koha-conf.xml
ZebraIndex: Subject
KohaIndex: su
Count: 200
Withcss: no
Output: /home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html</programlisting><emphasis
role="bold">IMPROVEMENTS</emphasis></para>
<para>Generated top terms have more informations than those
outputted from the time being. Some parameters could be easily
added to improve this script:</para>
<para>WithCount</para>
<para>In order to output terms with the number of occurrences they
have been found in Koha Catalogue by Zebra.</para>
<para>CloudLevels</para>
<para>Number of levels in the cloud. Now 24 levels are
hardcoded.</para>
<para>Weighting</para>
<para>Weighting method used to distribute terms in the cloud. We
could have two values: Logarithmic and Linear. Now it's
Logarithmic by default.</para>
<para>Order</para>
<para>Now terms are outputted in the lexical order. They could be
sorted by their weight.</para>
</section>
</section>
</section>
<section id="systemcron">
<title>System Administration</title>
<para/>
<section id="cleandbcron">
<title>Clean up Database</title>
<para>Script path: misc/cronjobs/cleanup_database.pl</para>
<para>Does: Truncates the sessions table and cleans out old
zebraqueue entries.</para>
</section>
</section>
<section id="acqcrons">
<title>Acquisitions</title>
<section id="cleansuggcron">
<title>Clean up old suggestions</title>
<para>Script path: misc/cronjobs/purge_suggestions.pl</para>
<para>Does: Removes old (defined by you) suggestions from the
suggestion management area.</para>
</section>
</section>
<section id="deprecatedcrons">
<title>Deprecated scripts</title>
<para>These should not be run without modification:</para>
<para>Script path: misc/cronjobs/update_items.pl</para>
<para>Script path:misc/cronjobs/smsoverdues.pl</para>
<para>Script path:misc/cronjobs/notifyMailsOp.pl</para>
<para>Script path:misc/cronjobs/reservefix.pl</para>
<para>Script path:misc/cronjobs/zebraqueue_start.pl</para>
<para>Script path:misc/cronjobs/j2a.pl</para>
</section>
</section>
</chapter>
<chapter id="webservices">
<title>Web Services</title>
<para/>
<section id="OAI-PMHservice">
<title>OAI-PMH</title>
<para/>
<section id="oaiconfsample">
<title>Sample OAI Conf File</title>
<para><programlisting> format:
vs:
metadataPrefix: vs
metadataNamespace: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs
schema: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs.xsd
xsl_file: /usr/local/koha/xslt/vs.xsl
marcxml:
metadataPrefix: marxml
metadataNamespace: http://www.loc.gov/MARC21/slim
http://www.loc.gov/standards/marcxml/schema/MARC21slim
schema: http://www.loc.gov/MARC21/slim
http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd
oai_dc:
metadataPrefix: oai_dc
metadataNamespace: http://www.openarchives.org/OAI/2.0/oai_dc/
schema: http://www.openarchives.org/OAI/2.0/oai_dc.xsd
xsl_file:
/usr/local/koha/koha-tmpl/intranet-tmpl/xslt/UNIMARCslim2OAIDC.xsl</programlisting></para>
</section>
</section>
</chapter>
<chapter id="sru">
<title>Using the SRU server</title>
<section id="usingsru">
<sectioninfo>
<author>
<firstname>Nicolas</firstname>
<surname>Morin</surname>
<affiliation>
<orgname>BibLibre</orgname>
</affiliation>
</author>
<pubdate>December 2009</pubdate>
</sectioninfo>
<title>Using the SRU server</title>
<para>Koha implements the Search/Retrieve via URL (SRU) protocol. More
information about the protocol itself can be found at <ulink
url="http://www.loc.gov/standards/sru/";>http://www.loc.gov/standards/sru/</ulink>.
The version implemented is version 1.1.</para>
<section id="sru_explain">
<title>Explain</title>
<para>If you want to have information about the implementation of SRU
on a given server, you should have access to the Explain file using a
request to the server without any parameter. Like
<http://myserver.com:9999/biblios/>. The response from the
server is an XML file that should look like the following and will
give you information about the default settings of the SRU
server.</para>
<programlisting>
<zs:explainResponse>
<zs:version>1.1</zs:version>
<zs:record>
<zs:recordSchema>http://explain.z3950.org/dtd/2.0/</zs:recordSchema>
<zs:recordPacking>xml</zs:recordPacking>
<zs:recordData>
<explain xml:base="zebradb/explain-biblios.xml">
<!--
try stylesheet url: http://./?stylesheet=docpath/sru2.xsl
-->
<serverInfo protocol="SRW/SRU/Z39.50">
<host>biblibre</host>
<port>9999</port>
<database>biblios</database>
</serverInfo>
<databaseInfo>
<title lang="en" primary="true">Koha 3 Bibliographic SRU/SRW/Z39.50 server</title>
<description lang="en" primary="true">Koha 3 Bibliographic Server</description>
<links>
<sru>http://biblibre:9999</sru>
</links>
</databaseInfo>
<indexInfo>
<set name="cql" identifier="info:srw/cql-context-set/1/cql-v1.1">
<title>CQL Standard Set</title>
</set>
<index search="true" scan="true" sort="false">
<title lang="en">CQL Server Choice</title>
<map>
<name set="cql">serverChoice</name>
</map>
<map>
<attr type="1" set="bib1">text</attr>
</map>
</index>
<index search="true" scan="true" sort="false">
<title lang="en">CQL All</title>
<map>
<name set="cql">all</name>
</map>
<map>
<attr type="1" set="bib1">text</attr>
</map>
</index>
<!-- Record ID index -->
<index search="true" scan="true" sort="false">
<title lang="en">Record ID</title>
<map>
<name set="rec">id</name>
</map>
<map>
<attr type="1" set="bib1">rec:id</attr>
<attr type="4" set="bib1">3</attr>
</map>
</index>
</programlisting>
</section>
<section id="sru_search">
<title>Search</title>
<para>This url :
http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs
is composed of the following elements:</para>
<itemizedlist>
<listitem>
<para>base url of the SRU server :
http://myserver.com:9999/biblios?</para>
</listitem>
<listitem>
<para>search part with the 3 required parameters : version,
operation and query. The parameters within the search part should
be of the key=value form, and can be combined with the &
character.</para>
</listitem>
</itemizedlist>
<para>One can add optional parameters to the query, for instance
maximumRecords indicating the maximum number of records to be returned
by the server. So
http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs&maximumRecords=5
will only get the first 5 results results from the server.</para>
<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>
gives more details about the search operations and in particular the
list of optional parameters for searching.</para>
<section id="sru_search_more_details">
<title>More details about Search</title>
<para>The "operation" key can take two values: scan or
searchRetrieve.</para>
<para>If operation=searchRetrieve, then the search key should be
query. As in : operation=searchRetrieve&query=reefs</para>
<para>If operation=scan, then the search key should be scanClause.
As in : operation=scan&scanClause=reefs</para>
<para>etc/zebradb/biblios/etc/bib1.att defines Zebra/3950 indexes
that exist on your system. For instance you'll see that we have
indexes for Subject and for Title: att 21 Subject and att 4 Title
respectively.</para>
<para>In the pqf.properties file located under
etc/zebradb/pqf.properties I see that an access point already uses
my Subject index (index.dc.subject = 1=21) while another uses my
Title index (index.dc.title = 1=4) I know this is my Subject index
because as I've seen just before in my bib1.att file, it's called
with =1=21 in Z3950: so index.dc.subject = 1=21 correctly points to
my Subject index. And Title was called with 1=4 so index.dc.title =
1=4 correctly points to my Title index. I can now construct my query
just like I would in a search box, just preceding it with the
"query" key: query=Subject=reefs and Title=coral searches "reefs" in
the subject and "coral" in the title. The full url would be
http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
and Title=coral If I want to limit the result set to just 5 records,
I can do
http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
and Title=coral&maximumRecords=5</para>
<para>I can also play with truncate, relations, etc. Those are also
defined in my pqf.properties file. I can see for instance the
position properties defined as:</para>
<programlisting>
position.first = 3=1 6=1
# "first in field"
position.any = 3=3 6=1
# "any position in field"
</programlisting>
<para>So as an example if I want "coral" to be at the beginning of
the title, I can do this query :
http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Title=coral
first</para>
</section>
</section>
<section id="sru_retrieve">
<title>Retrieve</title>
<para>My search for
http://univ_lyon3.biblibre.com:9999/biblios?version=1.1&operation=searchRetrieve&query=coral
reefs&maximumRecords=1 retrieves just on record. The response
looks like this:</para>
<programlisting>
<zs:searchRetrieveResponse>
<zs:version>1.1</zs:version>
<zs:numberOfRecords>1</zs:numberOfRecords>
<zs:records>
<zs:record>
<zs:recordPacking>xml</zs:recordPacking>
<zs:recordData>
<record xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd">
<leader> cam a22 4500</leader>
<datafield tag="010" ind1=" " ind2=" ">
<subfield code="a">2-603-01193-6</subfield>
<subfield code="b">rel.</subfield>
<subfield code="d">159 F</subfield>
</datafield>
<datafield tag="020" ind1=" " ind2=" ">
<subfield code="a">FR</subfield>
<subfield code="b">00065351</subfield>
</datafield>
<datafield tag="101" ind1="1" ind2=" ">
<subfield code="c">ita</subfield>
</datafield>
<datafield tag="105" ind1=" " ind2=" ">
<subfield code="a">a z 00|y|</subfield>
</datafield>
<datafield tag="106" ind1=" " ind2=" ">
<subfield code="a">r</subfield>
</datafield>
<datafield tag="100" ind1=" " ind2=" ">
<subfield code="a">20091130 frey50 </subfield>
</datafield>
<datafield tag="200" ind1="1" ind2=" ">
<subfield code="a">Guide des récifs coralliens / A Guide to Coral Reefs</subfield>
<subfield code="b">Texte imprimé</subfield>
<subfield code="e">la faune sous-marine des coraux</subfield>
<subfield code="f">A. et A. Ferrari</subfield>
</datafield>
<datafield tag="210" ind1=" " ind2=" ">
<subfield code="a">Lausanne</subfield>
<subfield code="a">Paris</subfield>
<subfield code="c">Delachaux et Niestlé</subfield>
<subfield code="d">cop. 2000</subfield>
<subfield code="e">impr. en Espagne</subfield>
</datafield>
<datafield tag="215" ind1=" " ind2=" ">
<subfield code="a">287 p.</subfield>
<subfield code="c">ill. en coul., couv. ill. en coul.</subfield>
<subfield code="d">20 cm</subfield>
</datafield>
......
<idzebra>
<size>4725</size>
<localnumber>2</localnumber>
<filename>/tmp/nw10BJv9Pk/upd_biblio/exported_records</filename>
</idzebra>
</record>
</zs:recordData>
<zs:recordPosition>1</zs:recordPosition>
</zs:record>
</zs:records>
</zs:searchRetrieveResponse>
</programlisting>
</section>
</section>
</chapter>
<appendix id="sysprefdefaults">
<title>System Preference Defaults</title>
<para/>
<section id="isbddefaults">
<title>ISBD Defaults</title>
<para/>
<section id="isbddefault">
<title>MARC Default</title>
<para>#100||{ 100a }{ 100b }{ 100c }{ 100d }{ 110a }{ 110b }{ 110c }{
110d }{ 110e }{ 110f }{ 110g }{ 130a }{ 130d }{ 130f }{ 130g }{ 130h
}{ 130k }{ 130l }{ 130m }{ 130n }{ 130o }{ 130p }{ 130r }{ 130s }{
130t }|<br/><br/></para>
<para>#245||{ 245a }{ 245b }{245f }{ 245g }{ 245k }{ 245n }{ 245p }{
245s }{ 245h }|</para>
<para>#246||{ : 246i }{ 246a }{ 246b }{ 246f }{ 246g }{ 246n }{ 246p
}{ 246h }|</para>
<para>#242||{ = 242a }{ 242b }{ 242n }{ 242p }{ 242h }|</para>
<para>#245||{ 245c }|</para>
<para>#242||{ = 242c }|</para>
<para>#250| - |{ 250a }{ 250b }|</para>
<para>#254|, |{ 254a }|</para>
<para>#255|, |{ 255a }{ 255b }{ 255c }{ 255d }{ 255e }{ 255f }{ 255g
}|</para>
<para>#256|, |{ 256a }|</para>
<para>#257|, |{ 257a }|</para>
<para>#258|, |{ 258a }{ 258b }|</para>
<para>#260| - |{ 260a }{ 260b }{ 260c }|</para>
<para>#300| - |{ 300a }{ 300b }{ 300c }{ 300d }{ 300e }{ 300f }{ 300g
}|</para>
<para>#306| - |{ 306a }|</para>
<para>#307| - |{ 307a }{ 307b }|</para>
<para>#310| - |{ 310a }{ 310b }|</para>
<para>#321| - |{ 321a }{ 321b }|</para>
<para>#340| - |{ 3403 }{ 340a }{ 340b }{ 340c }{ 340d }{ 340e }{ 340f
}{ 340h }{ 340i }|</para>
<para>#342| - |{ 342a }{ 342b }{ 342c }{ 342d }{ 342e }{ 342f }{ 342g
}{ 342h }{ 342i }{ 342j }{ 342k }{ 342l }{ 342m }{ 342n }{ 342o }{
342p }{ 342q }{ 342r }{ 342s }{ 342t }{ 342u }{ 342v }{ 342w }|</para>
<para>#343| - |{ 343a }{ 343b }{ 343c }{ 343d }{ 343e }{ 343f }{ 343g
}{ 343h }{ 343i }|</para>
<para>#351| - |{ 3513 }{ 351a }{ 351b }{ 351c }|</para>
<para>#352| - |{ 352a }{ 352b }{ 352c }{ 352d }{ 352e }{ 352f }{ 352g
}{ 352i }{ 352q }|</para>
<para>#362| - |{ 362a }{ 351z }|</para>
<para>#440| - |{ 440a }{ 440n }{ 440p }{ 440v }{ 440x }|.</para>
<para>#490| - |{ 490a }{ 490v }{ 490x }|.</para>
<para>#800| - |{ 800a }{ 800b }{ 800c }{ 800d }{ 800e }{ 800f }{ 800g
}{ 800h }{ 800j }{ 800k }{ 800l }{ 800m }{ 800n }{ 800o }{ 800p }{
800q }{ 800r }{ 800s }{ 800t }{ 800u }{ 800v }|.</para>
<para>#810| - |{ 810a }{ 810b }{ 810c }{ 810d }{ 810e }{ 810f }{ 810g
}{ 810h }{ 810k }{ 810l }{ 810m }{ 810n }{ 810o }{ 810p }{ 810r }{
810s }{ 810t }{ 810u }{ 810v }|.</para>
<para>#811| - |{ 811a }{ 811c }{ 811d }{ 811e }{ 811f }{ 811g }{ 811h
}{ 811k }{ 811l }{ 811n }{ 811p }{ 811q }{ 811s }{ 811t }{ 811u }{
811v }|.</para>
<para>#830| - |{ 830a }{ 830d }{ 830f }{ 830g }{ 830h }{ 830k }{ 830l
}{ 830m }{ 830n }{ 830o }{ 830p }{ 830r }{ 830s }{ 830t }{ 830v
}|.</para>
<para>#500|<br/><br/>|{ 5003 }{ 500a }|</para>
<para>#501|<br/><br/>|{ 501a }|</para>
<para>#502|<br/><br/>|{ 502a }|</para>
<para>#504|<br/><br/>|{ 504a }|</para>
<para>#505|<br/><br/>|{ 505a }{ 505t }{ 505r }{ 505g }{
505u }|</para>
<para>#506|<br/><br/>|{ 5063 }{ 506a }{ 506b }{ 506c }{
506d }{ 506u }|</para>
<para>#507|<br/><br/>|{ 507a }{ 507b }|</para>
<para>#508|<br/><br/>|{ 508a }{ 508a }|</para>
<para>#510|<br/><br/>|{ 5103 }{ 510a }{ 510x }{ 510c }{
510b }|</para>
<para>#511|<br/><br/>|{ 511a }|</para>
<para>#513|<br/><br/>|{ 513a }{513b }|</para>
<para>#514|<br/><br/>|{ 514z }{ 514a }{ 514b }{ 514c }{
514d }{ 514e }{ 514f }{ 514g }{ 514h }{ 514i }{ 514j }{ 514k }{ 514m
}{ 514u }|</para>
<para>#515|<br/><br/>|{ 515a }|</para>
<para>#516|<br/><br/>|{ 516a }|</para>
<para>#518|<br/><br/>|{ 5183 }{ 518a }|</para>
<para>#520|<br/><br/>|{ 5203 }{ 520a }{ 520b }{ 520u
}|</para>
<para>#521|<br/><br/>|{ 5213 }{ 521a }{ 521b }|</para>
<para>#522|<br/><br/>|{ 522a }|</para>
<para>#524|<br/><br/>|{ 524a }|</para>
<para>#525|<br/><br/>|{ 525a }|</para>
<para>#526|<br/><br/>|{\n510i }{\n510a }{ 510b }{ 510c }{
510d }{\n510x }|</para>
<para>#530|<br/><br/>|{\n5063 }{\n506a }{ 506b }{ 506c }{
506d }{\n506u }|</para>
<para>#533|<br/><br/>|{\n5333 }{\n533a }{\n533b }{\n533c
}{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }|</para>
<para>#534|<br/><br/>|{\n533p }{\n533a }{\n533b }{\n533c
}{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }{\n533t }{\n533x
}{\n533z }|</para>
<para>#535|<br/><br/>|{\n5353 }{\n535a }{\n535b }{\n535c
}{\n535d }|</para>
<para>#538|<br/><br/>|{\n5383 }{\n538a }{\n538i }{\n538u
}|</para>
<para>#540|<br/><br/>|{\n5403 }{\n540a }{ 540b }{ 540c }{
540d }{\n520u }|</para>
<para>#544|<br/><br/>|{\n5443 }{\n544a }{\n544b }{\n544c
}{\n544d }{\n544e }{\n544n }|</para>
<para>#545|<br/><br/>|{\n545a }{ 545b }{\n545u }|</para>
<para>#546|<br/><br/>|{\n5463 }{\n546a }{ 546b }|</para>
<para>#547|<br/><br/>|{\n547a }|</para>
<para>#550|<br/><br/>|{ 550a }|</para>
<para>#552|<br/><br/>|{ 552z }{ 552a }{ 552b }{ 552c }{
552d }{ 552e }{ 552f }{ 552g }{ 552h }{ 552i }{ 552j }{ 552k }{ 552l
}{ 552m }{ 552n }{ 562o }{ 552p }{ 552u }|</para>
<para>#555|<br/><br/>|{ 5553 }{ 555a }{ 555b }{ 555c }{
555d }{ 555u }|</para>
<para>#556|<br/><br/>|{ 556a }{ 506z }|</para>
<para>#563|<br/><br/>|{ 5633 }{ 563a }{ 563u }|</para>
<para>#565|<br/><br/>|{ 5653 }{ 565a }{ 565b }{ 565c }{
565d }{ 565e }|</para>
<para>#567|<br/><br/>|{ 567a }|</para>
<para>#580|<br/><br/>|{ 580a }|</para>
<para>#581|<br/><br/>|{ 5633 }{ 581a }{ 581z }|</para>
<para>#584|<br/><br/>|{ 5843 }{ 584a }{ 584b }|</para>
<para>#585|<br/><br/>|{ 5853 }{ 585a }|</para>
<para>#586|<br/><br/>|{ 5863 }{ 586a }|</para>
<para>#020|<br/><br/><label>ISBN: </label>|{
020a }{ 020c }|</para>
<para>#022|<br/><br/><label>ISSN: </label>|{
022a }|</para>
<para>#222| = |{ 222a }{ 222b }|</para>
<para>#210| = |{ 210a }{ 210b }|</para>
<para>#024|<br/><br/><label>Standard No.:
</label>|{ 024a }{ 024c }{ 024d }{ 0242 }|</para>
<para>#027|<br/><br/><label>Standard Tech. Report.
No.: </label>|{ 027a }|</para>
<para>#028|<br/><br/><label>Publisher. No.:
</label>|{ 028a }{ 028b }|</para>
<para>#013|<br/><br/><label>Patent No.:
</label>|{ 013a }{ 013b }{ 013c }{ 013d }{ 013e }{ 013f
}|</para>
<para>#030|<br/><br/><label>CODEN: </label>|{
030a }|</para>
<para>#037|<br/><br/><label>Source: </label>|{
037a }{ 037b }{ 037c }{ 037f }{ 037g }{ 037n }|</para>
<para>#010|<br/><br/><label>LCCN: </label>|{
010a }|</para>
<para>#015|<br/><br/><label>Nat. Bib. No.:
</label>|{ 015a }{ 0152 }|</para>
<para>#016|<br/><br/><label>Nat. Bib. Agency Control
No.: </label>|{ 016a }{ 0162 }|</para>
<para>#600|<br/><br/><label>Subjects--Personal
Names: </label>|{\n6003 }{\n600a}{ 600b }{ 600c }{ 600d }{ 600e
}{ 600f }{ 600g }{ 600h }{--600k}{ 600l }{ 600m }{ 600n }{ 600o
}{--600p}{ 600r }{ 600s }{ 600t }{ 600u
}{--600x}{--600z}{--600y}{--600v}|</para>
<para>#610|<br/><br/><label>Subjects--Corporate
Names: </label>|{\n6103 }{\n610a}{ 610b }{ 610c }{ 610d }{ 610e
}{ 610f }{ 610g }{ 610h }{--610k}{ 610l }{ 610m }{ 610n }{ 610o
}{--610p}{ 610r }{ 610s }{ 610t }{ 610u
}{--610x}{--610z}{--610y}{--610v}|</para>
<para>#611|<br/><br/><label>Subjects--Meeting Names:
</label>|{\n6113 }{\n611a}{ 611b }{ 611c }{ 611d }{ 611e }{ 611f
}{ 611g }{ 611h }{--611k}{ 611l }{ 611m }{ 611n }{ 611o }{--611p}{
611r }{ 611s }{ 611t }{ 611u }{--611x}{--611z}{--611y}{--611v}|</para>
<para>#630|<br/><br/><label>Subjects--Uniform
Titles: </label>|{\n630a}{ 630b }{ 630c }{ 630d }{ 630e }{ 630f
}{ 630g }{ 630h }{--630k }{ 630l }{ 630m }{ 630n }{ 630o }{--630p}{
630r }{ 630s }{ 630t }{--630x}{--630z}{--630y}{--630v}|</para>
<para>#648|<br/><br/><label>Subjects--Chronological
Terms: </label>|{\n6483 }{\n648a
}{--648x}{--648z}{--648y}{--648v}|</para>
<para>#650|<br/><br/><label>Subjects--Topical Terms:
</label>|{\n6503 }{\n650a}{ 650b }{ 650c }{ 650d }{ 650e
}{--650x}{--650z}{--650y}{--650v}|</para>
<para>#651|<br/><br/><label>Subjects--Geographic
Terms: </label>|{\n6513 }{\n651a}{ 651b }{ 651c }{ 651d }{ 651e
}{--651x}{--651z}{--651y}{--651v}|</para>
<para>#653|<br/><br/><label>Subjects--Index Terms:
</label>|{ 653a }|</para>
<para>#654|<br/><br/><label>Subjects--Facted Index
Terms: </label>|{\n6543
}{\n654a}{--654b}{--654x}{--654z}{--654y}{--654v}|</para>
<para>#655|<br/><br/><label>Index Terms--Genre/Form:
</label>|{\n6553 }{\n655a}{--655b}{--655x
}{--655z}{--655y}{--655v}|</para>
<para>#656|<br/><br/><label>Index Terms--Occupation:
</label>|{\n6563
}{\n656a}{--656k}{--656x}{--656z}{--656y}{--656v}|</para>
<para>#657|<br/><br/><label>Index Terms--Function:
</label>|{\n6573
}{\n657a}{--657x}{--657z}{--657y}{--657v}|</para>
<para>#658|<br/><br/><label>Index Terms--Curriculum
Objective:
</label>|{\n658a}{--658b}{--658c}{--658d}{--658v}|</para>
<para>#050|<br/><br/><label>LC Class. No.:
</label>|{ 050a }{ / 050b }|</para>
<para>#082|<br/><br/><label>Dewey Class. No.:
</label>|{ 082a }{ / 082b }|</para>
<para>#080|<br/><br/><label>Universal Decimal Class.
No.: </label>|{ 080a }{ 080x }{ / 080b }|</para>
<para>#070|<br/><br/><label>National Agricultural
Library Call No.: </label>|{ 070a }{ / 070b }|</para>
<para>#060|<br/><br/><label>National Library of
Medicine Call No.: </label>|{ 060a }{ / 060b }|</para>
<para>#074|<br/><br/><label>GPO Item No.:
</label>|{ 074a }|</para>
<para>#086|<br/><br/><label>Gov. Doc. Class. No.:
</label>|{ 086a }|</para>
<para>#088|<br/><br/><label>Report. No.:
</label>|{ 088a }|</para>
</section>
<section id="unimarcdefault">
<title>UNIMARC Default</title>
<para>#200|<h2>Title : |{200a}{. 200c}{ : 200e}{200d}{. 200h}{.
200i}|</h2></para>
<para>#461|<label class="ipt">A part of : </label>|<a
href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=461t&idx=ti}">{461t}</a>{N∞
461h} {v. 461v}{(461d)}<br/>|</para>
<para>#200b|<label class="ipt">Material Designation :
</label>| {200b }|<br/></para>
<para>#101a|<label class="ipt">Language(s): </label>|<a
href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=101a&idx=ln}">{101a}</a>|<br/></para>
<para>#200f|<label class="ipt">Authors : </label>|<a
href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=200f&idx=au}">{200f
; }</a>|<br/></para>
<para>#200g|<label class="ipt">Co-authors : </label>|<a
href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=200g&idx=au}">{200g
; }</a>|<br/></para>
<para>#210a|<br/><label class="ipt">Place of pubblication
: </label>|<a
href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=pl&q={210a}">{210a}</a>|<br/></para>
<para>#210c|<label class="ipt">Publisher : </label>|<a
href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=pb&q={210c}">{210c
; }</a>|<br/></para>
<para>#210d|<label class="ipt">Date of pubblication :
</label>|{ 210d}|<br/></para>
<para>#215|<label class="ipt">Description :
</label>|{215a}{ : 215c}{ ; 215d}{ + 215e}|<br/></para>
<para>#225a|<label class="ipt">Series :</label>|<a
href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=225a&idx=se}">{225a
;}</a> |</para>
<para>#225||{ = 225d}{ : 225e}{. 225h}{. 225i}{ / 225f}{, 225x}{ ;
225v}|<br/></para>
<para>#686|<label>Classification : </label>|{ 686a
}|<br/></para>
<para>#608|<label>Form, Genre : </label>|<a
href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={608a}"><img
border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
title="Search on {608a}">{
608a}</a>|<br/><br/></para>
<para>#200||<label class="ipt">Subjects :
</label><br/>|<ul></para>
<para>#600|<label class="ipt">Person(s)
</label><br/> |<li><a
href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={600a}"><img
border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
title="Search on {600a}">{
600a}</a></li>|<br/></para>
<para>#601|<label class="ipt">Organisation(s)
</label><br/>|<li><a
href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={601a}"><img
border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
title="Search on {601a}">{
601a}</a></li>|<br/></para>
<para>#606|<label class="ipt">Term(s)
</label><br/>|<li><a
href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={606a}"><img
border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
title="Search on {606a}">{
606a}</a></li>|<br/></para>
<para>#607|<label class="ipt">Place(s)
</label><br/>|<li><a
href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={607a}"><img
border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
title="Search on {607a}">{
607a}</a></li>|<br/></para>
<para>#610|<label>Keywords</label><br/>|<li><a
href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={610a}"><img
border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
title="Search on {610a}">{ 610a}</a></li>|</para>
<para>#200||</ul>|</para>
<para>#856|<label class="ipt">Electronic resource :
</label>|<a href="{856u}">click here</a> to go to
the external resource<br/></para>
<para>#010|<label class="ipt">ISBN : </label>|{010a
;}|<br/></para>
<para>#011|<label class="ipt">ISSN : </label>|{011a
;}|<br/></para>
<para>#200||<label class="ipt">Notes :
</label>|<br/><ul></para>
<para>#300||<li>{300a}</li>|</para>
<para>#307||<li>{307a}</li>|</para>
<para>#310||<li>{310a}</li>|</para>
<para>#326||<li>{326a}</li>|</para>
<para>#327||<li>{327a}</li>|</para>
<para>#333|<li>Public : |{333a}</li>|</para>
<para>#200||</ul>|</para>
<para>#330||<label class="ipt">Abstract :
</label>|<br/></para>
<para>#330||{330a}|<br/></para>
<para>#200||<br/><h2>Items</h2>|</para>
<para>#200|<table>|<th>Call
number</th><th>Copy
note</th><th>Fonds</th><th>Genre
detail</th><th>Circulation
type</th><th>Barcode</th>|</para>
<para>#995||<tr><td> {995k}</td><td>
{995u}</td><td>
{995y}</td><td>{995e} </td><td>
{995o}</td><td>{995f}</td></tr>|</table></para>
</section>
</section>
<section id="nozebradefault">
<title>NoZebraIndexes Default</title>
<para>'title' =>
'130a,210a,222a,240a,243a,245a,245b,246a,246b,247a,247b,250a,250b,440a,830a',</para>
<para>'author' =>
'100a,100b,100c,100d,110a,111a,111b,111c,111d,245c,700a,710a,711a,800a,810a,811a',</para>
<para>'isbn' => '020a',</para>
<para>'issn' => '022a',</para>
<para>'lccn' => '010a',</para>
<para>'biblionumber' => '999c',</para>
<para>'itemtype' => '942c',</para>
<para>'publisher' => '260b',</para>
<para>'date' => '260c',</para>
<para>'note' => '500a,
501a,504a,505a,508a,511a,518a,520a,521a,522a,524a,526a,530a,533a,538a,541a,546a,555a,556a,562a,563a,583a,585a,582a',</para>
<para>'subject' =>
'600*,610*,611*,630*,650*,651*,653*,654*,655*,662*,690*',</para>
<para>'dewey' => '082',</para>
<para>'bc' => '952p',</para>
<para>'callnum' => '952o',</para>
<para>'an' => '6009,6109,6119',</para>
<para>'homebranch' => '952a,952c'</para>
</section>
</appendix>
<appendix id="receiptprint">
<title>Configuring Receipt Printers</title>
<para>The following instructions are for specific receipt printers, but
can probably be used to help with setup of other brands as well.</para>
<section id="epsonprinters">
<sectioninfo>
<corpauthor>NEKLS</corpauthor>
<pubdate>2008</pubdate>
<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>
</sectioninfo>
<title>For Epson TM-T88III (3) & TM-T88IV (4) Printers</title>
<para/>
<section id="epsonprintdriver">
<title>In the Print Driver</title>
<para>For these instructions, we are using version 5,0,3,0 of the
Epson TM-T88III print driver; the EPSON TM-T88IV version is ReceiptE4.
Register at the <ulink
url="https://www.epsonexpert.com/login";>EpsonExpert Technical Resource
Center website</ulink> to gain access to the drivers; go to Technical
Resources, then choose the printer model from the Printers drop-down
list.</para>
<para>Click Start > Printers and Faxes > Right click the receipt
printer > Properties:</para>
<itemizedlist>
<listitem>
<para>Advanced Tab, click Printing Defaults button</para>
</listitem>
<listitem>
<para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
</listitem>
<listitem>
<para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
Printable Width</para>
</listitem>
<listitem>
<para>TM-T88IV: Check Reduced Size Print; Click OK on the popup
window that appears. Fit to Printable Width should be
automatically selected.</para>
</listitem>
<listitem>
<para>OK your way out of there.</para>
</listitem>
</itemizedlist>
</section>
<section id="epsonfirefox">
<title>In Firefox</title>
<para>Under File > Page Setup:</para>
<itemizedlist>
<listitem>
<para>Shrink to fit page on Format & Options tab</para>
</listitem>
<listitem>
<para>0,0,0,0 for Margins on Margins & Header/Footer Tab. This
makes the receipts use all available space on the paper
roll.</para>
</listitem>
<listitem>
<para>Set all Headers/Footers to -blank-. This removes all of the
gunk you might normally find on a print from firefox, such as the
URL, number of pages, etc.</para>
</listitem>
<listitem>
<para>Click OK</para>
</listitem>
</itemizedlist>
<para>Set the default printer settings in Firefox so you don't see a
"Print" dialog:</para>
<itemizedlist>
<listitem>
<para>Go to File > Print</para>
</listitem>
<listitem>
<para>Set the Printer to the receipt printer.</para>
</listitem>
<listitem>
<para>Click the Advanced (or Properties) button</para>
</listitem>
<listitem>
<para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
</listitem>
<listitem>
<para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
Printable Width</para>
</listitem>
<listitem>
<para>TM-T88IV: Check Reduced Size Print; click OK on the popup
window that appears. Fit to Printable Width should be
automatically selected.</para>
</listitem>
<listitem>
<para>OK your way out, go ahead and print whatever page you are
on.</para>
</listitem>
<listitem>
<para>Type about:config, in the address bar. Click "I'll be
careful, I promise!" on the warning message.</para>
</listitem>
<listitem>
<para>Type, print.always in Filter.</para>
</listitem>
<listitem>
<para>Look for print.always_print_silent.</para>
<itemizedlist>
<listitem>
<para>If the preference is there then set the value to
true.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If the preference is not there (and it shouldn't be in most
browsers) you have to add the preference.</para>
<itemizedlist>
<listitem>
<para>Right click the preference area and select New >
Boolean</para>
</listitem>
<listitem>
<para>Type print.always_print_silent in the dialog box and set
the value to True. This sets the print settings in Firefox to
always use the same settings and print without showing a
dialog box.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<warning>
<para>Setting the print.always_print_silent setting in about:config
DISABLES the ability to choose a printer in Firefox.</para>
</warning>
</section>
</section>
<section id="epson2">
<sectioninfo>
<corpauthor>NEKLS</corpauthor>
<pubdate>2008</pubdate>
<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>
</sectioninfo>
<title>For Epson TM-T88II (2) Printers</title>
<para>Register at the <ulink
url="https://www.epsonexpert.com/login";>EpsonExpert Technical Resource
Center website</ulink> to gain access to the drivers; go to Technical
Resources, then choose the printer model from the Printers drop-down
list.</para>
<section id="epson2firefox">
<title>In Firefox</title>
<para>Under File > Page Setup:</para>
<itemizedlist>
<listitem>
<para>Shrink to fit page on Format & Options tab</para>
</listitem>
<listitem>
<para>0,0,0,0 for Margins on Margins & Header/Footer Tab. This
makes the receipts use all available space on the paper
roll.</para>
</listitem>
<listitem>
<para>Set all Headers/Footers to -blank-. This removes all of the
gunk you might normally find on a print from firefox, such as the
URL, number of pages, etc.</para>
</listitem>
<listitem>
<para>Click OK</para>
</listitem>
</itemizedlist>
<para>Set the default printer settings in Firefox so you don't see a
"Print" dialog:</para>
<itemizedlist>
<listitem>
<para>Go to File > Print</para>
</listitem>
<listitem>
<para>Set the Printer to the receipt printer.</para>
</listitem>
<listitem>
<para>Print whatever page you are on.</para>
</listitem>
<listitem>
<para>Type about:config, in the address bar. Click "I'll be
careful, I promise!" on the warning message.</para>
</listitem>
<listitem>
<para>Type, print.always in Filter.</para>
</listitem>
<listitem>
<para>Look for, print.always_print_silent.</para>
<itemizedlist>
<listitem>
<para>If the preference is there then set the value to
true.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If the preference is not there (and it shouldn't be in most
browsers) you have to add the preference.</para>
<itemizedlist>
<listitem>
<para>Right click the preference area and select New >
Boolean</para>
</listitem>
<listitem>
<para>Type, print.always_print_silent in the dialog box and
set the value to True. This sets the print settings in Firefox
to always use the same settings and print without showing a
dialog box.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<warning>
<para>Setting the print.always_print_silent setting in about:config
DISABLES the ability to choose a printer in Firefox.</para>
</warning>
</section>
</section>
<section id="starprinter">
<sectioninfo>
<corpauthor>RHCL</corpauthor>
<editor>
<firstname>Nicole C.</firstname>
<surname>Engard</surname>
</editor>
<pubdate>2010</pubdate>
</sectioninfo>
<title>For Star SP542 Printers</title>
<section id="installstarprinter">
<title>Installing the Printer</title>
<para>While the following comments are based on the Star SP542 receipt
printer, they probably apply to all printers in the SP5xx
series.</para>
<para>The Star SP542 receipt printer works well with Koha and Firefox
on Windows XP SP3. This printer, with either the parallel or USB
interface, is fairly easy to install and configure. You will need the
following executable file which is available from numerous places on
the Internet:</para>
<para>linemode_2k-xp_20030205.exe</para>
<para>This executable actually does all of the installation; you will
not need to use the Microsoft Windows "Add Printer" program. We
recommend that when installing, the option for the software monitor
not be selected; we have experienced significant pauses and delays in
printing with it. Instead, simply choose to install the receipt
printer without the monitor.</para>
<para>Additionally, the install program may not put the printer on the
correct port, especially if using the USB interface. This is easily
corrected by going to "Start -> Printers and Faxes -> Properties
for the SP542 printer -> Ports", then check the appropriate
port.</para>
<para>A reboot may be required, even if not indicated by the
installation software or the operating system.</para>
</section>
</section>
<section id="firefoxreceipt">
<sectioninfo>
<corpauthor>VOKAL</corpauthor>
<editor>
<firstname>Nicole C.</firstname>
<surname>Engard</surname>
</editor>
<pubdate>2010</pubdate>
<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>
</sectioninfo>
<title>Configuring Firefox to Print to Receipt Printer</title>
<itemizedlist>
<listitem>
<para>Open File > Page Setup</para>
</listitem>
<listitem>
<para>Make all the headers and footers blank</para>
</listitem>
<listitem>
<para>Set the margins to 0 (zero)</para>
</listitem>
<listitem>
<para>In the address bar of Firefox, type about:config</para>
</listitem>
<listitem>
<para>Search for print.always_print_silent and double click
it</para>
</listitem>
<listitem>
<para>Change it from false to true</para>
<itemizedlist>
<listitem>
<para>This lets you skip the Print pop up box that comes up, as
well as skipping the step where you have to click OK,
automatically printing the right sized slip.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If print.always_print_silent does not come up</para>
<itemizedlist>
<listitem>
<para>Right click on a blank area of the preference
window</para>
</listitem>
<listitem>
<para>Select new > Boolean</para>
</listitem>
<listitem>
<para>Enter "print.always_print_silent" as the name (without
quotes)</para>
</listitem>
<listitem>
<para>Click OK</para>
</listitem>
<listitem>
<para>Select true for the value</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>You may also want to check what is listed for
print.print_printer</para>
<itemizedlist>
<listitem>
<para>You may have to choose Generic/Text Only (or whatever your
receipt printer might be named)</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
</appendix>
<appendix id="samplenotice">
<title>Example Notice</title>
<para>Nicole Engard</para>
<para>410 Library Rd.</para>
<para>Philadelphia, PA 19107</para>
<para>Dear Nicole Engard (23529000035726),</para>
<para>According to our records, at the time of this notice, you have items
that are overdue. Please return or renew them as soon as possible to avoid
increasing late fines.</para>
<para>If you have registered a password with the library, you may use it
with your library card number to renew online.</para>
<para>If you believe you have returned the items below please call at and
library staff will be happy to help resolve the issue.</para>
<para>The following item(s) are currently overdue:</para>
<para>07/08/2008 Creating drug-free schools and communities : 502326000054
Fox, C. Lynn.</para>
<para>06/27/2008 Eating fractions / 502326000022 McMillan, Bruce.</para>
<para>Sincerely, Library Staff</para>
</appendix>
<appendix id="sampleserialsapp">
<title>Sample Serials</title>
<para/>
<section id="readersdigestsample">
<title>Reader's Digest (0034-0375)</title>
<itemizedlist>
<listitem>
<para>Published 12 times a year (monthly)</para>
</listitem>
<listitem>
<para>The Volume number changes every 6 months and the the numbers
continues on (requires an advanced pattern).</para>
<screenshot>
<screeninfo>Sample Reader's Digest Subscription</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serialssamples/readersserial.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
<para/>
</section>
<section id="peoplesample">
<title>People Weekly (1076-0091)</title>
<itemizedlist>
<listitem>
<para>Published weekly</para>
<itemizedlist>
<listitem>
<para>The website says "on Saturday except the first week of
August, Thanksgiving week, the first and last weeks of the year"
but this does not match the pattern for 2007 or 2008</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>In the Jul-Dec there are 26 issues</para>
</listitem>
<listitem>
<para>In the Jan-Jun there are 25 issues (no issue for the first
week of January)</para>
</listitem>
</itemizedlist>
<para>Since the irregularity on the first # 26 does not skip a week,
this would be set up as to roll over on issue 25. The 26th issue in the
second half of the year would have to be received as a
supplemental.</para>
<para>The irregularity check will complain that 52 issues were expected,
but 25 entered. The current irregularity check can only check that the
first position of the numbering pattern matches the expected issue count
of the periodicity. But we do need to trigger the rollover on the
volume, so we need to define the last two weeks of the year as
irregularities. So we receive 50 issues the first 50 weeks, then one
supplemental issue in week 51, which we have to define the enumeration
for, then the next predicted issue will be the following year's first
week.</para>
</section>
<section id="hebrewserialsample">
<title>עת-מול
עיתון
לתולדות ארץ
ישראל ועם
ישראל</title>
<para>This journal is published with the following rules:</para>
<itemizedlist>
<listitem>
<para>6 issues a year (every 2 months)</para>
</listitem>
<listitem>
<para>year changes every 6 issues</para>
</listitem>
<listitem>
<para>we start in 2011</para>
</listitem>
<listitem>
<para>the issue number goes up indefinitly</para>
</listitem>
<listitem>
<para>starting from issue 215</para>
</listitem>
</itemizedlist>
<para>The planning would look like this:</para>
<screenshot>
<screeninfo>Sample for this Hebrew Journal</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/serialssamples/hebrewnewspaper.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
</appendix>
<appendix id="kohacms">
<title>Using Koha as a Content Management System (CMS)</title>
<para/>
<section id="kohacmssetup">
<title>Setup</title>
<para>These are instructions for taking a default install of Koha 3.0
and allowing it to function as a little content management system. This
will allow a library to publish an arbitrary number of pages based on a
template. This example uses the template for the main opac page, but you
could just as well use any template you wish with a bit more editing.
This may be appropriate if you have a small library, want to allow
librarians to easily add pages, and do not want to support a complete
CMS.</para>
<itemizedlist>
<listitem>
<para>Copy /usr/share/koha/opac/cgi-bin/opac/opac-main.pl to
/usr/share/koha/opac/cgi-bin/opac/pages.pl (in the same
directory)</para>
</listitem>
<listitem>
<para>Edit pages.pl in an editor</para>
</listitem>
<listitem>
<para>At approximately line 32 add:</para>
<programlisting>my $cgi = new CGI;</programlisting>
</listitem>
<listitem>
<para>At approximately line 36 change this code:</para>
<programlisting>template_name =>
"opac-main.tmpl",</programlisting>
<para>To this code:</para>
<programlisting>template_name => "pages.tmpl",</programlisting>
</listitem>
<listitem>
<para>At approximately line 54 change this code:</para>
<programlisting>$template->param(
koha_news => $all_koha_news,
koha_news_count => $koha_news_count
); </programlisting>
<para>To this:</para>
<programlisting>my $page = "page_" . $cgi->param("p");
$template->param(
koha_news => $all_koha_news,
koha_news_count => $koha_news_count,
local_page => "" .
C4::Context->preference($page)
); </programlisting>
</listitem>
<listitem>
<para>Copy
/usr/share/koha/opac/htdocs/opac-tmpl/prog/en/modules/opac-main.tmpl
to
/usr/share/koha/opac/htdocs/opac-tmpl/prog/en/modules/pages.tmpl</para>
</listitem>
<listitem>
<para>At approximately line 38, change this:</para>
<programlisting><!-- TMPL_IF NAME="OpacMainUserBlock"
--><div id="opacmainuserblock" class="container"><!--
TMPL_VAR NAME="OpacMainUserBlock" --></div><!-- /TMPL_IF
--> </programlisting>
<para>To this:</para>
<programlisting><!-- TMPL_IF NAME="local_page" --><div
id="opacmainuserblock" class="container"><!-- TMPL_VAR
NAME="local_page" --></div><!-- /TMPL_IF
--></programlisting>
</listitem>
<listitem>
<para>In system preferences in the staff client, click the button
for "New Preference" under "Local Use"</para>
</listitem>
<listitem>
<para>Fill it out as so</para>
<itemizedlist>
<listitem>
<para>Explanation: test page for pages tiny cms</para>
</listitem>
<listitem>
<para>Variable: page_test</para>
</listitem>
<listitem>
<para>Value: Lorem ipsum</para>
</listitem>
<listitem>
<para>Click the TextArea link (or enter "TextArea" into the
input field below it)</para>
</listitem>
<listitem>
<para>variable options (last field): 80|50</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>In a browser go to
http://youraddress/cgi-bin/koha/pages.pl?p=test The page should come
up with the words "Lorem ipsum" in the main content area of the
page. (replace "youraddress" with localhost, 127.0.0.1, or your
domain name depending on how you have Apache set up.)</para>
</listitem>
<listitem>
<para>To add more pages simply create a system preference where the
title begins with "page_" followed by any arbitrary letters. You can
add any markup you want as the value of the field. Reference the new
page by changing the value of the "p" parameter in the URL.</para>
</listitem>
</itemizedlist>
<section id="kohacmstrouble">
<title>Troubleshooting</title>
<para>If you have problems check file permissions on pages.pl and
pages.tmpl. They should have the same user and group as other Koha
files like opac-main.pl.</para>
</section>
<section id="kohacmsbonus">
<title>Bonus Points</title>
<para>Instead of using the address
http://youraddress/cgi-bin/koha/pages.pl?p=test you can shorten it to
http://youraddress/pages.pl?p=test Just open up
/etc/koha/koha-httpd.conf and add the follow at about line
13:<programlisting>ScriptAlias /pages.pl "/usr/share/koha/opac/cgi-bin/opac/pages.pl" </programlisting></para>
<para>Then restart Apache.</para>
</section>
</section>
<section id="kohacmsusage">
<title>Usage</title>
<para>After setting up Koha as a CMS you can create new pages following
these instructions:</para>
<section id="kohacmspages">
<title>Adding Pages</title>
<para>To add a new page you need to add a system preference under
Local Use.</para>
<itemizedlist>
<listitem>
<para>Get there: More > Administration > Global System
Preferences > Local Use</para>
</listitem>
<listitem>
<para>Click 'New Preference'</para>
</listitem>
<listitem>
<para>Enter in a description in the Explanation field</para>
</listitem>
<listitem>
<para>Enter a value that starts with 'page_' in the Variable
field</para>
</listitem>
<listitem>
<para>Enter starting HTML in the Value field</para>
<screenshot>
<screeninfo>Add a new preference</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-cms/newpreference.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Set the Variable Type to Textarea</para>
</listitem>
<listitem>
<para>Set the Variable options to something like 20|20 for 20 rows
and 20 columns</para>
<screenshot>
<screeninfo>Settings for the new preference</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-cms/newpref-settings.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
</itemizedlist>
</section>
<section id="kohacmsview">
<title>Viewing your page</title>
<para>You can view your new page at
http://YOUR-OPAC/cgi-bin/koha/pages.pl?p=PAGENAME where PAGENAME is
the part you entered after 'page_' in the Variable field.</para>
</section>
<section id="kohacmsexpage">
<title>Example</title>
<para>This process can be used to create recommended reading lists
within Koha. So once the code changes have been made per the
instructions on 'Koha as a CMS' you go through the 'Adding a New Page'
instructions above to great a page for 'Recommended Reading
Lists'</para>
<screenshot>
<screeninfo>Create page by modifying a system
preference</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-cms/recommendedreading.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Next we need to create pages for our various classes (or
categories). To do this, return to the 'Adding a New Page' section and
create a preference for the first class.</para>
<screenshot>
<screeninfo>Add a new sys pref for another page</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-cms/class101-pref.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Next you'll want to link your first page to your new second
page, go to the page_recommend preference and click 'Edit.' Now you
want to edit the HTML to include a link to your newest page:</para>
<screenshot>
<screeninfo>Edit original preference to add new page</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-cms/editrecommendpref.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="examplecms">
<title>Live Examples</title>
<itemizedlist>
<listitem>
<para>The Crawford Library at Dallas Christian College is using
this method for their recommended reading lists: <ulink
url="http://opac.dallas.edu/";>http://opac.dallas.edu/</ulink></para>
</listitem>
</itemizedlist>
</section>
</section>
</appendix>
<appendix id="resetkohadb">
<title>Resetting the Koha Database</title>
<para>These notes on how to reset the database for Koha 3 were derived
from the following email thread: <ulink
url="http://lists.koha-community.org/pipermail/koha-devel/2009-January/008939.html";>http://lists.koha-community.org/pipermail/koha-devel/2009-January/008939.html</ulink></para>
<para>Resetting the database may be useful if you install Koha with the
sample data, and then wish to use real data without reinstalling the
software.</para>
<section id="truncate">
<title>Truncate Tables</title>
<para>Use your preferred MySQL client to <ulink
url="http://dev.mysql.com/doc/refman/5.0/en/truncate.html";>truncate</ulink>
the following tables:</para>
<itemizedlist>
<listitem>
<para>bibio</para>
</listitem>
<listitem>
<para>biblioitems</para>
</listitem>
<listitem>
<para>items</para>
</listitem>
<listitem>
<para>auth_header</para>
</listitem>
<listitem>
<para>sessions</para>
</listitem>
<listitem>
<para>zebraqueue</para>
</listitem>
</itemizedlist>
</section>
<section id="resetzebra">
<title>Reset the Zebra Index</title>
<para>Run the following commands to reset the authorities and biblios
Zebra indices. <programlisting>$ zebraidx -c /etc/koha/zebradb/zebra-authorities-dom.cfg -g iso2709 -d authorities init
$ zebraidx -c /etc/koha/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init </programlisting></para>
</section>
</appendix>
<appendix id="importantlinks">
<title>Important Links</title>
<para/>
<section id="koharelatedlinks">
<title>Koha Related</title>
<itemizedlist>
<listitem>
<para>Report Koha Bugs - <ulink
url="http://bugs.koha-community.org";>http://bugs.koha-community.org</ulink></para>
</listitem>
<listitem>
<para>Koha Versioning Control - <ulink
url="http://git.koha-community.org/";>http://git.koha-community.org/</ulink></para>
</listitem>
<listitem>
<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>
</listitem>
<listitem>
<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>
</listitem>
<listitem>
<para>Kyles's Koha Tools - <ulink
url="http://millruntech.com/koha";>http://millruntech.com/koha</ulink></para>
</listitem>
<listitem>
<para>Koha Bibliography - <ulink
url="http://www.zotero.org/groups/koha";>http://www.zotero.org/groups/koha</ulink></para>
</listitem>
<listitem>
<para>Koha Shared Links - <ulink
url="http://groups.diigo.com/group/everything-koha";>http://groups.diigo.com/group/everything-koha</ulink></para>
</listitem>
<listitem>
<para>Koha Presentations - <ulink
url="http://www.slideshare.net/group/koha-ils/slideshows";>http://www.slideshare.net/group/koha-ils/slideshows</ulink></para>
</listitem>
</itemizedlist>
</section>
<section id="catalogrelatedlinks">
<title>Cataloging Related</title>
<itemizedlist>
<listitem>
<para>Koha MARC Tutorials - <ulink
url="http://www.pakban.net/brooke/";>http://www.pakban.net/brooke/</ulink></para>
</listitem>
<listitem>
<para>Z39.50 Server Search - <ulink
url="http://targettest.indexdata.com/";>http://targettest.indexdata.com/</ulink></para>
</listitem>
<listitem>
<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>
</listitem>
<listitem>
<para>Library of Congress Authorities - <ulink
url="http://authorities.loc.gov/";>http://authorities.loc.gov/</ulink></para>
</listitem>
<listitem>
<para>MARC Country Codes - <ulink
url="http://www.loc.gov/marc/countries/";>http://www.loc.gov/marc/countries/</ulink></para>
</listitem>
<listitem>
<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>
</listitem>
<listitem>
<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>
</listitem>
<listitem>
<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>
</listitem>
</itemizedlist>
</section>
<section id="enhancedcontentlinks">
<title>Enhanced Content Related</title>
<itemizedlist>
<listitem>
<para>Amazon Associates - <ulink
url="https://affiliate-program.amazon.com/";>https://affiliate-program.amazon.com</ulink></para>
</listitem>
<listitem>
<para>Amazon Web Services - <ulink
url="http://aws.amazon.com";>http://aws.amazon.com</ulink></para>
</listitem>
<listitem>
<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>
</listitem>
<listitem>
<para>XISBN - <ulink
url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp";>http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
</listitem>
<listitem>
<para>LibraryThing for Libraries - <ulink
url="http://www.librarything.com/forlibraries";>http://www.librarything.com/forlibraries</ulink></para>
</listitem>
</itemizedlist>
</section>
<section id="opaclinks">
<title>Design Related</title>
<itemizedlist>
<listitem>
<para>JQuery Library - <ulink
url="http://wiki.koha-community.org/wiki/JQuery_Library";>http://wiki.koha-community.org/wiki/JQuery_Library</ulink></para>
</listitem>
<listitem>
<para>Owen Leonard's Koha Blog - <ulink
url="http://www.myacpl.org/koha";>http://www.myacpl.org/koha</ulink></para>
</listitem>
</itemizedlist>
</section>
<section id="reportlinks">
<title>Reports Related</title>
<itemizedlist>
<listitem>
<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>
</listitem>
<listitem>
<para>Database Schema - <ulink
url="http://schema.koha-community.org";>http://schema.koha-community.org</ulink></para>
</listitem>
<listitem>
<para>Sample reports from NEKLS - <ulink
url="http://www.nexpresslibrary.org/training/reports-training/";>http://www.nexpresslibrary.org/training/reports-training/</ulink></para>
</listitem>
</itemizedlist>
</section>
<section id="installlinks">
<title>Installation Guides</title>
<itemizedlist>
<listitem>
<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>
</listitem>
<listitem>
<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>
</listitem>
<listitem>
<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>
</listitem>
</itemizedlist>
</section>
<section id="misclinks">
<title>Misc</title>
<itemizedlist>
<listitem>
<para>Zotero - <ulink
url="http://zotero.org";>http://zotero.org</ulink></para>
</listitem>
<listitem>
<para>SOPAC - <ulink
url="http://thesocialopac.net/";>http://thesocialopac.net</ulink></para>
</listitem>
</itemizedlist>
</section>
</appendix>
<appendix id="XSLTiTypes">
<title>Koha XSLT Item Types</title>
<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
<link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
preference turned on you will see item type icons on the related screen.
<important>
<para>These images are coming from values found in your leader, if
your leader is not cataloged properly it might be best to turn off the
<link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
preference (which can be done while leaving the other XSLT preferences
turned on).</para>
</important></para>
<screenshot>
<screeninfo>Book image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-xslt/book.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Book [BK]</para>
<itemizedlist>
<listitem>
<para>leader6 = a (and one of the leader7 values below)</para>
<itemizedlist>
<listitem>
<para>leader7 = a</para>
</listitem>
<listitem>
<para>leader7 = c</para>
</listitem>
<listitem>
<para>leader7 = d</para>
</listitem>
<listitem>
<para>leader7 = m</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>leader6 = t</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>Computer Image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-xslt/comp.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Computer File [CF]</para>
<itemizedlist>
<listitem>
<para>leader6 = m</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>Continuing Resource Image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-xslt/cr.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Continuing Resource [CR]</para>
<itemizedlist>
<listitem>
<para>leader7 = b</para>
</listitem>
<listitem>
<para>leader7 = i</para>
</listitem>
<listitem>
<para>leader7 = s</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>Map Image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-xslt/map.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Map [MP]</para>
<itemizedlist>
<listitem>
<para>leader6 = e</para>
</listitem>
<listitem>
<para>leader6 = f</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>Mixed Materials Image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-xslt/mixed.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Mixed [MX]</para>
<itemizedlist>
<listitem>
<para>leader6 = p</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>Sound Image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-xslt/sound.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Sound [MU]</para>
<itemizedlist>
<listitem>
<para>leader6 = c</para>
</listitem>
<listitem>
<para>leader6 = d</para>
</listitem>
<listitem>
<para>leader6 = i</para>
</listitem>
<listitem>
<para>leader6 = j</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>Visual Material Image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-xslt/visual.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Visual Material [VM]</para>
<itemizedlist>
<listitem>
<para>leader6 = g</para>
</listitem>
<listitem>
<para>leader6 = k</para>
</listitem>
<listitem>
<para>leader6 = r</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>Kit Image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-xslt/kit.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>Kit</para>
<itemizedlist>
<listitem>
<para>leader6 = o</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</appendix>
<appendix id="marcedit">
<title>MarcEdit</title>
<para/>
<section id="marceditprefix">
<title>Adding a prefix to call numbers</title>
<para>When bringing data into Koha, you may want to first clean it up.
One common action among Koha users is to add a prefix to the call
number.</para>
<itemizedlist>
<listitem>
<para>Open MarcEdit</para>
<screenshot>
<screeninfo>MarcEdit</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/marcedit.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>Click 'MarcEditor'</para>
</listitem>
<listitem>
<para>Go to Tools > Edit Subfield Data</para>
<screenshot>
<screeninfo>Edt subfield data</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/marcedit-editsubfield.png"/>
</imageobject>
</mediaobject>
</screenshot>
</listitem>
<listitem>
<para>To prepend data the special character is: ^b To simply
prepend data to the beginning of a subfield, add ^b to the Field
Data: textbox and the data to be appended in the Replace</para>
<screenshot>
<screeninfo>Prepend data to a field</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/editsubfield.png"/>
</imageobject>
</mediaobject>
</screenshot>
<itemizedlist>
<listitem>
<para>To prepend data to the beginning of the subfield while
replacing a text string, add ^b[string to replace] to the Field
Data textbox and the data to be appended in the Replace With
textbox.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="marceditexcel">
<sectioninfo>
<author>
<firstname>Kanika</firstname>
<surname>Goyal</surname>
<affiliation>
<orgname>Delhi Technological University</orgname>
</affiliation>
</author>
<editor>
<firstname>Nicole C.</firstname>
<surname>Engard</surname>
</editor>
<pubdate>2010</pubdate>
<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>
</sectioninfo>
<title>Importing Excel data into Koha</title>
<para>Suppose you have records of your library in excel data sheet
format and want them to import into Koha. But how will you do this? Koha
will not let you import excel records directly. Well here is a very
simple solution for you which will let you import your excel records in
Koha easily. First, we will convert excel file into Marc file and then
will import it into Koha.</para>
<para>Follow the given steps to import your excel records into
Koha</para>
<section id="convertexcel">
<title>Converting from Excel format into .mrk format</title>
<para>First, we will convert excel format into .mrk format. For this
we will use MarcEdit. You can download it from <ulink
url="http://people.oregonstate.edu/~reeset/marcedit/html/downloads.html";>http://people.oregonstate.edu/~reeset/marcedit/html/downloads.html</ulink>.</para>
<para>Now open it and select Add-ins-->Delimited Text
Translator.</para>
<screenshot>
<screeninfo>Delimited Text Translator</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-1.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Click Next when the following window appears.</para>
<screenshot>
<screeninfo>Delimited Text Translator</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-2.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Browse for your excel file.</para>
<screenshot>
<screeninfo>Delimited Text Translator</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-3.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Locate your excel file by choosing the format Excel
File(*.xls).</para>
<screenshot>
<screeninfo>Delimited Text Translator</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-4.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Similarly, fill all the other entries such as Output File, Excel
Sheet Name and check UTF-8 Encoded (if required) and Click
Next.</para>
<screenshot>
<screeninfo>Delimited Text Translator</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-5.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Now you will be prompted for mapping the fields to recognise the
fields by standard marc format.</para>
<para>Suppose for Field 0 that is first column I entered Map to:
022$a( Valid ISSN for the continuing resource) and then click on
Apply.</para>
<screenshot>
<screeninfo>Delimited Text Translator</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-6.png"/>
</imageobject>
</mediaobject>
</screenshot>
<note>
<para>You can customize Indicators and all other things, for more
information on marc21 format visit the <ulink
url="http://www.loc.gov/marc/bibliographic/";>official library of
congress site</ulink>.</para>
</note>
<para>Similarly map all other fields and then Click on Finish.</para>
<screenshot>
<screeninfo>Delimited Text Translator</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-7.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>And then a window will appear indicating that your Marc Text
File(*.mrk) has been created.</para>
<screenshot>
<screeninfo>Delimited Text Translator</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-8.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Click Close and we have created a .mrk file from .xls file in
this step. You can view the file by double clicking on it.</para>
</section>
<section id="convertmrk">
<title>Convert .mrk file to .mrc</title>
<para>We will convert .mrk file that we have created in the above step
into raw Marc format that can be directly imported into Koha.</para>
<para>For this again open MarcEdit and Select MARC Tools.</para>
<screenshot>
<screeninfo>MARC Tools</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-9.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Next Select MarcMaker to convert .mrk file into .mrc
format.</para>
<screenshot>
<screeninfo>MarcMaker</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-10.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Locate your input file and name your output file. Then Click
Execute.</para>
<screenshot>
<screeninfo>MarcMaker</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-11.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>And it will show you the Result.</para>
<screenshot>
<screeninfo>MarcMaker</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-12.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Click Close and now we have raw Marc records wih us (.mrc
file).</para>
</section>
<section id="importmrc">
<title>Import .mrc into Koha</title>
<para>More information on importing records into Koha can be found in
the '<link linkend="stagemarc">Stage MARC Records for Import</link>'
section of this manual.</para>
<para>Finally we will import above created .mrc file into Koha.</para>
<para>Click on Tools in your Koha staff client.</para>
<screenshot>
<screeninfo>Koha Staff Client</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-13.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Next Click on Stage MARC Records for Import.</para>
<screenshot>
<screeninfo>Stage MARC Records for Import</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-14.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>After this, choose your previously created .mrc file and click
on Upload.</para>
<screenshot>
<screeninfo>Stage File</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-15.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can also add comment about file and finally click on Stage
For Import.</para>
<screenshot>
<screeninfo>Stage for Import</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-17.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>When the import is done, you will get a result something like
this</para>
<screenshot>
<screeninfo>Staged Records Summary</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-18.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Next, click on Manage staged records.</para>
<para>Here you can even change matching rules.</para>
<screenshot>
<screeninfo>Manage Staged Records</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-19.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Click on Import this batch into catalog when you are
done.</para>
<para>Thats it. After all the records get imported, check Status and
it should read "imported"</para>
<screenshot>
<screeninfo>Finalize Import</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/appendix-marcedit/excelimport/step-20.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>You can even undo the Import operation.</para>
<para>And within few minutes, we have imported around 10,000 records
in Koha</para>
</section>
</section>
</appendix>
<appendix id="faqs">
<title>FAQs</title>
<para/>
<section id="displayfaq">
<title>Display</title>
<para/>
<section id="customicons">
<title>Custom Item Type/Authorized Value Icons</title>
<para><emphasis role="bold">Question:</emphasis> Can I have my own set
of item type images (or authorized value icons)?</para>
<para><emphasis role="bold">Answer: </emphasis>Absolutely. To add
additional icons to your system you simply add a new directory to
koha-tmpl/intranet-tmpl/prog/img/itemtypeimg/ and to
koha-tmpl/opac-tmpl/prog/itemtypeimg and put your icons in the new
directory. Your icons will show up in a new tab as soon as they are in
the folders.</para>
<itemizedlist>
<listitem>
<tip>
<para>Remember to put the icons in both places (on the OPAC and
the intranet).</para>
</tip>
</listitem>
</itemizedlist>
</section>
<section id="customkohaimages">
<title>Customizing Koha Images</title>
<para><emphasis role="bold">Question</emphasis>: Can I customize the
images in the OPAC?</para>
<para><emphasis role="bold">Answer</emphasis>: Absolutely. Koha comes
with a series of original images that you can alter to meet your
needs. The originals can be found in the misc/interface_customization/
directory.</para>
</section>
<section id="opacdisplayfaq">
<title>OPAC Display Fields</title>
<para><emphasis role="bold">Question</emphasis>: What MARC fields
print to the different OPAC screens in Koha?</para>
<para><emphasis role="bold">Answer</emphasis>: The XSLT preference
must be set as follows for the following fields to show</para>
<itemizedlist>
<listitem>
<para><link
linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> =
using XSLT stylesheets</para>
</listitem>
<listitem>
<para><link
linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
using XSLT stylesheets</para>
</listitem>
<listitem>
<para><link
linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> =
show</para>
</listitem>
</itemizedlist>
<para>The OPAC Results page shows:</para>
<itemizedlist>
<listitem>
<para>245</para>
</listitem>
<listitem>
<para>100, 110, 111</para>
</listitem>
<listitem>
<para>700, 710, 711</para>
</listitem>
<listitem>
<para>250</para>
</listitem>
<listitem>
<para>260</para>
</listitem>
<listitem>
<para>246</para>
</listitem>
<listitem>
<para>856</para>
</listitem>
</itemizedlist>
<para>The OPAC Details page shows:</para>
<itemizedlist>
<listitem>
<para>245</para>
</listitem>
<listitem>
<para>100, 110, 111</para>
</listitem>
<listitem>
<para>700, 710, 711</para>
</listitem>
<listitem>
<para>440, 490</para>
</listitem>
<listitem>
<para>260</para>
</listitem>
<listitem>
<para>250</para>
</listitem>
<listitem>
<para>300</para>
</listitem>
<listitem>
<para>020</para>
</listitem>
<listitem>
<para>022</para>
</listitem>
<listitem>
<para>246</para>
</listitem>
<listitem>
<para>130, 240</para>
</listitem>
<listitem>
<para>6xx</para>
</listitem>
<listitem>
<para>856</para>
</listitem>
<listitem>
<para>505</para>
</listitem>
<listitem>
<para>773</para>
</listitem>
<listitem>
<para>520</para>
</listitem>
<listitem>
<para>866</para>
</listitem>
<listitem>
<para>775</para>
</listitem>
<listitem>
<para>780</para>
</listitem>
<listitem>
<para>785</para>
</listitem>
<listitem>
<para>plus all of the 5xx fields in the Notes tab at the
bottom</para>
</listitem>
</itemizedlist>
</section>
<section id="displaysubtitle">
<title>Subtitle Display on Bib Records</title>
<para><emphasis role="bold">Question</emphasis>: How do I get the
subtitle to display on the detail pages for my bib records?</para>
<para><emphasis role="bold">Answer</emphasis>: Subtitle display now
depends on there being a <link linkend="keywordmapping">keyword
mapping</link> for the MARC field in question. Adding a mapping for
"subtitle" -> "245b" for an item's framework results in display of
the subtitle in OPAC and staff client search and detail pages
(although not in all instances where subtitles might be displayed,
e.g. the Cart).</para>
</section>
<section id="customlogo">
<sectioninfo>
<author>
<firstname>Owen</firstname>
<surname>Leonard</surname>
<affiliation>
<orgname>Athens County Public Library</orgname>
</affiliation>
</author>
<pubdate>July 2010</pubdate>
</sectioninfo>
<title>Customize Logo on Staff Client</title>
<para><emphasis role="bold">Question</emphasis>: How do I change the
Koha logo on the Staff Client login page?</para>
<para><emphasis role="bold">Answer</emphasis>: <link
linkend="opacsmallimage">Opacsmallimage</link> controls the display of
the Koha logo in the OPAC, but there is no system preference
controlling the logo on the staff client login page. Luckily the logo
is displayed via CSS so it can be easily customized through some
custom CSS.</para>
<para>These are the relevant parts of the staff client default CSS:
<programlisting>#login h1 {
background:url("../../img/koha-logo.gif") no-repeat scroll center
top transparent;
margin-bottom:0.5em;
margin-top:0;
}
#login h1 a {
border-bottom:medium none;
display:block;
height:74px;
text-indent:-1000px;
}</programlisting></para>
<para>If you have access to the file system on your Koha server you
can add a custom CSS file and specify that file using the <link
linkend="intranetcolorstylesheet">intranetcolorstylesheet</link>
system preference.</para>
<para>There is no analogue to the <link
linkend="OPACUserCSS">OPACUserCSS</link> preference in the staff
client, but you can get around this by putting this in the <link
linkend="intranetuserjs">intranetuserjs</link> preference:
<programlisting>//]]>
</script>
<style type="text/css">
/* inline styles */
</style>
<script type="text/javascript">
//<![CDATA[</programlisting></para>
<para>In the above snippet where it says /* inline styles */ we'll
redeclare the relevant properties from the styles of the login
image:<programlisting>//]]>
</script>
<style type="text/css">
/* inline styles */
#login h1 {
background:url("../../img/koha-logo.gif") no-repeat scroll center
top transparent;
}
#login h1 a {
height:74px;
}
</style>
<script type="text/javascript">
//<![CDATA[
</programlisting></para>
<para>I've only reproduced the properties necessary to make the change
we want. You can see that the "background:" property sets the path to
the default logo. You can change this to point to any image you want,
on the Koha server or anywhere else. Then you just need to change the
#login h1 a's "height" property to match the height of the image you
choose.</para>
<para>For example:</para>
<para><programlisting>//]]>
</script>
<style type="text/css">
/* inline styles */
#login h1 {
background:url("http://www.myacpl.org/sites/all/themes/npl/logo.png";)
no-repeat scroll center top transparent;
}
#login h1 a {
height:71px;
}
</style>
<script type="text/javascript">
//<![CDATA[</programlisting></para>
</section>
<section id="opacbarcodesfaq">
<title>Show patrons the barcodes of items they have checked
out</title>
<para><emphasis role="bold">Question</emphasis>: Can patrons see the
barcodes for the items they have checked out.</para>
<para><emphasis role="bold">Answer</emphasis>: Not by default, but
with a few edits to the patron record you can make a barcode column
appear on the patron's check out summary in the OPAC. You can set up a
<link linkend="patronattributetypes">patron attribute</link> with the
value of SHOW_BCODE and <link linkend="authorizedvalues">authorized
value</link> of YES_NO to make this happen.</para>
<screenshot>
<screeninfo>Add SHOW_BCODE patron attribute</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/SHOW_BCODEadd.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Then on the <link linkend="editpatrons">patron's record set the
value</link> for SHOW_BCODE to yes.</para>
<screenshot>
<screeninfo>Setting value for SHOW_BCODE on patron
record</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/SHOW_BCODEattribute.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>This will add a column to the check out summary in the OPAC that
shows the patrons the barcodes of the items they have checked
out.</para>
<screenshot>
<screeninfo>Barcode number on checkout list in OPAC</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/opac/barcodeoncheckouts.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>Clicking on the 'Overdue' tab will show only the items that are
overdue.</para>
</section>
</section>
<section id="circfaq">
<title>Circulation/Notices</title>
<para/>
<section id="dropboxfaq">
<title>Dropbox Date</title>
<para><emphasis role="bold">Question</emphasis>: How is the dropbox
date is determined? Is it the last open date for the checkout branch?
Is it today's date minus one? Can the dropbox checkin date be
set?</para>
<para><emphasis role="bold">Answer</emphasis>: If the library is
closed for four days for renovations, for example, there would be more
than one day needed for the dropbox date. You will only have one
dropbox date and that will be the last day that the library open
(determined by the holiday calendar) because there is no real way to
know what day the books were dropped into the box during the 4 closed
days. The only way to change the effective checkin date in dropbox
mode is to modify the calendar.</para>
</section>
<section id="dupoverduefaq">
<title>Duplicate Overdue Notices</title>
<para><emphasis role="bold">Question</emphasis>: Why are patrons
getting two overdue notices?</para>
<para><emphasis role="bold">Answer</emphasis>: This tool takes all
branches in the overdue rules and sent notifications to them. So, if
you have a default rule & a branch rule, the notification will be
generated twice. A quick fix is to discard "default rule" for
instance.</para>
</section>
<section id="printoverduefaq">
<title>Printing Overdue Notices</title>
<para><emphasis role="bold">Question</emphasis>: Can I print overdue
notices for patrons without email addresses on file?</para>
<para><emphasis role="bold">Answer</emphasis>: Yes. The <link
linkend="overduenoticecron">overdue notice cron job</link> has a
setting to generate the overdue notices as HTML for printing. An
example of this useage would be:</para>
<para><programlisting>overdue_notices.pl -t -html /tmp/noticedir -itemscontent issuedate,date_due,title,barcode,author </programlisting>In
this example, we wanted to use only certain item fields in our
notices, so we specified itemscontent fields in the cron entry; that's
not a requirement for the feature.</para>
<para>The command line needs to specify a web-accessible directory
where the print notices will go -- they get a filename like
notices-2009-11-24.html (or holdnotices-2009-11-24.html). The overdue
notice itself can be formatted to fit a Z-mailer. Within the notice
file, the text is spaced down or over to where it will print properly
on the form. The script has code that wraps around the notice file to
tell the HTML to obey the formatting, and to do a page break between
notices. That's so that when staff print it out, they get one per
page. We had to add an extra syspref (<link
linkend="PrintNoticesMaxLines">PrintNoticesMaxLines</link>) to specify
page length because our client allows a _lot_ of checkouts which meant
some notices were running onto multiple pages. That syspref says to
truncate the print notice at that page length and put in a message
about go check your OPAC account for the full list.</para>
<para>The print and email overdues use the same notice file. The print
notices for holds are different -- there's a separate HOLD_PRINT
notice file and the system uses it if there's no email address. Then a
nightly cron job runs to gather those up from the message queue and
put them in an HTML file in the notice directory, as above.</para>
<para>The cron entry is gather_print_notices.pl /tmp/noticedir</para>
</section>
<section id="renewfaq">
<title>Unable to Renew Items</title>
<para><emphasis role="bold">Question</emphasis>: We're trying to renew
some items for our patron. One of the items is on hold and ineligible
for renewal, but the other two items refuse to renew even though they
should be eligible. When I try to use the override renewal limit, it
just returns a little message that says “renewal failed". Any
idea what's going on here?</para>
<para><emphasis role="bold">Answer</emphasis>: At the very least you
will need to set an absolute <link linkend="circfinerules">default
circulation rule</link>. This rule should be set for the default
itemtype, default branchcode and default patron category. That will
catch anyone who doesn't match a specific rule. Patrons who do not
match a specific rule will get blocked from placing holds, since there
was no baseline number of holds to utilize.</para>
</section>
<section id="holdsfaq">
<title>Unable to Place Holds</title>
<para><emphasis role="bold">Question</emphasis>: Why can't I place
holds when I have all of the preferences turned on.</para>
<para><emphasis role="bold">Answer</emphasis>: You probably need to
set a default circulation rule. At the very least you will need to set
an default circulation rule. This rule should be set for all item
types, all branches and all patron categories. That will catch all
instances that do not match a specific rule. When checking out if you
do not have a rule for the default branch, default item and default
patron category then you may see patrons getting blocked from placing
holds.</para>
</section>
<section id="keyboardshort">
<title>Keyboard Shortcuts</title>
<para><emphasis role="bold">Question</emphasis>: Do I have to use my
mouse to access the checkout, checkin and cataloging tabs at the top
of the circulation pages?</para>
<para><emphasis role="bold">Answer</emphasis>: You can jump between
the tabs on the quick search box at the top of the screen by using the
following hot keys (if the tab is available):</para>
<itemizedlist>
<listitem>
<para>jump to the catalog search with Alt+Q</para>
</listitem>
<listitem>
<para>jump to the checkout with Alt+U</para>
<itemizedlist>
<listitem>
<para>this will not work for Mac user</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>jump to the checkin with Alt+R</para>
</listitem>
</itemizedlist>
<para><tip>
<para>Mac users use the OPTION button in place of ALT</para>
</tip></para>
</section>
<section id="smsnoticefaq">
<title>SMS Notices/Messages</title>
<para><emphasis role="bold">Question</emphasis>: I want Koha to send
notices via SMS, what do I need to do?</para>
<para><emphasis role="bold">Answer</emphasis>: First you need to
choose a SMS service to use with Koha. There is a list available 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</ulink>
Not all SMS services available to libraries have Perl drivers, so be
sure to check this list to see if the provider you're considering is
listed. If not you want to ask your provider if they have a Perl
module, if not you should consider another service. Some common
options in the US (that have Perl drivers) are:</para>
<itemizedlist>
<listitem>
<para>AQL (<ulink
url="http://www.aql.com";>www.aql.com</ulink>)</para>
</listitem>
<listitem>
<para>Wadja (<ulink
url="http://wadja.com";>wadja.com</ulink>)</para>
</listitem>
<listitem>
<para>Ipipi (<ulink
url="http://ipipi.com";>ipipi.com</ulink>)</para>
</listitem>
<listitem>
<para>T-mobile</para>
</listitem>
<listitem>
<para>SMSDiscount (<ulink
url="http://smsdiscount.com";>smsdiscount.com</ulink>)</para>
</listitem>
<listitem>
<para>Clickatell</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="catfaq">
<title>Cataloging</title>
<para/>
<section id="authorityfaq">
<title>Authority Fields</title>
<para><emphasis role="bold">Question: </emphasis>Why can't I edit 1xx,
6xx, or 7xx fields in my catalog record?</para>
<para><emphasis role="bold">Answer:</emphasis> These fields are
authority controlled and you probably have the <link
linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> set to
'allow'. When it is set to 'don't allow' these fields will be locked
and require you to search for an existing authority record.</para>
<screenshot>
<screeninfo>Locked fields show with a lock icon in the
left</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/cataloging/lockedauthority.png"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section id="kohamarcfaq">
<title>Koha to MARC Mapping</title>
<para><emphasis role="bold">Question</emphasis>: What's the
relationship between 'Koha to MARC Mapping' and 'MARC Bibliographic
Frameworks'?</para>
<para><emphasis role="bold">Answer</emphasis>: Mapping can be defined
through 'MARC Bibliographic Frameworks' OR 'Koha to MARC Mapping'.
'Koha to MARC Mapping' is just a shortcut to speed up linkage. If you
change a mapping in one of these modules, the mapping will change in
the other as well. (In other words, the two modules 'overwrite' each
other in order to prevent conflicts from existing in Koha).</para>
</section>
<section id="itemsperbibfaq">
<title>Number of Items Per Bib Record</title>
<para><emphasis role="bold">Question</emphasis>: Is there a limit on
the number of items I can attach to a bib record?</para>
<para><emphasis role="bold">Answer</emphasis>: There is no explicit
limit to the number of items you can attach to a bibliographic record,
but if you attach enough of them, your MARC record will exceed the
maximum file size limit for the ISO-2709 standard, which breaks
indexing for that record. I've found this occurs somewhere between 600
and 1000 items on a 'normal' bibliographic record.</para>
</section>
<section id="analyticsfaq">
<title>Analytics</title>
<para><emphasis role="bold">Question</emphasis>: I am using the <link
linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> feature,
but my links in the OPAC and Staff Client to 'Show Analytics' are not
working.</para>
<para><emphasis role="bold">Answer</emphasis>: If you plan on using
<link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> you
will want to make sure to set your <link
linkend="UseControlNumber">UseControlNumber</link> preference to
"Don't use," this will prevent broken links.</para>
</section>
</section>
<section id="acqfaq">
<title>Acquisitions</title>
<para/>
<section id="planningcatfaq">
<title>Planning Categories</title>
<para><emphasis role="bold">Question</emphasis>: What is a planning
category?</para>
<para><emphasis role="bold">Answer</emphasis>: When you plan in
advance for the way your budget is going to be spent, you initially
plan for how it's going to be spent over time, that's the most natural
thing to do.</para>
<para>So you plan for $1000 in Jan. $1000 in Feb., $3000 in March,
etc. You can basically do the same thing with a list of values in lieu
of the months.</para>
<para>Say you have a list like this one:</para>
<itemizedlist>
<listitem>
<para>< 1 month</para>
</listitem>
<listitem>
<para>< 6 months</para>
</listitem>
<listitem>
<para>< 1 year</para>
</listitem>
<listitem>
<para>< 3 years</para>
</listitem>
<listitem>
<para>< 10 years</para>
</listitem>
<listitem>
<para>> 10 years</para>
</listitem>
</itemizedlist>
<para>The list is meant to represent when the books acquired where
published. Then you plan for it, saying: we went to spend at list 40%
of our budgets on books published less than a year ago, 10% on books
more than 10 years old, etc.</para>
<para>Upon acquiring new material, you'll be able to select, for a
given item, a value from this list in a drop down. Then, after the
material has been acquired, at the end of the year, you'll be able to
compare the goals set, with what's been achieved.</para>
</section>
</section>
<section id="serialsfaq">
<title>Serials</title>
<para/>
<section id="advancedpatternfaq">
<title>Advanced Patterns</title>
<para><emphasis role="bold">Question</emphasis>: What is the 'inner
counter' on the advanced serials pattern interface?</para>
<para><emphasis role="bold">Answer</emphasis>: I think it is better to
give an example to understand this :</para>
<para>Example for a monthly subscription :</para>
<itemizedlist>
<listitem>
<para>First issue publication date : april 2010</para>
</listitem>
<listitem>
<para>Numbering : No {X}, year {Y}</para>
</listitem>
<listitem>
<para>First issue : No 4, year 2010</para>
</listitem>
</itemizedlist>
<para>For the year Y : you will want the year change on january
2011</para>
<para>So, the advanced pattern for Y will be :</para>
<itemizedlist>
<listitem>
<para>Add : 1</para>
</listitem>
<listitem>
<para>once every : 12</para>
</listitem>
<listitem>
<para>When more than 9999999</para>
</listitem>
<listitem>
<para>inner counter : 3</para>
</listitem>
<listitem>
<para>Set back to 0</para>
</listitem>
<listitem>
<para>Begins with 2010</para>
</listitem>
</itemizedlist>
<para>Year is going to change after 12 received issues from april
2010, that is in April 2011 if you don't set inner counter. Set inner
counter to 3 will say to Koha : change year after 12-3 = 9 received
issues.</para>
<para>Inner counter says to koha to take into account the first issues
of the year, even if they are not received with Koha. If you begin
with first issue of the year write nothing or 0.</para>
</section>
</section>
<section id="reportsfaq">
<title>Reports</title>
<para/>
<section id="accounttypefaq">
<title>Define Codes Stored in DB</title>
<para/>
<section id="finescodefaq">
<title>Fines Table</title>
<para><emphasis role="bold">Question:</emphasis> What do the codes
in the accounttype field in the accountlines table stand for?</para>
<para><emphasis role="bold">Answer:</emphasis></para>
<itemizedlist>
<listitem>
<para>A = acc't management fee</para>
</listitem>
<listitem>
<para>C = credit</para>
</listitem>
<listitem>
<para>F = overdue fine</para>
</listitem>
<listitem>
<para>FOR =forgiven</para>
</listitem>
<listitem>
<para>FU = overdue, still acccruing</para>
</listitem>
<listitem>
<para>L = Lost Item</para>
</listitem>
<listitem>
<para>M = Sundry</para>
</listitem>
<listitem>
<para>N = New Card</para>
</listitem>
<listitem>
<para>PAY = payment</para>
</listitem>
<listitem>
<para>W = writeoff</para>
</listitem>
</itemizedlist>
</section>
<section id="statscodefaq">
<title>Statistics Table</title>
<para><emphasis role="bold">Question: </emphasis>What are the
possible codes for the type field in the statistics table?</para>
<para><emphasis role="bold">Answer:</emphasis></para>
<itemizedlist>
<listitem>
<para>localuse</para>
<itemizedlist>
<listitem>
<para>Registers if an item that had been checked out to a
statistics patron (category type = 'X') is returned</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>issue</para>
</listitem>
<listitem>
<para>return</para>
</listitem>
<listitem>
<para>renew</para>
</listitem>
<listitem>
<para>writeoff</para>
</listitem>
<listitem>
<para>payment</para>
</listitem>
<listitem>
<para>CreditXXX</para>
<itemizedlist>
<listitem>
<para>stores different types of fee credits, so a query to
catch them all would include a clause like "type LIKE
'Credit%'"</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="rescodefaq">
<title>Reserves Table</title>
<para><emphasis role="bold">Question</emphasis>: What are the
possible codes for the found field in the reserves and old_reserves
tables?</para>
<para><emphasis role="bold">Answer</emphasis>:</para>
<itemizedlist>
<listitem>
<para>NULL: means the patron requested the 1st available, and we
haven't choosen the item</para>
</listitem>
<listitem>
<para>T = Transit: the reserve is linked to an item but is in
transit to the pickup branch</para>
</listitem>
<listitem>
<para>W =Waiting: the reserve is linked to an item, is at the
pickup branch, and is waiting on the hold shelf</para>
</listitem>
<listitem>
<para>F = Finished: the reserve has been completed, and is
done</para>
</listitem>
</itemizedlist>
</section>
<section id="reportdicfaq">
<title>Reports Dictionary Table</title>
<para><emphasis role="bold">Question</emphasis>: What are the
possible codes for the area field in the reports_dictionary
table?</para>
<para><emphasis role="bold">Answer</emphasis>:</para>
<itemizedlist>
<listitem>
<para>1 = Circulation</para>
</listitem>
<listitem>
<para>2 = Catalog</para>
</listitem>
<listitem>
<para>3 = Patrons</para>
</listitem>
<listitem>
<para>4 = Acquistions</para>
</listitem>
<listitem>
<para>5 = Accounts</para>
</listitem>
</itemizedlist>
</section>
<section id="msgtablefaq">
<title>Messages Table</title>
<para><emphasis role="bold">Question</emphasis>: What are the
possible codes for the message_type field in the messages
table?</para>
<para><emphasis role="bold">Answer</emphasis>:</para>
<itemizedlist>
<listitem>
<para>L = For Librarians</para>
</listitem>
<listitem>
<para>B = For Patrons/Borrowers</para>
</listitem>
</itemizedlist>
</section>
<section id="serialtablefaq">
<title>Serial Table</title>
<para><emphasis role="bold">Question</emphasis>: What are the
possible codes for the status field in the serial table"?</para>
<para><emphasis role="bold">Answer</emphasis>:</para>
<itemizedlist>
<listitem>
<para>1 = Expected</para>
</listitem>
<listitem>
<para>2 = Arrived</para>
</listitem>
<listitem>
<para>3 = Late</para>
</listitem>
<listitem>
<para>4 = Missing</para>
</listitem>
<listitem>
<para>5 = Not Available</para>
</listitem>
<listitem>
<para>6 = Delete</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="runtimefaq">
<title>Runtime Parameters</title>
<para><emphasis role="bold">Question</emphasis>: Is there a way to
filter my custom SQL reports before they run?</para>
<para><emphasis role="bold">Answer</emphasis>: If you feel that your
report might be too resource intesive you might want to consider using
runtime parameters to your query. Runtime parameters basically make a
filter appear before the report is run to save your system
resources.</para>
<para>There is a specific syntax that Koha will understand as 'ask for
values when running the report'. The syntax is <<Question to
ask|authorized_value>>.</para>
<itemizedlist>
<listitem>
<para>The << and >> are just delimiters. You must put
<< at the beginning and >> at the end of your
parameter</para>
</listitem>
<listitem>
<para>The 'Question to ask' will be displayed on the left of the
string to enter.</para>
</listitem>
<listitem>
<para>The authorized_value can be omitted if not applicable. If it
contains an authorized value category, or branches or itemtype or
categorycode, a list with the Koha authorized values will be
displayed instead of a free field Note that you can have more than
one parameter in a given SQL Note that entering nothing at run
time won't probably work as you expect. It will be considered as
"value empty" not as "ignore this parameter". For example entering
nothing for : "title=<<Enter title>>" will display
results with title='' (no title). If you want to have to have
something not mandatory, use "title like <<Enter
title>>" and enter a % at run time instead of nothing</para>
</listitem>
</itemizedlist>
<para>Examples:</para>
<itemizedlist>
<listitem>
<para>SELECT surname,firstname FROM borrowers WHERE
branchcode=<<Enter patrons library|branches>> AND
surname like <<Enter filter for patron surname (% if
none)>></para>
</listitem>
<listitem>
<para>SELECT * FROM items WHERE homebranch = <<Pick your
branch|branches>> and barcode like <<Partial barcode
value here>></para>
</listitem>
</itemizedlist>
<tip>
<para>To generate a date picker calendar to the right of the field
when running a report you can use the 'date' keyword like this:
<<Enter Date|date>></para>
<screenshot>
<screeninfo>Date Picker</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/datepicker.png"/>
</imageobject>
</mediaobject>
</screenshot>
</tip>
<tip>
<para>You have to put "%" in a text box to 'leave it blank'.
Otherwise, it literally looks for "" (empty string) as the value for
the field.</para>
</tip>
<para><important>
<para>In addition to using any authorized value code to generate a
dropdown, you can use the following values as well: Branches
(branches), Item Types (itemtypes) and Patron Categories
(categorycode). For example a branch pull down would be generated
like this <<Branch|branches>></para>
<screenshot>
<screeninfo>Branch pull down</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/reports/branchpulldown.png"/>
</imageobject>
</mediaobject>
</screenshot>
</important></para>
</section>
<section id="reportlimitfaq">
<title>Results Limited</title>
<para><emphasis role="bold">Question</emphasis>: When I download my
report it's limited to 10,000 results, how do I get all of the results
to download?</para>
<para><emphasis role="bold">Answer</emphasis>: There is a limit of
10,000 records put on SQL statements entered in Koha. To get around
this you want to add 'LIMIT 100000' to the end of your SQL statement
(or any other number above 10,000.</para>
</section>
</section>
<section id="searchfaq">
<title>Searching</title>
<para/>
<section id="advancedsearchfaq">
<title>Advanced Search</title>
<para/>
<section id="scanindexfaq">
<title>Scan Indexes</title>
<para><emphasis role="bold">Question</emphasis>: What does 'scan
indexes' on the advanced search page mean?</para>
<para><emphasis role="bold">Answer</emphasis>: When you choose an
index, enter a term, click 'scan indexes' and do the search, Koha
displays the searched term and the following terms found in this
index with the number of corresponding records That is search is not
made directly in the catalog, but first in the indexes It works only
for one index at once, and only with no limit in Location (All
libraries needed)</para>
</section>
<section id="searchstartswith">
<title>Searching for Terms that Start With a Character</title>
<para><emphasis role="bold">Question</emphasis>: How do I search for
all titles that start with the letter 'C'?</para>
<para><emphasis role="bold">Answer</emphasis>: You can choose to
search for things that start with a character or series of
characters by using the CCL 'first-in-subfield'</para>
<itemizedlist>
<listitem>
<para>example: ti,first-in-subfield=C</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="wildcardsearchfaq">
<title>Wildcard Searching</title>
<para><emphasis role="bold">Question</emphasis>:What is the difference
between a keyword search using the ‘*’ (asterisk) versus
a keyword search using the ‘%’ (percent)? Both work in
the catalog, but return different sets. Why?</para>
<para><emphasis role="bold">Answer</emphasis>: A wildcard is a
character (*,?,%,.) that can be used to represent one or more
characters in a word. Two of the wildcard characters that can be used
in Koha searches are the asterisk (‘*’) and the percent
sign (‘%’). However, these two characters act differently
when used in searching.</para>
<para>The ‘*’ is going to force a more exact search of
the first few characters you enter prior to the ‘*’. The
asterisk will allow for an infinite number of characters in the search
as long as the first few characters designated by your search remain
the same. For example, searching for authors using the term, Smi*,
will return a list that may include Smith, Smithers, Smithfield,
Smiley, etc depending on the authors in your database.</para>
<para>The ‘%’ will treat the words you enter in the terms
of “is like”. So a search of Smi% will search for words
like Smi. This results in a much more varied results list. For
example, a search on Smi% will return a list containing Smothers,
Smith, Smelley, Smithfield and many others depending on what is your
database.</para>
<para>The bottom line in searching with wildcards: ‘*’ is
more exact while ‘%’ searches for like terms.</para>
</section>
</section>
<section id="enhancedcontentfaq">
<title>Enhanced Content</title>
<para/>
<section id="frbrfaq">
<title>FRBRizing Content</title>
<para><emphasis role="bold">Question: </emphasis>At our public library
we are running a Koha installation and we've tried to turn on all the
nice functionalities in Koha such as the frbrising tool, but do not
get the same result as Nelsonville public library.</para>
<para><emphasis role="bold">Answer: </emphasis>In fact, this feature
is quite tricky to make that right. First it looks at xisbn service.
And then search in your database for that isbn. So both xisbn and your
internal isbn (in biblio table) have to be normalized. You could
therefore use the script misc/batchupdateISBNs.pl (it removes all the
- in your local ISBNs)</para>
</section>
<section id="amzfaq">
<title>Amazon</title>
<para/>
<section id="amzprivatekey">
<title>Amazon Private Key</title>
<para><emphasis role="bold">Question</emphasis>: Why do I need the
<link linkend="AWSPrivateKey">AWSPrivateKey</link> as well as the
<link linkend="AWSAccessKeyID">AWSAccessKeyID</link> to use Amazon
Content?</para>
<para><emphasis role="bold">Answer</emphasis>: After 2009-08-15,
Amazon Web Services will expect that all requests to the Product
Advertising API, which is what Koha uses for retrieving reviews and
other enhanced content from Amazon, include signatures. This patch
and subsequenct patches implement this functionality.</para>
<para>What this means in practice (assuming the user has elected to
use any enhanced content from Amazon) is that</para>
<orderedlist>
<listitem>
<para>The user must get a Amazon Secret Access Key. This can be
done by logging in to the user's AWS account at (e.g.)
http://aws.amazon.com/, going to the 'Access Identifiers' page,
and from there retrieving and/or creating a new Secret Access
Key.</para>
</listitem>
<listitem>
<para>The contents of the Secret Access Key should then be
entered into the new AWSPrivateKey system preference.</para>
</listitem>
</orderedlist>
<para>Once that is done, grabbing reviews and table of contents from
Amazon should work as normal. If the user doesn't do this before
2009-08-15, reviews and TOCs will no longer be supplied from Amazon,
although there should be no crashes - the content will simply not
show up.</para>
<para>Note that the requirement to sign requests does *NOT* appear
to apply to simply displaying book covers from Amazon.</para>
</section>
<section id="amazonfaq">
<title>All Amazon Content</title>
<para><emphasis role="bold">Question</emphasis>: I have all of the
Amazon preferences turned on and have entered both of my keys, but
none of the content appears in my system, why is that?</para>
<para><emphasis role="bold">Answer</emphasis>: Amazon's API checks
your server time on all requests and if your server time is not set
properly requests will be denied. To resolve this issue be sure to
set your system time appropriately. Once that change in made Amazon
content should appear immediately.</para>
<para>On Debian the the command is <emphasis>date -s "2010-06-30
17:21"</emphasis> (with the proper date and time for your
timezone).</para>
</section>
</section>
</section>
<section id="systemfaq">
<title>System Administration</title>
<para/>
<section id="zebracronfaq">
<title>Errors in Zebra Cron</title>
<para><emphasis role="bold">Question</emphasis>: I am noticing some
errors in the koha-zebradaemon-output.log file. When new records are
added it takes a bit longer to index than we think they should.
Running rebuild zebra is often faster. Zebra ends up indexing and
search works, but I am concerned about the errors. Any ideas?</para>
<para><emphasis role="bold">Answer</emphasis>: Rebuild_zebra.pl -r
deletes all of the files in the Zebra db directories (such as
reci-0.mf) and then recreates them. Thus, permissions will be lost,
and the files will be owned by the user who ran rebuild_zebra.pl. If
one rebuilds the zebra indexes as root, the daemons, which typically
run under the user koha, will not be able to update the indexes. Thus,
it's important then that the zebra rebuilds are put in the cronjob
file of the user koha, and not root. Also important is that other
users, such as root, don't manually execute rebuilds.</para>
<para>If one desires that another user be able to execute
rebuild_zebra.pl, he should be given the permission to execute 'sudo
-u Koha .../rebuild_zebra.pl,' (if you want to do this, you also have
to edit the sudoers file to pass the PERL5LIB variable with the
env_keep option as by default sudo strips away almost all environment
variables). Or, as root user, one can use a simple 'su koha' and then
the rebuild_zebra.pl command.</para>
<para>I've also tried to set the sticky bit on rebuild_zebra.pl, but
for whatever reason it didn't seem to work due to some problem with
the PERL5LIB variable that I wasn't able to figure. That seems to me
the easiest thing to do, if anybody has any idea how to make it work.
If it worked and were the default, I think it would help folks to
avoid a great deal of the problems that come up with zebra.</para>
</section>
<section id="publicztarget">
<title>Making Z39.50 Target Public</title>
<para><emphasis role="bold">Question</emphasis>: Could someone tell me
the exact steps I need to take to configure Zebra to expose my Koha 3
db as a public Z39.50 service?</para>
<para><emphasis role="bold">Answer</emphasis>: Edit the KOHA_CONF file
that your Koha is using. Uncomment the publicserver line like:</para>
<para><!-- <listen id="publicserver"
>tcp:@:9999</listen> --></para>
<para>to be:</para>
<para><listen id="publicserver"
>tcp:@:9999</listen></para>
<para>Then restart zebasrv and connect on the port specified
(9999).</para>
</section>
<section id="authvalfaq">
<title>Shelving Location Authorized Values</title>
<para><emphasis role="bold">Question</emphasis>: When editing an item,
the new shelving location I created is not showing up by default in
the items where I assigned it to.</para>
<para><emphasis role="bold">Answer</emphasis>: This is because you
created the new shelving location with a code value of 0 (zero) Just
FYI the system interprets authorized values of 0 as equaling a null so
when you edit a record in cataloging where the authorized value in a
field was assigned where the code was 0, the value displays as null in
the item editor (or MARC editor) instead of the value the library
meant it to be.</para>
</section>
<section id="whyauthvals">
<title>Why do I need Authorized Values?</title>
<para><emphasis role="bold">Question</emphasis>: Why would I want to
define authorized values for MARC tags?</para>
<para><emphasis role="bold">Answer</emphasis>: Authorized Values
create a 'controlled vocabulary' for your staff. As an example, let us
assume that your Koha installation is used by several libraries, and
you use MARC 21. You might want to restrict the 850a MARC subfield to
the institution codes for just those libraries. In that case, you
could define an authorized values category (perhaps called "INST") and
enter the institution codes as the authorized values for that
category.</para>
<tip>
<para>Koha automatically sets up authorized value categories for
your item types and branch codes, and you can link these authorized
values to MARC subfields when you set up your MARC tag
structure.</para>
</tip>
</section>
<section id="sessionstblfaq">
<title>How do I clean up the sessions table?</title>
<para><emphasis role="bold">Question</emphasis>: Is there a periodic
job that can be run to cull old sessions from the table? We don't want
to backup all the useless session data every night.</para>
<para><emphasis role="bold">Answer</emphasis>: You can run <link
linkend="cleandbcron">cleanup database cron job</link>.</para>
<para>Or just before doing a backup command (mysqldump), you can
truncate session table: </para>
<para><programlisting>mysql -u<kohauser -p<password <koha-db-name -e 'TRUNCATE TABLE sessions'</programlisting></para>
</section>
</section>
<section id="hardwarefaq">
<title>Hardware</title>
<para/>
<section id="barcodefaq">
<title>Barcode Scanners</title>
<para><emphasis role="bold">Question</emphasis>: What barcode scanners
have been known to work with Koha?</para>
<para><emphasis role="bold">Answer</emphasis>: The simple rule of
thumb is, does it act like a keyboard device?, if so, it will work.
(i.e. can you take the scanner, scan a barcode and have it show up in
a text editor, if so, it will work.)</para>
<para>The main points to check are that it connects to your PC
conveniently (can be USB or "keyboard wedge" which means it connects
in line with the keyboard, which is useful with older computers), and
that it scans the barcode type that you are using.</para>
<para>It is a good idea to test some 'used' barcodes if you have any,
to see whether the scanner can read scuffed or slightly wrinkled ones
successfully. Most scanners are capable of reading several barcode
types - there are many, and the specification should list the ones it
can read. You may need to adjust settings slightly, such as prefix and
suffix characters, or whether you want to send an 'enter' character or
not.</para>
<para>One more tip - some can be set 'always on' and may come with a
stand, some have triggers under the handle, some have buttons on top,
some are held like a pen. Think about the staff working with the
hardware before choosing, as a button in the wrong place can be very
awkward to use.</para>
</section>
<section id="printersfaq">
<title>Printers</title>
<para/>
<section id="kohaprinters">
<title>Printers used by Koha libraries</title>
<itemizedlist>
<listitem>
<para>POS-X receipt printer</para>
</listitem>
<listitem>
<para>Star Micronics printer (exact model unknown) with a
generic/plain text driver.</para>
</listitem>
<listitem>
<para>Star SP2000 (Nelsonville)</para>
</listitem>
<listitem>
<para>Star TSP-100 futurePRINT (Geauga)</para>
<itemizedlist>
<listitem>
<para>"I know there have been a lot of questions on receipt
printers so I thought I'd pass on my findings. We have been
testing the Star TSP-100 futurePRINT. I found this print to
be VERY easy to configure for Koha. I was even able to
customize the print job by adding our system logo (a .gif)
to the top of every receipt. Also with a bitmap created in
Paint was able to add a message at the bottom of each
receipt with the contact information, hours and website for
the library that the materials were checked out at."</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Epson TM 88 IIIP thermal receipt printers</para>
</listitem>
<listitem>
<para>Epson TM-T88IV</para>
</listitem>
<listitem>
<para>1x1 labels using a Dymolabelwriter printer</para>
</listitem>
</itemizedlist>
</section>
<section id="braillefaq">
<title>Braille Support</title>
<para><emphasis role="bold">Question</emphasis>: Are there any
braille embosser or printer which has inbuilt braille converter and
it is accessible with UNIX environment?</para>
<para><emphasis role="bold">Answer</emphasis>: You may want to look
into BRLTTY (<ulink
url="http://www.emptech.info/product_details.php?ID=1232";>http://www.emptech.info/product_details.php?ID=1232</ulink>).</para>
</section>
<section id="hardwaresupport">
<title>Additional Support</title>
<itemizedlist>
<listitem>
<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>
</listitem>
</itemizedlist>
</section>
</section>
</section>
</appendix>
<appendix id="extending">
<title>Extending Koha</title>
<section id="amzlookup">
<sectioninfo>
<author>
<firstname>Cab</firstname>
<surname>Vinton</surname>
<affiliation>
<orgname>Sanbornton Public Library</orgname>
</affiliation>
</author>
<pubdate>September 2009</pubdate>
<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>
</sectioninfo>
<title>Amazon lookup script for Koha libraries</title>
<para>We order most of our materials from Amazon, so I've been looking
for a convenient way to tell if a book under consideration is in our
catalog already.</para>
<para>Greasemonkey & a custom user script fit the bill
nicely:</para>
<itemizedlist>
<listitem>
<para><ulink
url="https://addons.mozilla.org/en-US/firefox/addon/748";>https://addons.mozilla.org/en-US/firefox/addon/748</ulink></para>
</listitem>
<listitem>
<para><ulink
url="http://userscripts.org/scripts/show/56847";>http://userscripts.org/scripts/show/56847</ulink></para>
</listitem>
</itemizedlist>
<para>A few caveats:</para>
<itemizedlist>
<listitem>
<para>Like most scripts, this one was designed to work with Firefox;
I haven't explored getting it to work with other browsers.</para>
</listitem>
<listitem>
<para>I'm not a JavaScript programmer -- this was adapted from
others' work. Just a few lines would have to be changed to get the
script to work with your catalog.</para>
</listitem>
<listitem>
<para>It depends on the existence of ISBN for the item in question,
so movies, older books, etc. would not work.</para>
</listitem>
</itemizedlist>
<para>Others have added all sorts of bells & whistles: xISBN lookups
to search for related titles, custom messages based on the status of
items (on order, on hold, etc.), ... just search the UserScripts site
for Amazon + library. For a later date!</para>
</section>
<section id="extendkeywordclouds">
<title>Keyword Clouds</title>
<para>In addition to the traditional tag cloud availabe in Koha, there
is a way to generate clouds for popular subjects within Koha.</para>
<para>The <link linkend="keywordclouds">Author/Subject Cloud cron
job</link> is used to help with this process. This cron job sends its
output to files.</para>
<itemizedlist>
<listitem>
<para>/home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html</para>
</listitem>
<listitem>
<para>/home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html</para>
</listitem>
</itemizedlist>
<para>This means that you can produce clouds for authors, collective
author, all kind of subjects, classifications, etc. And since it works
on zebra indexes, it is quick, even on large DBs. Tags clouds are sent
to files. It's up to library webmaster to deal with those files in order
to include them in <link
linkend="OpacMainUserBlock">OPACMainUserBlock</link>, or include them
into their library CMS.</para>
<para>Some libraries even send the file into a Samba shared folder where
webmaster take them, eventually clean them a little bit before
integrating them into navigation widgets or pages.</para>
</section>
</appendix>
<appendix id="gpl">
<title><acronym>GNU</acronym> General Public License version 3</title>
<para>Version 3, 29 June 2007</para>
<para>Copyright © 2007 Free Software Foundation, Inc. <ulink
url="http://fsf.org/";>http://fsf.org/</ulink></para>
<para>Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.</para>
<bridgehead id="Preamble" renderas="sect1">Preamble</bridgehead>
<para>The <acronym>GNU</acronym> General Public License is a free,
copyleft license for software and other kinds of works.</para>
<para>The licenses for most software and other practical works are
designed to take away your freedom to share and change the works. By
contrast, the <acronym>GNU</acronym> General Public License is intended to
guarantee your freedom to share and change all versions of a
program—to make sure it remains free software for all its users. We,
the Free Software Foundation, use the <acronym>GNU</acronym> General
Public License for most of our software; it applies also to any other work
released this way by its authors. You can apply it to your programs,
too.</para>
<para>When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you have
the freedom to distribute copies of free software (and charge for them if
you wish), that you receive source code or can get it if you want it, that
you can change the software or use pieces of it in new free programs, and
that you know you can do these things.</para>
<para>To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.</para>
<para>For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same freedoms
that you received. You must make sure that they, too, receive or can get
the source code. And you must show them these terms so they know their
rights.</para>
<para>Developers that use the <acronym>GNU</acronym>
<acronym>GPL</acronym> protect your rights with two steps: (1) assert
copyright on the software, and (2) offer you this License giving you legal
permission to copy, distribute and/or modify it.</para>
<para>For the developers' and authors' protection, the
<acronym>GPL</acronym> clearly explains that there is no warranty for this
free software. For both users' and authors' sake, the
<acronym>GPL</acronym> requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.</para>
<para>Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of protecting
users' freedom to change the software. The systematic pattern of such
abuse occurs in the area of products for individuals to use, which is
precisely where it is most unacceptable. Therefore, we have designed this
version of the <acronym>GPL</acronym> to prohibit the practice for those
products. If such problems arise substantially in other domains, we stand
ready to extend this provision to those domains in future versions of the
<acronym>GPL</acronym>, as needed to protect the freedom of users.</para>
<para>Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could make
it effectively proprietary. To prevent this, the <acronym>GPL</acronym>
assures that patents cannot be used to render the program non-free.</para>
<para>The precise terms and conditions for copying, distribution and
modification follow.</para>
<bridgehead>TERMS AND CONDITIONS</bridgehead>
<bridgehead id="Definitions" renderas="sect1">0. Definitions.</bridgehead>
<para>“This License" refers to version 3 of the
<acronym>GNU</acronym> General Public License.</para>
<para>“Copyright" also means copyright-like laws that apply to other
kinds of works, such as semiconductor masks.</para>
<para>“The Program" refers to any copyrightable work licensed under
this License. Each licensee is addressed as “you". “Licensees"
and “recipients" may be individuals or organizations.</para>
<para>To “modify" a work means to copy from or adapt all or part of
the work in a fashion requiring copyright permission, other than the
making of an exact copy. The resulting work is called a “modified
version" of the earlier work or a work “based on" the earlier
work.</para>
<para>A “covered work" means either the unmodified Program or a work
based on the Program.</para>
<para>To “propagate" a work means to do anything with it that,
without permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.</para>
<para>To “convey" a work means any kind of propagation that enables
other parties to make or receive copies. Mere interaction with a user
through a computer network, with no transfer of a copy, is not
conveying.</para>
<para>An interactive user interface displays “Appropriate Legal
Notices" to the extent that it includes a convenient and prominently
visible feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the work
under this License, and how to view a copy of this License. If the
interface presents a list of user commands or options, such as a menu, a
prominent item in the list meets this criterion.</para>
<bridgehead id="SourceCode" renderas="sect1">1. Source Code.</bridgehead>
<para>The “source code" for a work means the preferred form of the
work for making modifications to it. “Object code" means any
non-source form of a work.</para>
<para>A “Standard Interface" means an interface that either is an
official standard defined by a recognized standards body, or, in the case
of interfaces specified for a particular programming language, one that is
widely used among developers working in that language.</para>
<para>The “System Libraries" of an executable work include anything,
other than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that Major
Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
“Major Component", in this context, means a major essential
component (kernel, window system, and so on) of the specific operating
system (if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.</para>
<para>The “Corresponding Source" for a work in object code form
means all the source code needed to generate, install, and (for an
executable work) run the object code and to modify the work, including
scripts to control those activities. However, it does not include the
work's System Libraries, or general-purpose tools or generally available
free programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source includes
interface definition files associated with source files for the work, and
the source code for shared libraries and dynamically linked subprograms
that the work is specifically designed to require, such as by intimate
data communication or control flow between those subprograms and other
parts of the work.</para>
<para>The Corresponding Source need not include anything that users can
regenerate automatically from other parts of the Corresponding
Source.</para>
<para>The Corresponding Source for a work in source code form is that same
work.</para>
<bridgehead id="BasicPermissions" renderas="sect1">2. Basic
Permissions.</bridgehead>
<para>All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your rights
of fair use or other equivalent, as provided by copyright law.</para>
<para>You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains in
force. You may convey covered works to others for the sole purpose of
having them make modifications exclusively for you, or provide you with
facilities for running those works, provided that you comply with the
terms of this License in conveying all material for which you do not
control copyright. Those thus making or running the covered works for you
must do so exclusively on your behalf, under your direction and control,
on terms that prohibit them from making any copies of your copyrighted
material outside their relationship with you.</para>
<para>Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10 makes
it unnecessary.</para>
<bridgehead id="Protecting" renderas="sect1">3. Protecting Users' Legal
Rights From Anti-Circumvention Law.</bridgehead>
<para>No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article 11
of the WIPO copyright treaty adopted on 20 December 1996, or similar laws
prohibiting or restricting circumvention of such measures.</para>
<para>When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to the
covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.</para>
<bridgehead id="ConveyingVerbatim" renderas="sect1">4. Conveying Verbatim
Copies.</bridgehead>
<para>You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice; keep
intact all notices stating that this License and any non-permissive terms
added in accord with section 7 apply to the code; keep intact all notices
of the absence of any warranty; and give all recipients a copy of this
License along with the Program.</para>
<para>You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.</para>
<bridgehead id="ConveyingModified" renderas="sect1">5. Conveying Modified
Source Versions.</bridgehead>
<para>You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the terms of
section 4, provided that you also meet all of these conditions:</para>
<orderedlist numeration="loweralpha">
<listitem>
<para>The work must carry prominent notices stating that you modified
it, and giving a relevant date.</para>
</listitem>
<listitem>
<para>The work must carry prominent notices stating that it is
released under this License and any conditions added under section 7.
This requirement modifies the requirement in section 4 to “keep
intact all notices".</para>
</listitem>
<listitem>
<para>You must license the entire work, as a whole, under this License
to anyone who comes into possession of a copy. This License will
therefore apply, along with any applicable section 7 additional terms,
to the whole of the work, and all its parts, regardless of how they
are packaged. This License gives no permission to license the work in
any other way, but it does not invalidate such permission if you have
separately received it.</para>
</listitem>
<listitem>
<para>If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your work
need not make them do so.</para>
</listitem>
</orderedlist>
<para>A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work, and
which are not combined with it such as to form a larger program, in or on
a volume of a storage or distribution medium, is called an
“aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users beyond
what the individual works permit. Inclusion of a covered work in an
aggregate does not cause this License to apply to the other parts of the
aggregate.</para>
<bridgehead id="ConveyingNonSource" renderas="sect1">6. Conveying
Non-Source Forms.</bridgehead>
<para>You may convey a covered work in object code form under the terms of
sections 4 and 5, provided that you also convey the machine-readable
Corresponding Source under the terms of this License, in one of these
ways:</para>
<orderedlist numeration="loweralpha">
<listitem>
<para>Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium customarily
used for software interchange.</para>
</listitem>
<listitem>
<para>Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a written
offer, valid for at least three years and valid for as long as you
offer spare parts or customer support for that product model, to give
anyone who possesses the object code either (1) a copy of the
Corresponding Source for all the software in the product that is
covered by this License, on a durable physical medium customarily used
for software interchange, for a price no more than your reasonable
cost of physically performing this conveying of source, or (2) access
to copy the Corresponding Source from a network server at no
charge.</para>
</listitem>
<listitem>
<para>Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This alternative is
allowed only occasionally and noncommercially, and only if you
received the object code with such an offer, in accord with subsection
6b.</para>
</listitem>
<listitem>
<para>Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to copy
the object code is a network server, the Corresponding Source may be
on a different server (operated by you or a third party) that supports
equivalent copying facilities, provided you maintain clear directions
next to the object code saying where to find the Corresponding Source.
Regardless of what server hosts the Corresponding Source, you remain
obligated to ensure that it is available for as long as needed to
satisfy these requirements.</para>
</listitem>
<listitem>
<para>Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding Source
of the work are being offered to the general public at no charge under
subsection 6d.</para>
</listitem>
</orderedlist>
<para>A separable portion of the object code, whose source code is
excluded from the Corresponding Source as a System Library, need not be
included in conveying the object code work.</para>
<para>A “User Product" is either (1) a “consumer product",
which means any tangible personal property which is normally used for
personal, family, or household purposes, or (2) anything designed or sold
for incorporation into a dwelling. In determining whether a product is a
consumer product, doubtful cases shall be resolved in favor of coverage.
For a particular product received by a particular user, “normally
used" refers to a typical or common use of that class of product,
regardless of the status of the particular user or of the way in which the
particular user actually uses, or expects or is expected to use, the
product. A product is a consumer product regardless of whether the product
has substantial commercial, industrial or non-consumer uses, unless such
uses represent the only significant mode of use of the product.</para>
<para>“Installation Information" for a User Product means any
methods, procedures, authorization keys, or other information required to
install and execute modified versions of a covered work in that User
Product from a modified version of its Corresponding Source. The
information must suffice to ensure that the continued functioning of the
modified object code is in no case prevented or interfered with solely
because modification has been made.</para>
<para>If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as part
of a transaction in which the right of possession and use of the User
Product is transferred to the recipient in perpetuity or for a fixed term
(regardless of how the transaction is characterized), the Corresponding
Source conveyed under this section must be accompanied by the Installation
Information. But this requirement does not apply if neither you nor any
third party retains the ability to install modified object code on the
User Product (for example, the work has been installed in
<acronym>ROM</acronym>).</para>
<para>The requirement to provide Installation Information does not include
a requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.</para>
<para>Corresponding Source conveyed, and Installation Information
provided, in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in source
code form), and must require no special password or key for unpacking,
reading or copying.</para>
<bridgehead id="AdditionalTerms" renderas="sect1">7. Additional
Terms.</bridgehead>
<para>“Additional permissions" are terms that supplement the terms
of this License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall be
treated as though they were included in this License, to the extent that
they are valid under applicable law. If additional permissions apply only
to part of the Program, that part may be used separately under those
permissions, but the entire Program remains governed by this License
without regard to the additional permissions.</para>
<para>When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of it.
(Additional permissions may be written to require their own removal in
certain cases when you modify the work.) You may place additional
permissions on material, added by you to a covered work, for which you
have or can give appropriate copyright permission.</para>
<para>Notwithstanding any other provision of this License, for material
you add to a covered work, you may (if authorized by the copyright holders
of that material) supplement the terms of this License with terms:</para>
<orderedlist numeration="loweralpha">
<listitem>
<para>Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or</para>
</listitem>
<listitem>
<para>Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or</para>
</listitem>
<listitem>
<para>Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or</para>
</listitem>
<listitem>
<para>Limiting the use for publicity purposes of names of licensors or
authors of the material; or</para>
</listitem>
<listitem>
<para>Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or</para>
</listitem>
<listitem>
<para>Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.</para>
</listitem>
</orderedlist>
<para>All other non-permissive additional terms are considered
“further restrictions" within the meaning of section 10. If the
Program as you received it, or any part of it, contains a notice stating
that it is governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains a
further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms of
that license document, provided that the further restriction does not
survive such relicensing or conveying.</para>
<para>If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the additional
terms that apply to those files, or a notice indicating where to find the
applicable terms.</para>
<para>Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions; the above
requirements apply either way.</para>
<bridgehead id="Termination" renderas="sect1">8. Termination.</bridgehead>
<para>You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or modify
it is void, and will automatically terminate your rights under this
License (including any patent licenses granted under the third paragraph
of section 11).</para>
<para>However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means prior
to 60 days after the cessation.</para>
<para>Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after your
receipt of the notice.</para>
<para>Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under this
License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.</para>
<bridgehead id="AcceptanceNotRequired" renderas="sect1">9. Acceptance Not
Required for Having Copies.</bridgehead>
<para>You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission to
receive a copy likewise does not require acceptance. However, nothing
other than this License grants you permission to propagate or modify any
covered work. These actions infringe copyright if you do not accept this
License. Therefore, by modifying or propagating a covered work, you
indicate your acceptance of this License to do so.</para>
<bridgehead id="AutomaticDownstream" renderas="sect1">10. Automatic
Licensing of Downstream Recipients.</bridgehead>
<para>Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible for
enforcing compliance by third parties with this License.</para>
<para>An “entity transaction" is a transaction transferring control
of an organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered work
results from an entity transaction, each party to that transaction who
receives a copy of the work also receives whatever licenses to the work
the party's predecessor in interest had or could give under the previous
paragraph, plus a right to possession of the Corresponding Source of the
work from the predecessor in interest, if the predecessor has it or can
get it with reasonable efforts.</para>
<para>You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may not
impose a license fee, royalty, or other charge for exercise of rights
granted under this License, and you may not initiate litigation (including
a cross-claim or counterclaim in a lawsuit) alleging that any patent claim
is infringed by making, using, selling, offering for sale, or importing
the Program or any portion of it.</para>
<bridgehead id="Patents" renderas="sect1">11. Patents.</bridgehead>
<para>A “contributor" is a copyright holder who authorizes use under
this License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's “contributor
version".</para>
<para>A contributor's “essential patent claims" are all patent
claims owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted by
this License, of making, using, or selling its contributor version, but do
not include claims that would be infringed only as a consequence of
further modification of the contributor version. For purposes of this
definition, “control" includes the right to grant patent sublicenses
in a manner consistent with the requirements of this License.</para>
<para>Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to make,
use, sell, offer for sale, import and otherwise run, modify and propagate
the contents of its contributor version.</para>
<para>In the following three paragraphs, a “patent license" is any
express agreement or commitment, however denominated, not to enforce a
patent (such as an express permission to practice a patent or covenant not
to sue for patent infringement). To “grant" such a patent license to
a party means to make such an agreement or commitment not to enforce a
patent against the party.</para>
<para>If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone to
copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means, then
you must either (1) cause the Corresponding Source to be so available, or
(2) arrange to deprive yourself of the benefit of the patent license for
this particular work, or (3) arrange, in a manner consistent with the
requirements of this License, to extend the patent license to downstream
recipients. “Knowingly relying" means you have actual knowledge
that, but for the patent license, your conveying the covered work in a
country, or your recipient's use of the covered work in a country, would
infringe one or more identifiable patents in that country that you have
reason to believe are valid.</para>
<para>If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties receiving
the covered work authorizing them to use, propagate, modify or convey a
specific copy of the covered work, then the patent license you grant is
automatically extended to all recipients of the covered work and works
based on it.</para>
<para>A patent license is “discriminatory" if it does not include
within the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered work
if you are a party to an arrangement with a third party that is in the
business of distributing software, under which you make payment to the
third party based on the extent of your activity of conveying the work,
and under which the third party grants, to any of the parties who would
receive the covered work from you, a discriminatory patent license (a) in
connection with copies of the covered work conveyed by you (or copies made
from those copies), or (b) primarily for and in connection with specific
products or compilations that contain the covered work, unless you entered
into that arrangement, or that patent license was granted, prior to 28
March 2007.</para>
<para>Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may otherwise
be available to you under applicable patent law.</para>
<bridgehead id="NoSurrender" renderas="sect1">12. No Surrender of Others'
Freedom.</bridgehead>
<para>If conditions are imposed on you (whether by court order, agreement
or otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.</para>
<bridgehead id="UsedWithAGPL" renderas="sect1">13. Use with the
<acronym>GNU</acronym> Affero General Public License.</bridgehead>
<para>Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed under
version 3 of the <acronym>GNU</acronym> Affero General Public License into
a single combined work, and to convey the resulting work. The terms of
this License will continue to apply to the part which is the covered work,
but the special requirements of the <acronym>GNU</acronym> Affero General
Public License, section 13, concerning interaction through a network will
apply to the combination as such.</para>
<bridgehead id="RevisedVersions" renderas="sect1">14. Revised Versions of
this License.</bridgehead>
<para>The Free Software Foundation may publish revised and/or new versions
of the <acronym>GNU</acronym> General Public License from time to time.
Such new versions will be similar in spirit to the present version, but
may differ in detail to address new problems or concerns.</para>
<para>Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the
<acronym>GNU</acronym> General Public License “or any later version"
applies to it, you have the option of following the terms and conditions
either of that numbered version or of any later version published by the
Free Software Foundation. If the Program does not specify a version number
of the <acronym>GNU</acronym> General Public License, you may choose any
version ever published by the Free Software Foundation.</para>
<para>If the Program specifies that a proxy can decide which future
versions of the <acronym>GNU</acronym> General Public License can be used,
that proxy's public statement of acceptance of a version permanently
authorizes you to choose that version for the Program.</para>
<para>Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any author
or copyright holder as a result of your choosing to follow a later
version.</para>
<bridgehead id="WarrantyDisclaimer" renderas="sect1">15. Disclaimer of
Warranty.</bridgehead>
<para>THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS" WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF
THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</para>
<bridgehead id="LiabilityLimitation" renderas="sect1">16. Limitation of
Liability.</bridgehead>
<para>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT
LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES
SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE
WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</para>
<bridgehead id="InterpretationSecs1516" renderas="sect1">17.
Interpretation of Sections 15 and 16.</bridgehead>
<para>If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates an
absolute waiver of all civil liability in connection with the Program,
unless a warranty or assumption of liability accompanies a copy of the
Program in return for a fee.</para>
<bridgehead>END OF TERMS AND CONDITIONS</bridgehead>
<bridgehead id="HowToApply" renderas="sect1">How to Apply These Terms to
Your New Programs</bridgehead>
<para>If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these
terms.</para>
<para>To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively state
the exclusion of warranty; and each file should have at least the
“copyright" line and a pointer to where the full notice is
found.</para>
<screen>
<replaceable>one line to give the program's name and a brief idea of what it does.</replaceable>
Copyright (C) <replaceable>year</replaceable> <replaceable>name of author</replaceable>
This program is free software: you can redistribute it and/or modify
it under the terms of the <acronym>GNU</acronym> General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
<acronym>GNU</acronym> General Public License for more details.
You should have received a copy of the <acronym>GNU</acronym> General Public License
along with this program. If not, see <ulink
url="http://www.gnu.org/licenses/";>http://www.gnu.org/licenses/</ulink>.
</screen>
<para>Also add information on how to contact you by electronic and paper
mail.</para>
<para>If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:</para>
<screen>
<replaceable>program</replaceable> Copyright (C) <replaceable>year</replaceable> <replaceable>name of author</replaceable>
This program comes with ABSOLUTELY NO WARRANTY; for details type ‘<literal>show w</literal>'.
This is free software, and you are welcome to redistribute it
under certain conditions; type ‘<literal>show c</literal>' for details.
</screen>
<para>The hypothetical commands ‘<literal>show w</literal>' and
‘<literal>show c</literal>' should show the appropriate parts of the
General Public License. Of course, your program's commands might be
different; for a GUI interface, you would use an “about box".</para>
<para>You should also get your employer (if you work as a programmer) or
school, if any, to sign a “copyright disclaimer" for the program, if
necessary. For more information on this, and how to apply and follow the
<acronym>GNU</acronym> <acronym>GPL</acronym>, see <ulink
url="http://www.gnu.org/licenses/";>http://www.gnu.org/licenses/</ulink>.</para>
<para>The <acronym>GNU</acronym> General Public License does not permit
incorporating your program into proprietary programs. If your program is a
subroutine library, you may consider it more useful to permit linking
proprietary applications with the library. If this is what you want to do,
use the <acronym>GNU</acronym> Lesser General Public License instead of
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>
</appendix>
</book>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
![http://www.myacpl.org/sites/all/themes/npl/logo.png"](http://www.myacpl.org/sites/all/themes/npl/logo.png"){kind=link}