+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>
-<!-- This document is maintained with oXygen. -->
-<!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 16.11 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>2016</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">Published: 2016</pubdate>
- </bookinfo>
- <chapter id="introchapter">
- <title>Introduction</title>
- <section id="introbasics">
- <title><link linkend="introbasics">Koha Basics</link></title>
- <para>Koha is the first free and open source software library automation package (ILS).
- Development is sponsored by libraries of varying types and sizes, volunteers, and support
- companies from around the world.</para>
- <para>Learn more about Koha by visiting the official Koha website: <ulink url="http://koha-community.org">http://koha-community.org</ulink></para>
- </section>
- <section id="introrecommend">
- <title><link linkend="introrecommend">Koha Recommendations</link></title>
- <para>Full system recommendations can be found on the official Koha wiki along with the
- developer documentation: <ulink url="http://wiki.koha-community.org">
- http://wiki.koha-community.org</ulink></para>
- <para>When working in the Koha staff client it is strongly recommended that you use the
- Firefox browser. Koha's staff client is not supported in Internet Explorer and has not yet
- been fully optimized for Google Chrome.</para>
- </section>
- <section id="usingmanual">
- <title><link linkend="usingmanual">Using this Manual</link></title>
- <para>This manual is always changing and suggestions for edits can be sent to the
- Documentation Manager via the <ulink url="https://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-docs">DOCS mailing
- list</ulink>. The manual is organized by Koha module. At the start of most sections (and
- throughout) you will find 'Get there' tips. These lines tell you how to get to the section
- in Koha. </para>
- <para>For example: <emphasis>Get there:</emphasis> More > Administration > Global System
- Preferences</para>
- <para>
- <screenshot>
- <screeninfo>Get there: More > Administration > Global System Preferences</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/intro/getthere.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </para>
- <para>The instruction tells you where to find the necessary menu option at the top of the Koha
- staff client.</para>
- <para>Links will be found throughout the manual to other sections in the manual and images
- will depict what should be seen on the screen. </para>
- <para>The manual can be searched using the custom Google search on the <ulink url="http://koha-community.org/documentation/">Koha Documentation</ulink> page.</para>
- </section>
- <section id="contributing">
- <title><link linkend="contributing">Contributing to the Manual</link></title>
- <para>This manual is an ever-changing document and edits to the manual are welcome at any
- time. </para>
- <para>The <ulink url="http://manual.koha-community.org/">Koha Manual</ulink> is managed by the
- Documentation Manager, but that doesn't mean we can't all participate in making the best
- manual possible. </para>
- <para>The manual is stored in git at: <ulink url="http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary">http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary</ulink></para>
- <para>To edit the manual we recommend <ulink url="http://www.oxygenxml.com">oXygen</ulink> or
- other XML/DocBook editor. We ask that every chapter and section have an ID tag associated
- with it to enable permanent linking and searching. </para>
- <para>Patches to the manual should be emailed to the <ulink url="https://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-docs">DOCS mailing
- list</ulink> and will be reviewed by the Documentation Manager before inclusion. </para>
- </section>
- </chapter>
-
- <chapter id="administration">
- <title>Administration</title>
-
- <section id="globalsysprefs">
- <title><link linkend="globalsysprefs">Global System Preferences</link></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.<important>
- <para>For libraries systems with unique URLs for each site the system preference can be
- overridden by editing your koha-http.conf file this has to be done by a system
- administrator or someone with access to your system files. For example if all libraries
- but one want to have search terms highlighted in results you set the
- OpacHighlightedWords preference to 'Highlight' then edit the koha-http.conf for the
- library that wants this turned off by adding 'SetEnv
- OVERRIDE_SYSPREF_OpacHighlightedWords "0"'. After restarting the web server that one
- library will no longer see highlighted terms. Consult with your system administrator
- for more information.</para>
- </important></para>
-
- <section id="acqprefs">
- <title><link linkend="acqprefs">Acquisitions</link></title>
-
- <para><emphasis>Get there:</emphasis> More > Administration >
- Global System Preferences > Acquisitions</para>
-
- <section id="acqprefspolicy">
- <title><link linkend="acqprefspolicy">Policy</link></title>
-
- <section id="AcqCreateItem">
- <title><link linkend="AcqCreateItem">AcqCreateItem</link></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 receiving 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="AcqEnableFiles">
- <title><link linkend="AcqEnableFiles">AcqEnableFiles</link></title>
- <para>Default: Don't</para>
- <para>Asks: ___ enable the ability to upload and attach arbitrary files to invoices. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Do</para>
- </listitem>
- <listitem>
- <para>Don't</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference controls whether or not you allow the uploading of invoice
- files via the acquisitions module.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="AcqItemSetSubfieldsWhenReceiptIsCancelled">
- <title><link linkend="AcqItemSetSubfieldsWhenReceiptIsCancelled">AcqItemSetSubfieldsWhenReceiptIsCancelled</link></title>
- <para>Asks: Upon cancelling a receipt, update the item's subfields if they were created
- when placing an order (e.g. o=5|a="bar foo""). ___</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference is used in conjunction with the <link linkend="AcqItemSetSubfieldsWhenReceived">AcqItemSetSubfieldsWhenReceived</link> preference. If you have the system set
- to enter default values when you receive you will want to have those values
- revert back if reeipt is cancelled. This preference allows you to do
- that.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="AcqItemSetSubfieldsWhenReceived">
- <title><link linkend="AcqItemSetSubfieldsWhenReceived">AcqItemSetSubfieldsWhenReceived</link></title>
- <para>Asks: Upon receiving items, update their subfields if they were created when
- placing an order (e.g. o=5|a="foo bar"). ___</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference allows you to set default values for items that you receive
- via acquisitions. Enter the data as subfield=value and split your values with a
- bar ( | ). For example you can remove the Ordered status on the item
- automatically when you receive it just by entering 7=0 in this preference. That
- will set the Not for Loan status (subfield 7) to 0 which is available.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="AcqViewBaskets">
- <title><link linkend="AcqViewBaskets">AcqViewBaskets</link></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="AcqWarnOnDuplicateInvoice">
- <title><link linkend="AcqWarnOnDuplicateInvoice">AcqWarnOnDuplicateInvoice</link></title>
- <para>Default: Do not warn</para>
- <para>Asks: ___ when the librarian tries to create an invoice with a duplicate
- number.</para>
- <para>Values: <itemizedlist>
- <listitem>
- <para>Do not warn</para>
- </listitem>
- <listitem>
- <para>Warn</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="BasketConfirmations">
- <title><link linkend="BasketConfirmations">BasketConfirmations</link></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="ClaimsBccCopy">
- <title><link linkend="ClaimsBccCopy">ClaimsBccCopy</link></title>
- <para>Default: Don't send</para>
- <para>Asks: ___ blind copy (BCC) to logged in user when sending serial or acquisitions
- claims notices. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't send</para>
- </listitem>
- <listitem>
- <para>Send</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>When filing a claim in the <link linkend="serialclaims">serials</link> or
- <link linkend="acqclaims">acquisitions</link> module this preference will
- allow for the sending of a copy of the email to the librarian.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="CurrencyFormat">
- <title><link linkend="CurrencyFormat">CurrencyFormat</link></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><link linkend="gist">gist</link></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><note>
- <para>Enter this value as a number (.06) versus a percent
- (6%).</para>
- </note></para>
- </section>
- <section id="MarcFieldsToOrder">
- <title><link linkend="MarcFieldsToOrder">MarcFieldsToOrder</link></title>
- <para>Asks: Set the mapping values for a new order line created from a MARC record in a
- staged file. </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference includes MARC fields to check for order information to use
- when <link linkend="orderfromstagedfile">ordering from a staged file</link> in
- acquisitions. You can use the following fields: price, quantity, budget_code,
- discount, sort1, sort2.</para>
- <para>For
- example:<programlisting>price: 947$a|947$c
-quantity: 969$h
-budget_code: 922$a</programlisting></para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="UniqueItemFields">
- <title><link linkend="UniqueItemFields">UniqueItemFields</link></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><link linkend="acqprefsprinting">Printing</link></title>
-
- <section id="OrderPdfFormat">
- <title><link linkend="OrderPdfFormat">OrderPdfFormat</link></title>
-
- <para>Default: pdfformat::layout2pages</para>
-
- <para>Asks: Use ___ when printing basket groups.</para>
- </section>
- </section>
- </section>
-
- <section id="adminprefs">
- <title><link linkend="adminprefs">Administration</link></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><link linkend="casauthentication">CAS Authentication</link></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><link linkend="AllowPKIAuth">AllowPKIAuth</link></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 email address</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="casAuthentication">
- <title><link linkend="casAuthentication">casAuthentication</link></title>
-
- <para>Default: Don't use</para>
-
- <para>Asks: ___ CAS for login authentication.</para>
- </section>
-
- <section id="casLogout">
- <title><link linkend="casLogout">casLogout</link></title>
-
- <para>Default: Don't logout</para>
-
- <para>Asks: ___ of CAS when logging out of Koha.</para>
- </section>
-
- <section id="casServerUrl">
- <title><link linkend="casServerUrl">casServerUrl</link></title>
-
- <para>Asks: The CAS Authentication Server can be found at
- ___</para>
- </section>
- </section>
- <section id="googleopenid">
- <title><link linkend="googleopenid">Google OpenID Connect</link></title>
- <para>Visit the <ulink url="https://console.developers.google.com/">Google Developers
- Console</ulink> to obtain OAuth 2.0 credentials such as a client ID and client secret
- that are known to both Google and your application.<screenshot>
- <screeninfo>Developers Console</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/Google/1project.png"/>
- </imageobject>
- </mediaobject>
- </screenshot><itemizedlist>
- <listitem>
- <para>Create a project, and give it some details to help you identify it
- later</para>
- <screenshot>
- <screeninfo>New Project</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/Google/2newproject.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Next search for the Google Identity and Access Management API</para>
- <screenshot>
- <screeninfo>API Search</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/Google/3identity.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Enable the Google Identity and Access Management API</para>
- <screenshot>
- <screeninfo>Enable Google Identity</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/Google/4enable.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Go to 'Credentials' and set the OAuth cosent screen values</para>
- <screenshot>
- <screeninfo>OAuth Consent Screen</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/Google/5consent.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Next choose to 'Create credentials' from the 'Credentials' page</para>
- <screenshot>
- <screeninfo>Create credentials</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/Google/6credtype.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Choose 'Web application' from the 'Application type' menu and fill in the form
- presented</para>
- <screenshot>
- <screeninfo>Create Client ID</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/Google/7creds.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <listitem>
- <para>Set 'Authorized JavaScript origins' to your OPACBaseURL </para>
- </listitem>
- <listitem>
- <para>Change the 'Authorized Redirect URIs' to
- http://YOUROPAC/cgi-bin/koha/svc/auth/googleopenidconnect</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>You will be presented with your values for your client ID and your client
- secret after saving </para>
- <screenshot>
- <screeninfo>OAuth Client ID and Secret</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/Google/8oauth.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist></para>
- <section id="GoogleOAuth2ClientID">
- <title><link linkend="GoogleOAuth2ClientID">GoogleOAuth2ClientID</link></title>
- <para>Asks: Google OAuth2 Client ID ___</para>
- </section>
- <section id="GoogleOAuth2ClientSecret">
- <title><link linkend="GoogleOAuth2ClientSecret">GoogleOAuth2ClientSecret</link></title>
- <para>Asks: Google OAuth2 Client Secret ___</para>
- </section>
- <section id="GoogleOpenIDConnect">
- <title><link linkend="GoogleOpenIDConnect">GoogleOpenIDConnect</link></title>
- <para>Default: Don't use</para>
- <para>Asks ___ Google OpenID Connect login. <important>
- <para>You will need to select OAuth2 when creating an app in the google cloud
- console, and set the web origin to your_opac_url and the redirect url to
- your_opac_url/cgi-bin/koha/svc/auth/googleopenidconnect . </para>
- <screenshot>
- <screeninfo>Create Client ID</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/Google/7creds.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </important></para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't use</para>
- </listitem>
- <listitem>
- <para>Use</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="GoogleOpenIDConnectDomain">
- <title><link linkend="GoogleOpenIDConnectDomain">GoogleOpenIDConnectDomain</link></title>
- <para>Asks: Google OpenID Connect Restrict to domain (or subdomain of this domain) ___. <note>
- <para>Leave blank for all google domains </para>
- </note></para>
- </section>
- </section>
-
- <section id="adminprefsinterface">
- <title><link linkend="adminprefsinterface">Interface options</link></title>
-
- <para>These preference are related to your Koha interface</para>
-
- <section id="DebugLevel">
- <title><link linkend="DebugLevel">DebugLevel</link></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="DefaultToLoggedInLibraryCircRules">
- <title><link linkend="DefaultToLoggedInLibraryCircRules">DefaultToLoggedInLibraryCircRules</link></title>
- <para>Default: all libraries</para>
- <para>Asks: When editing circulation rules show ___ the rules by default. </para>
- <para>Values: <itemizedlist>
- <listitem>
- <para>all libraries</para>
- </listitem>
- <listitem>
- <para>logged in library's</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference controls the default value in the branch pull down found at
- the top of the <link linkend="circfinerules">circulation and fine
- rules</link>.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="DefaultToLoggedInLibraryNoticesSlips">
- <title><link linkend="DefaultToLoggedInLibraryNoticesSlips">DefaultToLoggedInLibraryNoticesSlips</link></title>
- <para>Default: all libraries</para>
- <para>Asks: When editing notices and slips show the ___ notices and slips by default. </para>
- <para>Values: <itemizedlist>
- <listitem>
- <para>all libraries</para>
- </listitem>
- <listitem>
- <para>logged in library's</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference controls the default value in the branch pull down found at
- the top of the <link linkend="notices">notices and slips</link> tool.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="DefaultToLoggedInLibraryOverdueTriggers">
- <title><link linkend="DefaultToLoggedInLibraryOverdueTriggers">DefaultToLoggedInLibraryOverdueTriggers</link></title>
- <para>Default: all libraries</para>
- <para>Asks: When editing overdue notice/status triggers show the ___ rules by default. </para>
- <para>Values: <itemizedlist>
- <listitem>
- <para>all libraries</para>
- </listitem>
- <listitem>
- <para>logged in library's</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference controls the default value in the branch pull down found at
- the top of the <link linkend="noticetriggers">overdue notices and
- triggers</link>.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="delimiter">
- <title><link linkend="delimiter">delimiter</link></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><link linkend="KohaAdminEmailAddress">KohaAdminEmailAddress</link></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><link linkend="noItemTypeImages">noItemTypeImages</link></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="ReplytoDefault">
- <title><link linkend="ReplytoDefault">ReplytoDefault</link></title>
- <para>Asks: Use ___ as the email address that will be set as the replyto in emails </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>By default replies to notice emails will go to the <link linkend="libsgroups">library email address</link>, if you would like to
- specify a default email address for all replies to notices you can do that
- here.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="ReturnpathDefault">
- <title><link linkend="ReturnpathDefault">ReturnpathDefault</link></title>
- <para>Asks: Use ___ as the email address set as the return path, if you leave this empty
- the KohaAdminEmailAddress will be used. </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>The return path is the email address that bounces will be delivered to. By
- default bounced notices will go to the <link linkend="libsgroups">library email
- address</link>, if you would like to specify a default email address for
- bounces to go to then fill in this preference.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="virtualshelves">
- <title><link linkend="virtualshelves">virtualshelves</link></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><link linkend="adminprefslogin">Login options</link></title>
-
- <para>These preferences are related to logging into your Koha
- system</para>
-
- <section id="AutoLocation">
- <title><link linkend="AutoLocation">AutoLocation</link></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="IndependentBranches">
- <title><link linkend="IndependentBranches">IndependentBranches</link></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="SessionRestrictionByIP">
- <title><link linkend="SessionRestrictionByIP">SessionRestrictionByIP</link></title>
- <para>Default: Enable</para>
- <para>Asks: ___ check for change in remote IP address for session security. Disable only
- when remote IP address changes frequently. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Disable</para>
- </listitem>
- <listitem>
- <para>Enable</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>When this preference is set to 'Enable' Koha will log you out of the staff
- client if your IP address changes as a security measure. For some systems the
- IP address changes frequently so you'll want to set this preference to 'Disable'
- to prevent Koha from logging you out of the staff client every time that
- happens.</para>
- </listitem>
- </itemizedlist></para>
- <important>
- <para>This is meant to help those whose IP address changes several times during the
- day, setting this preference to 'Disable' is not recommended otherwise because it is
- removing important security features from your staff client.</para>
- </important>
- </section>
-
- <section id="SessionStorage">
- <title><link linkend="SessionStorage">SessionStorage</link></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><link linkend="timeout">timeout</link></title>
-
- <para>Default: 12000000</para>
-
- <para>Asks: Automatically log out users after ___ seconds 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 id="mozillapersona">
- <title><link linkend="mozillapersona">Mozilla Persona</link></title>
- <section id="persona">
- <title><link linkend="persona">Persona</link></title>
- <para>Default: Don't allow</para>
- <para>Asks: ___ Mozilla persona for login.</para>
- <para>Values:</para>
- <itemizedlist>
- <listitem>
- <para>Allow</para>
- <screenshot>
- <screeninfo>Persona login on OPAC</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/persona.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Don't allow</para>
- </listitem>
- </itemizedlist>
- <para>Description:<itemizedlist>
- <listitem>
- <para>Mozilla Persona is an OpenID-like service that lets you log in to multiple
- websites with your Mozilla credentials. If you allow Persona log in for Koha
- then your patrons can log in to the OPAC using their Mozilla Persona. Learn
- more about Persona on the <ulink url="http://www.mozilla.org/en-US/persona/">official Mozilla site</ulink>.<important>
- <para>For Persona log in to work you will need you <link linkend="OPACBaseURL">OPACBaseURL</link> preference to be set correctly.</para>
- </important></para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- <section id="heaprefs">
- <title><link linkend="heaprefs">Share anonymous usage statistics</link></title>
- <para>As an open source project Koha is used all over the world. These preference will
- help us keep more accurate statistics on where Koha is being used. If you choose to
- share your information, it will be published on the <ulink url="http://hea.koha-community.org">Hea Koha community website</ulink>. You will need
- to enable the <link linkend="usagecron">matching cron job</link> to send this
- information at regular intervals to the community.</para>
- <section id="UsageStats">
- <title><link linkend="UsageStats">UsageStats</link></title>
- <para>Default: Don't share</para>
- <para>Asks: ___ anonymous Koha usage data with the Koha community.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't share</para>
- </listitem>
- <listitem>
- <para>Share</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This data is stored to help track usage of Koha around the world. If you
- choose to share your information, it will be published on the <ulink url="http://hea.koha-community.org">Hea Koha community website</ulink>. This
- information is sent using the <link linkend="usagecron">Usage Sharing Cron
- Job</link>.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="UsageStatsCountry">
- <title><link linkend="UsageStatsCountry">UsageStatsCountry</link></title>
- <para>Asks: The country where your library is located: ___</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This data is stored to help track usage of Koha around the world. If you
- choose to share your information, it will be published on the <ulink url="http://hea.koha-community.org">Hea Koha community website</ulink>. This
- information is sent using the <link linkend="usagecron">Usage Sharing Cron
- Job</link>.</para>
- </listitem>
- </itemizedlist></para>
- <important>
- <para>This preference depends on the <link linkend="UsageStats">UsageStats</link>
- preference. Set that to 'Share' to share your information.</para>
- </important>
- </section>
- <section id="UsageStatsLibraryName">
- <title><link linkend="UsageStatsLibraryName">UsageStatsLibraryName</link></title>
- <para>Asks: The library name ___ will be shown on the <ulink url="http://hea.koha-community.org">Hea Koha community website</ulink>.</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This data is stored to help track usage of Koha around the world. If you
- choose to share your information, it will be published on the <ulink url="http://hea.koha-community.org">Hea Koha community website</ulink>. This
- information is sent using the <link linkend="usagecron">Usage Sharing Cron
- Job</link>.</para>
- </listitem>
- </itemizedlist></para>
- <important>
- <para>This preference depends on the <link linkend="UsageStats">UsageStats</link>
- preference. Set that to 'Share' to share your information. If this field is empty
- data will be sent anonymously if you choose 'Share' for the <link linkend="UsageStats">UsageStats</link> preference. </para>
- </important>
- </section>
- <section id="UsageStatsLibraryType">
- <title><link linkend="UsageStatsLibraryType">UsageStatsLibraryType</link></title>
- <para>Default: public</para>
- <para>Asks: The library type ___ will be shown on the <ulink url="http://hea.koha-community.org">Hea Koha community website</ulink>.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>academic </para>
- </listitem>
- <listitem>
- <para>corporate </para>
- </listitem>
- <listitem>
- <para>government </para>
- </listitem>
- <listitem>
- <para>private </para>
- </listitem>
- <listitem>
- <para>public </para>
- </listitem>
- <listitem>
- <para>religious organization </para>
- </listitem>
- <listitem>
- <para>research </para>
- </listitem>
- <listitem>
- <para>school </para>
- </listitem>
- <listitem>
- <para>society or association </para>
- </listitem>
- <listitem>
- <para>subscription</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This data is stored to help track usage of Koha around the world. If you
- choose to share your information, it will be published on the <ulink url="http://hea.koha-community.org">Hea Koha community website</ulink>. This
- information is sent using the <link linkend="usagecron">Usage Sharing Cron
- Job</link>.</para>
- </listitem>
- </itemizedlist></para>
- <important>
- <para>This preference depends on the <link linkend="UsageStats">UsageStats</link>
- preference. Set that to 'Share' to share your information. </para>
- </important>
- </section>
- <section id="UsageStatsLibraryUrl">
- <title><link linkend="UsageStatsLibraryUrl">UsageStatsLibraryUrl</link></title>
- <para>Asks: The library URL ___ will be shown on the <ulink url="http://hea.koha-community.org">Hea Koha community website</ulink>.</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This data is stored to help track usage of Koha around the world. If you
- choose to share your information, it will be published on the <ulink url="http://hea.koha-community.org">Hea Koha community website</ulink>. This
- information is sent using the <link linkend="usagecron">Usage Sharing Cron
- Job</link>.</para>
- </listitem>
- </itemizedlist></para>
- <important>
- <para>This preference depends on the <link linkend="UsageStats">UsageStats</link>
- preference. Set that to 'Share' to share your information. </para>
- </important>
- </section>
- </section>
- </section>
-
- <section id="authprefs">
- <title><link linkend="authprefs">Authorities</link></title>
-
- <para><emphasis>Get there:</emphasis> More > Administration >
- Global System Preferences > Authorities</para>
-
- <section id="generalauthorities">
- <title><link linkend="generalauthorities">General</link></title>
-
- <section id="AuthDisplayHierarchy">
- <title><link linkend="AuthDisplayHierarchy">AuthDisplayHierarchy</link></title>
-
- <para>Default: Don't display</para>
-
- <para>Asks: ___ broader term/narrower term hierarchies when
- viewing authorities.</para>
-
- <para>Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>Display</para>
-
- <screenshot>
- <screeninfo>AuthDisplayHierarchy</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/AuthDisplayHierarchy.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>Don't display</para>
- </listitem>
- </itemizedlist>
-
- <para>Description:</para>
-
- <itemizedlist>
- <listitem>
- <para>If your authority records includes 5xx fields with
- linked references to broader and/or narrower see also
- references this preference will turn on a display of those
- authorities at the top of the record.</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="AutoCreateAuthorities">
- <title><link linkend="AutoCreateAuthorities">AutoCreateAuthorities</link></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><link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link></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><link linkend="dontmerge">dontmerge</link></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
- immediately 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, rather, this is done later by the
- <link linkend="mergeauthcron">merge_authority.pl cronjob</link>.</para>
- </listitem>
- </itemizedlist>
-
- <important>
- <para>If this is set to "Don't automatically update" you will need to ask your
- administrator to enable the <link linkend="mergeauthcron">merge_authority.pl
- cronjob</link>.</para>
- </important>
- </section>
-
- <section id="MARCAuthorityControlField008">
- <title><link linkend="MARCAuthorityControlField008">MARCAuthorityControlField008</link></title>
-
- <para>Default: || aca||aabn | a|a d</para>
-
- <para>Asks: Use the following text for the contents of MARC21 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="UNIMARCAuthorityField100">
- <title><link linkend="UNIMARCAuthorityField100">UNIMARCAuthorityField100</link></title>
- <para>Default: afrey50 ba0</para>
- <para>Asks: Use the following text for the contents of UNIMARC authority field 100
- position (fixed length data elements). <important>
- <para>Do not include the date (position 00-07) in this preference, Koha will
- calculate automatically and put that in before the values in this
- preference.</para>
- </important></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference controls the default value in the 100 field on Authority
- records cataloged in UNIMARC. It does not effect bibliographic records.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="UseAuthoritiesForTracings">
- <title><link linkend="UseAuthoritiesForTracings">UseAuthoritiesForTracings</link></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><link linkend="linkerauthorities">Linker</link></title>
-
- <para>These preferences 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><link linkend="CatalogModuleRelink">CatalogModuleRelink</link></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><link linkend="LinkerKeepStale">LinkerKeepStale</link></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><link linkend="LinkerModule">LinkerModule</link></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><link linkend="LinkerOptions">LinkerOptions</link></title>
-
- <para>Asks: Set the following options for the authority linker
- ___<important>
- <para>This feature is experimental and shouldn't be used in a
- production environment until further expanded upon.</para>
- </important></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:<programlisting>=600 10$aCamins-Esakov, Jared$xCoin collections$vCatalogs$vEarly works to 1800.</programlisting></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><link linkend="LinkerRelink">LinkerRelink</link></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><link linkend="catprefs">Cataloging</link></title>
-
- <para><emphasis>Get there:</emphasis> More > Administration >
- Global System Preferences > Cataloging</para>
-
- <section id="catdisplayprefs">
- <title><link linkend="catdisplayprefs">Display</link></title>
-
- <para/>
- <section id="AcquisitionDetails">
- <title><link linkend="AcquisitionDetails">AcquisitionDetails</link></title>
- <para>Default: Display</para>
- <para>Asks: ___ acquisition details on the biblio detail page. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Display</para>
- </listitem>
- <listitem>
- <para>Don't display</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference controls whether a tab will show on the detail page in the
- staff client that includes detailed acquisitions information for the title. This
- tab will include links to order information stored in the acquisitions module.<screenshot>
- <screeninfo>AcquisitionDetails</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/AcquisitionDetails.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="authoritysep">
- <title><link linkend="authoritysep">AuthoritySeparator</link></title>
-
- <para>Default: --</para>
-
- <para>Asks: Separate multiple displayed authors, series or
- subjects with ___.</para>
- </section>
-
- <section id="hide_marc">
- <title><link linkend="hide_marc">hide_marc</link></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><link linkend="IntranetBiblioDefaultView">IntranetBiblioDefaultView</link></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><link linkend="isbdpref">ISBD</link></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 in the staff client.
- 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><link linkend="LabelMARCView">LabelMARCView</link></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="MergeReportFields">
- <title><link linkend="MergeReportFields">MergeReportFields</link></title>
- <para>Asks: ___ fields to display for deleted records after merge </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>When merging records together you can receive a report of the merge process
- once it's done, this preference lets you set the default values for this
- report.</para>
- </listitem>
- </itemizedlist></para>
- <para>Example: '001,245ab,600' displays: <itemizedlist>
- <listitem>
- <para>value of 001</para>
- </listitem>
- <listitem>
- <para>subfields a and b of fields 245</para>
- </listitem>
- <listitem>
- <para>all subfields of fields 600</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="NotesBlacklist">
- <title><link linkend="NotesBlacklist">NotesBlacklist</link></title>
- <para>Asks: Don't show these ___ note fields in title notes separator (OPAC record
- details) and in the description separator (Staff client record details). </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference lets you define which of your note fields are hidden from
- the title notes (OPAC) and descriptions (Staff) tabs. Enter the values as a
- comma separated list. For example to hide the local note and the bibliography
- note in MARC21 enter 504, 590.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="OpacSuppression">
- <title><link linkend="OpacSuppression">OpacSuppression, OpacSuppressionByIPRange, OpacSuppressionRedirect, and
- OpacSuppressionMessage</link></title>
- <para>OpacSuppression Default: Don't hide</para>
-
- <para>Asks: ___ items marked as suppressed from OPAC search results. Note that you must
- have the Suppress index set up in Zebra and at least one suppressed item, or your
- searches will be broken. Restrict the suppression to IP adresses outside of the IP
- range ___ (Leave blank if not used. Define a range like 192.168..) Redirect the opac
- detail page for suppressed records to ___ Display the following message on the
- redirect page for suppressed biblios ___.</para>
-
- <para>OpacSuppression Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>Don't hide</para>
-
- <itemizedlist>
- <listitem>
- <para>Will show records in OPAC search results if they are marked
- suppressed</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>Hide</para>
-
- <itemizedlist>
- <listitem>
- <para>Will not show records in OPAC search results if they're marked as
- suppressed</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- <para>OpacSuppressionRedirect Values:<itemizedlist>
- <listitem>
- <para>an explanatory page ('This record is blocked').</para>
- </listitem>
- <listitem>
- <para>the 404 error page ('Not found').</para>
- </listitem>
- </itemizedlist></para>
-
- <para>Description:</para>
-
- <itemizedlist>
- <listitem>
- <para>These preferences control hiding of bibliographic records from display in the
- OPAC. Each bibliogrphic record you want to hide from the OPAC simply needs to have
- the value "1" in the field mapped with Suppress index (942$n field in MARC21, no
- official field in UNIMARC). The indexer then hides it from display in OPAC but
- will still display it in the Staff Client. If you want to further control
- suppression you can set an IP address range to still show suppressed items to.
- Define a range like 192.168.. If you don't want to limit suppression in this way,
- leave the IP field blank. You can also decide what the patrons will see in the
- OPAC when a title is suppressed by setting the OpacSuppressionRedirect and
- OpacSuppressionMessage preferences. You can either show the patron a 404 page if
- they try to see a suppressed record or you can create a custom page by entering
- the HTML in the OpacSuppressionMessage part of this preference.</para>
- <para>
- <note>
- <para>An <link linkend="authorizedvalues">authorized value</link> for the MARC21
- 942$n field (or the equivalent UNIMARC 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>
- </note>
- </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 record with
- the value "1" in the field mapped with this index, or your searches will be
- completely broken in OPAC (you won't get any results at all).</para>
- </important>
- <note>
- <para>Suppressed records will show a note in the staff client indicating that they are
- suppressed from view in the OPAC.<screenshot>
- <screeninfo>Suppressed in Staff</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/suppressedstaff.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>This note can be styled by using the <link linkend="IntranetUserCSS"
- >IntranetUserCSS</link> preference to stand out more if you'd like.<screenshot>
- <screeninfo>Style suppression note</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/suppressedstyled.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </note>
- </section>
- <section id="SeparateHoldings">
- <title><link linkend="SeparateHoldings">SeparateHoldings & SeparateHoldingsBranch </link></title>
- <para>SeparateHoldings default: Don't separate</para>
- <para>SeparateHoldingsBranch default: home library </para>
- <para>Asks: ___ items display into two tabs, where the first tab contains items whose
- ___ is the logged in user's library. The second tab will contain all other items. </para>
- <para>SeparateHoldings values:<itemizedlist>
- <listitem>
- <para>Don't separate</para>
- </listitem>
- <listitem>
- <para>Separate</para>
- </listitem>
- </itemizedlist></para>
- <para>SeparateHoldingsBranch values:<itemizedlist>
- <listitem>
- <para>holding library</para>
- </listitem>
- <listitem>
- <para>home library</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:</para>
- <itemizedlist>
- <listitem>
- <para>This preference lets you decide if you would like to have the holding
- information on the bibliographic detail page in the staff client split in to
- multiple tabs. The default is to show all holdings on one tab.</para>
- <screenshot>
- <screeninfo>Separate holdings tabs</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/SeparateHoldings.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="URLLinkText">
- <title><link linkend="URLLinkText">URLLinkText</link></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><link linkend="UseControlNumber">UseControlNumber</link></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="catexportprefs">
- <title><link linkend="catexportprefs">Exporting</link></title>
- <section id="BibtexExportAdditionalFields">
- <title><link linkend="BibtexExportAdditionalFields">BibtexExportAdditionalFields</link></title>
- <para>Asks: Include following fields when exporting BibTeX</para>
- <para>Description: <itemizedlist>
- <listitem>
- <para>Use one line per tag in the format BT_TAG: TAG$SUBFIELD ( e.g. lccn: 010$a )
- </para>
- </listitem>
- <listitem>
- <para>To specificy multiple marc tags/subfields as targets for a repeating BibTex
- tag, use the following format: BT_TAG: [TAG2$SUBFIELD1, TAG2$SUBFIELD2] ( e.g.
- notes: [501$a, 505$g] )</para>
- </listitem>
- <listitem>
- <para>All values of repeating tags and subfields will be printed with the given
- BibTeX tag. </para>
- </listitem>
- <listitem>
- <para>Use '@' ( with quotes ) as the BT_TAG to replace the bibtex record type with
- a field value of your choosing. </para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="RisExportAdditionalFields">
- <title><link linkend="RisExportAdditionalFields">RisExportAdditionalFields</link></title>
- <para>Asks: Include following fields when exporting RIS</para>
- <para>Description: <itemizedlist>
- <listitem>
- <para>Use one line per tag in the format RIS_TAG: TAG$SUBFIELD ( e.g. LC: 010$a )
- </para>
- </listitem>
- <listitem>
- <para>To specificy multiple marc tags/subfields as targets for a repeating RIS
- tag, use the following format: RIS_TAG: [TAG2$SUBFIELD1, TAG2$SUBFIELD2] ( e.g.
- NT: [501$a, 505$g] ) </para>
- </listitem>
- <listitem>
- <para>All values of repeating tags and subfields will be printed with the given
- RIS tag. </para>
- </listitem>
- <listitem>
- <para>Use of TY ( record type ) as a key will <emphasis role="italic">replace</emphasis> the default TY with the field value of your choosing.
- </para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- <section id="catimportprefs">
- <title><link linkend="catimportprefs">Importing</link></title>
- <section id="AggressiveMatchOnISBN">
- <title><link linkend="AggressiveMatchOnISBN">AggressiveMatchOnISBN</link></title>
- <para>Default: don't</para>
- <para>Asks: When matching on ISBN with the record import tool, ___ attempt to match
- aggressively by trying all variations of the ISBNs in the imported record as a phrase
- in the ISBN fields of already cataloged records. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>do</para>
- </listitem>
- <listitem>
- <para>don't</para>
- </listitem>
- </itemizedlist>Description:<itemizedlist>
- <listitem>
- <para>This preference allows you to choose to alter the ISBN matching rule used
- when staging records for import to be more aggressive. This means that all text
- will be stripped from the ISBN field so that a pure number match is possible. If
- this preference is set to "Don't" then Koha will find a match only if the ISBN
- fields are identical.</para>
- </listitem>
- </itemizedlist><important>
- <para>Note that this preference has no effect if <link linkend="UseQueryParser">UseQueryParser</link> is on. </para>
- </important></para>
- </section>
- </section>
-
- <section id="catinterfaceprefs">
- <title><link linkend="catinterfaceprefs">Interface</link></title>
-
- <para/>
-
- <section id="advancedMARCeditor">
- <title><link linkend="advancedMARCeditor">advancedMARCeditor</link></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><link linkend="DefaultClassificationSource">DefaultClassificationSource</link></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>
- <authorgroup>
- <author>
- <firstname>Linda</firstname>
- <surname>Culberson</surname>
- <affiliation>
- <orgname>Ms. Dept. of Archives and History</orgname>
- </affiliation>
- </author>
-
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- <contrib>Fixed typos, changed content
- where necessary and added new screenshots.</contrib>
- </editor>
- </authorgroup>
-
- <pubdate>October 2011</pubdate>
- </sectioninfo>
-
- <title><link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link></title>
- <para>Default: Don't Display</para>
-
- <para>Asks: ___ easy ways to create analytical record
- relationships</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><link linkend="catrecordprefs">Record Structure</link></title>
-
- <para/>
-
- <section id="AlternateHoldingsField">
- <title><link linkend="AlternateHoldingsField">AlternateHoldingsField &
- AlternateHoldingsSeparator</link></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><link linkend="autoBarcode">autoBarcode</link></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, <year>-0002</para>
- </listitem>
-
- <listitem>
- <para>generated in the form 1, 2, 3</para>
- </listitem>
-
- <listitem>
- <para>incremental EAN-13 barcodes</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). The default
- behavior makes it so that when you click in the barcode field
- (952$p in MARC21) it will populate with the automatic barcode
- you have chosen. If you would rather it only enter an
- automatic barcode when you click on the plugin (the ... to the
- right of the field) you can change the plugin used for that
- field in the framework. Set the plugin for 952$p (if using
- MARC21 or equivalent field mapped to items.barcode in your
- local MARC format) for your frameworks to barcode_manual.pl
- instead of barcode.pl. Learn more about editing frameworks
- under the <link linkend="marcbibframeworks">MARC Bibliographic
- Frameworks</link> section of this manual.</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="DefaultLanguageField008">
- <title><link linkend="DefaultLanguageField008">DefaultLanguageField008</link></title>
- <para>Default: Empty defaults to eng</para>
-
- <para>Asks: Fill in the default language for field 008 Range 35-37 of MARC21 records
- ___.</para>
-
- <para>Description:</para>
-
- <itemizedlist>
- <listitem>
- <para>This preference will allow you to set the language for your MARC21 008 field
- by default. If this is left empty it will default to English (eng). See the <ulink url="http://www.loc.gov/marc/languages/language_code.html">MARC Code List for
- Languages</ulink> for additional values for this preference.</para>
- </listitem>
- </itemizedlist>
- <note>
- <para>This preference won't have any effect if your records are in UNIMARC.</para>
- </note>
- </section>
-
- <section id="item-level_itypes">
- <title><link linkend="item-level_itypes">item-level_itypes</link></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><link linkend="itemcallnumber">itemcallnumber</link></title>
-
- <para>Default: 082ab</para>
-
- <para>Asks: Map the MARC subfield to an item's callnumber.</para>
-
- <note>
- <para>This can contain multiple subfields to look in; for
- instance 082ab would look in 082 subfields a and b.</para>
- </note>
-
- <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 in MARC21)
- 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><link linkend="marcflavour">marcflavour</link></title>
-
- <para>Default: MARC21</para>
-
- <para>Asks: Interpret and store MARC records in the ___
- format.</para>
-
- <para>Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>MARC21<itemizedlist>
- <listitem>
- <para>The standard style for the US, Canada, Australia, New Zealand, United
- Kingdom, Germany and other countries</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
-
- <listitem>
- <para>UNIMARC<itemizedlist>
- <listitem>
- <para>The standard style used in France, Italy, Portugal, Russia, and other
- countries</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>NORMARC<itemizedlist>
- <listitem>
- <para>The standard style for Norway</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- <para>Description:</para>
- <itemizedlist>
- <listitem>
- <para>This preference defines global MARC style (MARC21, UNIMARC or NORMARC) used
- for encoding.</para>
- </listitem>
- </itemizedlist>
- <important>
- <para>Changing the value of this preference will not convert your records from one
- MARC style to an other.</para>
- </important>
- </section>
-
- <section id="MARCOrgCode">
- <title><link linkend="MARCOrgCode">MARCOrgCode</link></title>
-
- <para>Default: OSt</para>
-
- <para>Asks: Fill in the MARC organization code ___ by default in new MARC21 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 MARC21 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>.<note>
- <para>This preference won't have any effect if your records are in UNIMARC.</para>
- </note></para>
- </section>
-
- <section id="NewItemsDefaultLocation">
- <title><link linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link></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="PrefillItem">
- <title><link linkend="PrefillItem">PrefillItem</link></title>
- <para>Default: the new item is not prefilled with last created item values.</para>
- <para>Asks: When a new item is added ___</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>the new item is not prefilled with last created item values.</para>
- </listitem>
- <listitem>
- <para>the new item is prefilled with last created item values.</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference controls the behavior used when adding new items. Using the
- options here you can choose to have your next new item prefill with the values
- used in the last item was added to save time typing values or to have the item
- form appear completely blank. Using <link linkend="SubfieldsToUseWhenPrefill">SubfieldsToUseWhenPrefill</link> you can control specifically which fields
- are prefilled.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="SubfieldsToAllowForRestrictedBatchmod">
- <title><link linkend="SubfieldsToAllowForRestrictedBatchmod">SubfieldsToAllowForRestrictedBatchmod</link></title>
- <para>Asks: Define a list of subfields for which editing is authorized when <link linkend="items_batchmod_restricted">items_batchmod_restricted</link> permission is
- enabled, separated by spaces. ___</para>
- <para>Examples:<itemizedlist>
- <listitem>
- <para>UNIMARC: "995$f 995$h 995$j" </para>
- </listitem>
- <listitem>
- <para>MARC21: "952$a 952$b 952$c" </para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference lets you define what fields can be edited via the <link linkend="batchmodifyitems">batch item modification tool</link> if the
- items_batchmod_restricted permission is enabled.</para>
- <para>
- <note>
- <para>The FA framework is excluded from the permission. If the pref is empty,
- no fields are restricted. </para>
- </note>
- </para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="SubfieldsToAllowForRestrictedEditing">
- <title><link linkend="SubfieldsToAllowForRestrictedEditing">SubfieldsToAllowForRestrictedEditing</link></title>
- <para>Asks: Define a list of subfields for which editing is authorized when
- edit_items_restricted permission is enabled, separated by spaces. ___</para>
- <para>Examples:<itemizedlist>
- <listitem>
- <para>UNIMARC: "995$f 995$h 995$j"</para>
- </listitem>
- <listitem>
- <para>MARC21: "952$a 952$b 952$c"</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference lets you define what fields can be edited via cataloging if
- the <link linkend="edit_items_restricted">edit_items_restricted</link>
- permission is enabled<note>
- <para>The Fast Add (FA) framework is excluded from the permission. If the pref
- is empty, no fields are restricted. </para>
- </note></para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="SubfieldsToUseWhenPrefill">
- <title><link linkend="SubfieldsToUseWhenPrefill">SubfieldsToUseWhenPrefill</link></title>
- <para>Asks: Define a list of subfields to use when prefilling items ___<important>
- <para>Separate values with a space.</para>
- </important></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>When the <link linkend="PrefillItem">PrefillItem</link> preference is set to
- prefill item values with those from the last added item, this preference can
- control which fields are prefilled (and which are not). Enter a space separated
- list of fields that you would like to prefill when adding a new item.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="z3950NormalizeAuthor">
- <title><link linkend="z3950NormalizeAuthor">z3950NormalizeAuthor & z3950AuthorAuthFields</link></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><link linkend="catspineprefs">Spine Labels</link></title>
-
- <para/>
-
- <section id="SpineLabelAutoPrint">
- <title><link linkend="SpineLabelAutoPrint">SpineLabelAutoPrint</link></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><link linkend="SpineLabelFormat">SpineLabelFormat</link></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><link linkend="SpineLabelShowPrintOnBibDetails">SpineLabelShowPrintOnBibDetails</link></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><link linkend="circprefs">Circulation</link></title>
-
- <para><emphasis>Get there:</emphasis> More > Administration >
- Global System Preferences > Circulation</para>
- <section id="batchcheckoutprefs">
- <title><link linkend="batchcheckoutprefs">Batch Checkout</link></title>
- <section id="BatchCheckouts">
- <title><link linkend="BatchCheckouts">BatchCheckouts</link></title>
- <para>Default: Don't allow</para>
- <para>Asks: ___ batch checkouts </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Allow</para>
- </listitem>
- <listitem>
- <para>Don't allow</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="BatchCheckoutsValidCategories">
- <title><link linkend="BatchCheckoutsValidCategories">BatchCheckoutsValidCategories</link></title>
- <para>Asks: Patron categories allowed to checkout in a batch ___ (list of patron
- categories separated with a pipe '|') </para>
- </section>
- </section>
- <section id="checkinpolicyprefs">
- <title><link linkend="checkinpolicyprefs">Checkin Policy</link></title>
- <para/>
- <section id="AllowMultipleIssuesOnABiblio">
- <title><link linkend="AllowMultipleIssuesOnABiblio">AllowMultipleIssuesOnABiblio</link></title>
- <para>Default: Allow</para>
- <para>Asks: ___ patrons to check out multiple items from the same record. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Allow</para>
- </listitem>
- <listitem>
- <para>Don't allow</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>If this preference is set to 'Allow' then patrons will be able to check out
- multiple copies of the same title at the same time. If it's set to "Don't allow"
- then patrons will only be allowed to check out one item attached to a record at
- a time. Regardless of the option chosen in this preference records with
- subscriptions attached will allow multiple check outs.<important>
- <para>This will only effect records without a subscription attached.</para>
- </important></para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="BlockReturnOfWithdrawnItems">
- <title><link linkend="BlockReturnOfWithdrawnItems">BlockReturnOfWithdrawnItems</link></title>
- <para>Default: Block</para>
- <para>Asks: ___ returning of items that have been withdrawn. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Block</para>
- </listitem>
- <listitem>
- <para>Don't block</para>
- </listitem>
- </itemizedlist>Description:<itemizedlist>
- <listitem>
- <para>This preference controls whether and item with a withdrawn status (952$0 in
- MARC21) can be checked in or not.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="CalculateFinesOnReturn">
- <title><link linkend="CalculateFinesOnReturn">CalculateFinesOnReturn</link></title>
- <para>Default: Do</para>
- <para>Asks: ___ calculate and update overdue charges when an item is returned.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Do</para>
- </listitem>
- <listitem>
- <para>Don't</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>If this preference is set to "Do" and the <link linkend="finescronjob">fines
- cron job</link> is off then Koha will calculate fines only when items are
- returned. If you have the fines cron job on and this preference set to "Do" then
- this preference will calculate fines based on the cron (usually run nightly) and
- then again when you check the item in. This option is best for those who are
- doing hourly loans. If this preference is set to "Don't" then fines will only
- be accrued if the fines cron job is running.</para>
- </listitem>
- </itemizedlist></para>
- <para>
- <important>
- <para>If you are doing hourly loans then you should have this set to 'Do'.</para>
- </important>
- </para>
- </section>
- <section id="RentalFeesCheckoutConfirmation">
- <title><link linkend="RentalFeesCheckoutConfirmation">RentalFeesCheckoutConfirmation</link></title>
- <para>Default: do not ask</para>
- <para>Asks: When checking out an item with rental fees, ___ for confirmation.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>ask<screenshot>
- <screeninfo>RentalFeesCheckoutConfirmation</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/RentalFeesCheckoutConfirmation.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- <listitem>
- <para>do not ask</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>If you are charging rental fees for items this preference will make it so
- that you can show (or not show) a confirmation before checking out an item that
- will incur a rental charge.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="UpdateNotForLoanStatusOnCheckin">
- <title><link linkend="UpdateNotForLoanStatusOnCheckin">UpdateNotForLoanStatusOnCheckin</link></title>
- <para>Asks: This is a list of value pairs. When an item is checked in, if the not for
- loan value on the left matches the items not for loan value it will be updated to the
- right-hand value. E.g. '-1: 0' will cause an item that was set to 'Ordered' to now be
- available for loan. Each pair of values should be on a separate line. </para>
- </section>
- </section>
-
- <section id="circcheckoutpolicy">
- <title><link linkend="circcheckoutpolicy">Checkout Policy</link></title>
-
- <para/>
-
- <section id="AgeRestrictionMarker">
- <title><link linkend="AgeRestrictionMarker">AgeRestrictionMarker</link></title>
-
- <para>Asks: Restrict patrons with the following target audience
- values from checking out inappropriate materials: ___</para>
-
- <para>Description:</para>
-
- <itemizedlist>
- <listitem>
- <para>This preference defines certain keywords that will
- trigger Koha to restrict checkout based on age. These
- restrictions can be overridden by the <link linkend="AgeRestrictionOverride">AgeRestrictionOverride</link>
- preference. Enter in this field a series of keywords separated
- by bar (|) with no spaces. For example PG|R|E|EC|Age| will
- look for PG followed by an age number, R folllowed by an age
- number, Age followed by an age number, and so on. These values
- can appear in any MARC field, but Library of Congress
- recommends the 521$a (Target Audience Note). Whatever field
- you decide to use you must map the word agerestriction in the
- biblioitems table to that field in the <link linkend="kohamarcmapping">Koha to MARC Mapping</link>. When
- cataloging you can enter values like PG 13 or E 10 in the
- 521$a and Koha will then notify circulation librarians that
- the material may not be recommended for the patron based on
- their age.<important>
- <para>You must map the word agerestriction in the biblioitems table to the MARC
- field where this information will appear via the <link linkend="kohamarcmapping">Koha to MARC Mapping</link> administration
- area.</para>
- </important></para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="AgeRestrictionOverride">
- <title><link linkend="AgeRestrictionOverride">AgeRestrictionOverride</link></title>
-
- <para>Default: Don't allow</para>
-
- <para>Asks: ___ staff to check out an item with age
- restriction.</para>
-
- <para>Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>Allow</para>
-
- <screenshot>
- <screeninfo>Allow age restriction override</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/AgeRestrictionOverride.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>Don't allow</para>
-
- <screenshot>
- <screeninfo>Don't allow age restriction
- override</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/AgeRestrictionMarker.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
-
- <para>Description:</para>
-
- <itemizedlist>
- <listitem>
- <para>When the <link linkend="AgeRestrictionMarker">AgeRestrictionMarker</link>
- preference is set, Koha will try to warn circulation
- librarians before checking out an item that might have an age
- restriction listed in the MARC record. This preference asks if
- you would like the staff to be able to still check out these
- items to patrons under the age limit.</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="AllFinesNeedOverride">
- <title><link linkend="AllFinesNeedOverride">AllFinesNeedOverride</link></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><link linkend="AllowFineOverride">AllowFineOverride</link></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><link linkend="AllowItemsOnHoldCheckout">AllowItemsOnHoldCheckout</link></title>
-
- <para>Default: Don't allow</para>
-
- <para>Asks: ___ checkouts of 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><link linkend="AllowNotForLoanOverride">AllowNotForLoanOverride</link></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><link linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link></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="AllowReturnToBranch">
- <title><link linkend="AllowReturnToBranch">AllowReturnToBranch</link></title>
-
- <para>Default: to any library</para>
-
- <para>Asks: Allow materials to be returned to ___</para>
-
- <para>Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>either the library the item is from or the library it
- was checked out from.</para>
- </listitem>
-
- <listitem>
- <para>only the library the item is from.</para>
- </listitem>
-
- <listitem>
- <para>only the library the item was checked out from.</para>
- </listitem>
-
- <listitem>
- <para>to any library.</para>
- </listitem>
- </itemizedlist>
-
- <para>Description:</para>
-
- <itemizedlist>
- <listitem>
- <para>This preference lets the library system decide how they
- will accept returns. Some systems allow for items to be
- returned to any library in the system (the default value of
- this preference) others want to limit item returns to only
- specific branches. This preference will allow you to limit
- item returns (checkins) to the branch(es) set in the
- value.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="AllowTooManyOverride">
- <title><link linkend="AllowTooManyOverride">AllowTooManyOverride</link></title>
- <para>Default: Allow</para>
- <para>Asks: ___ staff to override and check out items when the patron has reached the
- maximum number of allowed checkouts.</para>
- <para>Values:</para>
- <itemizedlist>
- <listitem>
- <para>Allow</para>
- <screenshot>
- <screeninfo>Allow too many checkouts override</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/AllowTooManyOverride-yes.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Don't allow</para>
- <screenshot>
- <screeninfo>Don't allow too many checkouts override</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/AllowTooManyOverride-no.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- <para>Description:<itemizedlist>
- <listitem>
- <para>If this preference is set to "Allow" then staff all will be presented with
- an option to checkout more items to a patron than are normally allowed in the
- <link linkend="circfinerules">Circulation and Fine Rules</link>. If this
- preference is set to "Don't allow" then no staff member will be able to check
- out more than the circulation limit.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="AutomaticItemReturn">
- <title><link linkend="AutomaticItemReturn">AutomaticItemReturn</link></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="AutoRemoveOverduesRestrictions">
- <title><link linkend="AutoRemoveOverduesRestrictions">AutoRemoveOverduesRestrictions</link></title>
- <para>Default: Do not</para>
- <para>Asks: ___ allow OVERDUES restrictions triggered by sent notices to be cleared
- automatically when all overdue items are returned by a patron. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Do</para>
- </listitem>
- <listitem>
- <para>Do not</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>Using the <link linkend="noticetriggers">Overdue Notice/Status
- Triggers</link> you can restrict patrons after they receive an overdue notice.
- This preference lets you define whether Koha will automatically remove that
- restriction once the overdue items in question are returned or not.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="CircControl">
- <title><link linkend="CircControl">CircControl</link></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 <link linkend="circfinerules">circulation and fines policies</link>
- will be determined by the item's library where <link linkend="HomeOrHoldingBranch">HomeOrHoldingBranch</link> chooses if item's
- home library is used or holding library is used.</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>the library the patron is from</para>
-
- <itemizedlist>
- <listitem>
- <para>The <link linkend="circfinerules">circulation and fines policies</link>
- 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 <link linkend="circfinerules">circulation and fines policies</link>
- will be determined by the library that checked the item out to the
- patron</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </section>
- <section id="ConsiderOnSiteCheckoutsAsNormalCheckouts">
- <title><link linkend="ConsiderOnSiteCheckoutsAsNormalCheckouts">ConsiderOnSiteCheckoutsAsNormalCheckouts</link></title>
- <para>Default: Consider</para>
- <para>Asks: ___ on-site checkouts as normal checkouts. If enabled, the number of
- checkouts allowed will be normal checkouts + on-site checkouts. If disabled, both
- values will be checked separately. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Consider</para>
- </listitem>
- <listitem>
- <para>Don't consider</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference allows you to decide if checkouts that are <link linkend="OnSiteCheckouts">OnSiteCheckouts</link> are counted toward the total
- checkouts a patron can have. You can also set your <link linkend="circfinerules">circulation and fine rules</link> to allow only a certain number of normal
- and OnSite checkouts.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="DefaultLongOverdueChargeValue">
- <title><link linkend="DefaultLongOverdueChargeValue">DefaultLongOverdueChargeValue</link></title>
- <para>Asks: Charge a lost item to the borrower's account when the LOST value of the item
- changes to ___</para>
- <para>Description: <itemizedlist>
- <listitem>
- <para>Leave this field empty if you don't want to charge the user for lost items.
- If you want the user to be charged enter the <link linkend="lost">LOST
- authorized value</link> you are using in the <link linkend="DefaultLongOverdueLostValue">DefaultLongOverdueLostValue</link>
- preference. This preference is used when the <link linkend="longoverduecron">longoverdue cron job</link> is called without the --charge parameter.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="DefaultLongOverdueLostValue">
- <title><link linkend="DefaultLongOverdueLostValue">DefaultLongOverdueLostValue & DefaultLongOverdueDays </link></title>
- <para>Asks: By default, set the LOST value of an item to ___ when the item has been
- overdue for more than ___ days. </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>These preferences are used when the <link linkend="longoverduecron">longoverdue cron job</link> is called without the --lost parameter. It allows
- users to set the values of the <link linkend="longoverduecron">longoverdue
- cron</link> without having to edit the crontab. Setting the values to 1 and
- 30 for example will mark the item with the <link linkend="lost">LOST authorized
- value</link> of 1 after the item is 30 days overdue. </para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="HoldsInNoissuesCharge">
- <title><link linkend="HoldsInNoissuesCharge">HoldsInNoissuesCharge</link></title>
- <para>Default: Don't include</para>
- <para>Asks: ___ hold charges when summing up charges for noissuescharge.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't include</para>
- </listitem>
- <listitem>
- <para>Include</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="HomeOrHoldingBranch">
- <title><link linkend="HomeOrHoldingBranch">HomeOrHoldingBranch</link></title>
-
- <para>Default: the library the item was checked out from</para>
-
- <para>Asks: Use the checkout and fines rules of ___</para>
-
- <para>Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>the library the item is from<itemizedlist>
- <listitem>
- <para>This is equivalent to 'home library'</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
-
- <listitem>
- <para>the library the item was checked out from<itemizedlist>
- <listitem>
- <para>This is equivalent to 'holding library'</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- <para>Description:</para>
- <itemizedlist>
- <listitem>
- <para>This preference does several things. <itemizedlist>
- <listitem>
- <para>If <link linkend="CircControl">CircControl</link> is set to 'the library
- the item is from' then the <link linkend="circfinerules">circulation and
- fines policies</link> will be determined by the item's library where
- HomeOrHoldingBranch chooses if item's home library is used or holding
- library is used.</para>
- </listitem>
- <listitem>
- <para>If <link linkend="IndependentBranches">IndependentBranches</link> is set
- to 'Prevent' then the value of this preference is used in figuring out if
- the item can be checked out. If the item's home library does not match the
- logged in library, the item cannot be checked out unless you are a <link linkend="patronpermsdefined">superlibrarian</link>.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- <important>
- <para>It is not recommend that this setting be changed after initial setup of Koha
- because it will change the behavior of items already checked out.</para>
- </important>
- </section>
-
- <section id="InProcessingToShelvingCart">
- <title><link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link></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>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference is used to manage automatically changing item locations from
- processing (PROC) to the book cart (CART). A <link linkend="proccartcron">cron
- job</link> needs to be set to run 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.) More information can
- be found in the <link linkend="processinglocations">related chapter</link> in
- this manual.</para>
-
- <itemizedlist>
- <listitem>
- <note>
- <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>
- </note>
- </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>
- </itemizedlist></para>
- </section>
-
- <section id="IssuingInProcess">
- <title><link linkend="IssuingInProcess">IssuingInProcess</link></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="IssueLostItem">
- <title><link linkend="IssueLostItem">IssueLostItem</link></title>
-
- <para>Default: display a message</para>
-
- <para>Asks: When issuing an item that has been marked as lost,
- ___.</para>
-
- <para>Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>display a message</para>
-
- <screenshot>
- <screeninfo>Lost message when checking out</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/IssueLostItem-msg.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>do nothing</para>
-
- <itemizedlist>
- <listitem>
- <para>This option will just check the item out without
- notifying you that the item was marked lost.</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>require confirmation</para>
-
- <screenshot>
- <screeninfo>Confirm checkout of lost item</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/IssueLostItem-confirm.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
-
- <para>Description:</para>
-
- <itemizedlist>
- <listitem>
- <para>This preference lets you define how library staff are
- notified that an item with a lost status is being checked out.
- This will help staff mark items as 'available' if you choose
- to 'display a message' or 'require confirmation.' If you
- choose to 'do nothing,' there will be no notification that the
- item being checked out is marked as 'lost.'</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="ManInvInNoissuesCharge">
- <title><link linkend="ManInvInNoissuesCharge">ManInvInNoissuesCharge</link></title>
- <para>Default: Include</para>
- <para>Asks: ___ MANUAL_INV charges when summing up charges for noissuescharge. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't include</para>
- </listitem>
- <listitem>
- <para>Include</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference lets you decide if charges entered as manual invoices are
- included when calculating the <link linkend="noissuescharge">noissuescharge</link>. If this is set to include then Koha will include all
- manual invoices when deciding if the patron owes too much money to check
- anything else out of the library. If it's set to Don't include then Koha will
- ignore all manual invoice charges when figuring out if the patron owes too much
- money to checkout additional materials.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="maxoutstanding">
- <title><link linkend="maxoutstanding">maxoutstanding</link></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><link linkend="noissuescharge">noissuescharge</link></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. Using the <link linkend="ManInvInNoissuesCharge">ManInvInNoissuesCharge</link> and <link linkend="RentalsInNoissuesCharge">RentalsInNoissuesCharge</link> preferences you
- can control which types of charges are considered in this total. 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="NoIssuesChargeGuarantees">
- <title><link linkend="NoIssuesChargeGuarantees">NoIssuesChargeGuarantees</link></title>
- <para>Asks: Prevent a patron from checking out if the patron has guarantees owing in
- total more than ___ USD in fines. </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>Allows a library to prevent patrons from checking out items if his or her
- guarantees owe too much in fines.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="NoRenewalBeforePrecision">
- <title><link linkend="NoRenewalBeforePrecision">NoRenewalBeforePrecision</link></title>
- <para>Default: date</para>
- <para>Asks: Calculate "No renewal before" based on ___. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>date</para>
- </listitem>
- <listitem>
- <para>exact time</para>
- </listitem>
- </itemizedlist><note>
- <para>Only relevant for loans calculated in days, hourly loans are not affected.
- </para>
- </note></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference allows you to control how the 'No renewal before" option in
- the <link linkend="circfinerules">Circulation and fine rules</link>
- administration area.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="OnSiteCheckouts">
- <title><link linkend="OnSiteCheckouts">OnSiteCheckouts</link></title>
- <para>Default: Disable</para>
- <para>Asks: ___ the on-site checkouts feature.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Disable</para>
- </listitem>
- <listitem>
- <para>Enable<screenshot>
- <screeninfo>OnSiteCheckouts</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OnSiteCheckouts.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference lets you check out items that are 'not for loan' to patrons.
- A checkbox is added to the checkout screen when this preference is set to
- 'Enable' labeled 'On-site checkout'. This allows you to track who's using items
- that are normally not for loan or are in a closed stack setting.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="OnSiteCheckoutsForce">
- <title><link linkend="OnSiteCheckoutsForce">OnSiteCheckoutsForce</link></title>
- <para>Default: Disable</para>
- <para>Asks: ___ the on-site for all cases (Even if a user is debarred, etc.).</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Disable</para>
- </listitem>
- <listitem>
- <para>Enable</para>
- <screenshot>
- <screeninfo>Force checkouts on restricted patrons</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OnSiteCheckoutsForce.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference lets the staff override any restrictions a patron might have
- and check out items for use within the library. The <link linkend="OnSiteCheckouts">OnSiteCheckouts</link> preference must first be set
- to 'Enable' for this preference to be considered.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="OverduesBlockCirc">
- <title><link linkend="OverduesBlockCirc">OverduesBlockCirc</link></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="OverduesBlockRenewing">
- <title><link linkend="OverduesBlockRenewing">OverduesBlockRenewing</link></title>
- <para>Default: allow renewing</para>
- <para>Asks: When a patron's checked out item is overdue, ___</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>allow renewing</para>
- </listitem>
- <listitem>
- <para>block renewing for all the patron's items</para>
- </listitem>
- <listitem>
- <para>block renewing for only this item</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="OverdueNoticeBcc">
- <title><link linkend="OverdueNoticeBcc">OverdueNoticeBcc</link></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.<note>
- <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>
- </note><note>
- <para>The name of this preference is misleading, it does not only send overdues, but
- all notices to the BCC address.</para>
- </note></para>
- </section>
- <section id="OverdueNoticeCalendar">
- <title><link linkend="OverdueNoticeCalendar">OverdueNoticeCalendar</link></title>
- <para>Default: Ignore calendar</para>
- <para>Asks: ___ when working out the period for overdue notices</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Ignore calendar<itemizedlist>
- <listitem>
- <para>Notices do not take holidays into account, so they will be sent even
- if holidays have meant the item is not actually overdue yet</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>Use calendar<itemizedlist>
- <listitem>
- <para>Notices take holidays into account, so they will not be sent if
- holidays mean the item is not actually overdue yet</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="PrintNoticesMaxLines">
- <title><link linkend="PrintNoticesMaxLines">PrintNoticesMaxLines</link></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>
-
- <note>
- <para>Set to 0 to include all overdue items in the notice, no
- matter how many there are.</para>
- </note>
-
- <important>
- <para>This preference only refers to the print notices, not
- those sent via email.</para>
- </important>
- </section>
-
- <section id="RenewalPeriodBase">
- <title><link linkend="RenewalPeriodBase">RenewalPeriodBase</link></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="RenewalSendNotice">
- <title><link linkend="RenewalSendNotice">RenewalSendNotice</link></title>
- <para> Default: Don't send </para>
- <para>Asks: ____ a renewal notice according to patron checkout alert preferences. </para>
- <para>Values: <itemizedlist>
- <listitem>
- <para>Don't send</para>
- </listitem>
- <listitem>
- <para>Send</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>If a patron has chosen to receive a check out notice in their messaging
- preferences and this preference is set to 'Send' then those patrons will also
- receive a notice when they renew materials. You will want to set up a <link linkend="addnotices">new notice</link> with the code of RENEWAL (if you don't
- already have it) with custom text for renewing items.<important>
- <para>This preference requires that you have <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
- set to 'Allow'</para>
- </important></para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="RentalsInNoissuesCharge">
- <title><link linkend="RentalsInNoissuesCharge">RentalsInNoissuesCharge</link></title>
- <para>Default: Include</para>
- <para>Asks: ___ rental charges when summing up charges for noissuescharge. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't include</para>
- </listitem>
- <listitem>
- <para>Include</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference lets you decide if rental charges are included when
- calculating the <link linkend="noissuescharge">noissuescharge</link>. If this is
- set to include then Koha will include all rental charges when deciding if the
- patron owes too much money to check anything else out of the library. If it's
- set to Don't include then Koha will ignore all rental charges when figuring out
- if the patron owes too much money to checkout additional materials.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="RestrictionBlockRenewing">
- <title><link linkend="RestrictionBlockRenewing">RestrictionBlockRenewing</link></title>
- <para>Default: Allow</para>
- <para>Asks: If patron is restricted, ___ renewing of items. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Allow</para>
- </listitem>
- <listitem>
- <para>Block</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="ReturnBeforeExpiry">
- <title><link linkend="ReturnBeforeExpiry">ReturnBeforeExpiry</link></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><link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link></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>
- <para>Description:<itemizedlist>
- <listitem>
- <para>More information can be found in the <link linkend="processinglocations">related chapter</link> in this manual.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="StaffSearchResultsDisplayBranch">
- <title><link linkend="StaffSearchResultsDisplayBranch">StaffSearchResultsDisplayBranch</link></title>
- <para>Default: the library the item is held by</para>
- <para>Asks: For search results in the staff client, display the branch of ___</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>the library the item is from</para>
- </listitem>
- <listitem>
- <para>the library the items is held by</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="TransfersMaxDaysWarning">
- <title><link linkend="TransfersMaxDaysWarning">TransfersMaxDaysWarning</link></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><link linkend="UseBranchTransferLimits">UseBranchTransferLimits &
- BranchTransferLimitsType</link></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><link linkend="useDaysMode">useDaysMode</link></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 id="UseTransportCostMatrix">
- <title><link linkend="UseTransportCostMatrix">UseTransportCostMatrix</link></title>
- <para>Default: Don't use</para>
- <para>Asks: ___ Transport Cost Matrix for calculating optimal holds filling between
- branches.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't use</para>
- </listitem>
- <listitem>
- <para>Use</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>If the system is configured to use the <link linkend="transportcostmatrix">Transport cost matrix</link> for filling holds, then when attempting to fill
- a hold, the system will search for the lowest cost branch, and attempt to fill
- the hold with an item from that branch first. Branches of equal cost will be
- selected from randomly. The branch or branches of the next highest cost shall be
- selected from only if all the branches in the previous group are unable to fill
- the hold.</para>
- <para>The system will use the item's current holding branch when determining
- whether the item can fulfill a hold using the Transport Cost Matrix. </para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- <section id="coursereserveprefs">
- <title><link linkend="coursereserveprefs">Course Reserves</link></title>
- <section id="UseCourseReserves">
- <title><link linkend="UseCourseReserves">UseCourseReserves</link></title>
- <para>Default: Don't use</para>
- <para>Asks: ___ course reserves</para>
- <para>Values:</para>
- <itemizedlist>
- <listitem>
- <para>Don't use</para>
- </listitem>
- <listitem>
- <para>Use</para>
- </listitem>
- </itemizedlist>
- <para>Description:<itemizedlist>
- <listitem>
- <para>The <link linkend="coursereserves">Course Reserves</link> module in Koha
- allows you to temporarily move items to 'reserve' and assign different
- circulation rules to these items while they are being used for a specific
- course.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
-
- <section id="circfinespolicy">
- <title><link linkend="circfinespolicy">Fines Policy</link></title>
-
- <para/>
-
- <section id="finesCalendar">
- <title><link linkend="finesCalendar">finesCalendar</link></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="FinesIncludeGracePeriod">
- <title><link linkend="FinesIncludeGracePeriod">FinesIncludeGracePeriod</link></title>
- <para>Default: Include</para>
- <para>Asks: ___ the grace period when calculating the fine for an overdue item.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't include</para>
- </listitem>
- <listitem>
- <para>Include</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference lets you control how Koha calculates fines when there is a
- grace period. If you choose to include the grace period when calculating fines
- then Koha will charge for the days in the grace period should the item be
- overdue more than those days. If you choose not to include the grace period then
- Koha will only charge for the days overdue after the grace period.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="finesMode">
- <title><link linkend="finesMode">finesMode</link></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 id="RefundLostItemFeeOnReturn">
- <title><link linkend="RefundLostItemFeeOnReturn">RefundLostItemFeeOnReturn</link></title>
- <para>Default: Refund</para>
- <para>Asks: ___ lost item fees charged to a borrower when the lost item is
- returned.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't refund</para>
- </listitem>
- <listitem>
- <para>Refund</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>When an item is marked lost in Koha the system charges the patron the
- replacement fee for the item. This preference lets you control how Koha handles
- returns of these items. By default when an item that was previously marked lost
- is checked in Koha refunds the patron the replacement fee. Change this
- preference to "Don't refund" if you would like Koha to not refund the
- replacement fee.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="WhenLostChargeReplacementFee">
- <title><link linkend="WhenLostChargeReplacementFee">WhenLostChargeReplacementFee</link></title>
- <para>Default: Charge</para>
- <para>Asks: ___ the replacement price when a patron loses an item. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Charge</para>
- </listitem>
- <listitem>
- <para>Don't charge</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference lets you tell Koha what to do with an item is marked lost.
- If you want Koha can 'Charge' the patron the replacement fee listed on the item
- they lost or it can do nothing in reference to the patron and just mark the item
- lost in the catalog.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="WhenLostForgiveFine">
- <title><link linkend="WhenLostForgiveFine">WhenLostForgiveFine</link></title>
- <para>Default: Don't forgive</para>
- <para>Asks: ___ the fines on an item when it is lost.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't forgive</para>
- </listitem>
- <listitem>
- <para>Forgive</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference allows the library to decide if fines are charged in
- addition to the replacement fee when an item is marked as lost. If this
- preference is set to 'Forgive' then the patron won't be charged fines in
- addition to the replacement fee.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
-
- <section id="circholdspolicy">
- <title><link linkend="circholdspolicy">Holds Policy</link></title>
-
- <para/>
-
- <section id="AllowHoldDateInFuture">
- <title><link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link></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="AllowHoldItemTypeSelection">
- <title><link linkend="AllowHoldItemTypeSelection">AllowHoldItemTypeSelection</link></title>
- <para>Default: Don't allow</para>
- <para>Asks: ___ hold fulfillment to be limited by itemtype.</para>
- <para>Values:</para>
- <itemizedlist>
- <listitem>
- <para>Allow</para>
- </listitem>
- <listitem>
- <para>Don't allow</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="AllowHoldsOnDamagedItems">
- <title><link linkend="AllowHoldsOnDamagedItems">AllowHoldsOnDamagedItems</link></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="AllowHoldsOnPatronsPossessions">
- <title><link linkend="AllowHoldsOnPatronsPossessions">AllowHoldsOnPatronsPossessions</link></title>
- <para>Default: Allow </para>
- <para>Asks: ____ a patron to place a hold on a record where the patron already has one
- or more items attached to that record checked out. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Allow</para>
- </listitem>
- <listitem>
- <para>Don't allow</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>By setting to "Don't allow," you can prevent patrons from placing holds on
- items they already have out, thus preventing them from blocking anyone else from
- getting an item. </para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="AllowHoldPolicyOverride">
- <title><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link></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="AllowRenewalIfOtherItemsAvailable">
- <title><link linkend="AllowRenewalIfOtherItemsAvailable">AllowRenewalIfOtherItemsAvailable</link></title>
- <para>Default: Don't allow</para>
- <para>Asks: ___ a patron to renew an item with unfilled holds if other available items
- can fill that hold.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Allow</para>
- </listitem>
- <listitem>
- <para>Don't allow</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="AutoResumeSuspendedHolds">
- <title><link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link></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 after 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>
- <important>
- <para>The holds will become unsuspended the date after that entered by the
- patron.</para>
- </important>
- </section>
-
- <section id="canreservefromotherbranches">
- <title><link linkend="canreservefromotherbranches">canreservefromotherbranches</link></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="IndependentBranches">independent
- branches</link>)</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="ConfirmFutureHolds">
- <title><link linkend="ConfirmFutureHolds">ConfirmFutureHolds</link></title>
- <para>Default: 0</para>
- <para>Asks: Confirm future hold requests (starting no later than ___ days from now) at
- checkin time. </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>When confirming a hold at checkin time, the number of days in this
- preference is taken into account when deciding which holds to show alerts for.
- This preference does not interfere with renewing, checking out or transferring a
- book.</para>
- </listitem>
- </itemizedlist></para>
- <note>
- <para>This number of days will be used too in calculating the default end date for the
- Holds to pull-report. But it does not interfere with issuing, renewing or
- transferring books.</para>
- </note>
- <important>
- <para>This preference is only looked at if you're allowing hold dates in the future
- with <link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link> or <link linkend="OPACAllowHoldDateInFuture">OPACAllowHoldDateInFuture</link></para>
- </important>
- </section>
- <section id="decreaseLoanHighHolds">
- <title><link linkend="decreaseLoanHighHolds">decreaseLoanHighHolds, decreaseLoanHighHoldsDuration, decreaseLoanHighHoldsValue,
- decreaseLoanHighHoldsControl, and decreaseLoanHighHoldsIgnoreStatuses </link></title>
- <para>Asks: ___ the reduction of loan period ___ to days for items with more than ___
- holds ___ . Ignore items with the following statuses when counting items ___</para>
- <para>decreaseLoanHighHolds default: Don't enable</para>
- <para>decreaseLoanHighHoldsControl default: on the record</para>
- <para>decreaseLoanHighHolds values:<itemizedlist>
- <para>Don't enable</para>
- <listitem>
- <para>Enable</para>
- </listitem>
- </itemizedlist></para>
- <para>decreaseLoanHighHoldsControl values:<itemizedlist>
- <listitem>
- <para>over the number of holdable items on the records</para>
- </listitem>
- <listitem>
- <para>on the record</para>
- </listitem>
- </itemizedlist></para>
- <para>decreaseLoanHighHoldsIgnoreStatuses values:<itemizedlist>
- <listitem>
- <para>[Select All]</para>
- </listitem>
- <listitem>
- <para>Damages</para>
- </listitem>
- <listitem>
- <para>Lost</para>
- </listitem>
- <listitem>
- <para>Not for loan</para>
- </listitem>
- <listitem>
- <para>Withdrawn</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>These preferences let you change the loan length for items that have many
- holds on them. This will not effect items that are already checked out, but
- items that are checked out after the decreaseLoanHighHoldsValue is met will only
- be checked out for the number of days entered in the
- decreaseLoanHighHoldsDuration preference.</para>
- <screenshot>
- <screeninfo>Warning on checkout</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/decreaseLoanHighHoldsDuration.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="DisplayMultiPlaceHold">
- <title><link linkend="DisplayMultiPlaceHold">DisplayMultiPlaceHold</link></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><link linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link></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 HOLDPLACED</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><link linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link></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><link linkend="ExpireReservesMaxPickUpDelayCharge">ExpireReservesMaxPickUpDelayCharge</link></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 running.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="ExpireReservesOnHolidays">
- <title><link linkend="ExpireReservesOnHolidays">ExpireReservesOnHolidays</link></title>
- <para>Default: Allow</para>
- <para>Asks: ___ expired holds to be cancelled on days the library is closed.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Allow</para>
- </listitem>
- <listitem>
- <para>Don't allow</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section label="" id="LocalHoldsPriority">
- <title><link linkend="LocalHoldsPriority">LocalHoldsPriority, LocalHoldsPriorityPatronControl,
- LocalHoldsPriorityItemControl</link></title>
- <para>Asks: ___ priority for filling holds to patrons whose ___ matches the item's
- ___</para>
- <para>LocalHoldsPriority Values:<itemizedlist>
- <listitem>
- <para>Don't give</para>
- </listitem>
- <listitem>
- <para>Give</para>
- </listitem>
- </itemizedlist></para>
- <para>LocalHoldsPriorityPatronControl Values:<itemizedlist>
- <listitem>
- <para>home library</para>
- </listitem>
- <listitem>
- <para>pickup library</para>
- </listitem>
- </itemizedlist></para>
- <para>LocalHoldsPriorityItemControl Values:<itemizedlist>
- <listitem>
- <para>holding library</para>
- </listitem>
- <listitem>
- <para>home library</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This feature will allow libraries to specify that, when an item is returned,
- a local hold may be given priority for fulfillment even though it is of lower
- priority in the list of unfilled holds. </para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="maxreserves">
- <title><link linkend="maxreserves">maxreserves</link></title>
-
- <para>Default: 50</para>
-
- <para>Asks: Patrons can only have ___ holds at once.</para>
- </section>
-
- <section id="OPACAllowHoldDateInFuture">
- <title><link linkend="OPACAllowHoldDateInFuture">OPACAllowHoldDateInFuture</link></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><link linkend="OPACAllowUserToChooseBranch">OPACAllowUserToChooseBranch</link></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><link linkend="ReservesControlBranch">ReservesControlBranch</link></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><link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link></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><link linkend="ReservesNeedReturns">ReservesNeedReturns</link></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><link linkend="holdqueueweight">StaticHoldsQueueWeight, HoldsQueueSkipClosed
- & RandomizeHoldsQueueWeight</link></title>
-
- <para>StaticHoldsQueueWeight Default: 0</para>
- <para>HoldsQueueSkipClosed Default: open or closed</para>
-
- <para>RandomizeHoldsQueueWeight Default: in that order</para>
-
- <para>Asks: Satisfy holds using items from the libraries ___ (as branchcodes, separated
- by commas; if empty, uses all libraries) when they are ___ ___.</para>
- <para>HoldsQueueSkipClosed Values:<itemizedlist>
- <listitem>
- <para>open or closed</para>
- </listitem>
- <listitem>
- <para>open</para>
- </listitem>
- </itemizedlist></para>
-
- <para>RandomizeHoldsQueueWeight Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>in random order</para>
-
- <itemizedlist>
- <listitem>
- <para>If StaticHoldsQueueWeight is left at the default
- Koha will randomize all libraries, otherwise it will
- randomize the libraries listed.</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>in that order</para>
-
- <itemizedlist>
- <listitem>
- <para>If StaticHoldsQueueWeight is left at the default
- then this will use all of your branches in alphabetical
- order, otherwise it will use the branches in the order
- that you entered them in the StaticHoldsQueueWeight
- preference.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
-
- <para>Descriptions:</para>
-
- <itemizedlist>
- <listitem>
- <para>These preferences control how the <link linkend="holdsqueue">Holds Queue report</link> is generated
- using <link linkend="buildholdscron">a cron job</link>.</para>
-
- <para>If you do not want all of your libraries to participate
- in the on-shelf holds fulfillment process, you should list the
- the libraries that *do* participate in the process here by
- inputting all the participating library's branchcodes,
- separated by commas ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
-
- <para>By default, the holds queue will be generated such that
- the system will first attempt to hold fulfillment using items
- already at the pickup library if possible. If there are no
- items available at the pickup library to fill a hold,
- build_holds_queue.pl will then use the list of libraries
- defined in StaticHoldsQueueWeight. If
- RandomizeHoldsQueueWeight is disabled ( which it is by default
- ), the script will assign fulfillment requests in the order
- the branches are placed in the StaticHoldsQueueWeight system
- preference.</para>
-
- <para>For example, if your system has three libraries, of
- varying sizes ( small, medium and large ) and you want the
- burden of holds fulfillment to be on larger libraries before
- smaller libraries, you would want StaticHoldsQueueWeight to
- look something like "LRG,MED,SML".</para>
-
- <para>If you want the burden of holds fulfillment to be spread
- out equally throughout your library system, simply enable
- RandomizeHoldsQueueWeight. When this system preference is
- enabled, the order in which libraries will be requested to
- fulfill an on-shelf hold will be randomized each time the list
- is regenerated.</para>
-
- <para>Leaving StaticHoldsQueueWeight empty is contraindicated
- at this time. Doing so will cause the build_holds_queue script
- to ignore RandomizeHoldsQueueWeight, causing the script to
- request hold fulfillment not randomly, but by alphabetical
- order.</para>
- </listitem>
- </itemizedlist>
- <important>
- <para>The <link linkend="transportcostmatrix">Transport Cost Matrix</link> takes
- precedence in controlling where holds are filled from, if the matrix is not used
- then Koha checks the StaticHoldsQueueWeight. To use the Transport Cost Matrix
- simply set your <link linkend="UseTransportCostMatrix">UseTransportCostMatrix</link>
- preference to 'Use'</para>
- </important>
- </section>
-
- <section id="SuspendHoldsIntranet">
- <title><link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link></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 suspension 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><link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link></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 suspension 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 id="TransferWhenCancelAllWaitingHolds">
- <title><link linkend="TransferWhenCancelAllWaitingHolds">TransferWhenCancelAllWaitingHolds</link></title>
- <para>Default: Don't transfer</para>
- <para>Asks: ___ items when cancelling all waiting holds. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't transfer</para>
- </listitem>
- <listitem>
- <para>Transfer</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>When TransferWhenCancelAllWaitingHolds is set to "Don't transfer", no branch
- transfer records are created. Koha will not allow the holds to be transferred,
- because that would orphan the items at the library where the holds were awaiting
- pickup, without any further instruction to staff as to what items are at the
- library or where they need to go. When that system preference set to "Transfer",
- branch transfers are created, so the holds may be cancelled.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
-
- <section id="circinterfaceprefs">
- <title><link linkend="circinterfaceprefs">Interface</link></title>
-
- <para/>
-
- <section id="AllowAllMessageDeletion">
- <title><link linkend="AllowAllMessageDeletion">AllowAllMessageDeletion</link></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="AllowOfflineCirculation">
- <title><link linkend="AllowOfflineCirculation">AllowOfflineCirculation</link></title>
- <para>Default: Do not enable</para>
- <para>Asks: ___ offline circulation on regular circulation computers. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Do not enable</para>
- </listitem>
- <listitem>
- <para>Enable</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>Setting this preference to 'Enable' allows you to use the Koha interface for
- <link linkend="offlinecirc">offline circulation</link>. This system preference
- does not affect the <link linkend="firefoxofflinecirc">Firefox plugin</link> or
- the <link linkend="windowsofflinecirc">desktop application</link>, any of these
- three options can be used for offline circulation without effecting the
- other.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="AudioAlerts">
- <title><link linkend="AudioAlerts">AudioAlerts</link></title>
- <para>Default: Don't enable</para>
- <para>Asks: ___ audio alerts for events defined in the audio alerts section of
- administration.</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="CircAutocompl">
- <title><link linkend="CircAutocompl">CircAutocompl</link></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><link linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link></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>
- <listitem>
- <para>open a print slip window</para>
- </listitem>
- </itemizedlist>
-
- <para>Description:</para>
-
- <itemizedlist>
- <listitem>
- <para>If this preference is set to open a quick slip (<link linkend="existingnotices">ISSUEQSLIP</link>) or open a slip (<link linkend="existingnotices">ISSUESLIP</link>) 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><link linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link></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><link linkend="FineNotifyAtCheckin">FineNotifyAtCheckin</link></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><link linkend="DisplayClearScreenButton">DisplayClearScreenButton</link></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="ExportRemoveFields">
- <title><link linkend="ExportRemoveFields">ExportRemoveFields</link></title>
- <para>Asks: The following fields should be excluded from the patron checkout history CSV
- or iso2709 export ___ </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This space separated list of fields (e.g. 100a 245b) will automatically be
- excluded when exporting the patron's current checkout history.</para>
- <screenshot>
- <screeninfo>ExportRemoveFields</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/ExportRemoveFields.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="ExportWithCsvProfile">
- <title><link linkend="ExportWithCsvProfile">ExportWithCsvProfile</link></title>
- <para>Asks: Use the ___ CSV profile when exporting patron checkout history</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>Use this preference to define which <link linkend="csvprofiles">CSV
- profile</link> should be used when exporting patron's current checkout data.
- Enter the CSV Profile name as the value for this preference. If this preference
- is left blank you will not be able to export the patron's current checkout
- summary.</para>
- <screenshot>
- <screeninfo>ExportWithCsvProfile</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/ExportWithCsvProfile.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="HoldsToPullStartDate">
- <title><link linkend="HoldsToPullStartDate">HoldsToPullStartDate</link></title>
- <para>Default: 2</para>
- <para>Asks: Set the default start date for the Holds to pull list to ___ day(s) ago. </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>The <link linkend="holdspull">Holds to Pull</link> report in circulation
- defaults to filtering holds placed 2 days ago. This preference allows you to set
- this default filter to any number of days.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="itemBarcodeFallbackSearch">
- <title><link linkend="itemBarcodeFallbackSearch">itemBarcodeFallbackSearch</link></title>
- <para>Default: Don't enable</para>
- <para>Asks: ___ the automatic use of a keyword catalog search if the phrase entered as
- a barcode on the checkout page does not turn up any results during an item barcode
- search. </para>
- <para>Values:</para>
- <itemizedlist>
- <listitem>
- <para>Don't enable</para>
- </listitem>
- <listitem>
- <para>Enable</para>
- <screenshot>
- <screeninfo>Checkout by keyword</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/itemBarcodeFallbackSearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- <para>Description:<itemizedlist>
- <listitem>
- <para>Sometimes libraries want to checkout using something other than the barcode.
- Enabling this preference will do a keyword search of Koha to find the item
- you're trying to check out. You can use the call number, barcode, part of the
- title or anything you'd enter in the keyword search when this preference is
- enabled and Koha will ask you which item you're trying to check out.</para>
- </listitem>
- </itemizedlist></para>
- <important>
- <para>While you're not searching by barcode a barcode is required on every title you
- check out. Only titles with barcodes will appear in the search results.</para>
- </important>
- </section>
-
- <section id="itemBarcodeInputFilter">
- <title><link linkend="itemBarcodeInputFilter">itemBarcodeInputFilter</link></title>
-
- <para>Default: Don't filter</para>
-
- <para>Asks: ___ scanned item barcodes.</para>
-
- <para>Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>Convert from CueCat format</para>
- </listitem>
-
- <listitem>
- <para>Convert from Libsuite8 form</para>
- </listitem>
-
- <listitem>
- <para>Don't filter</para>
- </listitem>
-
- <listitem>
- <para>EAN-13 or zero-padded UPC-A from</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><link linkend="NoticeCSS">NoticeCSS</link></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><link linkend="numReturnedItemsToShow">numReturnedItemsToShow</link></title>
-
- <para>Default: 20</para>
-
- <para>Asks : Show the ___ last returned items on the checkin
- screen.</para>
- </section>
-
- <section id="previousIssuesDefaultSortOrder">
- <title><link linkend="previousIssuesDefaultSortOrder">previousIssuesDefaultSortOrder</link></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><link linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link></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="ShowAllCheckins">
- <title><link linkend="ShowAllCheckins">ShowAllCheckins</link></title>
- <para>Default: Do not show</para>
- <para>Asks: ___ all items in the "Checked-in items" list, even items that were not
- checked out.</para>
- <para>Values: <itemizedlist>
- <listitem>
- <para>Do not show</para>
- </listitem>
- <listitem>
- <para>Show</para>
- </listitem>
- </itemizedlist>Description:<itemizedlist>
- <listitem>
- <para>When items that are not currently checked out are checked in they don't show
- on the list of checked in items. This preference allows you to choose how you'd
- like the log of checked in items displays.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="SpecifyDueDate">
- <title><link linkend="SpecifyDueDate">SpecifyDueDate</link></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>
-
- <screenshot>
- <screeninfo>Specify Due Date Box Shows</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/SpecifyDueDate.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>Don't allow</para>
-
- <screenshot>
- <screeninfo>Specify Due Date Box Doesn't Show</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/SpecifyDueDate-no.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- </section>
- <section id="SpecifyReturnDate">
- <title><link linkend="SpecifyReturnDate">SpecifyReturnDate</link></title>
- <para>Default: Don't allow</para>
- <para>Asks: ___ staff to specify a return date for a check in.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Allow<screenshot>
- <screeninfo>Allow return date edits</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/SpecifyReturnDate.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- <listitem>
- <para>Don't allow<screenshot>
- <screeninfo>Don't allow return date edits</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/SpecifyReturnDate-no.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference lets you decide if staff can specify an arbitrary return
- date when checking in items.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="todaysIssuesDefaultSortOrder">
- <title><link linkend="todaysIssuesDefaultSortOrder">todaysIssuesDefaultSortOrder</link></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="UpdateTotalIssuesOnCirc">
- <title><link linkend="UpdateTotalIssuesOnCirc">UpdateTotalIssuesOnCirc</link></title>
-
- <para>Default: Do not</para>
-
- <para>Asks: ___ update a bibliographic record's total issues count
- whenever an item is issued</para>
-
- <para>Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>Do<important>
- <para>This increases server load significantly; if
- performance is a concern, use the <link linkend="updateissuescron">cron job</link> to update the
- total issues count instead.</para>
- </important></para>
- </listitem>
-
- <listitem>
- <para>Do not</para>
- </listitem>
- </itemizedlist>
-
- <para>Description:</para>
-
- <itemizedlist>
- <listitem>
- <para>Koha can track the number of times and item is checked
- out and store that on the item record in the database. This
- information is not stored by default. Setting this preference
- to 'Do' will tell Koha to track that info everytime the item
- is checked out in real time. Otherwise you could use the <link linkend="updateissuescron">cron job</link> to have Koha update
- that field nightly.</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="WaitingNotifyAtCheckin">
- <title><link linkend="WaitingNotifyAtCheckin">WaitingNotifyAtCheckin</link></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><link linkend="circscoprefs">Self Checkout</link></title>
-
- <para/>
-
- <section id="AllowSelfCheckReturns">
- <title><link linkend="AllowSelfCheckReturns">AllowSelfCheckReturns</link></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><link linkend="AutoSelfCheckAllowed">AutoSelfCheckAllowed, AutoSelfCheckID &
- AutoSelfCheckPass</link></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 Value:<itemizedlist>
- <listitem>
- <para>The username of a staff patron with 'circulate' <link linkend="patronpermissions">permissions</link>.</para>
- </listitem>
- </itemizedlist></para>
-
- <para>AutoSelfCheckPass Value:<itemizedlist>
- <listitem>
- <para>The password of a staff patron with 'circulate' <link linkend="patronpermissions">permissions</link>.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="SCOUserCSS">
- <title><link linkend="SCOUserCSS">SCOUserCSS</link></title>
- <para>Asks: Include the following CSS on all pages in the web-based self checkout</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>The CSS entered in this preference will be used on all of your Koha self
- checkout screens.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="SCOUserJS">
- <title><link linkend="SCOUserJS">SCOUserJS</link></title>
- <para>Asks: Include the following JavaScript on all pages in the web-based self
- checkout</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>The JavaScript entered in this preference will effect all of your Koha self
- checkout screens.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="SelfCheckHelpMessage">
- <title><link linkend="SelfCheckHelpMessage">SelfCheckHelpMessage</link></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><link linkend="SelfCheckoutByLogin">SelfCheckoutByLogin</link></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="SelfCheckReceiptPrompt">
- <title><link linkend="SelfCheckReceiptPrompt">SelfCheckReceiptPrompt</link></title>
- <para>Default: Show</para>
- <para>Asks: ___ the print receipt popup dialog when self checkout is finished.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't show</para>
- </listitem>
- <listitem>
- <para>Show</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference controls whether a prompt shows up on the web based self
- check out when the patron clicks the 'Finish' button.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="SelfCheckTimeout">
- <title><link linkend="SelfCheckTimeout">SelfCheckTimeout</link></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><link linkend="ShowPatronImageInWebBasedSelfCheck">ShowPatronImageInWebBasedSelfCheck</link></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><link linkend="WebBasedSelfCheck">WebBasedSelfCheck</link></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="enhancedcontent">
- <title><link linkend="enhancedcontent">Enhanced Content</link></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>
-
- <note>
- <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>
- </note>
-
- <section id="frbrenhancedprefs">
- <title><link linkend="frbrenhancedprefs">All</link></title>
-
- <para/>
-
- <section id="FRBRizeEditions">
- <title><link linkend="FRBRizeEditions">FRBRizeEditions</link></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> and/or <link linkend="XISBN">XISBN</link>). This option is only for the Staff Client; the <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> option must be enabled
- 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 (<link linkend="ThingISBN">ThingISBN</link> and/or <link linkend="XISBN">XISBN</link>)</para>
- </important>
- </section>
-
- <section id="OPACFRBRizeEditions">
- <title><link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link></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> and/or <link linkend="XISBN">XISBN</link>). This option is only for the OPAC; the <link linkend="FRBRizeEditions">FRBRizeEditions</link> option must be turned "On" to
- 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 (<link linkend="ThingISBN">ThingISBN</link> and/or <link linkend="XISBN">XISBN</link>)</para>
- </important>
- </section>
- </section>
-
- <section id="amazonprefs">
- <title><link linkend="amazonprefs">Amazon</link></title>
-
- <para/>
-
- <section id="AmazonAssocTag">
- <title><link linkend="AmazonAssocTag">AmazonAssocTag</link></title>
-
- <para>Asks: Put the associate tag ___ on links to Amazon.</para>
-
- <note>
- <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>
- </note>
-
- <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><link linkend="AmazonCoverImages">AmazonCoverImages</link></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. 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. 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>
- </section>
-
- <section id="AmazonLocale">
- <title><link linkend="AmazonLocale">AmazonLocale</link></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="OPACAmazonCoverImages">
- <title><link linkend="OPACAmazonCoverImages">OPACAmazonCoverImages</link></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. 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. 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>
- </section>
- </section>
-
- <section id="Babelthequeprefs">
- <title><link linkend="Babelthequeprefs">Babelthèque</link></title>
-
- <para/>
-
- <section id="Babeltheque">
- <title><link linkend="Babeltheque">Babeltheque</link></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><link linkend="Babeltheque_url_js">Babeltheque_url_js</link></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><link linkend="Babeltheque_url_update">Babeltheque_url_update</link></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><link linkend="btcontentprefs">Baker & Taylor</link></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><link linkend="BakerTaylorEnabled">BakerTaylorEnabled</link></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><link linkend="BakerTaylorBookstoreURL">BakerTaylorBookstoreURL</link></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>
-
- <note>
- <para>Leave it blank to disable these links.</para>
- </note>
-
- <important>
- <para>Be sure to get this information from Baker & Taylor
- when subscribing.</para>
- </important>
- </section>
-
- <section id="btuserpass">
- <title><link linkend="btuserpass">BakerTaylorUsername & BakerTaylorPassword</link></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="coceimages">
- <title><link linkend="coceimages">Coce Cover images cache</link></title>
- <para>Coce is a remote image URL cache. With this option, cover images are not fetched
- directly from Amazon, Google, and so on. Their URLs are requested via a web service to
- Coce which manages a cache of URLs. </para>
- <section id="Coce">
- <title><link linkend="Coce">Coce</link></title>
- <para>Default: Don't enable</para>
- <para>Asks: ___ a Coce image cache service.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't enable</para>
- </listitem>
- <listitem>
- <para>Enable</para>
- </listitem>
- </itemizedlist></para>
- <para>Description: <itemizedlist>
- <listitem>
- <para>Coce has many benefits when it comes to choosing and displaying cover images
- in Koha:<itemizedlist>
- <listitem>
- <para>If a book cover is not available from a provider, but is available
- from another one, Koha will be able to display a book cover, which isn't
- the case now </para>
- </listitem>
- <listitem>
- <para>Since URLs are cached, it isn't necessary for each book cover to
- request, again and again, the provider, and several of them if necessary.
- </para>
- </listitem>
- <listitem>
- <para>Amazon book covers are retrieved with Amazon Product Advertising API,
- which means that more covers are retrieved (ISBN13).</para>
- </listitem>
- </itemizedlist><important>
- <para>Coce does not come bundled with Koha. Your Koha install with not already
- have a Coce server set up. Before enabling this functionality you will want
- to be sure to have a Coce server set up. Instructions on installing and
- setting up Coce can be found on the official github page at <ulink url="https://github.com/fredericd/coce">https://github.com/fredericd/coce</ulink>.</para>
- </important></para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="CoceHost">
- <title><link linkend="CoceHost">CoceHost</link></title>
- <para>Asks: Coce server URL ___</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This will be the full URL (starting with http://) to your Coce server.
- </para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="CoceProviders">
- <title><link linkend="CoceProviders">CoceProviders</link></title>
- <para>Asks: Use the following providers to fetch the covers ___</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>[Select all]</para>
- </listitem>
- <listitem>
- <para>Amazon Web Services</para>
- </listitem>
- <listitem>
- <para>Google Books</para>
- </listitem>
- <listitem>
- <para>Open Library</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>The providers chosen here will be used to gather cover images for display in
- your Koha catalog.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
-
- <section id="googleprefs">
- <title><link linkend="googleprefs">Google</link></title>
-
- <para/>
-
- <section id="GoogleJackets">
- <title><link linkend="GoogleJackets">GoogleJackets</link></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="html5">
- <title><link linkend="html5">HTML5 Media</link></title>
- <section id="HTML5MediaEnabled">
- <title><link linkend="HTML5MediaEnabled">HTML5MediaEnabled</link></title>
- <para>Default: not at all</para>
- <para>Asks: Show a tab with a HTML5 media player for files catalogued in field 856
- ___</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>in OPAC and staff client</para>
- </listitem>
- <listitem>
- <para>in the OPAC</para>
- <screenshot>
- <screeninfo>HTML5 Media in the OPAC</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/HTML5MediaEnabled-opac.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>in the staff client</para>
- <screenshot>
- <screeninfo>HTML5 Media in the staff client</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/HTML5MediaEnabled-staff.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>not at all</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>If you have media elements in the 856 of your MARC record this preference
- can run/show those media files in a separate tab using HTML5.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="HTML5MediaExtensions">
- <title><link linkend="HTML5MediaExtensions">HTML5MediaExtensions</link></title>
- <para>Default: webm|ogg|ogv|oga|vtt</para>
- <para>Asks: Media file extensions ___</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>Enter in file extensions separated with bar (|)</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- <section id="HTML5MediaYouTube">
- <title><link linkend="HTML5MediaYouTube">HTML5MediaYouTube</link></title>
- <para>Default: Don't embed</para>
- <para><important>
- <para>To turn this on first enable <link linkend="HTML5MediaEnabled">HTML5MediaEnabled</link></para>
- </important>Asks: ___ YouTube links as videos.</para>
- <para>Values: <itemizedlist>
- <listitem>
- <para>Don't embed</para>
- </listitem>
- <listitem>
- <para>Embed</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference will allow MARC21 856$u that points to YouTube to appear as a
- playable video on the pages defined in <link linkend="HTML5MediaEnabled">HTML5MediaEnabled</link>.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="IDreamLibraries">
- <title><link linkend="IDreamLibraries">IDreamLibraries</link></title>
- <para><ulink url="http://idreambooks.com/">IDreamBooks.com</ulink> aggregates book reviews
- by critics to help you discover the very best of what's coming out each week. These
- preferences let you integrated content from <ulink url="http://IDreamBooks.com">IDreamBooks.com</ulink> in to your Koha OPAC. <note>
- <para>This is a new website and has limited content, so you may only see these
- features on new popular titles until the database grows some more.</para>
- </note></para>
- <section id="IDreamBooksReadometer">
- <title><link linkend="IDreamBooksReadometer">IDreamBooksReadometer</link></title>
- <para>Default: Don't add</para>
- <para>Asks: ___ a "Readometer" that summarizes the reviews gathered by IDreamBooks.com
- to the OPAC details page. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Add</para>
- <screenshot>
- <screeninfo>Readometer on the details page</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/IDreamBooksReadometer.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Don't add</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="IDreamBooksResults">
- <title><link linkend="IDreamBooksResults">IDreamBooksResults</link></title>
- <para>Default: Don't add</para>
- <para>Asks: ___ the rating from IDreamBooks.com to OPAC search results. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Add</para>
- <screenshot>
- <screeninfo>iDreamBooks rating on search results</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/IDreamBooksResults.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Don't add</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="IDreamBooksReviews">
- <title><link linkend="IDreamBooksReviews">IDreamBooksReviews</link></title>
- <para>Default: Don't add</para>
- <para>Asks: ___ a tab on the OPAC details with book reviews from critics aggregated by
- IDreamBooks.com. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Add</para>
- <screenshot>
- <screeninfo>Reviews tab on the detail page</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/IDreamBooksReviews.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Don't add</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
-
- <section id="librarythingprefs">
- <title><link linkend="librarythingprefs">LibraryThing</link></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="LibraryThingForLibrariesEnabled">
- <title><link linkend="LibraryThingForLibrariesEnabled">LibraryThingForLibrariesEnabled</link></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><link linkend="LibraryThingForLibrariesID">LibraryThingForLibrariesID</link></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><link linkend="LibraryThingForLibrariesTabbedView">LibraryThingForLibrariesTabbedView</link></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 id="ThingISBN">
- <title><link linkend="ThingISBN">ThingISBN</link></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>
-
- <section id="localimages">
- <title><link linkend="localimages">Local Cover Images</link></title>
-
- <para/>
-
- <section id="AllowMultipleCovers">
- <title><link linkend="AllowMultipleCovers">AllowMultipleCovers</link></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><link linkend="LocalCoverImages">LocalCoverImages</link></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><link linkend="OPACLocalCoverImages">OPACLocalCoverImages</link></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><link linkend="novelistselect">Novelist Select</link></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 or you can contract with Ebsco to get access to the <link linkend="btcontentprefs">Baker & Taylor Content Cafe</link> for an added
- fee.</para>
- </important></para>
-
- <section id="NovelistSelectEnabled">
- <title><link linkend="NovelistSelectEnabled">NovelistSelectEnabled</link></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><link linkend="NovelistSelectProfile">NovelistSelectProfile & NovelistSelectPassword</link></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><link linkend="NovelistSelectView">NovelistSelectView</link></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><link linkend="oclcprefs">OCLC</link></title>
-
- <para/>
-
- <section id="XISBN">
- <title><link linkend="XISBN">XISBN</link></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><link linkend="OCLCAffiliateID">OCLCAffiliateID</link></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><link linkend="XISBNDailyLimit">XISBNDailyLimit</link></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><link linkend="OpenLibraryPrefs">Open Library</link></title>
-
- <section id="OpenLibraryCovers">
- <title><link linkend="OpenLibraryCovers">OpenLibraryCovers</link></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 id="OpenLibrarySearch">
- <title><link linkend="OpenLibrarySearch">OpenLibrarySearch</link></title>
- <para>Default: Don't show</para>
- <para>Asks: ___ search results from Open Library on the OPAC. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't show</para>
- </listitem>
- <listitem>
- <para>Show<screenshot>
- <screeninfo>Open Library results</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OpenLibrarySearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- <section id="overdriveprefs">
- <title><link linkend="overdriveprefs">Overdrive</link></title>
- <para>OverDrive is an pay service. You must first contact OverDrive directly for pricing
- and subscription information. Enabling this service will integrate Overdrive results in
- to your OPAC searches. You will have to apply for these 3 pieces of information through
- an application as an API developer. Overdrive API applications are evaluated once a week
- so you may not be able to use this feature immediately after signing up. To learn more
- please contact your OverDrive representative.</para>
- <screenshot>
- <screeninfo>Overdrive results</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/Overdrive.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <section id="OverDriveClientKey">
- <title><link linkend="OverDriveClientKey">OverDriveClientKey and OverDriveClientSecret</link></title>
- <para>Asks: Include OverDrive availability information with the client key __ and client
- secret ___</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>OverDrive customers can get this information by visiting the <ulink url="https://developer.overdrive.com/docs/getting-started">OverDrive Developer
- Portal</ulink> and following the instructions found there to apply as an API
- developer. Once this data and the <link linkend="OverDriveLibraryID">OverDriveLibraryID</link> are populated you will see OverDrive results on
- your OPAC searches.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="OverDriveLibraryID">
- <title><link linkend="OverDriveLibraryID">OverDriveLibraryID</link></title>
- <para>Asks: Show items from the OverDrive catalog of library # ___</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>OverDrive customers can get this information by visiting the <ulink url="https://developer.overdrive.com/docs/getting-started">OverDrive Developer
- Portal</ulink> and following the instructions found there to apply as an API
- developer. Once this data and the <link linkend="OverDriveClientKey">OverDriveClientKey and OverDriveClientSecret</link> are populated you will
- see OverDrive results on your OPAC searches.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- <section id="pluginprefs">
- <title><link linkend="pluginprefs">Plugins</link></title>
- <section id="UseKohaPlugins">
- <title><link linkend="UseKohaPlugins">UseKohaPlugins</link></title>
- <para>Default: Don't enable</para>
- <para>Asks: ___ the ability to use Koha Plugins.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't enable</para>
- </listitem>
- <listitem>
- <para>Enable</para>
- </listitem>
- </itemizedlist></para>
- <note>
- <para>The plugin system must also be enabled in the Koha configuration file to be
- fully enabled. Learn more in the <link linkend="pluginsystem">Plugins
- chapter</link>.</para>
- </note>
- </section>
- </section>
-
- <section id="Syndeticsprefs">
- <title><link linkend="Syndeticsprefs">Syndetics</link></title>
-
- <para>Syndetics is a pay service. You must first contact Syndetics
- directly for pricing and subscription information.</para>
-
- <section id="SyndeticsEnabled">
- <title><link linkend="SyndeticsEnabled">SyndeticsEnabled</link></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><link linkend="SyndeticsClientCode">SyndeticsClientCode</link></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><link linkend="SyndeticsCoverImages">SyndeticsCoverImages & SyndeticsCoverImageSize</link></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><link linkend="SyndeticsAuthorNotes">SyndeticsAuthorNotes</link></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><link linkend="SyndeticsAwards">SyndeticsAwards</link></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><link linkend="SyndeticsEditions">SyndeticsEditions</link></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><link linkend="SyndeticsExcerpt">SyndeticsExcerpt</link></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><link linkend="SyndeticsReviews">SyndeticsReviews</link></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><link linkend="SyndeticsSeries">SyndeticsSeries</link></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><link linkend="SyndeticsSummary">SyndeticsSummary</link></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><link linkend="SyndeticsTOC">SyndeticsTOC</link></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><link linkend="taggingprefs">Tagging</link></title>
-
- <section id="TagsEnabled">
- <title><link linkend="TagsEnabled">TagsEnabled</link></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><link linkend="TagsModeration">TagsModeration</link></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><link linkend="TagsShowOnList">TagsShowOnList</link></title>
-
- <para>Default: 6</para>
-
- <para>Asks: Show ___ tags on search results on the OPAC.</para>
-
- <note>
- <para>Set the value to 0 (zero) to turn this feature off.</para>
- </note>
- </section>
-
- <section id="TagsInputOnList">
- <title><link linkend="TagsInputOnList">TagsInputOnList</link></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><link linkend="TagsShowOnDetail">TagsShowOnDetail</link></title>
-
- <para>Default: 10</para>
-
- <para>Asks: Show ___ tags on item detail pages on the OPAC.</para>
-
- <note>
- <para>Set the value to 0 (zero) to turn this feature off.</para>
- </note>
- </section>
-
- <section id="TagsInputOnDetail">
- <title><link linkend="TagsInputOnDetail">TagsInputOnDetail</link></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><link linkend="TagsExternalDictionary">TagsExternalDictionary</link></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><link linkend="l18nprefs">I18N/L10N</link></title>
-
- <para>These preferences control your Internationalization and Localization
- settings.</para>
-
- <para><emphasis>Get there:</emphasis> More > Administration >
- Global System Preferences > I18N/L10N</para>
- <section id="AddressFormat">
- <title><link linkend="AddressFormat">AddressFormat</link></title>
- <para>Default: US style ([Street number], [Address] - [City], [Zip/Postal Code],
- [Country])</para>
- <para>Asks: Format postal addresses using ___</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>German style ([Address] [Street number] - [Zip/Postal Code] [City] -
- [Country]) </para>
- </listitem>
- <listitem>
- <para>US style ([Street number], [Address] - [City], [Zip/Postal Code],
- [Country])</para>
- </listitem>
- </itemizedlist>Description:<itemizedlist>
- <listitem>
- <para>This preference will let you control how Koha displays patron addresses given
- the information entered in the various fields on their record.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="alphabet">
- <title><link linkend="alphabet">alphabet</link></title>
- <para>Default: A B C D E F G H I J K L M N O P Q R S T U V W X Y Z</para>
- <para>Asks: Use the alphabet ___ for lists of browsable letters. This should be a space
- separated list of uppercase letters. </para>
- <para>Description:</para>
- <itemizedlist>
- <listitem>
- <para>This preference allows you define your own alphabet for browsing patrons in Koha.</para>
- <screenshot>
- <screeninfo>Alphabet browse on patron module</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/alphabet.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="CalendarFirstDayOfWeek">
- <title><link linkend="CalendarFirstDayOfWeek">CalendarFirstDayOfWeek</link></title>
-
- <para>Default: Sunday</para>
-
- <para>Asks: Use ___ as the first day of week in the calendar.</para>
-
- <para>Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>Sunday</para>
- </listitem>
- <listitem>
- <para>Monday</para>
- </listitem>
-
- <listitem>
- <para>Tuesday</para>
- </listitem>
- <listitem>
- <para>Wednesday</para>
- </listitem>
- <listitem>
- <para>Thursday</para>
- </listitem>
- <listitem>
- <para>Friday</para>
- </listitem>
- <listitem>
- <para>Saturday</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><link linkend="dateformat">dateformat</link></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>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><link linkend="languagepref">language</link></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 please refer to <ulink url="http://wiki.koha-community.org/wiki/Installation_of_additional_languages_for_OPAC_and_INTRANET_staff_client">http://wiki.koha-community.org/wiki/Installation_of_additional_languages_for_OPAC_and_INTRANET_staff_client</ulink>
- </para>
- </section>
-
- <section id="opaclanguages">
- <title><link linkend="opaclanguages">opaclanguages</link></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>
- <note>
- <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 install-code.pl
- fr-FR 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>
- </note>
- </section>
-
- <section id="opaclanguagesdisplay">
- <title><link linkend="opaclanguagesdisplay">opaclanguagesdisplay</link></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<itemizedlist>
- <listitem>
- <para>Patrons can choose their language from a list at the bottom of the public
- catalog</para>
-
- <screenshot>
- <screeninfo>Language selector in OPAC</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/opaclanguagesdisplay.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist></para>
-
-
- </listitem>
-
- <listitem>
- <para>Don't allow<itemizedlist>
- <listitem>
- <para>The public catalog will not give an option to choose a language</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- <para>Description:<itemizedlist>
- <listitem>
- <para>Using the <link linkend="OpacLangSelectorMode">OpacLangSelectorMode</link>
- preference you can decide where these language options will appear in the public
- catalog.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="TimeFormat">
- <title><link linkend="TimeFormat">TimeFormat</link></title>
- <para>Default: 24 hour format</para>
- <para>Asks: Format times in ___ </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>12 hour format (eg 02:18PM)</para>
- </listitem>
- <listitem>
- <para>24 hour format (eg 14:18)</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- <section id="labsprefs">
- <title><link linkend="labsprefs">Labs</link></title>
- <para><emphasis>Get there:</emphasis> More > Administration > Global System
- Preferences > Labs</para>
- <para>The preferences in this section are for experimental features that need additional
- testing and debugging.</para>
- <section id="EnableAdvancedCatalogingEditor">
- <title><link linkend="EnableAdvancedCatalogingEditor">EnableAdvancedCatalogingEditor</link></title>
- <para>Default: Don't enable</para>
- <para>Asks: ___ the advanced cataloging editor.</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference will allow you to choose between a basic editor and a advanced
- editor for cataloging.</para>
- </listitem>
- </itemizedlist></para>
- <para>
- <important>
- <para>This feature is currently experimental, and may have bugs that cause corruption
- of records. It also does not include any support for UNIMARC or NORMARC fixed
- fields. Please help us test it and report any bugs, but do so at your own risk.
- </para>
- </important>
- </para>
- </section>
- </section>
-
- <section id="localprefs">
- <title><link linkend="localprefs">Local Use</link></title>
-
- <para>These preferences are defined
- locally.</para>
-
- <para><emphasis>Get there:</emphasis> More > Administration >
- Global System Preferences > Local Use<note>
- <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>
- </note></para>
- </section>
-
- <section id="logs">
- <title><link linkend="logs">Logs</link></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. Logs can then be viewed in the <link linkend="logviewer">Log Viewer</link> under Tools.</para>
-
- <para><emphasis>Get there:</emphasis> More > Administration >
- Global System Preferences > Logs</para>
- <section id="debuggingprefs">
- <title><link linkend="debuggingprefs">Debugging</link></title>
- <section id="DumpTemplateVarsIntranet">
- <title><link linkend="DumpTemplateVarsIntranet">DumpTemplateVarsIntranet</link></title>
- <para>Default: Don't</para>
- <para>Asks: ___ dump all Template Toolkit variable to a comment in the html source for
- the staff intranet. </para>
- <para>Value: <itemizedlist>
- <listitem>
- <para>Don't </para>
- </listitem>
- <listitem>
- <para>Do</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="DumpTemplateVarsOpac">
- <title><link linkend="DumpTemplateVarsOpac">DumpTemplateVarsOpac</link></title>
- <para>Default: Don't</para>
- <para>Asks: ___ dump all Template Toolkit variable to a comment in the html source for
- the OPAC. </para>
- <para>Value: <itemizedlist>
- <listitem>
- <para>Don't </para>
- </listitem>
- <listitem>
- <para>Do</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- <section id="loggingprefs">
- <title><link linkend="loggingprefs">Logging</link></title>
- <section id="AuthoritiesLog">
- <title><link linkend="AuthoritiesLog">AuthoritiesLog</link></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><link linkend="BorrowersLog">BorrowersLog</link></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><link linkend="CataloguingLog">CataloguingLog</link></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="CronjobLog">
- <title><link linkend="CronjobLog">CronjobLog</link></title>
- <para>Default: Don't log</para>
- <para>Asks: ___ information from cron jobs. </para>
- <para>Values:</para>
- <itemizedlist>
- <listitem>
- <para>Don't log</para>
- </listitem>
- <listitem>
- <para>Log</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="FinesLog">
- <title><link linkend="FinesLog">FinesLog</link></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><link linkend="IssueLog">IssueLog</link></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><link linkend="LetterLog">LetterLog</link></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>
- <note>
- <para>This log tracks all notices that go to patrons including the overdue
- notices.</para>
- </note>
- </section>
- <section id="ReportsLog">
- <title><link linkend="ReportsLog">ReportsLog</link></title>
- <para>Default: Don't log</para>
- <para>Asks: ___ when reports 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 id="ReturnLog">
- <title><link linkend="ReturnLog">ReturnLog</link></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><link linkend="SubscriptionLog">SubscriptionLog</link></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>
-
- <section id="opacprefs">
- <title><link linkend="opacprefs">OPAC</link></title>
-
- <para><emphasis>Get there:</emphasis> More > Administration >
- Global System Preferences > OPAC</para>
- <section id="advancedsearchopt">
- <title><link linkend="advancedsearchopt">Advanced Search Options</link></title>
- <para/>
- <section id="OpacAdvSearchMoreOptions">
- <title><link linkend="OpacAdvSearchMoreOptions">OpacAdvSearchMoreOptions</link></title>
- <para>Default: Select All</para>
- <para>Asks: Show search options for the expanded view ___</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>[Select all]</para>
- </listitem>
- <listitem>
- <para>Item types</para>
- </listitem>
- <listitem>
- <para>Language</para>
- </listitem>
- <listitem>
- <para>Location and availability</para>
- </listitem>
- <listitem>
- <para>Publication date</para>
- </listitem>
- <listitem>
- <para>Sorting</para>
- </listitem>
- <listitem>
- <para>Subtypes</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>The settings in this preference will determine which search fields will show
- when the patron is using the 'More options' mode on the advanced search
- page.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="OpacAdvSearchOptions">
- <title><link linkend="OpacAdvSearchOptions">OpacAdvSearchOptions</link></title>
- <para>Default: Item types, Language, Location and availability, Publication date,
- Sorting</para>
- <para>Asks: Show search options ___ </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>[Select all]</para>
- </listitem>
- <listitem>
- <para>Item types</para>
- </listitem>
- <listitem>
- <para>Language</para>
- </listitem>
- <listitem>
- <para>Location and availability</para>
- </listitem>
- <listitem>
- <para>Publication date</para>
- </listitem>
- <listitem>
- <para>Sorting</para>
- </listitem>
- <listitem>
- <para>Subtypes</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>The settings in this preference will determine which search fields will show
- when the patron is using the 'Fewer options' mode on the advanced search
- page.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
-
- <section id="opacappearanceprefs">
- <title><link linkend="opacappearanceprefs">Appearance</link></title>
-
- <para>These preferences control how things appear in the
- OPAC.</para>
-
- <section id="AuthorisedValueImages">
- <title><link linkend="AuthorisedValueImages">AuthorisedValueImages</link></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><link linkend="BiblioDefaultView">BiblioDefaultView</link></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><link linkend="COinSinOPACResults">COinSinOPACResults</link></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><link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link></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><note>
- <para>See the <link linkend="XSLTiTypes">XSLT Icon
- Guide</link> for more information on these icons.</para>
- </note></para>
- </section>
-
- <section id="hidelostitems">
- <title><link linkend="hidelostitems">hidelostitems</link></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="HighlightOwnItemsOnOPAC">
- <title><link linkend="HighlightOwnItemsOnOPAC">HighlightOwnItemsOnOPAC & HighlightOwnItemsOnOPACWhich</link></title>
- <para>HighlightOwnItemsOnOPAC Default: Don't emphasize</para>
- <para>HighlightOwnItemsOnOPACWhich Default: patron's home library </para>
- <para>Asks: ___ results from the ___ by moving the results to the front and increasing
- the size or highlighting the rows for those results. </para>
- <para>HighlightOwnItemsOnOPAC Values:<itemizedlist>
- <listitem>
- <para>Don't emphasize</para>
- </listitem>
- <listitem>
- <para>Emphasize</para>
- </listitem>
- </itemizedlist></para>
- <para>HighlightOwnItemsOnOPACWhich Values:<itemizedlist>
- <listitem>
- <para>OPAC's branch based via the URL<itemizedlist>
- <listitem>
- <para>The library is chosen based on the Apache environment variable
- BRANCHCODE. For example, this could be added to the OPAC section of
- koha-httpd.conf: SetEnv BRANCHCODE "CPL"</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>patron's home library<itemizedlist>
- <listitem>
- <para>The items emphasized will be those of the same library as the patron's
- library. If no one is logged into the OPAC, no items will be
- highlighted.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist></para>
- <important>
- <para>This preference will only effect sites that are not using an XSLT stylesheet.
- XSLT stylesheets are defined in the <link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> and <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> preferences.</para>
- </important>
- </section>
- <section id="GoogleIndicTransliteration">
- <title><link linkend="GoogleIndicTransliteration">GoogleIndicTransliteration</link></title>
- <para>Default: Don't show</para>
- <para>Asks: ___ GoogleIndicTransliteration on the OPAC. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't show</para>
- </listitem>
- <listitem>
- <para>Show<screenshot>
- <screeninfo/>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/GoogleIndicTransliteration.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="LibraryName">
- <title><link linkend="LibraryName">LibraryName</link></title>
-
- <para>Asks: Show ___ as the name of the library on the
- OPAC.</para>
-
- <note>
- <para>This value will appear in the title bar of the
- browser</para>
- </note>
-
- <note>
- <para>Edit '<link linkend="opacheader">opacheader</link>' if
- you'd like to add a library name above your search box on the
- OPAC</para>
- </note>
-
- <screenshot>
- <screeninfo>Browser title and address bar</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/LibraryName.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- <section id="NoLoginInstructions">
- <title><link linkend="NoLoginInstructions">NoLoginInstructions</link></title>
- <para>Asks: Show the following HTML on the OPAC login form when a patron is not logged
- in: </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference allows you to override the default text seen on the log in
- page in the Koha OPAC. The default HTML
- is:<programlisting><h5>Don't have a password yet?</h5>
-<p> If you don't have a password yet, stop by the circulation desk the next time you're in the library. We'll happily set one up for you.</p>
-<h5>Don't have a library card?</h5>
-<p> If you don't have a library card, stop by your local library to sign up.</p></programlisting></para>
- <para>Any HTML in this box will replace the above text below the log in box.<screenshot>
- <screeninfo>No login instructions</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/NoLoginInstructions.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="OpacAddMastheadLibraryPulldown">
- <title><link linkend="OpacAddMastheadLibraryPulldown">OpacAddMastheadLibraryPulldown</link></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><link linkend="OPACBaseURL">OPACBaseURL</link></title>
-
- <para>Asks: The OPAC is located at ___</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference is looking for the URL of your public catalog (OPAC) with
- the http:// in front of it (enter http://www.mycatalog.com instead of
- www.mycatalog.com). Once it is filled in Koha will use it to generate permanent
- links in your RSS feeds, for your social network share buttons and in your staff
- client when generating links to bib records in the OPAC.</para>
- </listitem>
- </itemizedlist></para>
- <important>
- <para>Do not include a trailing slash in the URL this will break links created using
- this URL. (example: http://www.google.com not http://www.google.com/)</para>
- </important>
-
- <important>
- <para>This must be filled in with the URL of your public catalog for RSS, unAPI, and
- search plugins to work.</para>
- </important>
-
- <important>
- <para>This must be filled in with the URL of your public catalog 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="OpacAdditionalStylesheet">
- <title><link linkend="OpacAdditionalStylesheet">OpacAdditionalStylesheet</link></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>
- <note>
- <para>Leave this field blank to disable it</para>
- </note>
- <para>
- <note>
- <para>This file will add a linked CSS, not replace the existing default CSS.</para>
- </note>
- </para>
- </section>
-
- <section id="opaccredits">
- <title><link linkend="opaccredits">opaccredits</link></title>
-
- <para>Asks: Include the following HTML in the footer of all pages
- in the OPAC:</para>
-
- <note>
- <para>Click the 'Click to edit; link to enter HTML to appear at
- the bottom of every page in the OPAC</para>
- </note>
-
- <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="OpacCustomSearch">
- <title><link linkend="OpacCustomSearch">OpacCustomSearch</link></title>
- <para>Asks: Replace the search box at the top of OPAC pages with the following
- HTML</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference allows you to replace the default search box at the top of
- the OPAC : <screenshot>
- <screeninfo>Default search box</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OpacCustomSearch-default.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>with any HTML you would like :<screenshot>
- <screeninfo>Edited search box area</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OpacCustomSearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="OPACDisplay856uAsImage">
- <title><link linkend="OPACDisplay856uAsImage">OPACDisplay856uAsImage</link></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 have a value in it 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="OpacExportOptions">
- <title><link linkend="OpacExportOptions">OpacExportOptions</link></title>
-
- <para>Default: <screenshot>
- <screeninfo>Default OpacExportOptions options</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OpacExportOptions.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
-
- <para>Asks: List export options that should be available from OPAC detail page :
- ___</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="OPACFallback">
- <title><link linkend="OPACFallback">OPACFallback</link></title>
- <para>Default: bootstrap</para>
- <para>Asks: Use the ___ theme as the fallback theme on the OPAC. </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference has no use right now, as Koha has only one theme, but if
- your library has a custom theme it will show here as an option. The purpose of
- this preference is to provide a way to choose to what theme to fallback on when
- you have a partial theme in place.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="OpacFavicon">
- <title><link linkend="OpacFavicon">OpacFavicon</link></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>
-
- <note>
- <para>Turn your logo into a favicon with the <ulink url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
- </note>
-
- <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><link linkend="opacheader">opacheader</link></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>
-
- <note>
- <para>This value will appear above the main content of your
- page</para>
- </note>
-
- <screenshot>
- <screeninfo>OPAC display of the value from
- 'opacheader'</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/opacheader.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <note>
- <para>Edit '<link linkend="LibraryName">LibraryName</link>' if
- you'd like to edit the contents of the <title> tag</para>
- </note>
-
- <para>Learn more in the <link linkend="editableopac">OPAC Editable
- Regions</link> section.</para>
- </section>
-
- <section id="OpacHighlightedWords">
- <title><link linkend="OpacHighlightedWords">OpacHighlightedWords & NotHighlightedWords</link></title>
-
- <para>OpacHighlightedWords Default: Don't highlight</para>
- <para>NotHighlightedWords Default: and|or|not</para>
-
- <para>Asks: ___ words the patron searched for in their search results and detail pages;
- To prevent certain words from ever being highlighted, enter a list of stopwords here
- ___ (separate columns with |) </para>
-
- <para>OpacHighlightedWords Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>Don't highlight</para>
- </listitem>
-
- <listitem>
- <para>Highlight</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="OpacKohaUrl">
- <title><link linkend="OpacKohaUrl">OpacKohaUrl</link></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="OpacLangSelectorMode">
- <title><link linkend="OpacLangSelectorMode">OpacLangSelectorMode</link></title>
- <para>Default: only footer</para>
- <para>Asks: Display language selector on ___.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>both top and footer</para>
- </listitem>
- <listitem>
- <para>only footer</para>
- </listitem>
- <listitem>
- <para>top</para>
- </listitem>
- </itemizedlist>Description:<itemizedlist>
- <listitem>
- <para>If you have the <link linkend="opaclanguagesdisplay">opaclanguagesdisplay</link> preference set to display language options in the
- public catlaog, then this preference will allow you to control where the
- language selector shows. You can choose to show it only on the top or bottom or
- in both places.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="opaclayoutstylesheet">
- <title><link linkend="opaclayoutstylesheet">opaclayoutstylesheet</link></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. The
- stylesheets listed in the opaclayoutstylesheet preference are
- held on the Koha server.</para>
- </listitem>
- </itemizedlist>
-
- <note>
- <para>Leave this field blank to disable it and let Koha use the
- default file instead</para>
- </note>
- <important>
- <para>Using a custom value in this preference causes Koha to completely ignore the
- default layout stylesheet.</para>
- </important>
- </section>
- <section id="OpacLocationBranchToDisplay">
- <title><link linkend="OpacLocationBranchToDisplay">OpacLocationBranchToDisplay</link></title>
- <para>Default: holding library</para>
- <para>Asks: Display the ___ for items on the OPAC record details page. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>holding library</para>
- </listitem>
- <listitem>
- <para>home and holding library</para>
- </listitem>
- <listitem>
- <para>home library</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>Defines whether to display the holding library, the home library, or both
- for the opac details page.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="OpacLocationBranchToDisplayShelving">
- <title><link linkend="OpacLocationBranchToDisplayShelving">OpacLocationBranchToDisplayShelving</link></title>
- <para>Default: holding library</para>
- <para>Asks: Display the shelving location under the ___ for items on the OPAC record
- details page. </para>
- <para>Values:</para>
- <itemizedlist>
- <listitem>
- <para>holding library</para>
- </listitem>
- <listitem>
- <para>home and holding library</para>
- </listitem>
- <listitem>
- <para>home library</para>
- </listitem>
- </itemizedlist>
- <para>Description:<itemizedlist>
- <listitem>
- <para>Defines where the shelving location should be displayed, under the home
- library, the holding library, or both.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="OpacMaintenance">
- <title><link linkend="OpacMaintenance">OpacMaintenance</link></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. The default message can be
- altered by using the <link linkend="OpacMaintenanceNotice">OpacMaintenanceNotice</link> preference.</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="OpacMaintenanceNotice">
- <title><link linkend="OpacMaintenanceNotice">OpacMaintenanceNotice</link></title>
- <para>Asks: Show the following HTML when OpacMaintenance is enabled</para>
- <para>Descritpion:<itemizedlist>
- <listitem>
- <para>This preference will allow you to set the text the OPAC displays when the
- <link linkend="OpacMaintenance">OpacMaintenance</link> preference is set to
- 'Show.'</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="OpacMainUserBlock">
- <title><link linkend="OpacMainUserBlock">OpacMainUserBlock</link></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>Description: </para>
- <itemizedlist>
- <listitem>
- <para>HTML entered in this field will appear in the center of the main page of your
- OPAC</para>
- </listitem>
- </itemizedlist>
-
- <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="OpacMaxItemsToDisplay">
- <title><link linkend="OpacMaxItemsToDisplay">OpacMaxItemsToDisplay</link></title>
- <para>Default: 50</para>
- <para>Asks: Display up to ___ items on the biblio detail page </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference will help with slow load times on the bibliographic detail
- pages by limiting the number of items to display by default. If the biblio has
- more items than this, a link is displayed instead that allows the user to choose
- to display all items.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="OPACMySummaryHTML">
- <title><link linkend="OPACMySummaryHTML">OPACMySummaryHTML</link></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="OPACMySummaryNote">
- <title><link linkend="OPACMySummaryNote">OPACMySummaryNote</link></title>
- <para>Asks: Note to display on the patron summary page. </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference will display text above the patron's summary and below the
- welcome message when the patron logs in to the OPAC and view their 'my summary' tab.<screenshot>
- <screeninfo>OPACMySummaryNote in the OPAC</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OPACMySummaryNote.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="OpacNav">
- <title><link linkend="OpacNav">OpacNav</link></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><link linkend="OpacNavBottom">OpacNavBottom</link></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="OpacNavRight">
- <title><link linkend="OpacNavRight">OpacNavRight</link></title>
-
- <para>Asks: Show the following HTML in the right hand column of
- the main page under the main login form.</para>
-
- <para>Description: HTML entered in this preference will appear on
- the right hand side of the OPAC under the log in form. If the log
- in form is not visible this content will move up on the right
- column.</para>
-
- <screenshot>
- <screeninfo>OpacNavRight</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OpacNavRight.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="OPACNoResultsFound">
- <title><link linkend="OPACNoResultsFound">OPACNoResultsFound</link></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>
- <note>
- <para>You can insert placeholders {QUERY_KW} that will be replaced with the keywords
- of the query. </para>
- </note>
- </section>
-
- <section id="OpacPublic">
- <title><link linkend="OpacPublic">OpacPublic</link></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><link linkend="OPACResultsSidebar">OPACResultsSidebar</link></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><link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link></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>
- </section>
- <section id="OpacSeparateHoldings">
- <title><link linkend="OpacSeparateHoldings">OpacSeparateHoldings & OpacSeparateHoldingsBranch </link></title>
- <para>OpacSeparateHoldings default: Don't separate</para>
- <para>OpacSeparateHoldingsBranch default: home library </para>
- <para>Asks: ___ items display into two tabs, where the first tab contains items whose
- ___ is the logged in user's library. The second tab will contain all other items. </para>
- <para>OpacSeparateHoldings values:<itemizedlist>
- <listitem>
- <para>Don't separate</para>
- </listitem>
- <listitem>
- <para>Separate</para>
- </listitem>
- </itemizedlist></para>
- <para>OpacSeparateHoldingsBranch values:<itemizedlist>
- <listitem>
- <para>holding library</para>
- </listitem>
- <listitem>
- <para>home library</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference lets you decide if you would like to have the holding
- information on the bibliographic detail page in the OPAC split in to multiple
- tabs. The default is to show all holdings on one tab.</para>
- <screenshot>
- <screeninfo>Separate holdings tabs</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OpacSeparateHoldings.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="OPACShowBarcode">
- <title><link linkend="OPACShowBarcode">OPACShowBarcode</link></title>
-
- <para>Default: Don't show</para>
-
- <para>Asks: ___ the item's barcode on the holdings tab.</para>
-
- <para>Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>Don't show</para>
-
- <screenshot>
- <screeninfo>Barcode not shown in the OPAC</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OPACShowBarcode-noshow.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>Show</para>
-
- <screenshot>
- <screeninfo>Barcode shown in the OPAC</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OPACShowBarcode-show.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
-
- <para>Description:</para>
-
- <itemizedlist>
- <listitem>
- <para>This preference allows you to control whether patrons
- can see items' barcodes in the OPAC.</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="OPACShowCheckoutName">
- <title><link linkend="OPACShowCheckoutName">OPACShowCheckoutName</link></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="OPACShowHoldQueueDetails">
- <title><link linkend="OPACShowHoldQueueDetails">OPACShowHoldQueueDetails</link></title>
-
- <para>Default: Don't show any hold details</para>
-
- <para>Asks: ___ to patrons in the OPAC.</para>
-
- <para>Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>Don't show any hold details</para>
- </listitem>
-
- <listitem>
- <para>Show holds</para>
-
- <screenshot>
- <screeninfo>The holdings table on the bibliographic record
- will show the number of holds</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OPACShowHoldQueueDetails-showholds.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>Show holds and priority level</para>
- </listitem>
-
- <listitem>
- <para>Show priority level</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/OPACShowHoldQueueDetails-priority.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="OpacShowRecentComments">
- <title><link linkend="OpacShowRecentComments">OpacShowRecentComments</link></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="OPACShowUnusedAuthorities">
- <title><link linkend="OPACShowUnusedAuthorities">OPACShowUnusedAuthorities</link></title>
-
- <para>Default: Show</para>
-
- <para>Asks: ___ unused authorities in the OPAC authority
- browser.</para>
-
- <para>Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>Do not show</para>
- </listitem>
-
- <listitem>
- <para>Show</para>
-
- <itemizedlist>
- <listitem>
- <important>
- <para>Requires that the <link linkend="OpacAuthorities">OpacAuthorities</link>
- preference is set to 'Allow'</para>
- </important>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
-
- <para>Description:</para>
-
- <itemizedlist>
- <listitem>
- <para>When patrons search your authority file via the OPAC
- they will see all authorities in your system even if you don't
- have them linked to any bibliographic records. This preference
- lets you determine what the default behavior is when searching
- authorities via the OPAC. If you choose 'Do not show' it will
- only show patrons authority records that are linked to bib
- records in the search results. Otherwise the system will show
- all authority records even if they aren't linked to
- records.</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="OpacStarRatings">
- <title><link linkend="OpacStarRatings">OpacStarRatings</link></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="OpacSuggestionManagedBy">
- <title><link linkend="OpacSuggestionManagedBy">OpacSuggestionManagedBy</link></title>
- <para>Default: Show</para>
- <para>Asks: ___ the name of the staff member who managed a suggestion in OPAC. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't show</para>
- </listitem>
- <listitem>
- <para>Show</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>If you're <link linkend="suggestionspref">allowing patrons to make purchase
- suggestions</link> then they will see the 'my suggestions' tab when logged in.
- This tab shows the patron the librarian who approved or rejected the purchase
- suggestion. This preference controls if the patron sees the librarian's name or
- not.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="opacthemes">
- <title><link linkend="opacthemes">opacthemes</link></title>
-
- <para>Default: bootstrap</para>
-
- <para>Asks: Use the ___ theme on the OPAC.</para>
-
- <para>Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>bootstrap</para>
- <para>
- <screenshot>
- <screeninfo>Bootstrap Theme</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/opacthemes-bootstrap.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </para>
- <para>This theme is completely responsive</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="OPACURLOpenInNewWindow">
- <title><link linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link></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><link linkend="OPACUserCSS">OPACUserCSS</link></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/bootstrap/css/opac.css. Unlike <link linkend="OpacAdditionalStylesheet">OpacAdditionalStylesheet</link> and <link linkend="opaclayoutstylesheet">opaclayoutstylesheet</link> this preference will
- embed the CSS directly on your OPAC pages.</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="opacuserjs">
- <title><link linkend="opacuserjs">OPACUserJS</link></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><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link></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-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACDetail.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><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link></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-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACResults.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><link linkend="opacfeaturesprefs">Features</link></title>
-
- <para/>
-
- <section id="numSearchRSSResults">
- <title><link linkend="numSearchRSSResults">numSearchRSSResults</link></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="OPACAcquisitionDetails">
- <title><link linkend="OPACAcquisitionDetails">OPACAcquisitionDetails</link></title>
- <para>Default: Don't display</para>
- <para>Asks: ___ the acquisition details on OPAC detail pages.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Display<screenshot>
- <screeninfo>Acquisitions details in the OPAC</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OPACAcquisitionDetails.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- <listitem>
- <para>Don't display</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference shows the patrons how many items are on order in the
- Holdings tab if you have the <link linkend="AcqCreateItem">AcqCreateItem</link>
- set to 'cataloging the record'</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="OpacAuthorities">
- <title><link linkend="OpacAuthorities">OpacAuthorities</link></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. By
- setting the preference to "Allow" patrons can use this search link of the
- OPAC.</para>
- </listitem>
- </itemizedlist>
-
- <para>Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>Allow</para>
-
- <itemizedlist>
- <listitem>
- <para>A link labeled 'Authority search' 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/authoritysearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>Don't allow</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="opacbookbag">
- <title><link linkend="opacbookbag">opacbookbag</link></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><link linkend="OpacBrowser">OpacBrowser</link></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><link linkend="OpacBrowseResults">OpacBrowseResults</link></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="OpacCloud">
- <title><link linkend="OpacCloud">OpacCloud</link></title>
- <para><important>
- <para>This preference only applies to French systems at this time.</para>
- </important>Default: Don't show</para>
- <para>Asks: ___ a subject cloud on OPAC</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't show</para>
- </listitem>
- <listitem>
- <para>Show</para>
- </listitem>
- </itemizedlist></para>
- <para>
- <important>
- <para>run the <link linkend="authbrowsercron">Authorities Browser Cron Job</link> to
- create the browser list</para>
- </important>
- </para>
- </section>
-
- <section id="OPACFinesTab">
- <title><link linkend="OPACFinesTab">OPACFinesTab</link></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="OpacHoldNotes">
- <title><link linkend="OpacHoldNotes">OpacHoldNotes</link></title>
- <para>Default: Do not allow</para>
- <para>Asks: ___ users to add a note when placing a hold.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Allow</para>
- <screenshot>
- <screeninfo>Holds notes in the OPAC</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OpacHoldNotes.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Do not allow</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="OPACISBD">
- <title><link linkend="OPACISBD">OPACISBD</link></title>
- <para>Default: <link linkend="opacisbdmarcdefault">MARC21
- Default Appendix</link>
- </para>
- <para>Asks: Use the following as the OPAC ISBD template:</para>
- <para>Description:</para>
- <itemizedlist>
- <listitem>
- <para>This determines how the ISBD information will display in the OPAC. 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="OpacItemLocation">
- <title><link linkend="OpacItemLocation">OpacItemLocation</link></title>
- <para>Default: call number only</para>
- <para>Asks: Show ____ for items on the OPAC search results.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>call number only</para>
- </listitem>
- <listitem>
- <para>collection code</para>
- </listitem>
- <listitem>
- <para>location</para>
- </listitem>
- </itemizedlist></para>
- <para>Description: </para>
- <itemizedlist>
- <listitem>
- <para>This setting allows users of the OPAC results XSLT stylesheet to choose to
- display collection code or location in addition to call number.</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="OpacPasswordChange">
- <title><link linkend="OpacPasswordChange">OpacPasswordChange</link></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><link linkend="OPACPatronDetails">OPACPatronDetails</link></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 to their account then
- staff will need to approve the changes via the staff client. Notification of
- patron account requests will appear on the dashaboard below the list of modules
- with other pending actions.</para>
- <screenshot>
- <screeninfo>Patrons requesting modifications</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OPACPatronDetails.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Once you click the notification you will be presented with the changes the
- patron would like to make to their account and from there you can choose how to
- proceed.</para>
- <screenshot>
- <screeninfo>Patrons modifications</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OPACPatronDetails-approve.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <note>
- <para>You can control what fields patrons see and can modify via the OPAC by
- setting the <link linkend="PatronSelfRegistrationBorrowerMandatoryField">PatronSelfRegistrationBorrowerMandatoryField</link>
- <link linkend="PatronSelfRegistrationBorrowerUnwantedField">PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
- </note>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="OPACpatronimage">
- <title><link linkend="OPACpatronimage">OPACpatronimage</link></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="OPACPopupAuthorsSearch">
- <title><link linkend="OPACPopupAuthorsSearch">OPACPopupAuthorsSearch</link></title>
- <para>Default: Don't display</para>
- <para>Asks: ___ the list of authors/subjects in a popup for a combined search on OPAC
- detail pages.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Display</para>
- <para>
- <screenshot>
- <screeninfo>Subject search pop up</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OPACPopupAuthorsSearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <listitem>
- <important>
- <para>This will only display the pop up if you are not using an XSLT
- stylesheet. Review your <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> to find out what stylesheet you're
- using.</para>
- </important>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- <listitem>
- <para>Don't display<itemizedlist>
- <listitem>
- <para>Authors and subjects will display as search links instead of pop up
- menus.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>If this preference is set to 'Display' then clicking a subject or author
- from the details page in the OPAC will present the searcher with a pop up box.
- From this box you can check off any of the subjects or authors listed and search
- them all at once by clicking 'Search' at the bottom of the pop up. The default
- behavior is for Koha to search just the clicked author or subject.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="OpacResetPassword">
- <title><link linkend="OpacResetPassword">OpacResetPassword</link></title>
- <para>Default: not allowed</para>
- <para>Asks: Library users are ___ to recover their password via e-mail in the
- OPAC.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>allowed<screenshot>
- <screeninfo>Forgot your password link</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/OpacResetPassword.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- <listitem>
- <para>not allowed</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference controls whether you present users of the public catalog
- with a 'Forgot your password' link or not. Learn more in the <link linkend="resetpwopac">OPAC section</link> of this manual.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="OpacTopissue">
- <title><link linkend="OpacTopissue">OpacTopissue</link></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><link linkend="opacuserlogin">opacuserlogin</link></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="QuoteOfTheDay">
- <title><link linkend="QuoteOfTheDay">QuoteOfTheDay</link></title>
-
- <para>Default: Disable</para>
-
- <para>Asks: ___ Quote of the Day display on OPAC home page</para>
-
- <para>Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>Disable</para>
- </listitem>
-
- <listitem>
- <para>Enable</para>
- </listitem>
- </itemizedlist>
-
- <para>Description:</para>
-
- <itemizedlist>
- <listitem>
- <para>This feature will allow you to enter a series of quotes
- that will then show on the OPAC homepage in random order. To
- add/edit quotes, visit the <link linkend="QOTDEditor">Quote of
- the Day Editor</link> under Tools.</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="RequestOnOpac">
- <title><link linkend="RequestOnOpac">RequestOnOpac</link></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><link linkend="reviewson">reviewson</link></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><link linkend="ShowReviewer">ShowReviewer</link></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><link linkend="ShowReviewerPhoto">ShowReviewerPhoto</link></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><link linkend="SocialNetworks">SocialNetworks</link></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>
-
- <important>
- <para>In order for these share buttons to work when clicked you
- must have filled in your <link linkend="OPACBaseURL">OPACBaseURL</link> preference.</para>
- </important>
- </section>
-
- <section id="suggestionspref">
- <title><link linkend="suggestionspref">suggestion</link></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="opacpayments">
- <title><link linkend="opacpayments">Payments</link></title>
- <para>These preferences will allow you control the tools you use to accept online payments
- from your patrons via the OPAC.</para>
- <section id="EnablePayPalOpacPayments">
- <title><link linkend="EnablePayPalOpacPayments">EnablePayPalOpacPayments & PayPalSandboxMode</link></title>
- <para>EnablePayPalOpacPayments Default: Don't all</para>
- <para>PayPalSandboxMode Default: Sandbox</para>
- <para>Asks: ___ patrons to make payments from the OPAC via PayPal in ___ mode. </para>
- <para>EnablePayPalOpacPayments values:<itemizedlist>
- <listitem>
- <para>Allow</para>
- </listitem>
- <listitem>
- <para>Don't allow</para>
- </listitem>
- </itemizedlist></para>
- <para>PayPalSandboxMode values:<itemizedlist>
- <listitem>
- <para>Production<itemizedlist>
- <listitem>
- <para>Visit <ulink url="https://developer.paypal.com/">https://developer.paypal.com/</ulink> to get information for accepting
- payments in production</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>Sandbox<itemizedlist>
- <listitem>
- <para>Visit <ulink url="https://developer.paypal.com/developer/accounts/">https://developer.paypal.com/developer/accounts/</ulink> to get
- information for your sandbox account</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference will allow you to accept credit card payments via the OPAC
- for fines via PayPal. You will need to set up your PayPal account and it is
- recommended that you run tests before using this in production. </para>
- </listitem>
- </itemizedlist></para>
- <important>
- <para>PayPayl's terms of service state that you cannot charge your patrons for the
- processing fees and so this plugin will not add additional fees to the
- charges.</para>
- </important>
- </section>
- <section id="PayPalChargeDescription">
- <title><link linkend="PayPalChargeDescription">PayPalChargeDescription</link></title>
- <para>Default: Koha fee payment</para>
- <para>Asks: The patron should see the charge description as ___</para>
- <para>Description<itemizedlist>
- <listitem>
- <para>This preference controls what the patron will see on their PayPal
- account/Bank account for this charge.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="PayPalPwd">
- <title><link linkend="PayPalPwd">PayPalPwd</link></title>
- <para>Asks: The password for the PayPal account to receive payments is ___</para>
- </section>
- <section id="PayPalSignature">
- <title><link linkend="PayPalSignature">PayPalSignature</link></title>
- <para>Asks: The signature for the PayPal account to receive payments is ___</para>
- </section>
- <section id="PayPalUser">
- <title><link linkend="PayPalUser">PayPalUser</link></title>
- <para>Asks: The email address to receive PayPal payments is ___</para>
- </section>
- </section>
-
- <section id="opacpolicyprefs">
- <title><link linkend="opacpolicyprefs">Policy</link></title>
-
- <para/>
-
- <section id="AllowPurchaseSuggestionBranchChoice">
- <title><link linkend="AllowPurchaseSuggestionBranchChoice">AllowPurchaseSuggestionBranchChoice</link></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="BlockExpiredPatronOpacActions">
- <title><link linkend="BlockExpiredPatronOpacActions">BlockExpiredPatronOpacActions</link></title>
- <para>Default: Don't block</para>
- <para>Asks: ___ expired patrons from OPAC actions such as placing a hold or renewing. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Block</para>
- </listitem>
- <listitem>
- <para>Don't block</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference lets you set a default value for how Koha handles
- permissions for patrons who are expired. This preference can be overwritten by
- the setting on <link linkend="patcats">individual patron
- categories</link>.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="OpacAllowPublicListCreation">
- <title><link linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link></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><link linkend="OpacAllowSharingPrivateLists">OpacAllowSharingPrivateLists</link></title>
-
- <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. When this is set to 'Allow' patrons will see a share link at the top of
- their list. When they click that link it will ask for the email of the patron they
- would like to share with. Koha will then email the patron an invitation to see the
- list.</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="OPACFineNoRenewals">
- <title><link linkend="OPACFineNoRenewals">OPACFineNoRenewals</link></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>
-
- <note>
- <para>Leave this field blank to disable</para>
- </note>
-
- <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><link linkend="OpacHiddenItems">OpacHiddenItems</link></title>
-
- <para>Asks: Allows to define custom rules for hiding specific
- items at opac. <note>
- <para>See docs/opac/OpacHiddenItems.txt in your Koha install
- directory for more information</para>
- </note></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="OpacRenewalAllowed">
- <title><link linkend="OpacRenewalAllowed">OpacRenewalAllowed</link></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><link linkend="OpacRenewalBranch">OpacRenewalBranch</link></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><link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link></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><link linkend="SearchMyLibraryFirst">SearchMyLibraryFirst</link></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>
-
- <section id="opacprivacyprefs">
- <title><link linkend="opacprivacyprefs">Privacy</link></title>
-
- <para/>
- <section id="AllowPatronToSetCheckoutsVisibilityForGuarantor">
- <title><link linkend="AllowPatronToSetCheckoutsVisibilityForGuarantor">AllowPatronToSetCheckoutsVisibilityForGuarantor</link></title>
- <para>Default: Don't allow</para>
- <para>Asks: ___ patrons to choose their own privacy settings for showing the patron's
- checkouts to the patron's guarantor".</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Allow</para>
- </listitem>
- <listitem>
- <para>Don't allow</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>By default staff can see checkouts to family members via the staff client.
- This preference will allow guarantees (children) to grant permission to
- guarantors (guardians) to view their current checkouts via the public catalog.
- This preference requires that you allow patrons to se their own privacy with the
- <link linkend="OPACPrivacy">OPACPrivacy</link> preference.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="AnonSuggestions">
- <title><link linkend="AnonSuggestions">AnonSuggestions</link></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><link linkend="AnonymousPatron">AnonymousPatron</link></title>
-
- <para>Default: 0</para>
-
- <para>Asks: Use borrowernumber ___ as the Anonymous Patron (for anonymous suggestions
- and reading history) </para>
- <note>
- <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>
- </note>
- <important>
- <para>Remember to use the borrowernumber note the patron's cardnumber for this value.
- The borrowernumber can be found on the patron record under 'Library use' on the right.<screenshot>
- <screeninfo>Borrowernumber</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/AnonymousPatron.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </important>
- </section>
-
- <section id="EnableOpacSearchHistory">
- <title><link linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link></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><link linkend="OPACPrivacy">OPACPrivacy</link></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>
- <para>Description:<itemizedlist>
- <listitem>
- <para>The default privacy setting for each patron category can be set in the <link linkend="patcats">Patrons Categories</link> area. If you set this preference
- to 'allow' then patrons can change that for themselves via the OPAC.</para>
- </listitem>
- </itemizedlist><important>
- <para>If patron has chosen to have their reading history anonymized and you have
- <link linkend="StoreLastBorrower">StoreLastBorrower</link> set to "Don't store"
- then as soon as the item is checked in the last borrower will be
- anonymized.</para>
- </important></para>
- </section>
-
- <section id="opacreadinghistory">
- <title><link linkend="opacreadinghistory">opacreadinghistory</link></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 <link linkend="OPACPrivacy">OPACPrivacy</link> 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 id="StoreLastBorrower">
- <title><link linkend="StoreLastBorrower">StoreLastBorrower</link></title>
- <para>Default: Don't store</para>
- <para>Asks: ___ the last patron to return an item. </para>
- <para>Values: <itemizedlist>
- <listitem>
- <para>Don't store</para>
- </listitem>
- <listitem>
- <para>Store</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference allows you to store the last patron to borrow an item even
- if the patron has chosen to have their reading history anonymized. </para>
- </listitem>
- </itemizedlist><note>
- <para>This setting is independent of <link linkend="opacreadinghistory">opacreadinghistory</link> and/or <link linkend="AnonymousPatron">AnonymousPatron</link>.</para>
- </note></para>
- </section>
- <section id="TrackClicks">
- <title><link linkend="TrackClicks">TrackClicks</link></title>
- <para>Default: Don't track</para>
- <para>Asks: ___ links that patrons click on.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't track</para>
- </listitem>
- <listitem>
- <para>Track</para>
- </listitem>
- <listitem>
- <para>Track anonymously</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>By setting this preference to one of the track options you will allow Koha
- to track every link clicked in Koha. This data will be stored in a database
- table so that you can run reports against that data. If you choose to 'Track'
- clicks then Koha will record both the link clicked and the logged in user who
- clicked the link. If you choose to 'Track anonymously' then the borrowernumber
- will not be recorded, but the rest of the data will.<note>
- <para>Remember to update your local privacy policies and link to them from the
- OPAC to notify your users that you are tracking their information.</para>
- </note></para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- <section id="opacrestrictedpg">
- <title><link linkend="opacrestrictedpg">Restricted Page</link></title>
- <para>Using the following preference you can create a page within your Koha system that is
- accessible by only specific IP addresses. This can be used to house links to databases
- that can only be accessed from with the library or other licensed content.</para>
- <section id="RestrictedPageContent">
- <title><link linkend="RestrictedPageContent">RestrictedPageContent</link></title>
- <para>Asks: HTML content of your restricted page.</para>
- </section>
- <section id="RestrictedPageLocalIPs">
- <title><link linkend="RestrictedPageLocalIPs">RestrictedPageLocalIPs</link></title>
- <para>Asks: Access from IP addresses beginning with ___ do not need to be
- authenticated</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>You can enter individual IPS as a comma separated list (ex:
- '127.0.0,127.0.1') or just the beginning of the IP range allowed (ex:
- '127.0.')</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="RestrictedPageTitle">
- <title><link linkend="RestrictedPageTitle">RestrictedPageTitle</link></title>
- <para>Asks: Use ___ as title of your restricted page</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This title will appear in the breadcrumb and on the top of the restricted
- page.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- <section id="opacselfregistrationprefs">
- <title><link linkend="opacselfregistrationprefs">Self Registration</link></title>
- <section id="PatronSelfModificationBorrowerUnwantedField">
- <title><link linkend="PatronSelfModificationBorrowerUnwantedField">PatronSelfModificationBorrowerUnwantedField</link></title>
- <para>Default: password</para>
- <para>Asks: The following <ulink url="http://schema.koha-community.org/tables/borrowers.html">database
- columns</ulink> will not appear on the patron self-modification screen: ___</para>
- <para>Description:</para>
- <itemizedlist>
- <listitem>
- <para>This preference allows you to define what fields patrons can edit if you're
- allowing them to update their personal information via the public catalog with the
- <link linkend="OPACPatronDetails">OPACPatronDetails</link> preference.</para>
- </listitem>
- </itemizedlist>
- <important>
- <para>Separate columns with |</para>
- </important>
- </section>
- <section id="PatronSelfRegistration">
- <title><link linkend="PatronSelfRegistration">PatronSelfRegistration</link></title>
- <para>Default: Don't allow</para>
- <para>Asks: ___ library patrons to register an account via the OPAC.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Allow</para>
- </listitem>
- <listitem>
- <para>Don't allow</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:</para>
- <itemizedlist>
- <listitem>
- <para>Setting this preference to 'Allow' will provide a link on the OPAC to register
- for a new account. Using the other <link linkend="opacselfregistrationprefs">Self
- Registration</link> system preferences you can control how this preference will function.</para>
- <screenshot>
- <screeninfo>Register link in the OPAC</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/PatronSelfRegistration.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- <important>
- <para>Patrons registering via the OPAC will not need to be approved by a librarian.
- For this reason it is recommended that you set up a provisional <link linkend="patcats">patron category</link> with no <link linkend="circfinerules">circulation rights</link>. That way patrons will have to come in to the library
- to verify their identity before given circulation rights at the library. Once the
- patron confirms their identiy the library staff can change the category to one with
- permissions to check items out and place holds.</para>
- </important>
- </section>
- <section id="PatronSelfRegistrationAdditionalInstructions">
- <title><link linkend="PatronSelfRegistrationAdditionalInstructions">PatronSelfRegistrationAdditionalInstructions</link></title>
- <para>Asks: Display the following additional instructions for patrons who self register
- via the OPAC ( HTML is allowed ): </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference takes any HTML you'd like to display on the page the patron
- sees after successfully registering for their library card.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="PatronSelfRegistrationBorrowerMandatoryField">
- <title><link linkend="PatronSelfRegistrationBorrowerMandatoryField">PatronSelfRegistrationBorrowerMandatoryField</link></title>
- <para>Default: surname|firstname</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 allows you to define what fields patrons must fill in on their
- self regisration form. If any of the required fields are blank Koha will not let
- the patron register.</para>
- </listitem>
- </itemizedlist>
- <important>
- <para>Separate columns with |</para>
- </important>
- <note>
- <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>
- </note>
- <note>
- <para>If you're going to require that patrons verify their accounts via email with the
- <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link> preference the email field will
- automatically be marked as required.</para>
- </note>
- </section>
- <section id="PatronSelfRegistrationBorrowerUnwantedField">
- <title><link linkend="PatronSelfRegistrationBorrowerUnwantedField">PatronSelfRegistrationBorrowerUnwantedField</link></title>
- <para>Default: password</para>
- <para>Asks: The following database columns will not appear on the patron entry screen:
- ___</para>
- <para>Description:</para>
- <itemizedlist>
- <listitem>
- <para>Using this preference you can hide fields from the patron registraion and
- update form in the OPAC.</para>
- </listitem>
- </itemizedlist>
- <important>
- <para>Separate columns with |</para>
- </important>
- <note>
- <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>
- </note>
- </section>
- <section id="PatronSelfRegistrationDefaultCategory">
- <title><link linkend="PatronSelfRegistrationDefaultCategory">PatronSelfRegistrationDefaultCategory</link></title>
- <para>Asks: Use the patron category code ___ as the default patron category for patrons
- registered via the OPAC. </para>
- <para>Description:</para>
- <itemizedlist>
- <listitem>
- <para>Enter in the patron category code for the category that all new patrons
- registered via the OPAC will be put in to.</para>
- </listitem>
- </itemizedlist>
- <important>
- <para>Patrons registering via the OPAC will not need to be approved by a librarian.
- For this reason it is recommended that you set up a provisional <link linkend="patcats">patron category</link> with no <link linkend="circfinerules">circulation rights</link>. That way patrons will have to come in to the library
- to verify their identity before given circulation rights at the library. Once the
- patron confirms their identiy the library staff can change the category to one with
- permissions to check items out and place holds.</para>
- </important>
- <important>
- <para>If you leave this blank or enter in an invalid code your patrons will still be
- able to register but will not be given a username. There will be no errors on the
- page to explain this, so be sure to enter a valid patron category code.</para>
- </important>
- </section>
- <section id="PatronSelfRegistrationExpireTemporaryAccountsDelay">
- <title><link linkend="PatronSelfRegistrationExpireTemporaryAccountsDelay">PatronSelfRegistrationExpireTemporaryAccountsDelay</link></title>
- <para>Default: 0</para>
- <para>Asks: Delete patrons registered via the OPAC, but not yet verified after ___
- days.</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This prefence links to the <link linkend="deleteexpiredregistrationcron">delete_expired_opac_registrations.pl cron job</link>. If that cron is set to
- run nightly it will clean up any registrations that have not been verified via
- email in the number of days entered on this preference. This is dependent on
- <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link> preference.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="PatronSelfRegistrationVerifyByEmail">
- <title><link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link></title>
- <para>Default: Don't require</para>
- <para>Asks: ___ that a self-registering patron verify his or herself via email.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't require</para>
- </listitem>
- <listitem>
- <para>Require</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>If you require patrons to verify their accounts via email they will not be
- able to log in to the OPAC until they acknowledge the email sent by Koha. If you
- don't require this then patrons will be able to log in as soon as they fill in
- the registration form. You can set the <link linkend="PatronSelfRegistrationExpireTemporaryAccountsDelay">PatronSelfRegistrationExpireTemporaryAccountsDelay</link> preference to
- delete the un-verified self registrations after a certain number of days.</para>
- </listitem>
- </itemizedlist><note>
- <para>If you're going to require that patrons verify their accounts via email then
- the email field will automatically be marked as required.</para>
- </note></para>
- </section>
- </section>
-
- <section id="shelfbrowseprefs">
- <title><link linkend="shelfbrowseprefs">Shelf Browser</link></title>
-
- <para/>
-
- <section id="OPACShelfBrowser">
- <title><link linkend="OPACShelfBrowser">OPACShelfBrowser</link></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><link linkend="ShelfBrowserUsesCcode">ShelfBrowserUsesCcode</link></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><link linkend="ShelfBrowserUsesHomeBranch">ShelfBrowserUsesHomeBranch</link></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><link linkend="ShelfBrowserUsesLocation">ShelfBrowserUsesLocation</link></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><link linkend="patronprefs">Patrons</link></title>
-
- <para><emphasis>Get there:</emphasis> More > Administration >
- Global System Preferences > Patrons</para>
-
- <section id="generalpatronpref">
- <title><link linkend="generalpatronpref">General</link></title>
- <section id="AutoEmailOPACUser">
- <title><link linkend="AutoEmailOPACUser">AutoEmailOpacUser</link></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><link linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link></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><link linkend="autoMemberNum">autoMemberNum</link></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><link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link></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>
- <note>
- <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>
- </note>
- </section>
- <section id="borrowerRelationship">
- <title><link linkend="borrowerRelationship">borrowerRelationship</link></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><link linkend="BorrowerRenewalPeriodBase">BorrowerRenewalPeriodBase</link></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 subscription period to the old expiration date for the
- patron when renewing their account.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="BorrowersTitles">
- <title><link linkend="BorrowersTitles">BorrowersTitles</link></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="BorrowerUnwantedField">
- <title><link linkend="BorrowerUnwantedField">BorrowerUnwantedField</link></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>
- <note>
- <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>
- </note>
- </section>
- <section id="CardnumberLength">
- <title><link linkend="CardnumberLength">CardnumberLength</link></title>
- <para>Asks: Card numbers for patrons must be ___ characters long. </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>The length can be a single number to specify an exact length, a range
- separated by a comma (i.e., 'Min,Max'), or a maximum with no minimum (i.e.,
- ',Max'). If 'cardnumber' is included in the <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> list, the
- minimum length, if not specified here, defaults to one. </para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="checkdigit">
- <title><link linkend="checkdigit">checkdigit</link></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="EnableBorrowerFiles">
- <title><link linkend="EnableBorrowerFiles">EnableBorrowerFiles</link></title>
- <para>Default: Don't</para>
- <para>Asks: ___ enable the ability to upload and attach arbitrary files to a borrower
- record.</para>
- <para>Values:</para>
- <itemizedlist>
- <listitem>
- <para>Do</para>
- </listitem>
- <listitem>
- <para>Don't</para>
- </listitem>
- </itemizedlist>
- <para>Description:</para>
- <itemizedlist>
- <listitem>
- <para>When enabled this will add a 'Files' tab to the left of the patron detail page
- where you can view and upload files to the patron record.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="EnhancedMessagingPreferences">
- <title><link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link></title>
- <para>Default: Allow</para>
- <para>Asks: ___ staff to manage which notices patrons will receive and when they will
- 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>
- <note>
- <para>To manage if patrons have also access to these settings, use <link linkend="EnhancedMessagingPreferencesOPAC">EnhancedMessagingPreferencesOPAC</link>. </para>
- </note>
- <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 staff to choose
- for patrons 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 and/or renewed, 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
- (Staff can choose the number of days in advance)</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </section>
- <section id="EnhancedMessagingPreferencesOPAC">
- <title><link linkend="EnhancedMessagingPreferencesOPAC">EnhancedMessagingPreferencesOPAC</link></title>
- <para>Default: Show</para>
- <para>Asks: ___ patron messaging setting on the OPAC</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't show</para>
- </listitem>
- <listitem>
- <para>Show</para>
- </listitem>
- </itemizedlist><important>
- <para><link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link> must be enabled for messaging options to
- show in the OPAC</para>
- </important></para>
- <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 and/or renewed, 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><link linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link></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>
- <note>
- <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>
- </note>
- </section>
- <section id="FeeOnChangePatronCategory">
- <title><link linkend="FeeOnChangePatronCategory">FeeOnChangePatronCategory</link></title>
- <para>Default: Do</para>
- <para>Asks: ___ charge a fee when a patron changes to a category with an enrollment
- fee.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Do</para>
- </listitem>
- <listitem>
- <para>Don't</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="intranetreadinghistory">
- <title><link linkend="intranetreadinghistory">intranetreadinghistory</link></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>Reading history is still stored, regardless of staff being allowed access or not
- unless the patron has chosen to have their history anonymized via their <link linkend="opacmyprivacy">privacy page</link>.</para>
- </important>
- </section>
- <section id="MaxFine">
- <title><link linkend="MaxFine">MaxFine</link></title>
- <para>Default: 9999</para>
- <para>Asks: The late fine for all checkouts will only go up to ___ USD.</para>
- <para>Description:</para>
- <itemizedlist>
- <listitem>
- <para>This preference controls the default cap on fines accrued by the patron.
- Leaving this preference blank means that there is no cap on the amount of fines a
- patron can accrue. If you'd like, single item caps can be specified in the <link linkend="circfinerules">circulation rules matrix</link>.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="MembershipExpiryDaysNotice">
- <title><link linkend="MembershipExpiryDaysNotice">MembershipExpiryDaysNotice</link></title>
- <para>Asks: Send an account expiration notice when a patron's card will expire in ___
- days.</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>If you would like to notify patrons that their accounts are about to expire
- then you can enter a number of days before expiration in this preference. The
- notice text can be customized in the <link linkend="notices">Notices &
- Slips</link> tool.</para>
- </listitem>
- </itemizedlist><important>
- <para>You will need to enable the <link linkend="patronexpirycron">membership expiry
- cron job</link> for this notice to send.</para>
- </important></para>
- </section>
- <section id="minPasswordLength">
- <title><link linkend="minPasswordLength">minPasswordLength</link></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><link linkend="NotifyBorrowerDeparture">NotifyBorrowerDeparture</link></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><link linkend="patronimages">patronimages</link></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>
- <para>Description:<itemizedlist>
- <listitem>
- <para>If this preference is set to 'Allow' the staff will be able to upload images
- of patrons either <link linkend="addpatronimages">one by one</link> or <link linkend="uploadpatronimages">in bulk</link>. Patrons images will show on the
- detail page to the left of the patron information. They can also show in the
- OPAC if you set the <link linkend="OPACpatronimage">OPACpatronimage</link>
- preference or in the self check out module if you set the <link linkend="ShowPatronImageInWebBasedSelfCheck">ShowPatronImageInWebBasedSelfCheck</link> preference.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="PatronsPerPage">
- <title><link linkend="PatronsPerPage">PatronsPerPage</link></title>
- <para>Default: 20</para>
- <para>Asks: By default, show ___ results per page in the staff client.</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference will let you define how many patrons to show on patron
- search results pages.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="SMSSendDriver">
- <title><link linkend="SMSSendDriver"> SMSSendDriver, SMSSendUsername, and SMSSendPassword </link></title>
- <para>Asks: Use the SMS::Send:: ___ driver to send SMS messages. Define a username/login
- ___ and a password ___.</para>
- <para><important>
- <para> Please refer to your national laws concerning the sending of bulk SMS
- messages before enabling this feature.</para>
- </important>Descritpion:<itemizedlist>
- <listitem>
- <para>There are two options for using SMS in Koha. You can use the Email protocol
- for free by entering 'Email' as the SMSSendDriver or you can pay for a SMS
- driver. Some examples of values for the driver 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>
- <listitem>
- <para>SMS::Send::IN::Unicel</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>
- </listitem>
- </itemizedlist></para>
- <important>
- <para>You must allow <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link> for this to work.</para>
- </important>
- </section>
- <section id="StatisticsFields">
- <title><link linkend="StatisticsFields">StatisticsFields</link></title>
- <para>Default: location|itype|ccode</para>
- <para>Asks: Show the following fields from the items database table as columns on the
- statistics tab on the patron record: ___</para>
- <screenshot>
- <screeninfo>Statistics on Patron Record</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/StatisticsFields.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <important>
- <para>Enter the values separated by bars (|)</para>
- </important>
- <para>Description:</para>
- <itemizedlist>
- <listitem>
- <para>This preference lets you set which fields will show on the patron record on
- the Statistics tab.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="TalkingTechItivaPhoneNotification">
- <title><link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></title>
- <para>Default: Disable</para>
- <para>Asks: ___ patron phone notifications using Talking Tech i-tiva (overdues, predues
- and holds notices currently supported).</para>
- <para>Values:</para>
- <itemizedlist>
- <listitem>
- <para>Disable</para>
- </listitem>
- <listitem>
- <para>Enable</para>
- </listitem>
- </itemizedlist>
- <para>Description:</para>
- <itemizedlist>
- <listitem>
- <para>To learn more about setting up this third party product view the <link linkend="talkingtechappendix">Talking Tech Appendix</link>.</para>
- </listitem>
- </itemizedlist>
- <important>
- <para>Requires that you have <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link> set to Allow to use.</para>
- </important>
- </section>
- <section id="uppercasesurnames">
- <title><link linkend="uppercasesurnames">uppercasesurnames</link></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 id="useDischarge">
- <title><link linkend="useDischarge">useDischarge</link></title>
- <para>Default: Don't allow</para>
- <para>Asks: ___ librarians to discharge borrowers and borrowers to request a
- discharge.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Allow</para>
- </listitem>
- <listitem>
- <para>Don't allow</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>A discharge is a certificate that says the patron has no current checkouts,
- no holds and owe no money.<note>
- <para>In France a "quitus" ("discharge") is needed if you want to register for
- an account in a library or a university). </para>
- </note><note>
- <para>Academic libraries often require that you have a clear record at the
- library before you can graduate.</para>
- </note></para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- <section id="norwegianpref">
- <title><link linkend="norwegianpref">Norwegian patron database</link></title>
- <section id="NorwegianPatronDBEnable">
- <title><link linkend="NorwegianPatronDBEnable">NorwegianPatronDBEnable & NorwegianPatronDBEndpoint</link></title>
- <para>NorwegianPatronDBEnable Default: Disable</para>
- <para>Asks: ___ the ability to communicate with the Norwegian national patron database
- via the ___ endpoint. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Disable</para>
- </listitem>
- <listitem>
- <para>Enable</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="NorwegianPatronDBSearchNLAfterLocalHit">
- <title><link linkend="NorwegianPatronDBSearchNLAfterLocalHit">NorwegianPatronDBSearchNLAfterLocalHit</link></title>
- <para>Default: Don't</para>
- <para>Asks: ___ search the Norwegian national patron database after a local search
- result was found.</para>
- <para>Values:</para>
- <itemizedlist>
- <listitem>
- <para>Do</para>
- </listitem>
- <listitem>
- <para>Don't</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="NorwegianPatronDBUsername">
- <title><link linkend="NorwegianPatronDBUsername">NorwegianPatronDBUsername & NorwegianPatronDBPassword</link></title>
- <para>Asks: Communicate with the Norwegian national patron database using the username
- ___ and the password ___. </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>You can get these from "Base Bibliotek", which is maintained by the
- Norwegian National Library. </para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- </section>
-
- <section id="searchingprefs">
- <title><link linkend="searchingprefs">Searching</link></title>
-
- <para><emphasis>Get there:</emphasis> More > Administration >
- Global System Preferences > Searching</para>
-
- <section id="searchfeatureprefs">
- <title><link linkend="searchfeatureprefs">Features</link></title>
-
- <para/>
- <section id="EnableSearchHistory">
- <title><link linkend="EnableSearchHistory">EnableSearchHistory</link></title>
- <para>Default: Don't keep</para>
- <para>Asks: ___ patron search history in the staff client.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't keep</para>
- </listitem>
- <listitem>
- <para>Keep<screenshot>
- <screeninfo>EnableSearchHistory</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/EnableSearchHistory.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist>Description:<itemizedlist>
- <listitem>
- <para>This preference controls whether the staff client keeps search history for
- logged in users. Search history will be accessible under the link to your
- account in the top right of the staff client.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="IncludeSeeFromInSearches">
- <title><link linkend="IncludeSeeFromInSearches">IncludeSeeFromInSearches</link></title>
- <para>Default: Don't include</para>
- <para>Asks: ___ <emphasis role="italic">see from</emphasis> (non-preferred form)
- headings in bibliographic searches. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't include</para>
- </listitem>
- <listitem>
- <para>Include</para>
- </listitem>
- </itemizedlist></para>
- <para>Description: <itemizedlist>
- <listitem>
- <para>When this preference is set to include the search engine indexer will insert
- <emphasis role="italic">see from</emphasis> headings from authority records
- into bibliographic records when indexing, so that a search on an obsolete term
- will turn up relevant records. For example when you search for cookery (the old
- term) you get titles with the heading of cooking (the new term).</para>
- </listitem>
- </itemizedlist><important>
- <para>You will need to reindex your bibliographic database when changing this
- preference. </para>
- </important></para>
- </section>
-
- <section id="OpacGroupResults">
- <title><link linkend="OpacGroupResults">OpacGroupResults</link></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><link linkend="QueryAutoTruncate">QueryAutoTruncate</link></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><link linkend="QueryFuzzy">QueryFuzzy</link></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="UseICU">UseICU</link> set to 'Not using'</para>
- </important>
- </section>
-
- <section id="QueryStemming">
- <title><link linkend="QueryStemming">QueryStemming</link></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>
- </section>
-
- <section id="QueryWeightFields">
- <title><link linkend="QueryWeightFields">QueryWeightFields</link></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>
- </section>
-
- <section id="TraceCompleteSubfields">
- <title><link linkend="TraceCompleteSubfields">TraceCompleteSubfields</link></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><link linkend="TraceSubjectSubdivisions">TraceSubjectSubdivisions</link></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><link linkend="UseICU">UseICU</link></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 id="UseQueryParser">
- <title><link linkend="UseQueryParser">UseQueryParser</link></title>
- <para>Default: Do not try</para>
- <para>Asks: ___ to use the QueryParser module for parsing queries. <note>
- <para>Enabling this will have no impact if you do not have QueryParser installed,
- and everything will continue to work as usual.</para>
- </note></para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Do not try</para>
- </listitem>
- <listitem>
- <para>Try</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference enables an experimental new query parser which opens the
- door for a more expressive and more-effective search syntax.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
-
- <section id="searchresultsprefs">
- <title><link linkend="searchresultsprefs">Results Display</link></title>
-
- <para/>
-
- <section id="defaultSortField">
- <title><link linkend="defaultSortField">defaultSortField & defaultSortOrder</link></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><link linkend="displayFacetCount">displayFacetCount</link></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="DisplayLibraryFacets">
- <title><link linkend="DisplayLibraryFacets">DisplayLibraryFacets</link></title>
- <para>Default: holding library</para>
- <para>Asks: Show facets for ___</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>both home and holding library</para>
- </listitem>
- <listitem>
- <para>holding library</para>
- </listitem>
- <listitem>
- <para>home library</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preferenc controls the libraries facet that displays on search results
- in the staff and opac. The value selected here will determin which library(s)
- show in the facets when a search is run.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="FacetLabelTruncationLength">
- <title><link linkend="FacetLabelTruncationLength">FacetLabelTruncationLength</link></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="FacetMaxCount">
- <title><link linkend="FacetMaxCount">FacetMaxCount</link></title>
- <para>Default: 20</para>
- <para>Asks: Show up ___ to facets for each category.</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference allows you to control how many possible limits show under
- each heading (Author, Series, Topics, etc) on the facets in the OPAC.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="maxItemsInSearchResults">
- <title><link linkend="maxItemsInSearchResults">maxItemsInSearchResults</link></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><link linkend="maxRecordsForFacets">maxRecordsForFacets</link></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="MaxSearchResultsItemsPerRecordStatusCheck">
- <title><link linkend="MaxSearchResultsItemsPerRecordStatusCheck"
- >MaxSearchResultsItemsPerRecordStatusCheck</link></title>
- <para>Default: 20</para>
- <para>Asks: For records with many items, only check the availability status for the
- first ___ items. </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>Availability statuses may show incorrectly in search results if a record has
- more items than the limit set. Statuses will display correctly in the record
- details. Leave empty for no limit.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="numSearchResults">
- <title><link linkend="numSearchResults">numSearchResults</link></title>
-
- <para>Default: 20</para>
-
- <para>Asks: By default, show ___ results per page in the staff
- client.</para>
- </section>
-
- <section id="opacdefaultsort">
- <title><link linkend="opacdefaultsort">OPACdefaultSortField & OPACdefaultSortOrder</link></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>
- </section>
-
- <section id="OPACItemsResultsDisplay">
- <title><link linkend="OPACItemsResultsDisplay">OPACItemsResultsDisplay</link></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><link linkend="OPACnumSearchResults">OPACnumSearchResults</link></title>
-
- <para>Default: 20</para>
-
- <para>Asks: By default, show ___ results per page in the
- OPAC.</para>
- </section>
- <section id="SearchWithISBNVariations">
- <title><link linkend="SearchWithISBNVariations">SearchWithISBNVariations</link></title>
- <para>Default: don't search</para>
- <para>Asks: When searching on the ISBN index, ___ on all variations of the ISBN.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>don't search</para>
- </listitem>
- <listitem>
- <para>search</para>
- </listitem>
- </itemizedlist> Descriptions:<itemizedlist>
- <listitem>
- <para>With this preference set to search you'll be able to search for ISBNs even
- if there are dashes or spaces in the field. So if you search for 9781843345855
- but the ISBN was cataloged as 978-1843345855 you'll still be able to find it if
- this preference is set to 'search'.</para>
- </listitem>
- </itemizedlist><important>
- <para>This preference has no effect if <link linkend="UseQueryParser">UseQueryParser</link> is on</para>
- </important></para>
- </section>
- </section>
-
- <section id="searchformprefs">
- <title><link linkend="searchformprefs">Search Form</link></title>
- <section id="AdvancedSearchLanguages">
- <title><link linkend="AdvancedSearchLanguages">AdvancedSearchLanguages</link></title>
- <para>Asks: Limit the languages listed in the advanced search drop-down to the ___ ISO
- 639-2 language codes (separate values with | or ,).</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference will allow you to decide what languages show in the pull
- down menu on the advanced search page in the OPAC and the staff client. If this
- preference is left blank, all languages will show. To limit the languages that
- are shown enter their <ulink url="http://www.loc.gov/standards/iso639-2/php/code_list.php">ISO 639-2
- language codes</ulink> separated by comma ( , ) or bar ( | ). For example to
- limit listing to French and Italian, enter ita|fre. </para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="AdvancedSearchTypes">
- <title><link linkend="AdvancedSearchTypes">AdvancedSearchTypes</link></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><link linkend="expandedSearchOption">expandedSearchOption</link></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 id="IntranetNumbersPreferPhrase">
- <title><link linkend="IntranetNumbersPreferPhrase">IntranetNumbersPreferPhrase</link></title>
- <para>Default: don't use</para>
- <para>Asks: By default, ___ the operator "phr" in the callnumber and standard number
- staff client searches </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>don't use</para>
- </listitem>
- <listitem>
- <para>use</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>When searching by call number and standard number (biblionumber) in Koha
- Staff Client you can choose to force the search to be a phrase search by setting
- this preference to 'use.' This will allow for more accurate results over doing a
- general keyword field search.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="OPACNumbersPreferPhrase">
- <title><link linkend="OPACNumbersPreferPhrase">OPACNumbersPreferPhrase</link></title>
- <para>Default: don't use</para>
- <para>Asks: By default, ___ the operator "phr" in the callnumber and standard number
- OPAC searches </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>don't use</para>
- </listitem>
- <listitem>
- <para>use</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>When searching by call number and standard number (biblionumber) in the Koha
- OPAC you can choose to force the search to be a phrase search by setting this
- preference to 'use.' This will allow for more accurate results over doing a
- general keyword field search.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- </section>
-
- <section id="serialsprefs">
- <title><link linkend="serialsprefs">Serials</link></title>
-
- <para><emphasis>Get there:</emphasis> More > Administration >
- Global System Preferences > Serials</para>
-
- <section id="opacSerialDefaultTab">
- <title><link linkend="opacSerialDefaultTab">opacSerialDefaultTab</link></title>
-
- <para>Default: Subscriptions tab</para>
-
- <para>Asks: Show ___ as default tab for serials in OPAC. </para>
-
- <para>Values:</para>
-
- <itemizedlist>
- <listitem>
- <para>Holdings tab</para>
- </listitem>
-
- <listitem>
- <para>Serial Collection tab</para>
- <important>
- <para>Please note that the Serial Collection tab is currently available only for
- systems using the UNIMARC standard.</para>
- </important>
- <screenshot>
- <screeninfo>Serial Collection tab</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/opacSerialDefaultTab-colltab.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>Subscriptions tab</para>
- <screenshot>
- <screeninfo>Subscriptions tab</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/opacSerialDefaultTab-subtab.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="OPACSerialIssueDisplayCount">
- <title><link linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link></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><link linkend="RenewSerialAddsSuggestion">RenewSerialAddsSuggestion</link></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><link linkend="RoutingListAddReserves">RoutingListAddReserves</link></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><link linkend="RoutingListNote">RoutingListNote</link></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><link linkend="RoutingSerials">RoutingSerials</link></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><link linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link></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><link linkend="SubscriptionDuplicateDroppedInput">SubscriptionDuplicateDroppedInput</link></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><link linkend="SubscriptionHistory">SubscriptionHistory</link></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><link linkend="staffprefs">Staff Client</link></title>
-
- <para><emphasis>Get there:</emphasis> More > Administration >
- Global System Preferences > Staff Client</para>
-
- <section id="staffappearprefs">
- <title><link linkend="staffappearprefs">Appearance</link></title>
-
- <para/>
-
- <section id="Display856uAsImage">
- <title><link linkend="Display856uAsImage">Display856uAsImage</link></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="DisplayIconsXSLT">
- <title><link linkend="DisplayIconsXSLT">DisplayIconsXSLT</link></title>
- <para>Default: Show</para>
- <para>Asks: ___ the format, audience, and material type icons in XSLT MARC21 results and
- detail pages in the staff client.<important>
- <para><link linkend="XSLTResultsDisplay">XSLTResultsDisplay</link> and/or <link linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link> must be set to use an
- XSLT stylesheet (default or custom) for these icons to show.</para>
- </important></para>
- <para>Values:</para>
- <itemizedlist>
- <listitem>
- <para>Don't show</para>
- </listitem>
- <listitem>
- <para>Show</para>
- <screenshot>
- <screeninfo>DisplayIconsXSLT</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/DisplayIconsXSLT.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- <para>
- <note>
- <para>See the <link linkend="XSLTiTypes">XSLT Icon Guide</link> for more information
- on these icons.</para>
- </note>
- </para>
- </section>
-
- <section id="intranet_includes">
- <title><link linkend="intranet_includes">intranet_includes</link></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="IntranetCirculationHomeHTML">
- <title><link linkend="IntranetCirculationHomeHTML">IntranetCirculationHomeHTML</link></title>
- <para>Asks: Show the following HTML in its own div on the bottom of the home page of the
- circulation module: <screenshot>
- <screeninfo>IntranetCirculationHomeHTML</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/IntranetCirculationHomeHTML.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </section>
-
- <section id="intranetcolorstylesheet">
- <title><link linkend="intranetcolorstylesheet">intranetcolorstylesheet</link></title>
-
- <para>Asks: Include the additional CSS stylesheet ___ to override specified settings
- from the default stylesheet</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. Enter just a filename, a full local path or a complete URL
- starting with http:// (if the file lives on a remote server). Please note that if
- you just enter a filename, the file should be in the css subdirectory for each
- active theme and language within the Koha templates directory. A full local path
- is expected to start from your HTTP document root. </para>
- </listitem>
- </itemizedlist>
-
- <important>
- <para>Leave this field blank to disable.</para>
- </important>
- </section>
-
- <section id="IntranetFavicon">
- <title><link linkend="IntranetFavicon">IntranetFavicon</link></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>
-
- <note>
- <para>Turn your logo into a favicon with the <ulink url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
- </note>
-
- <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><link linkend="IntranetmainUserblock">IntranetmainUserblock</link></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><link linkend="IntranetNav">IntranetNav</link></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="IntranetReportsHomeHTML">
- <title><link linkend="IntranetReportsHomeHTML">IntranetReportsHomeHTML</link></title>
- <para>Asks: Show the following HTML in its own div on the bottom of the home page of the
- reports module: <screenshot>
- <screeninfo>HTML on Reports page</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/IntranetReportsHomeHTML.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </section>
-
- <section id="IntranetSlipPrinterJS">
- <title><link linkend="IntranetSlipPrinterJS">IntranetSlipPrinterJS</link></title>
-
- <para>Asks: Use the following JavaScript for printing
- slips.</para>
-
- <para>Description:</para>
-
- <itemizedlist>
- <listitem>
- <para>The most logical use of this preference is in
- conjunction with the <ulink url="http://jsprintsetup.mozdev.org/">jsPrintSetup</ulink>
- Firefox add-on. Learn more about this preference and the
- add-on setup on the Koha wiki at <ulink url="http://wiki.koha-community.org/wiki/Setting_up_slip_printer_to_print_silently">http://wiki.koha-community.org/wiki/Setting_up_slip_printer_to_print_silently</ulink>.</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="intranetstylesheet">
- <title><link linkend="intranetstylesheet">intranetstylesheet</link></title>
-
- <para>Asks: Use the CSS stylesheet ___ on all pages in the staff interface, instead of
- the default css (used when leaving this field blank). </para>
-
- <para>Description:</para>
-
- <itemizedlist>
- <listitem>
- <para>The Intranetstylesheet preference is a layout and design feature for the
- intranet or staff client. This preference allows a library to customize the
- appearance of the Staff Client. Enter just a filename, a full local path or a
- complete URL starting with http:// (if the file lives on a remote server). Please
- note that if you just enter a filename, the file should be in the css subdirectory
- for each active theme and language within the Koha templates directory. A full
- local path is expected to start from your HTTP document root. </para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="IntranetUserCSS">
- <title><link linkend="IntranetUserCSS">IntranetUserCSS</link></title>
-
- <para>Asks: Include the following CSS on all pages in the staff
- client</para>
- </section>
-
- <section id="intranetuserjs">
- <title><link linkend="intranetuserjs">IntranetUserJS</link></title>
-
- <para>Asks: Include the following JavaScript on all pages in the
- staff interface</para>
-
- <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><link linkend="SlipCSS">SlipCSS</link></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><link linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link></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><link linkend="staffClientBaseURL">staffClientBaseURL</link></title>
-
- <para>Asks: The staff client is located at http:// ___</para>
- </section>
-
- <section id="template">
- <title><link linkend="template">template</link></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>
- <important>
- <para>Do not include a trailing slash in the URL this will break links created using
- this URL. (example: www.google.com not www.google.com/)</para>
- </important>
- </section>
-
- <section id="XSLTDetailsDisplay">
- <title><link linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link></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><link linkend="XSLTResultsDisplay">XSLTResultsDisplay</link></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>
-
- <section id="staffoptsprefs">
- <title><link linkend="staffoptsprefs">Options</link></title>
-
- <section id="HidePatronName">
- <title><link linkend="HidePatronName">HidePatronName</link></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><link linkend="intranetbookbag">intranetbookbag</link></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="StaffDetailItemSelection">
- <title><link linkend="StaffDetailItemSelection">StaffDetailItemSelection</link></title>
- <para>Default: Enable</para>
- <para>Asks: ___ item selection in record detail page. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Disable</para>
- </listitem>
- <listitem>
- <para>Enable</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference lets you choose to show (or not show) checkboxes to the left
- of every item in the holdings tab on the detail display of a record in the staff
- client. Showing these checkboxes allows the staff members to select multiple
- items to edit or delete at once.</para>
- <screenshot>
- <screeninfo>Items with the checkboxes enabled</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/StaffDetailItemSelection.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="UseWYSIWYGinSystemPreferences">
- <title><link linkend="UseWYSIWYGinSystemPreferences">UseWYSIWYGinSystemPreferences</link></title>
- <para>Default: Don't show</para>
- <para>Asks: ___ WYSIWYG editor when editing certain HTML system preferences.</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Don't show</para>
- </listitem>
- <listitem>
- <para>Show<screenshot>
- <screeninfo>WYSIWYG Editor in Sys Prefs</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/UseWYSIWYGinSystemPreferences.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This preference allows you to chang system preferences with HTML in them to
- WYSIWYG editors instead of plain text boxes.</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="viewISBD">
- <title><link linkend="viewISBD">viewISBD</link></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><link linkend="viewLabeledMARC">viewLabeledMARC</link></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><link linkend="viewMARC">viewMARC</link></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="toolsprefs">
- <title><link linkend="toolsprefs">Tools</link></title>
- <para><emphasis>Get there:</emphasis> More > Administration > Global System
- Preferences > Tools</para>
- <section id="batchitemodprefs">
- <title><link linkend="batchitemodprefs">Batch Item Modification</link></title>
- <para>These preferences are in reference to the <link linkend="batchmodifyitems">Batch
- Item Modification</link> tool.</para>
- <section id="MaxItemsForBatch">
- <title><link linkend="MaxItemsForBatch">MaxItemsForBatch</link></title>
- <para>Default: 1000</para>
- <para>Asks: Process up to ___ items in a single modification or deletion batch. </para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>In the <link linkend="batchdeleteitems">batch item delete tool</link> this
- will prevent the display of more than the items you entered in this preference,
- but you will be able to delete more than the number you enter here. In the <link linkend="batchmodifyitems">batch item modification tool</link> this preference
- will prevent the editing of more than the number entered here.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- <section id="newstoolprefs">
- <title><link linkend="newstoolprefs">News</link></title>
- <section id="NewsAuthorDisplay">
- <title><link linkend="NewsAuthorDisplay">NewsAuthorDisplay</link></title>
- <para>Default: not at all</para>
- <para>Asks: Show the author for news items: ___</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Both OPAC and staff client</para>
- </listitem>
- <listitem>
- <para>Not at all</para>
- </listitem>
- <listitem>
- <para>OPAC only</para>
- </listitem>
- <listitem>
- <para>Staff client only</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- <section id="patcardprefs">
- <title><link linkend="patcardprefs">Patron Cards</link></title>
- <para>These preferences are in reference to the <link linkend="patroncardcreator">Patron
- Card Creator</link> tool.</para>
- <section id="ImageLimit">
- <title><link linkend="ImageLimit">ImageLimit</link></title>
- <para>Asks: Limit the number of creator images stored in the database to ___
- images.</para>
- </section>
- </section>
- </section>
-
- <section id="webserviceprefs">
- <title><link linkend="webserviceprefs">Web Services</link></title>
-
- <para><emphasis>Get there:</emphasis> More > Administration >
- Global System Preferences > Web Services</para>
- <section id="idref">
- <title><link linkend="idref">IdRef</link></title>
- <para>Default: Disable</para>
- <para>Asks: ___ the IdRef webservice from the opac detail page. IdRef allows to request
- authorities from the Sudoc database. </para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>Disable</para>
- </listitem>
- <listitem>
- <para>Enable</para>
- </listitem>
- </itemizedlist></para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>IdRef is a French service for Sudoc autorities. Using the <ulink url="http://www.sudoc.abes.fr/">Sudoc database</ulink>, it allows to request /
- modify / add authorities. If a record comes from the Sudoc (so 009 is filled with
- an integer), at the OPAC you will see "Author: Idref" if a 7..$3 (unimarc author)
- if filled with a ppn. On clicking on the Idref link, a popup will display. <screenshot>
- <screeninfo>IdRef link</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/idref1.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>The Idref webservice is requested and all records (by roles) for this author
- will be displayed<screenshot>
- <screeninfo>Sudoc</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/globalprefs/idref2.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>There is 1 line / record and 2 links at the end. 1 will request Koha
- (cgi-bin/koha/opac-search.pl?q=ident:003381862), the other one will redirect to
- the sudoc page (http://www.sudoc.fr/003381862).</para>
- </listitem>
- <listitem>
- <para>
- <important>
- <para>Please note that this feature is available only for libraries using
- UNIMARC. </para>
- </important>
- </para>
- </listitem>
- <listitem>
- <note>
- <para>The French Sudoc database should not be confused with the US Superintendent
- of Documents (SuDocs) Classification Scheme.</para>
- </note>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="ilsdiprefs">
- <title><link linkend="ilsdiprefs">ILS-DI</link></title>
-
- <para/>
-
- <section id="ILS-DI">
- <title><link linkend="ILS-DI">ILS-DI</link></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><link linkend="ILS-DIAuthorized_IPs">ILS-DI:AuthorizedIPs</link></title>
-
- <para>Asks: ___ allowed IPs to use the ILS-DI services</para>
- </section>
- </section>
-
- <section id="oaiprefs">
- <title><link linkend="oaiprefs">OAI-PMH</link></title>
-
- <section id="OAI-PMH">
- <title><link linkend="OAI-PMH">OAI-PMH</link></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>Once enabled you can visit http://YOURKOHACATALOG/cgi-bin/koha/oai.pl to see
- your file. 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><link linkend="OAI-PMHarchiveID">OAI-PMH:archiveID</link></title>
-
- <para>Default: KOHA-OAI-TEST</para>
-
- <para>Asks: Identify records at this site with the prefix ___
- :</para>
- </section>
-
- <section id="OAI-PMHAutoUpdateSets">
- <title><link linkend="OAI-PMHAutoUpdateSets">OAI-PMH:AutoUpdateSets</link></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><link linkend="OAI-PMHConfFile">OAI-PMH:ConfFile</link></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-PMHDeletedRecord">
- <title><link linkend="OAI-PMHDeletedRecord">OAI-PMH:DeletedRecord</link></title>
- <para>Default: will never be emptied or truncated (persistent)</para>
- <para>Asks: Koha's deletedbiblio table ___</para>
- <para>Values:<itemizedlist>
- <listitem>
- <para>will never have any data in it (no)</para>
- </listitem>
- <listitem>
- <para>will never be emptied or truncated (persistent)</para>
- </listitem>
- <listitem>
- <para>might be emptied or truncated at some point (transient)</para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="OAI-PMHMaxCount">
- <title><link linkend="OAI-PMHMaxCount">OAI-PMH:MaxCount</link></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 id="reportingservice">
- <title><link linkend="reportingservice">Reporting</link></title>
- <section id="SvcMaxReportRows">
- <title><link linkend="SvcMaxReportRows">SvcMaxReportRows</link></title>
- <para>Default: 10</para>
- <para>Asks: Only return ___ rows of a report requested via the reports web
- service.</para>
- <para>Description:<itemizedlist>
- <listitem>
- <para>This value will be used to limit the number of results returned by <link linkend="publicreport">public reports</link>.</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- </section>
- </section>
-
- <section id="basicparams">
- <title><link linkend="basicparams">Basic Parameters</link></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><link linkend="libsgroups">Libraries & Groups</link></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><link linkend="addingalibrary">Adding a Library</link></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 you'd like you can enter a different 'Reply-To' email address. This is
- the email address that all replies will go to.<itemizedlist>
- <listitem>
- <para>
- <note>
- <para>If you do not fill in this value Koha will use the address in the
- <link linkend="ReplytoDefault">ReplytoDefault</link>
- preference</para>
- </note>
- </para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>If you'd like you can also enter a different 'Return-Path' email address.
- This is the email address that all bounced messages will go to.<itemizedlist>
- <listitem>
- <note>
- <para>If you do not fill in this value Koha will use the address in the
- <link linkend="ReturnpathDefault">ReturnpathDefault</link>
- preference</para>
- </note>
- </listitem>
- </itemizedlist></para>
- </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>
-
- <note>
- <para>Of the fields listed, only 'Library code' and 'Name' are
- required</para>
- </note>
-
- <para/>
- </section>
-
- <section id="editingalibrary">
- <title><link linkend="editingalibrary">Editing/Deleting a Library</link></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><link linkend="addinglibgroup">Adding a group</link></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>Give the group a 'Category type; of 'searchdomain' and if you would like the group
- to show up in the library pull down at the top of the OPAC (with <link linkend="OpacAddMastheadLibraryPulldown">OpacAddMastheadLibraryPulldown</link> set to
- 'Add') and on the advanced search page you can check the 'Show in search pulldown'
- box.</para>
-
- <para>Of the fields on the group form, 'Category code', 'Name', and 'Category type' are
- the only required fields</para>
-
- <section id="searchdomaingroups">
- <title><link linkend="searchdomaingroups">Search Domain Groups</link></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><link linkend="libpropertygroups">Library Property Groups</link></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><link linkend="itemtypeadmin">Item Types</link></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><link linkend="additemtype">Adding Item Types</link></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>New 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 (for those with
- multiple languages installed you can translate the item type description in to all
- of those languages using the 'Translate in to other languages' link)</para>
- </listitem>
- <listitem>
- <para>Item types and can grouped together for searching at the same time. For example
- you can put DVDs and Bluray in to a group called Movie and then they can be searched
- together. These groups are defined in the ITEMTYPECAT authorized value.</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 <link
- linkend="noItemTypeImages">noItemTypeImages</link> 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 you are suppressing from the OPAC you can hide their item type
- from being searched in the OPAC</para>
- </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 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>If you would like a message or alert to appear when items of this type are
- checked in you can enter that in the 'Checkin message' box</para>
- <screenshot>
- <screeninfo>Checkin message setup</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/basicparams/itemtype-msgsetup.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>
- <itemizedlist>
- <listitem>
- <para>The Checkin message type can be a Message or an Alert. The only
- difference between these two is the styling. By default a Message is blue </para>
- <screenshot>
- <screeninfo>Checkin Message</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/basicparams/itemtype-msg.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>and an Alert is yellow.</para>
- <screenshot>
- <screeninfo>Checkin Alert</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/basicparams/itemtype-alert.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- <listitem>
- <para>Some SIP devices need you to use a SIP-specific media type instead of Koha's
- item type (usually lockers and sorters need this media type), if you use a device
- like this you'll want to enter the SIP media type.</para>
- </listitem>
- <listitem>
- <para>When finished, click 'Save Changes'</para>
- <itemizedlist>
- <listitem>
- <note>
- <para>All fields, with the exception of the 'Item Type' will be editable from
- the Item Types list</para>
- </note>
- </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><link linkend="edititemtype">Editing Item Types</link></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><link linkend="deleteitemtype">Deleting Item Types</link></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><link linkend="authorizedvalues">Authorized Values</link></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><link linkend="existingauthvalues">Existing Values</link></title>
-
- <para>Koha installs with pre-defined values that your library is
- likely to use, for instance 'Lost'.</para>
-
- <itemizedlist>
- <listitem id="asort1">
- <para>Asort1</para>
- <itemizedlist>
- <listitem>
- <para>Used for acquisitions statistical purposes</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="asort2">
- <para>Asort2</para>
- <itemizedlist>
- <listitem>
- <para>Used for acquisitions statistical purposes</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="bornotes">
- <para>BOR_NOTES</para>
- <itemizedlist>
- <listitem>
- <para>Values for custom patron messages that appear on the circulation screen and
- the OPAC. The value in the Description field should be the message text and is
- limited to 200 characters.</para>
- <screenshot>
- <screeninfo>Borrower messages</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/basicparams/bor_notes.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="bsort1">
- <para>Bsort1</para>
- <itemizedlist>
- <listitem>
- <para>Values that can be entered to fill in the patron's sort 1 field</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="bsort2">
- <para>Bsort2</para>
- <itemizedlist>
- <listitem>
- <para>Values that can be entered to fill in the patron's sort 2 field</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="cartauth">
- <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 id="ccode">
- <para>CCODE</para>
- <itemizedlist>
- <listitem>
- <para>Collection codes (appears when cataloging and working with items)</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="damageauth">
- <para>DAMAGED</para>
- <itemizedlist>
- <listitem>
- <para>Descriptions for items marked as damaged (appears when cataloging and
- working with items)</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="hingsas">
- <para>DEPARTMENT<itemizedlist>
- <listitem>
- <para>Departments are required by and will be used in the <link linkend="coursereserves">Course Reserves</link> module</para>
- </listitem>
- </itemizedlist></para>
- </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.</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="hingsc">
- <para>HINGS_C</para>
- <itemizedlist>
- <listitem>
- <para>General Holdings: Completeness Designator</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="hingspf">
- <para>HINGS_PF</para>
- <itemizedlist>
- <listitem>
- <para>Physical Form Designators</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="hingsrd">
- <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 id="hingsut">
- <para>HINGS_UT</para>
- <itemizedlist>
- <listitem>
- <para>General Holdings: Type of Unit Designator</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="shelvelocvals">
- <para>LOC</para>
- <itemizedlist>
- <listitem>
- <para>Shelving location (usually appears when adding or editing an item)</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="lost">
- <para>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 id="manualinvvals">
- <para>MANUAL_INV</para>
- <itemizedlist>
- <listitem>
- <para>Values for manual invoicing types</para>
- </listitem>
- <listitem>
- <para>
- <important>
- <para>The value set as the Authorized Value for the MANUAL_INV authorized
- value category will appear as the Description and the Authorized Value
- Description will be used as the amount. Enter monetary amounts in the
- description without currency symbols.</para>
- </important>
- </para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="notforloan">
- <para>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>
- <note>
- <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>
- </note>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="procauth">
- <para>ORDER_CANCELLATION_REASON<itemizedlist>
- <listitem>
- <para>Reasons why an order might have been cancelled</para>
- </listitem>
- </itemizedlist></para>
- </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 id="reportgroup">
- <para>REPORT_GROUP</para>
- <itemizedlist>
- <listitem>
- <para>A way to sort and filter your reports, the default values in this category
- include the Koha modules (Accounts, Acquitisions, Catalog, Circulation,
- Patrons)</para>
- <screenshot>
- <screeninfo>Report Groups</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/basicparams/report_group.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="reportsubgroup">
- <para>REPORT_SUBGROUP</para>
- <itemizedlist>
- <listitem>
- <para>Can be used to further sort and filter your reports. This category is empty
- by default. Values here need to include the authorized value code from
- REPORT_GROUP in the Description (OPAC) field to link the subgroup to the
- appropriate group.</para>
- <screenshot>
- <screeninfo>Report Subgroups</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/basicparams/report_subgroup.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="restricted">
- <para>RESTRICTED</para>
- <itemizedlist>
- <listitem>
- <para>Restricted status of an item</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="suggestauthorized">
- <para>ROADTYPE<itemizedlist>
- <listitem>
- <para>Road types to be used in patron addresses</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>SIP_MEDIA_TYPE<itemizedlist>
- <listitem>
- <para>Used when <link linkend="additemtype">creating</link> or <link linkend="edititemtype">editing</link> an item type to assign a SIP specific
- media type for devices like lockers and sorters.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>SUGGEST</para>
- <itemizedlist>
- <listitem>
- <para>List of patron suggestion reject or accept reasons (appears when managing
- suggestions)</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="withdrawnauth">
- <para>WITHDRAWN</para>
- <itemizedlist>
- <listitem>
- <para>Description of a withdrawn item (appears when adding or editing an
- item)</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="yesnoauth">
- <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><link linkend="newauthvalcat">Add new Authorized Value Category</link></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 would like to limit this authorized value category to only specific
- libraries you can choose them from the 'Branches limitation' menu. To have it
- show for all libraries just choose 'All branches' at the top of the list.</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><link linkend="newauthval">Add new Authorized Value</link></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 would like to limit this authorized value category to only specific
- libraries you can choose them from the 'Branches limitation' menu. To have it show
- for all libraries just choose 'All branches' at the top of the list.</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><link linkend="patscirc">Patrons & Circulation</link></title>
-
- <para>Settings for controlling circulation and patron
- information.</para>
-
- <section id="patcats">
- <title><link linkend="patcats">Patron Categories</link></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><link linkend="addingpatroncat">Adding a patron category</link></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>
-
- <itemizedlist>
- <listitem>
- <important>
- <para>This value will only be checked if <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
- defines the dateofbirth as a required field on the patron
- record</para>
- </important>
- </listitem>
- </itemizedlist>
- </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>
-
- <itemizedlist>
- <listitem>
- <important>
- <para>This value will only be checked if <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
- defines the dateofbirth as a required field on the patron
- record</para>
- </important>
- </listitem>
- </itemizedlist>
- </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>
- <listitem>
- <note><para>Depending on your value for the <link linkend="FeeOnChangePatronCategory">FeeOnChangePatronCategory</link> preference this fee will be charged on
- patron renewal as well as when they are first enrolled.</para></note>
- </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>The Branch Limitations let you limit this patron category to only some branches
- in your library system. Select 'All branches' if you would like any library to be
- able to use this category.</para>
- </listitem>
- <listitem>
- <para>You can decide if this patron category is blocked from performing actions in the
- OPAC if their card is expired using the next option. By default it will follow the
- rule set in the <link linkend="BlockExpiredPatronOpacActions">BlockExpiredPatronOpacActions</link> preference<screenshot>
- <screeninfo>Block expired patrons</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/patroncirc/blockexpired.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- <listitem>
- <para>Next you can choose the default privacy settings for this patron category. This
- setting can be edited by the patron via the OPAC if you allow it with the <link linkend="OPACPrivacy">OPACPrivacy</link> system preference.<screenshot>
- <screeninfo>Default privacy</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/patroncirc/defaultprivacy.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- <listitem>
- <para>Finally you can assign advanced messaging preferences by default to a patron
- category</para>
- <itemizedlist>
- <listitem>
- <para>
- <important>
- <para>Requires that you have <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link> enabled</para>
- </important>
- </para>
- </listitem>
- <listitem>
- <para>These defaults will be applied to new patrons that are added to the system.
- They will not edit the preferences of the existing patrons. Also, 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.<itemizedlist>
- <listitem>
- <note>
- <para>After setting the default for the patron category you can force
- those changes to all existing patrons by running the <emphasis role="italic">borrowers-force-messaging-defaults</emphasis> script
- found in the <emphasis role="italic">misc/maintenance</emphasis> folder.
- Ask your system administrator for assistance with this script.</para>
- </note>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </section>
- </section>
- <section id="circfinerules">
- <title><link linkend="circfinerules">Circulation and Fine Rules</link></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>default (all libraries), same patron type, same item type</para>
- </listitem>
- <listitem>
- <para>default (all libraries), same patron type, all item types</para>
- </listitem>
- <listitem>
- <para>default (all libraries), all patron types, same item type</para>
- </listitem>
- <listitem>
- <para>default (all libraries), all patron types, all item types</para>
- </listitem>
- </itemizedlist>
- <para>The <link linkend="CircControl">CircControl</link> and <link linkend="HomeOrHoldingBranch">HomeOrHoldingBranch</link> also come in to play when
- figuring out which circulation rule to follow.<itemizedlist>
- <listitem>
- <para>If CircControl is set to "the library you are logged in at" circ rules will be
- selected based on the library you are logged in at </para>
- </listitem>
- <listitem>
- <para>If CircControl is set to "the library the patron is from" circ rules will be
- selected based on the patron's library </para>
- </listitem>
- <listitem>
- <para>If CircControl is set to "the library the item is from" circ rules will be
- selected based on the item's library where HomeOrHoldingBranch chooses if item's
- home library is used or holding library is used.</para>
- </listitem>
- <listitem>
- <para>If <link linkend="IndependentBranches">IndependentBranches</link> is set to
- 'Prevent' then the value of HomeOrHoldingBranch is used in figuring out if the item
- can be checked out. If the item's home library does not match the logged in library,
- the item cannot be checked out unless you are a <link linkend="patronpermsdefined">superlibrarian</link>.</para>
- </listitem>
- </itemizedlist></para>
- <note>
- <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>
- </note>
- <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><link linkend="defaultcircrules">Default Circulation Rules</link></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>If you're allowing <link linkend="OnSiteCheckouts">OnSiteCheckouts</link> then
- you may also want to set a limit on the number of items patron's can have onsite.<itemizedlist>
- <listitem>
- <note>
- <para>This setting also depends on the <link linkend="ConsiderOnSiteCheckoutsAsNormalCheckouts">ConsiderOnSiteCheckoutsAsNormalCheckouts</link> preference</para>
- </note>
- </listitem>
- </itemizedlist></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
- calculated in in the 'Unit' column</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>'When to charge' is most handy in libraries that have a fine charging interval
- of more than 1 day. <itemizedlist>
- <listitem>
- <para>End of interval<itemizedlist>
- <listitem>
- <para>Given a grace period of 2 days and a fine interval of 7 days, the
- first fine will appear 7 days after the due date, it will always take
- one fine interval (7 days), before the first fine is charged</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>Start of interval<itemizedlist>
- <listitem>
- <para>Given a grace period of 2 days and a fine interval of 7 days, the
- first fine will appear 2 days after the due date and the second fine 7
- days after the due date.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist></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>The 'Overdue fines cap' is the maximum fine for this patron and item
- combination</para>
- <itemizedlist>
- <listitem>
- <important>
- <para>If this field is left blank then Koha will not put a limit on the fines
- this item will accrue. A maximum fine amount can be set using the <link linkend="MaxFine">MaxFine</link> system preference.</para>
- </important>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>If you would like to prevent overcharging patrons for a lost items, you can
- check the box under 'Cap fine at replacement price.' This will prevent the patron's
- fines from going above the replacement price on the item.<itemizedlist>
- <listitem>
- <note>
- <para>If the 'Overdue fines cap' is also set, the fine will be the lesser of
- the two, if both apply to the given overdue checkout.</para>
- </note>
- </listitem>
- </itemizedlist></para>
- </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>You can also define the maximum number of days a patron will be suspended in the
- 'Max suspension duration' setting</para>
- </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 you're allowing renewals you can control how long the renewal loan period
- will be (in the units you have chosen) in the 'Renewal period' box</para>
- </listitem>
- <listitem>
- <para>If you're allowing renewals you can control how soon before the due date patrons
- can renew their materials with the 'No renewals before' box.<itemizedlist>
- <listitem>
- <para>Items can be renewed at any time if this value is left blank. Otherwise
- items can only be renewed if the item is due after the number in units
- (days/hours) entered in this box.</para>
- </listitem>
- <listitem>
- <para>To control this value on a more granular level please set the <link
- linkend="NoRenewalBeforePrecision">NoRenewalBeforePrecision</link>
- preference.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>You can enable automatic renewals for certain items/patrons if you'd like. This
- will renew automatically following your circulation rules unless there is a hold on
- the item<itemizedlist>
- <listitem>
- <important>
- <para>You will need to enable the <link linkend="autorenewcron">automatic
- renewal cron job</link> for this to work.</para>
- </important>
- </listitem>
- <listitem>
- <important>
- <para>This feature needs to have the "no renewal before" column filled in or
- it will auto renew everyday after the due date </para>
- </important>
- </listitem>
- </itemizedlist></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>Next you can decide if this patron/item combo are allowed to place holds on
- items that are on the shelf (or available in the library) or not. If you choose 'no'
- then items can only be placed on hold if checked out</para>
- </listitem>
- <listitem>
- <para>You can also decide if patrons are allowed to place item specific holds on the
- item type in question. The options are:<itemizedlist>
- <listitem>
- <para>Allow: Will allow patrons the option to choose next available or item
- specific</para>
- </listitem>
- <listitem>
- <para>Don't allow: Will only allow patrons to choose next available</para>
- </listitem>
- <listitem>
- <para>Force: Will only allow patrons to choose an specific item</para>
- </listitem>
- </itemizedlist></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, simply click the
- 'Edit' link to the right of the fule and edit the values that appear filled in at the
- bottom of the form.</para>
- <screenshot>
- <screeninfo>Edit circ and fine rule</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/patroncirc/editcircfine.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If you would like to delete your rule, 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><link linkend="defaultcheckoutpolicy">Default Checkouts and Hold Policy</link></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. This is the fall back
- rule for defaults.</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 if no other option is set in the forms below.</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>In 'Total current on-site checkouts allowed' enter the total number of items
- patrons can have checked out on site at a time (<link linkend="OnSiteCheckouts">OnSiteCheckouts</link> needs to be set to 'Enable')</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 if there is a limit to filling a hold based on the item's library<itemizedlist>
- <listitem>
- <para>any library</para>
- </listitem>
- <listitem>
- <para>item's home library</para>
- </listitem>
- <listitem>
- <para>item's holding library</para>
- </listitem>
- <listitem>
- <note>
- <para>The patron's home library should not affect whether a patron can place
- the hold, instead the hold will only be fillable when an item matching the
- pickup location becomes available.</para>
- </note>
- </listitem>
- </itemizedlist></para>
- </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><link linkend="checkoutperpatron">Checkouts Per Patron</link></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>
- <note>
- <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>
- </note>
- <para>For example, if you have a rule in the matrix that says Board patrons are allowed 10
- books and 5 DVDs but you want to make it so that Board patrons only have a total of 12
- things checked out at once. If you enter 12 here and the patron has 10 books out
- already they will only be allowed 2 DVDs to equal the 12 total they're allowed.</para>
- </section>
- <section id="holdpolicies">
- <title><link linkend="holdpolicies">Item Hold Policies</link></title>
- <para>For this library, you can edit hold and return policies for a given item type,
- regardless of the patron's category.</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>Control if there is a limit to filling a hold based on the item's library<itemizedlist>
- <listitem>
- <para>any library</para>
- </listitem>
- <listitem>
- <para>item's home library</para>
- </listitem>
- <listitem>
- <para>item's holding library</para>
- </listitem>
- <listitem>
- <note>
- <para>The patron's home library should not affect whether a patron can place
- the hold, instead the hold will only be fillable when an item matching the
- pickup location becomes available.</para>
- </note>
- </listitem>
- </itemizedlist></para>
-
- <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>
- <para>For example you might allow holds at your libraries but not what New items or DVDs to
- be placed on hold by other branches so you can set the 'Hold policy' to 'From home
- library' so that those items can only be placed on hold if the items' owning library and
- the patron's home library are the same. You can also block holds completely on specific
- item types from this form. This is also how you can set up floating item types and
- types that remain with their home library.</para>
- </section>
- </section>
- <section id="patronattributetypes">
- <title><link linkend="patronattributetypes">Patron Attribute Types</link></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><link linkend="addpatattributes">Adding Patron Attributes</link></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>
- <para>Unique attributes can be used as match points on the <link linkend="patronimport">patron import tool</link></para>
- </listitem>
- <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 would like this attribute to only be used by specific branches you can
- choose those branches from the 'Branches limitation' list. Choose 'All branches' to
- show it for all libraries.<itemizedlist>
- <listitem>
- <important>
- <para>Note that items with locations already set on them will not be altered.
- The branch limitation only limits the choosing of an authorized value based
- on the home branch of the current staff login. All authorized values for
- item records (LOC, LOST, CCODE, etc) will show in the OPAC for all
- patrons.</para>
- </important>
- </listitem>
- </itemizedlist></para>
- </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><link linkend="editpatattributes">Editing/Deleting Patron Attributes</link></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="libtransferlimits">
- <title><link linkend="libtransferlimits">Library Transfer Limits</link></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="transportcostmatrix">
- <title><link linkend="transportcostmatrix">Transport cost matrix</link></title>
- <para>The Transport cost matrix lets a library system define relative costs to transport
- books to one another. In order for the system to use this matrix you must first set the
- <link linkend="UseTransportCostMatrix">UseTransportCostMatrix</link> preference to
- 'Use'. <important>
- <para>The Transport cost matrix takes precedence in controlling where holds are filled
- from, if the matrix is not used then Koha checks the <link linkend="holdqueueweight">StaticHoldsQueueWeight</link>.</para>
- </important></para>
- <para>Costs are decimal values between some arbitrary maximum value (e.g. 1 or 100) and 0
- which is the minimum (no) cost. For example, you could just use the distance between each
- library in miles as your 'cost', if that would accurately reflect the cost of transferring
- them. Perhaps post offices would be a better measure. Libraries sharing a post office
- would have a cost of 1, adjacent post offices would have a cost of 2, etc.</para>
- <para>To enter transport costs simply click in the cell you would like to alter, uncheck the
- 'Disable' box and enter your 'cost'</para>
- <screenshot>
- <screeninfo>Transport cost matrix</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/patroncirc/transportcostmatrix.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>After entering in your cost, hit 'Enter' on your keyboard or click the 'Save' button
- at the bottom of the matrix to save your changes.</para>
- <para>
- <note>
- <para>A NULL value will make no difference where the From and To libraries are the same
- library. However, as a best practice, you should put a 0 in there. For all other
- To/From combinations, a NULL value will cause that relationship to act as if it has
- been disabled. So, in summary, don't leave any of the values empty. It's best to
- always put a number in there ( even if you choose to disable that given To/From option
- ).</para>
- </note>
- </para>
- </section>
- <section id="itemcircalerts">
- <title><link linkend="itemcircalerts">Item Circulation Alerts</link></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 overridden 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 id="citytowns">
- <title><link linkend="citytowns">Cities and Towns</link></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><link linkend="addingcity">Adding a City</link></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><link linkend="citiesonpatform">Viewing Cities on Patron Add Form</link></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>
-
- <section id="catadmin">
- <title><link linkend="catadmin">Catalog Administration</link></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><link linkend="marcbibframeworks">MARC Bibliographic Frameworks</link></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><link linkend="addframework">Add New Framework</link></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><link linkend="editframeworks">Edit Existing Frameworks</link></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><link linkend="addsubfieldsframework">Add subfields to Frameworks</link></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><link linkend="editsubfields">Edit Framework Subfields</link></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) that is uneditable</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>
- </listitem>
-
- <listitem>
- <para>For each subfield you can set the following Basic constraint values</para>
- <screenshot>
- <screeninfo>Editing the 504 Subfield</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/cataloging/editsubfield.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <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>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>For each subfield you can set the following Advanced constraint values</para>
- <screenshot>
- <screeninfo>Advanced constraints</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/cataloging/advancedoptsubfield.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <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>
- <listitem>
- <note>
- <para>If you would like a field to fill in with today's date you can use the
- YYYY MM DD syntax in the 'Default value'. For example: a default of
- "Year:YYYY Month:MM Day:DD" (without quotes) will print as "Year:2015
- Month:11 Day:30"</para>
- </note>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Visibility</para>
- <itemizedlist>
- <listitem>
- <para>allows you to select from where this subfield is visible/hidden, simply
- check the boxes where you would like the field to show and uncheck the boxes
- where you would like it hidden.</para>
- <screenshot>
- <screeninfo>Framework visibility</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/cataloging/frameworkvisibility.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </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. If you need to change this value you must ask your system
- administrator to run misc/batchRebuildBiblioTables.pl. </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>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>For each subfield you can set the following Other option values</para>
- <screenshot>
- <screeninfo/>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/cataloging/otheroptssubfield.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <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>Examples:<itemizedlist>
- <listitem id="cnbrowseplugin">
- <para>For call numbers there is an option to add a call number browser
- next to the the call number subfield so that you can identify which
- call numbers are in use and which are not. Simply choose the
- cn_browser.pl plugin. Learn more in the <link linkend="addingitems">cataloging section</link> of this manual.</para>
- </listitem>
- <listitem>
- <para>If you'd like to let file uploads via cataloging you can choose
- the upload.pl plugin and this will allow you to <link linkend="uploadbibfile">upload files to Koha to link to your
- records</link>.</para>
- </listitem>
- <listitem>
- <para>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></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><link linkend="importexportframeworks">Import/Export Frameworks</link></title>
-
- <para>Next to each framework is a link to either import or export
- the framework.</para>
-
- <section id="exportframeworks">
- <title><link linkend="exportframeworks">Export Framework</link></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><link linkend="importframeworks">Import Framework</link></title>
-
- <para>An easy way to create a new framework is to import one created for your or another
- Koha installation. This framework would need to be exported from the other system
- <link linkend="exportframeworks">using the instructions above</link> to be available
- for import here. </para>
- <para>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><link linkend="kohamarcmapping">Koha to MARC Mapping</link></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><link linkend="keywordmapping">Keywords to MARC Mapping</link></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. <note>
- <para>Chain together the fields you want to show after the item
- title in the order in which you want them to appear.</para>
- </note></para>
-
- <para>Future developments will include additional keyword assigned
- fields.</para>
- </section>
-
- <section id="marcbibframeworkstest">
- <title><link linkend="marcbibframeworkstest">MARC Bibliographic Framework Test</link></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><link linkend="authoritiesadmin">Authority Types</link></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>
- <authorgroup>
- <author>
- <firstname>Savitra</firstname>
- <surname>Sirohi</surname>
- <affiliation>
- <orgname>Nucsoft OSS Labs</orgname>
- </affiliation>
- </author>
-
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- <contrib>Fixed typos, changed content where
- necessary and added new screenshots.</contrib>
- </editor>
- </authorgroup>
-
- <pubdate>2010</pubdate>
- </sectioninfo>
-
- <title><link linkend="classificationsources">Classification Sources</link></title>
-
- <para>Source of classification or shelving scheme is an <link linkend="authorizedvalues">Authorized Values</link> category that is mapped to field 952$2 and 942$2 in Koha's
- MARC Bibliographic frameworks and stored in the items.cn_source field in the
- database.</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><link linkend="addingclasssource">Adding/Editing Classification Sources</link></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><link linkend="classfilingrules">Classification Filing Rules</link></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">
- <sectioninfo>
- <authorgroup>
- <author>
- <firstname>Joy</firstname>
- <surname>Nelson</surname>
- <affiliation>
- <orgname>ByWater Solutions</orgname>
- </affiliation>
- </author>
-
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- <contrib>Changed/edited content where necessary.</contrib>
- </editor>
- </authorgroup>
-
- <pubdate>2013</pubdate>
- </sectioninfo>
- <title><link linkend="recordmatchingrules">Record Matching Rules</link></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>It is important to understand the difference between Match Points and Match Checks
- before adding new matching rules to Koha.</para>
-
- <para>Match Points are the criteria that you enter that must be met in order for an incoming
- record to match an existing MARC record in your catalog. You can have multiple match
- points on an import rule each with its own score. An incoming record will be compared
- against your existing records (‘one record at a time’) and given a score for each match
- point. When the total score of the matchpoints matches or exceeds the threshold given for
- the matching rule, Koha assumes a good match and imports/overlays according your
- specifications in the import process. An area to watch out for here is the sum of the
- match points. Doublecheck that the matches you want will add up to a successful
- match.</para>
-
-<para>Example: </para>
- <para>Threshold of 1000 </para>
- <para>Match Point on 020$a 1000 </para>
- <para>Match Point on 022$a 1000 </para>
- <para>Match Point on 245$a 500 </para>
- <para>Match Point on 100$a 100</para>
-
-<para>In the example above, a match on either the 020$a or the 022$a will result in a successful match. A match on 245$a title and 100$a author (and not on 020$a or 022$a) will only add up to 600 and not be a match. And a match on 020$a and 245$a will result in 1500 and while this is a successful match, the extra 500 point for the 245$a title match are superfluous. The incoming record successfully matched on the 020$a without the need for the 245$a match. However, if you assigned a score of 500 to the 100$a Match Point, a match on 245$a title and 100$a author will be considered a successful match (total of 1000) even if the 020$a is not a match.</para>
-
-<para>Match Checks are not commonly used in import rules. However, they can serve a couple of
- purposes in matching records. First, match checks can be used as the matching criteria
- instead of the match points if your indexes are stale and out of date. The match checks go
- right for the data instead of relying on the data in the indexes. (If you fear your
- indexes are out of date, a rebuild of your indexes would be a great idea and solve that
- situation!) The other use for a Match Check is as a “double check” or “veto” of your
- matching rule. For example, if you have a matching rule as below:</para>
-<para>Threshold of 1000 </para>
- <para>Match Point on 020$a 1000 </para>
- <para>Match Check on 245$a</para>
-
-<para>Koha will first look at the 020$a tag/subfield to see if the incoming record matches an existing record. If it does, it will then move on to the Match Check and look directly at the 245$a value in the incoming data and compare it to the 245$a in the existing ‘matched’ record in your catalog. If the 245$a matches, Koha continues on as if a match was successful. If the 245$a does not match, then Koha concludes that the two records are not a match after all. The Match Checks can be a really useful tool in confirming true matches.</para>
-
-<para>When looking to create matching rules for your authority records the following indexes will be
- of use:</para>
- <table frame="void" id="authorityindexes">
- <caption>Authority Indexes</caption>
- <thead>
- <tr>
- <th>Index name</th>
- <th>Matches Marc Tag</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>LC-cardnumber</td>
- <td>010$a</td>
- </tr>
- <tr>
- <td>Personal-name</td>
- <td>100$a</td>
- </tr>
- <tr>
- <td>Corporate-name-heading</td>
- <td>110$a</td>
- </tr>
- <tr>
- <td>Meeting-name</td>
- <td>111$a</td>
- </tr>
- <tr>
- <td>Title-uniform</td>
- <td>130$a</td>
- </tr>
- <tr>
- <td>Chronological-term</td>
- <td>148$a</td>
- </tr>
- <tr>
- <td>Subject-topical</td>
- <td>150$a</td>
- </tr>
- <tr>
- <td>Name-geographic</td>
- <td>151$a</td>
- </tr>
- <tr>
- <td>Term-genre-form</td>
- <td>155$a</td>
- </tr>
- </tbody>
- </table>
- <section id="addrecordmatchrule">
- <title><link linkend="addrecordmatchrule">Adding Matching Rules</link></title>
- <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' is the total number of 'points' a biblio must earn to be
- considered a 'match'</para>
- </listitem>
- <listitem>
- <para>'Record type' is the type of import this rule will be used for - either
- authority or bibliographic</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>
- </section>
- <section id="samplerecordmatch">
- <title><link linkend="samplerecordmatch">Sample Bibliographic Record Matching Rule: Control Number</link></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>Record type: Bibliographic<itemizedlist>
- <listitem>
- <note>
- <para>If you'd like a rule to match on the 001 in authority records you will
- need the repeat all of these values and change just the record type to
- 'Authority record'</para>
- </note>
- </listitem>
- </itemizedlist></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><link linkend="oaisetsconfig">OAI Sets Configuration</link></title>
-
- <para>On this page you can create, modify and delete OAI-PMH
- sets</para>
-
- <section id="oaicreate">
- <title><link linkend="oaicreate">Create a set</link></title>
-
- <para>To create 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><link linkend="oaimodify">Modify/Delete a set</link></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><link linkend="oaimapping">Define mappings</link></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><link linkend="oaibuild">Build sets</link></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 id="itemsearchadmin">
- <title><link linkend="itemsearchadmin">Item search fields</link></title>
- <para>From here you can add custom search fields to the <link linkend="searchguide-itemsearch">item search</link> option in the staff client. <screenshot>
- <screeninfo>Item search fields</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/cataloging/itemsearchfields.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>To add a new search term simply click the 'New search field' button<screenshot>
- <screeninfo>Add new field</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/cataloging/additemsearchfields.png"/>
- </imageobject>
- </mediaobject>
- </screenshot><itemizedlist>
- <listitem>
- <para>Name is a field for you to identify the search term</para>
- </listitem>
- <listitem>
- <para>Label is what will appear on the item search page</para>
- </listitem>
- <listitem>
- <para>MARC field allows you to pick which field you'd like to search in</para>
- </listitem>
- <listitem>
- <para>MARC subfield is the subfield you'd like to search in</para>
- </listitem>
- <listitem>
- <para>Authorised values category can be used to turn this search field in to a pull
- down instead of a free text field</para>
- </listitem>
- </itemizedlist></para>
- <para>Once your new field is added it will be visible at the top of this page and on the
- item search page<screenshot>
- <screeninfo>Search option</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/cataloging/customsearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </section>
- </section>
-
- <section id="acqadmin">
- <title><link linkend="acqadmin">Acquisitions</link></title>
-
- <para>The Koha Acquisitions module provides a way for the library to
- record orders placed with vendors and manage purchase budgets.</para>
-
- <para>Before using the <link linkend="acqmodule">Acquisitions
- Module</link>, you will want to make sure that you have completed all of
- the set up.</para>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Administration >
- Acquisitions</para>
- </listitem>
- </itemizedlist>
-
- <section id="currexchangeadmin">
- <title><link linkend="currexchangeadmin">Currencies and Exchange Rates</link></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>
-
- <note>
- <para>This data is not automatically updated, so be sure to keep it
- up to date so that your accounting is kept correct.</para>
- </note>
- <para>The ISO code you enter will be used when importing MARC files via the staging tools,
- the tool will attempt to find and use the price of the currently active currency. </para>
-
- <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><link linkend="budgetplanning">Budgets</link></title>
-
- <para>Budgets are used for tracking accounting values related to acquisitions. For example
- you could create a Budget for the current year (ex. 2015) and then break that into <link linkend="funds">Funds</link> for different areas of the library (ex. Books, Audio,
- etc).</para>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Administration
- > Acquisitions > Budgets</para>
- </listitem>
- </itemizedlist>
-
- <para>When visiting the main budget administration you will see two
- tabs, one for active and one for inactive budgets.</para>
-
- <screenshot>
- <screeninfo>Budgets List</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <section id="addbudget">
- <title><link linkend="addbudget">Adding budgets</link></title>
-
- <para>Budgets can either be created <link linkend="addnewbudget">from scratch</link>, by
- <link linkend="duplicatebudget">duplicating the previous year's budget</link> or by
- <link linkend="closebudget">closing a previous year's budget</link>.</para>
- <section id="addnewbudget">
- <title><link linkend="addnewbudget">Add a new budget</link></title>
- <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/budgetslist.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- <section id="duplicatebudget">
- <title><link linkend="duplicatebudget">Duplicate a budget</link></title>
- <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 can also click the 'Actions' button to the right of the budget and choose 'Duplicate'.<screenshot>
- <screeninfo>Duplicate budget</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/acquisitions/duplicateaction.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>In both cases 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>Check the box for 'Mark the original budget as inactive' if the original budget
- should no longer be used. </para>
- <para>Check the box for 'Set all funds to zero' if you wish the new budget to contain
- all the same fund structures as the previous budget but no allocations until you
- manually enter an amount in the fund.</para>
- <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 and so that you
- can move unreceived orders and if desired unspent funds from a previous budget to the
- new budget.</para>
- </section>
- <section id="closebudget">
- <sectioninfo>
- <authorgroup>
- <author>
- <firstname>Denise</firstname>
- <surname>Hannibal</surname>
- <affiliation>
- <orgname>Washington University in St. Louis</orgname>
- </affiliation>
- </author>
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- </editor>
- </authorgroup>
- <pubdate>2014</pubdate>
- </sectioninfo>
- <title><link linkend="closebudget">Close a budget</link></title>
- <para>Close a budget to move or roll over unreceived orders and if desired unspent funds
- from a previous budget to a new budget. Before closing your budget you might want to
- <link linkend="duplicatebudget">duplicate the previous year's budget</link> so that
- you have somewhere for the unreceived orders to roll to.</para>
- <para>Find the previous budget with unreceived orders on the Active budgets or the
- Inactive budgets tab and select 'Close' under 'Actions'. <screenshot>
- <screeninfo>Close a budget</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/acquisitions/closebudget.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <note>
- <para>In order for the unreceived orders to be automatically moved to the new budget,
- the fund structures in the previous budget must exist in the new budget. Budgets
- without unreceived orders cannot be closed.</para>
- </note>
- <para>When you select 'Close' you will be presented with a form.<screenshot>
- <screeninfo>Closing a budget</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/acquisitions/closebudgetoptions.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>Use the 'Select a budget' drop down to choose the new budget for the unreceived
- orders.</para>
- <para>Check the box for 'Move remaining unspent funds' to move the unspent amounts from
- the funds of the budget being closed to the selected budget.</para>
- <para>Once you have made your choices, click the 'Move unreceived orders' button. You
- will be presented with a dialog box that says 'You have chosen to move all unreceived
- orders from 'Budget X' to 'Budget Y'. This action cannot be reversed. Do you wish to
- continue?' Budget X is the budget to be closed and Budget Y is the selected budget. <screenshot>
- <screeninfo>Close warning</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/acquisitions/closewarning.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>If everything seems correct click 'OK' and the unreceived orders and, if selected,
- unspent funds will be moved. </para>
- <para>Wait until the 'Report after moving unreceived orders from budget X to Y'
- displays. This will list the order numbers which have been impacted (grouped by fund)
- and detail if the unreceived order was moved or if there was a problem. For example,
- if the new budget does not contain a fund with the same name as the previous budget,
- the order will not be moved.</para>
- <screenshot>
- <screeninfo>Close report</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/acquisitions/closereport.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- </section>
- </section>
-
- <section id="funds">
- <title><link linkend="funds">Funds</link></title>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Administration
- > Acquisitions > Funds</para>
- </listitem>
- </itemizedlist>
-
- <section id="addbudgetfund">
- <title><link linkend="addbudgetfund">Add a Fund</link></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 want 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>Warning at (%) or Warning at (amount) can be filled in to make Koha warn you
- before you spend a certain percentage or amount of your budget. This will prevent
- you from overspending.</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',
- 'owner and users' or 'owner, users and 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>
- <itemizedlist>
- <listitem>
- <important>
- <para>Without an owner, the access restriction will be ignored, be sure to enter
- an owner as well as choose a restriction</para>
- </important>
- </listitem>
- </itemizedlist>
- </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>The monetary columns in the fund table break down as follows:<orderedlist>
- <listitem>
- <para>Base-level allocated is the "Amount" value you defined when creating the
- fund</para>
- </listitem>
- <listitem>
- <para>Base-level ordered is the ordered amount for this fund (without child
- funds)</para>
- </listitem>
- <listitem>
- <para>Total ordered is the base-level ordered for this fund and all its child
- funds</para>
- </listitem>
- <listitem>
- <para>Base-level spent is the spent amount for this fund (without child
- funds)</para>
- </listitem>
- <listitem>
- <para>Total spent is the base-level spent for this fund and all its child
- funds</para>
- </listitem>
- <listitem>
- <para>Base-level available is 1 - 2</para>
- </listitem>
- <listitem>
- <para>Total available is 1 - 3</para>
- </listitem>
- </orderedlist></para>
-
- <para>To the right of each fund you will find the 'Actions' button under which you will
- find the 'Edit,' 'Delete,' and 'Add Child Fund' options. </para>
- <screenshot>
- <screeninfo>Fund actions</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/acquisitions/fundactions.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>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>
- <para>Funds with children will show with a small arrow to the left. Clicking that will
- show you the children funds.</para>
- <screenshot>
- <screeninfo>Child funds</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/acquisitions/childfunds.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="fundsplanning">
- <title><link linkend="fundsplanning">Budget Planning</link></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 'hide' link 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 id="ediaccounts">
- <title><link linkend="ediaccounts">EDI Accounts</link></title>
- <para>From here you can set up the information needed to connect to your acquisitions
- vendors. <note>
- <para>Before you begin you will need at least one <link linkend="addacqvendor">Vendor
- set up in Acquisitions</link>.</para>
- </note></para>
- <para>To add account information click the 'New account' button.<screenshot>
- <screeninfo>New account</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/acquisitions/newedi.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>In the form that appears you will want to enter your vendor information. </para>
- <para>
- <screenshot>
- <screeninfo>New account information</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/acquisitions/newediaccount.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </para>
- <para>Each vendor will have one account.</para>
- </section>
- <section id="libraryeans">
- <title><link linkend="libraryeans">Library EANs</link></title>
- <para>A library EAN is the identifier the vendor gives the library to send back to them so
- they know which account to use when billing. One EDI account can have multiple
- EANs.</para>
- <para>To add an EAN click the 'New EAN' button.</para>
- <para>
- <screenshot>
- <screeninfo>New EAN</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/acquisitions/newean.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </para>
- <para>In the form that appears enter the information provided by your vendor.</para>
- <para>
- <screenshot>
- <screeninfo>New EAN Form</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/acquisitions/neweanform.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </para>
- </section>
- </section>
-
- <section id="additionaladmin">
- <title><link linkend="additionaladmin">Additional Parameters</link></title>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Administration >
- Additional Parameters</para>
- </listitem>
- </itemizedlist>
-
- <section id="z3950admin">
- <title><link linkend="z3950admin">Z39.50/SRU servers</link></title>
-
- <para>Z39.50 is a client–server protocol for searching and retrieving information from
- remote computer databases, in short it's a tool used for copy cataloging. </para>
- <para>SRU- Search/Retrieve via URL - is a standard XML-based protocol for search queries,
- utilizing CQL - Contextual Query Language - a standard syntax for representing queries. </para>
- <para>Using Koha you can connect to any Z39.50 or SRU target that is publicly available or
- that you have the log in information to and copy both bibliographic and/or authority
- records from that source.</para>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Administration > Additional
- Parameters > Z39.50/SRU Servers</para>
- </listitem>
- </itemizedlist>
-
- <para>Koha comes with a default list of Z39.50/SRU 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 Z39.50 targets you use IndexData's IRSpy: <ulink url="http://irspy.indexdata.com/">http://irspy.indexdata.com</ulink> or the Library of
- Congress's List of Targets <ulink url="http://www.loc.gov/z3950/">http://www.loc.gov/z3950/</ulink>
- </para>
-
- <section id="addztarget">
- <title><link linkend="addztarget">Add a Z39.50 Target</link></title>
-
- <itemizedlist>
- <listitem>
- <para>From the main Z39.50 page, click 'New Z39.50
- Server'</para>
- <screenshot>
- <screeninfo>New Z39.50 Server Form</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/newz39.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <itemizedlist>
- <listitem>
- <para>'Z39.50 server' should be populated with a name that will help you identify
- the source (such as the library name).</para>
- </listitem>
- <listitem>
- <para>'Hostname' will be the address to the Z39.50 target.</para>
- </listitem>
- <listitem>
- <para>'Port' tells Koha what port to listen on to get results from this
- target.</para>
- </listitem>
- <listitem>
- <para>'Userid' and 'Password' are only required for servers that are password
- protected.</para>
- </listitem>
- <listitem>
- <para>Check the 'Preselected' box if you want this target to always be selected by
- default.</para>
- </listitem>
- <listitem>
- <para>'Rank' lets you enter where in the list you'd like this target to appear.<itemizedlist>
- <listitem>
- <para>If this is left blank the targets will be in alphabetical
- order.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>'Syntax' is the MARC flavor you use.</para>
- </listitem>
- <listitem>
- <para>'Encoding' tells the system how to read special characters.</para>
- </listitem>
- <listitem>
- <para>'Timeout' is helpful for targets that take a long while. You can set the
- timeout so that it doesn't keep trying the target if results aren't found in a
- reasonable amount of time.</para>
- </listitem>
- <listitem>
- <para>'Record type' lets you define if this is a bibliographic or an authority
- target.</para>
- </listitem>
- <listitem>
- <para>'XSLT file(s)' lets enter one or more (comma-separated) XSLT file names that
- you want to apply on the search results.<itemizedlist>
- <listitem>
- <para>When retrieving records from external targets you may wish to automate
- some changes to those records. XSLT's allow you to do this. Koha ships
- with some sample XSLT files in the /koha-tmpl/intranet-tmpl/prog/en/xslt/
- directory ready for use: <itemizedlist>
- <listitem>
- <para>Del952.xsl: Remove items (MARC21/NORMARC)</para>
- </listitem>
- <listitem>
- <para>Del995.xsl: Remove items (UNIMARC)</para>
- </listitem>
- <listitem>
- <para>Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
- (MARC21/NORMARC)</para>
- </listitem>
- <listitem>
- <para>Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
- (UNIMARC)</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="suggestztarget">
- <title><link linkend="suggestztarget">Suggested Bibliographic Z39.50 Targets</link></title>
- <para>Koha libraries with open Z39.50 targets can share and find connection information on
- the Koha wiki: <ulink url="http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources">http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources</ulink>. You can also
- find open Z39.50 targets by visiting IRSpy: <ulink url="http://irspy.indexdata.com">http://irspy.indexdata.com</ulink>.</para>
-
- <para>The following targets have been used successfully by other
- Koha libraries (in the Americas):</para>
-
- <itemizedlist>
- <listitem>
- <para>ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC</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 lx2.loc.gov: 210 LCDB</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>NHUPAC 199.192.6.130:211 nh_nhupac</para>
- </listitem>
- <listitem>
- <para>OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC</para>
- </listitem>
- <listitem>
- <para>OHIOLINK olc1.ohiolink.edu:210 INNOPAC</para>
- </listitem>
- <listitem>
- <para>PUBCAT prod890.dol.state.vt.us:2300 unicorn</para>
- </listitem>
- <listitem>
- <para>SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210 ZSERVER</para>
- </listitem>
- <listitem>
- <para>SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON</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 id="suggestauthz39">
- <title><link linkend="suggestauthz39">Suggested Authority Z39.50 Targets</link></title>
- <para>The following targets have been used successfully by other Koha libraries (in the
- Americas):</para>
- <itemizedlist>
- <listitem>
- <para>LIBRARIESAUSTRALIA AUTHORITIES z3950-test.librariesaustralia.nla.gov.au:210
- AuthTraining Userid: ANLEZ / Password: z39.50</para>
- </listitem>
- <listitem>
- <para>LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF </para>
- </listitem>
- <listitem>
- <para>LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="addsru">
- <title><link linkend="addsru">Add a SRU Target</link></title>
- <itemizedlist>
- <listitem>
- <para>From the main Z39.50/SRU page, click 'New SRU Server'</para>
- <screenshot>
- <screeninfo>New SRU Server Form</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/newsru.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <listitem>
- <para>'Server name' should be populated with a name that will help you identify
- the source (such as the library name).</para>
- </listitem>
- <listitem>
- <para>'Hostname' will be the address to the Z39.50 target.</para>
- </listitem>
- <listitem>
- <para>'Port' tells Koha what port to listen on to get results from this
- target.</para>
- </listitem>
- <listitem>
- <para>'Userid' and 'Password' are only required for servers that are password
- protected.</para>
- </listitem>
- <listitem>
- <para>Check the 'Preselected' box if you want this target to always be selected by
- default.</para>
- </listitem>
- <listitem>
- <para>'Rank' lets you enter where in the list you'd like this target to appear.<itemizedlist>
- <listitem>
- <para>If this is left blank the targets will be in alphabetical
- order.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>'Syntax' is the MARC flavor you use.</para>
- </listitem>
- <listitem>
- <para>'Encoding' tells the system how to read special characters.</para>
- </listitem>
- <listitem>
- <para>'Timeout' is helpful for targets that take a long while. You can set the
- timeout so that it doesn't keep trying the target if results aren't found in a
- reasonable amount of time.</para>
- </listitem>
- <listitem>
- <para>'Additional SRU options' is where you can enter additional options of the
- external server here, like sru_version=1.1 or schema=marc21, etc. Note that
- these options are server dependent.</para>
- </listitem>
- <listitem>
- <para>'SRU Search field mapping' lets you add or update the mapping from the
- available fields on the Koha search form to the specific server dependent index
- names. <itemizedlist>
- <listitem>
- <para>To further refine your searches, you could add the following index
- names to the SRU search field mappings. To do this, edit the server and
- click the Modify button next to this field.
- <table cellpadding="4" cellspacing="4" frame="all">
- <title>SRU Mapping</title>
-
- <tgroup align="left" cols="2" colsep="1" rowsep="1">
- <tbody>
- <row>
- <entry>Title</entry>
- <entry>dc.title</entry>
- </row>
- <row>
- <entry>ISBN</entry>
- <entry>bath.isbn</entry>
- </row>
- <row>
- <entry>Any</entry>
- <entry>cql.anywhere</entry>
- </row>
- <row>
- <entry>Author</entry>
- <entry>dc.author</entry>
- </row>
- <row>
- <entry>ISSN</entry>
- <entry>bath.issn</entry>
- </row>
- <row>
- <entry>Subject</entry>
- <entry>dc.subject</entry>
- </row>
- <row>
- <entry>Standard ID</entry>
- <entry>bath.standardIdentifier</entry>
- </row>
- </tbody>
- </tgroup>
- </table></para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>'XSLT file(s)' lets enter one or more (comma-separated) XSLT file names that
- you want to apply on the search results.<itemizedlist>
- <listitem>
- <para>When retrieving records from external targets you may wish to automate
- some changes to those records. XSLT's allow you to do this. Koha ships
- with some sample XSLT files in the /koha-tmpl/intranet-tmpl/prog/en/xslt/
- directory ready for use: <itemizedlist>
- <listitem>
- <para>Del952.xsl: Remove items (MARC21/NORMARC)</para>
- </listitem>
- <listitem>
- <para>Del995.xsl: Remove items (UNIMARC)</para>
- </listitem>
- <listitem>
- <para>Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
- (MARC21/NORMARC)</para>
- </listitem>
- <listitem>
- <para>Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
- (UNIMARC)</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </section>
- </section>
- <section id="didyoumean">
- <title><link linkend="didyoumean">Did you mean?</link></title>
- <para><emphasis>Get there:</emphasis> More > Administration > Additional Parameters
- > Did you mean?</para>
- <para>Koha can offer 'Did you mean?' options on searches based on values in your <link linkend="catauthorities">authorities</link>. <important>
- <para>Did you mean? only works in the OPAC at this time. The Intranet options are here
- for future development.</para>
- </important></para>
- <para>Using this page you can control which options Koha gives patrons on their search results.</para>
- <screenshot>
- <screeninfo>Did you mean?</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/didyoumean.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>To turn on the 'Did you mean?' bar on your search results you need to check the box
- next to each plugin you would like to use. The two plugins you have to choose from are:<itemizedlist>
- <listitem>
- <para>The ExplodedTerms plugin suggests that the user try searching for
- broader/narrower/related terms for a given search (e.g. a user searching for "New
- York (State)" would click the link for narrower terms if they're also interested in
- "New York (City)"). This is only relevant for libraries with highly hierarchical
- authority data. </para>
- </listitem>
- <listitem>
- <para>The AuthorityFile plugin searches the authority file and suggests the user might
- be interested in bibs linked to the top 5 authorities</para>
- </listitem>
- </itemizedlist></para>
- <para>If you want one plugin to take priority over another you simply drag it above the other.</para>
- <screenshot>
- <screeninfo>Drag and drop options</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/didyoumeandrag.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If you choose both plugins you will see several options at the top of your search results</para>
- <screenshot>
- <screeninfo>Both plugins</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/didyoumeanopacexplode.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If you choose just the AuthorityFile you'll see just authorities.</para>
- <screenshot>
- <screeninfo>AuthorityFile</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/didyoumeanopacauth.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- <section id="admincolumns">
- <title><link linkend="admincolumns">Column settings</link></title>
- <para>This administration area will help you hide or display columns on fixed tables
- throughout the staff client. </para>
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> Administration > Additional Parameters > Column
- settings</para>
- </listitem>
- </itemizedlist>
- <screenshot>
- <screeninfo>Column settings</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/columns.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Clicking on the module you'd like to edit tables for will show you the options
- available to you. </para>
- <para>This area lets you control the columns that show in the table in question. If nothing
- is hidden you will see no check marks in the 'is hidden by default' column.</para>
- <screenshot>
- <screeninfo>Column settings</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/setcurrencynohide.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>And will see all of the columns when viewing the table on its regular page.</para>
- <screenshot>
- <screeninfo>Columns on currency table</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/currenciesnohide.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If columns are hidden they will have checks in the 'is hidden by default'
- column.</para>
- <screenshot>
- <screeninfo>Column settings</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/setcurrencyhide.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>And hidden when you view the table.</para>
- <screenshot>
- <screeninfo>Columns on currency table</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/currencieshide.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>You can also toggle columns using the 'Show/Hide Columns button in the top right of
- the page</para>
- <screenshot>
- <screeninfo>Toggle columns</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/togglecolumns.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- <section id="audioadmin">
- <title><link linkend="audioadmin">Audio alerts</link></title>
- <para>If you have your <link linkend="AudioAlerts">AudioAlerts</link> preference set to
- 'Enable' you will be able to control the various alert sounds that Koha uses from this
- area.</para>
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Administration > Additional Parameters >
- Audio alerts</para>
- </listitem>
- </itemizedlist>
- <para>Each dialog box in Koha has a CSS class assigned to it that can be used as a selector
- for a sound.<screenshot>
- <screeninfo>Audio alerts</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/alerts.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>You can edit the defaults by clicking the 'Edit' button to the right of each alert<screenshot>
- <screeninfo>Edit alert</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/editalert.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>You can assign alerts to other CSS classes in Koha by entering that information in the
- selector box. For example if you enter
- <programlisting id="comment_text_146">body:contains('Check in message')</programlisting></para>
- <para>Then when you visit the checkin page you will hear an alert.</para>
- <para>Every page in Koha has a unique ID in the body tag which can be used to limit a sound
- to a specific page </para>
- <para>Any ID selector (where html contains id="name_of_id" ) and can also be a trigger as:
- #name_of_selector </para>
- </section>
- <section id="smsadmin">
- <title><link linkend="smsadmin">SMS cellular providers</link></title>
- <important><para>This option will only appear if the <link linkend="SMSSendDriver">SMSSendDriver</link>
- preference is set to 'Email'</para></important>
- <para>From here you can enter as many cellular providers as you need to send SMS notices to
- your patrons using the email protocol.<screenshot>
- <screeninfo>SMS Providers</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/smsproviders.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>Some examples in the US are:<table frame="all" id="smsproviderstbl">
- <title>SMS Provider Examples</title>
- <tgroup cols="2">
- <colspec colname="c1" colnum="1"/>
- <colspec colname="c2" colnum="2"/>
- <thead>
- <row>
- <entry>Mobile Carrier</entry>
- <entry>SMS Gateway Domain</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Alltel</entry>
- <entry>sms.alltelwireless.com</entry>
- </row>
- <row>
- <entry>AT&T</entry>
- <entry>txt.att.net</entry>
- </row>
- <row>
- <entry>Boost Mobile</entry>
- <entry>sms.myboostmobile.com</entry>
- </row>
- <row>
- <entry>Project Fi</entry>
- <entry>msg.fi.google.com</entry>
- </row>
- <row>
- <entry>Republic Wireless</entry>
- <entry>text.republicwireless.com</entry>
- </row>
- <row>
- <entry>Sprint</entry>
- <entry>messaging.sprintpcs.com</entry>
- </row>
- <row>
- <entry>T-Mobile</entry>
- <entry>tmomail.net</entry>
- </row>
- <row>
- <entry>U.S. Cellular</entry>
- <entry>email.uscc.net</entry>
- </row>
- <row>
- <entry>Verizon Wireless</entry>
- <entry>vtext.com</entry>
- </row>
- <row>
- <entry>Virgin Mobile</entry>
- <entry>vmobl.com</entry>
- </row>
- </tbody>
- </tgroup>
- </table></para>
-
- <para>To add new providers enter the details in the form and click 'Add new' to save.<screenshot>
- <screeninfo>Add SMS Provider</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/smsadd.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>These options will appear in the OPAC for patrons to choose from on the <link linkend="opacmymsgs">messaging tab</link> if you have <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link> enabled.<screenshot>
- <screeninfo>Options for providers in the OPAC</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/admin/additional/smsopacoptions.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </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><link linkend="patrontools">Patrons and Circulation</link></title>
-
- <para/>
- <section id="patronlists">
- <title><link linkend="patronlists">Patron lists</link></title>
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Patrons and Circulation >
- Patron lists</para>
- </listitem>
- </itemizedlist>
- <para>Patron lists are a way to store a group of patrons for easy modification via the <link linkend="batchpatronmod">batch patron modification tool</link> or reporting.</para>
- <screenshot>
- <screeninfo>Patron lists</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patronlists/patronlists.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>To create a new list of patrons click the 'New patron list' button</para>
- <screenshot>
- <screeninfo>New patron list</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patronlists/newpatronlist.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Enter a list name and save the list.</para>
- <screenshot>
- <screeninfo>Empty patron list</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patronlists/addtopatronlist.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Each list has an 'Actions' menu with more list options.<screenshot>
- <screeninfo>Patron list actions</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patronlists/patronlistmenu.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>To add patrons to the list click the 'Add patrons' link in the 'Actions' menu.</para>
- <screenshot>
- <screeninfo>Add patron to a list</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patronlists/addpatrontolist.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Enter the patron's name or cardnumber in the search box and click on the right result
- to add the patron.</para>
- <screenshot>
- <screeninfo>Patrons to add</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patronlists/patronstoadd.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Once you have all of the patrons you would like to add you can click the 'Add patrons'
- button to save them to the list.</para>
- <screenshot>
- <screeninfo>List of patrons</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patronlists/patronlist.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="comments">
- <title><link linkend="comments">Comments</link></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 page of the staff client below the module list:</para>
-
- <screenshot>
- <screeninfo>Comments pending approval</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/comments/commentswaiting.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>and next to the Comments tool on the Tools Module<screenshot>
- <screeninfo>Comment count on Tools</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/comments/commentswaitingtools.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
-
- <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><link linkend="patronimport">Patron Import</link></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><link linkend="createpatronfile">Creating Patron File</link></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>cardnumber, surname, firstname, title, othernames, initials, streetnumber,
- streettype, address, address2, city, state, zipcode, country, email, phone, mobile, fax,
- emailpro, phonepro, B_streetnumber, B_streettype, B_address, B_address2, B_city,
- B_state, B_zipcode, B_country, B_email, B_phone, dateofbirth, branchcode, categorycode,
- dateenrolled, dateexpiry, gonenoaddress, lost, debarred, debarredcomment, contactname,
- contactfirstname, contacttitle, guarantorid, borrowernotes, relationship, ethnicity,
- ethnotes, sex, password, flags, userid, opacnote, contactnote, sort1, sort2,
- altcontactfirstname, altcontactsurname, altcontactaddress1, altcontactaddress2,
- altcontactaddress3, altcontactstate, altcontactzipcode, altcontactcountry,
- altcontactphone, smsalertnumber, privacy, patron_attributes </para>
-
- <important>
- <para>The 'password' should be stored in plaintext, and will be converted to a Bcrypt
- hash.</para>
-
- <para>If your passwords are already encrypted, talk to your
- systems administrator about options</para>
- </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', 'categorycode' and all fields you have defined in the
- <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> preference are
- required and must match valid entries in your database.</para>
- </important>
-
- <note>
- <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.<itemizedlist>
- <listitem>
- <para>For example: "INSTID:12345,BASEBALL:Cubs" </para>
- </listitem>
- <listitem>
- <para>This field must be wrapped in quotes if multiple values are defined.
- </para>
- </listitem>
- <listitem>
- <para>Since values can contain spaces, additional doubled-quotes may be
- required: <itemizedlist>
- <listitem>
- <para>"INSTID:12345,BASEBALL:Cubs,""BASEBALL:White Sox""" </para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>When replacing a patron record, any attributes specified in the input
- file replace all of the attribute values of any type that were previously
- assigned to the patron record. </para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- </note>
- </section>
-
- <section id="importpatrons">
- <title><link linkend="importpatrons">Importing Patrons</link></title>
-
- <para>Once you have created your file, you can use the Patron Import
- Tool to bring the data into Koha.</para>
-
- <itemizedlist>
- <listitem>
- <para>Choose your CSV file </para>
- <screenshot>
- <screeninfo>Import Patron Form</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/importpatrons/importpatrons.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Choose to match on 'Cardnumber' or 'Username' to prevent adding of duplicate
- card numbers to the system</para>
- <screenshot>
- <screeninfo>Patron match options</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/importpatrons/patronmatch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </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>If match found</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><link linkend="notices">Notices & Slips</link></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>
- <para>You will also want to review the <link linkend="noticesfieldguide">Notices & Slips
- Field Guide</link> for more information on formatting these notices. </para>
-
- <section id="addnotices">
- <title><link linkend="addnotices">Adding Notices & Slips</link></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<itemizedlist>
- <listitem>
- <important>
- <para>Not all notices can be branch specific for more information review the
- <link linkend="noticesfieldguide">Notices & Slips Field Guide</link>
- in this manual. </para>
- </important>
- </listitem>
- </itemizedlist></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 to 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>
- <note>
- <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>
- </note>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>Next you can customize the notice for every possible delivery method<itemizedlist>
- <listitem>
- <para>Every notice should have an Email template set for it<screenshot>
- <screeninfo>New Email notice</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/notices/newemail.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- <listitem>
- <para>If you're using the <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link> service you can set up a Phone notification<screenshot>
- <screeninfo>New Phone notice</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/notices/newphone.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- <listitem>
- <para>If you plan on printing this notice you can set the Print template next<screenshot>
- <screeninfo>New Print notice</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/notices/newprint.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- <listitem>
- <para>If you have enabled SMS notices with the <link linkend="SMSSendDriver">SMSSendDriver</link> preference you can set the text for your SMS notices next<screenshot>
- <screeninfo>New SMS notice</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/notices/newsms.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>Each notice offers you the same options<itemizedlist>
- <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>
- <note>
- <para>Review the <link linkend="noticesfieldguide">Notices & Slip
- Field Guide</link> for info on what fields can be used here.</para>
- </note>
- </listitem>
- <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: <<items.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>
- <listitem>
- <note>
- <para>To add today's date you can use the <<today>> syntax</para>
- </note>
- </listitem>
- <listitem>
- <note>
- <para>If you don't want to print the patron's full name on your slips or
- notice you can enter data in the Other name or Initials field for each
- patron and use that value instead.</para>
- </note>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
-
- <section id="noticemarkup">
- <title><link linkend="noticemarkup">Overdue Notice Markup</link></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. You will also want to review the
- <link linkend="noticesfieldguide">Notices & Slips Field Guide</link> for
- information on formatting item information in these notices. <important>
- <para>These new tags only work on the overdue notices, not other circulation related
- notices at this time.</para>
- </important>These tags are <item> and </item> which should enclose all
- fields from the biblio, biblioitems, and items tables.</para>
-
- <para>An example of using these 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: <<items.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><link linkend="existingnotices">Existing Notices & Slips</link></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. You will also want to review the <link linkend="noticesfieldguide">Notices & Slips Field Guide</link> for information on formatting item information
- in these notices. 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>CHECKIN<itemizedlist>
- <listitem>
- <para>This notice is sent as the 'Check in' notice for all items that are
- checked in</para>
- </listitem>
- <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>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>CHECKOUT<itemizedlist>
- <listitem>
- <para>This notice is sent as the 'Check out' notice for all items that are
- checked out</para>
- </listitem>
- <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>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>DUE<itemizedlist>
- <listitem>
- <para>This notice is sent as the 'Item due' for an item is due</para>
- </listitem>
- <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>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>DUEDGST<itemizedlist>
- <listitem>
- <para>This notice is sent as the 'Item due' for all items that are due</para>
- </listitem>
- <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 as a digest</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>
- </itemizedlist></para>
- </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>MEMBERSHIP_EXPIRY<itemizedlist>
- <listitem>
- <para>This notice can be sent to patrons to warn them that their cards are
- expiring soon.</para>
- </listitem>
- <listitem>
- <para>Requires that you have the <link linkend="MembershipExpiryDaysNotice">MembershipExpiryDaysNotice</link> set and the <link linkend="patronexpirycron">related cron job</link> set.</para>
- </listitem>
- </itemizedlist></para>
- </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>PREDUE<itemizedlist>
- <listitem>
- <para>This notice is sent as the 'Advanced notice' for an item is due</para>
- </listitem>
- <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>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>PREDUEDGST<itemizedlist>
- <listitem>
- <para>This notice is sent as the 'Advanced notice' for all items that are
- due</para>
- </listitem>
- <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 as a digest</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>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>RENEWAL<itemizedlist>
- <listitem>
- <para>This notice is sent as the 'Check out' notice for all items that are
- renewed</para>
- </listitem>
- <listitem>
- <para>This notice is used if three criteria are met:</para>
- <orderedlist>
- <listitem>
- <para>The <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link> is set to 'Allow'</para>
- </listitem>
- <listitem>
- <para>The <link linkend="RenewalSendNotice">RenewalSendNotice</link>
- preference is set to 'Send'</para>
- </listitem>
- <listitem>
- <para>The patron has requested to receive the checkout 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>
- </itemizedlist></para>
- </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>
- <note>
- <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>
- </note>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>SHARE_ACCEPT<itemizedlist>
- <listitem>
- <para>Used to notify a patron when another patron has accepted their shared
- list.</para>
- </listitem>
- <listitem>
- <para>Requires that you set <link linkend="OpacAllowSharingPrivateLists">OpacAllowSharingPrivateLists</link> to 'Allow'</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>SHARE_INVITE <itemizedlist>
- <listitem>
- <para>Used to notify a patron that another patron would like to share a list
- with them.</para>
- </listitem>
- <listitem>
- <para>Requires that you set <link linkend="OpacAllowSharingPrivateLists">OpacAllowSharingPrivateLists</link> to 'Allow'</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem id="toprocessnotice">
- <para>TO_PROCESS<itemizedlist>
- <listitem>
- <para>Used to notify a staff member if a purchase suggestion has been moved to
- the fund they manage</para>
- </listitem>
- <listitem>
- <para>Requires the <link linkend="emailsuggestfund">notice_unprocessed_suggestions</link> cron job</para>
- </listitem>
- </itemizedlist></para>
- </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>HOLD_SLIP</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 slip 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><link linkend="noticetriggers">Overdue Notice/Status Triggers</link></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><important>
- <para>Depending on the value of your <link linkend="OverdueNoticeCalendar">OverdueNoticeCalendar</link> preference the delay may or may not include days the
- library is closed based on the <link linkend="calholidays">holiday
- calendar</link>.</para>
- </important>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.<itemizedlist>
- <listitem>
- <para>If you choose to restrict a patron in this way you can also have Koha
- automatically remove that restriction with the <link linkend="AutoRemoveOverduesRestrictions">AutoRemoveOverduesRestrictions</link>
- preference.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
-
- <listitem>
- <para>Next you can choose the delivery method for the overdue notice. You can choose
- from Email, Phone (if you are using the <link linkend="TalkingTechItivaPhoneNotification">iTiva Talking Tech service</link>),
- Print and SMS (if you have set your <link linkend="SMSSendDriver">SMSSendDriver</link>). <itemizedlist>
- <listitem>
- <note>
- <para>The Feed option is not yet a feature in Koha, it is there for future
- development.</para>
- </note>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>See a <link linkend="samplenotice">Sample Overdue Notice</link></para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="patroncardcreator">
- <title><link linkend="patroncardcreator">Patron Card Creator</link></title>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Patron Card Creator</para>
- </listitem>
- </itemizedlist>
-
- <para>The Patron Card Creator allow you to use layouts and templates which you design to
- print your custom patron cards on your printer. Here are some of the features of the
- Patron Card Creator module:</para>
-
- <itemizedlist>
- <listitem>
- <para>Customize patron card layouts with text retrieved from the Koha patron data</para>
- </listitem>
-
- <listitem>
- <para>Design custom card templates for printed patron cards (to match the label
- sheets)</para>
- </listitem>
-
- <listitem>
- <para>Build and manage batches of patron cards to print</para>
- </listitem>
-
- <listitem>
- <para>Export (as PDF) single or multiple batches to print</para>
- </listitem>
-
- <listitem>
- <para>Export (as PDF) single or multiple patron cards from within a batch</para>
- </listitem>
- </itemizedlist>
- <section id="cardlayouts">
- <title><link linkend="cardlayouts">Layouts</link></title>
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Patron Card Creator >
- Manage > 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. <note>
- <para>Up to three lines of text, the patron's number in barcode representation and up
- to two images can be printed on to the card.</para>
- </note></para>
- <section id="addcardlayout">
- <title><link linkend="addcardlayout">Add a Layout</link></title>
- <para>If you have no layouts defined, you will add a new layout by clicking the 'New'
- button and choosing 'Layout'.<screenshot>
- <screeninfo>New layout button</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patroncards/newlayout.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>You may also choose to press 'Manage layout' on the left side. Here you are
- offered a list of available layouts you can select for editing. But at the top of the
- page there is still the 'New layout' button.</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>
- <itemizedlist>
- <listitem>
- <note>
- <para>A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch is 25.4 SI
- Millimeters </para>
- </note>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Next note if this layout is for the front or the back of the patron
- card</para>
- <itemizedlist>
- <listitem>
- <para>
- <note>
- <para>You will need a layout for both the front and back of your card if you
- have 2-sided library cards, this option doesn't allow you to print two
- sided cards, just lets you track which side of the card you're
- designing.</para>
- </note>
- </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><itemizedlist>
- <listitem>
- <note>
- <para>A full list of field names can be found in the database schema at
- <ulink url="http://schema.koha-community.org">http://schema.koha-community.org</ulink></para>
- </note>
- </listitem>
- </itemizedlist></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><important>
- <para>It is the designers responsibility to define textlines, barcode and images
- such that overlap is avoided.</para>
- </important>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="patrontemplate">
- <title><link linkend="patrontemplate">Templates</link></title>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Patron Card Creator >
- Manage > Card templates</para>
- </listitem>
- </itemizedlist>
-
- <para>A template describes the arrangement of labels on the label sheet/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. All of the
- information you will need for setting up a template may be on the packaging, and if not
- it can usually be found on the vendor's website or can be measured from a sample
- sheet.</para>
-
- <section id="addcardtemplate">
- <title><link linkend="addcardtemplate">Add a Template</link></title>
-
- <para>To add a new template click on the 'New template' button at the top of your page
- which brings you to the Edit template form immediately. You may also choose to press
- 'Manage templates' on the left side. Here you are offered a list of available
- templates you can select for editing. But in the top of the page there is still the
- 'New template' button.</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 after pressing either 'Edit' or 'New template'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 is simply a system generated unique id</para>
- </listitem>
-
- <listitem>
- <para>Template Code should be the name of this template to identify it 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. </para>
- <screenshot>
- <screeninfo>Measurement Units</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patroncards/units.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <listitem>
- <note>
- <para>A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch is 25.4 SI
- Millimeters </para>
- </note>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>The measurements (page height, page width, card width, card height) may be on
- the packaging, and if not it can usually be found on the vendor's website or can
- be measured from a sample sheet.</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 defining a profile try printing some sample cards so that you can
- take measurements to define a profile to perform the right adjustments for
- your printer/template combination.</para>
- </listitem>
-
- <listitem>
- <para>After finding and documenting any anomalies in the printed document, then
- you can <link linkend="addcardprofile">create a profile</link> and assign it
- to the template.</para>
- </listitem>
- <listitem>
- <para>
- <important>
- <para>Do not specify a profile unless needed, i.e. do not click to define a
- printer profile. It is not possible to remove a profile from a template
- but you can switch to another profile. </para>
- </important>
- </para>
- </listitem>
- <listitem>
- <note>
- <para>If you are using different printers you may be required to define
- several templates that are identical only different profiles are
- specified.</para>
- </note>
- </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><link linkend="patronprofile">Profiles</link></title>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Patron Card Creator >
- Manage > 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. 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 (or even different tray
- selections on the same 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><link linkend="addcardprofile">Add a Profile</link></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>To add a new profile, you want to click on the 'New profile' button at the top of
- your page. Using the form that appears you can define the values to correct the card
- misalignments on your label sheet. You may also choose 'Manage profiles' on the left
- side and select one of the currently available profiles for editing.</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. <itemizedlist>
- <listitem>
- <para>
- <note>
- <para>For example: if you want to use the Printer model number in printer
- name you can, or you can call it 'the printer on my desk'</para>
- </note>
- </para>
- </listitem>
- </itemizedlist></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>
- <itemizedlist>
- <listitem>
- <note>
- <para>A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch is 25.4 SI
- Millimeters </para>
- </note>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>Offset should be used when the entire image is off center either vertically or
- horizontally. Creep describes a condition where the distance between the labels changes
- across the page or up and down the page<itemizedlist>
- <listitem>
- <para>For offset and creep values, negative numbers move the printed
- information up and to the left on the printed sheet and positive numbers
- move down and to the right</para>
- </listitem>
- <listitem>
- <para>Example: the text is printed 0 .25" from the left edge of the first label,
- 0 .28" from the left edge of the second label and 0 .31" from the left edge of
- the third label. This means the horizontal creep should be set to (minus)
- -0.03 " to make up for this difference.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
-
- <para>After saving, your profiles will appear on the 'Manage Printer 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="patroncardbatches">
- <title><link linkend="patroncardbatches">Batches</link></title>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Patron Card Creator >
- Manage > Card batches</para>
- </listitem>
- </itemizedlist>
-
- <para>A batch is a collection of patrons for whom you want to
- generate cards.</para>
-
- <section id="addcardbatch">
- <title><link linkend="addcardbatch">Add a Batch</link></title>
-
- <para>To add a new batch, you want to click on the 'New batches' button at the top of
- your page. Choosing the menu item 'Manage batches' on the left a list of already
- defined batches is displayed. In this display you can either select a batch for
- editing or add a new batch.</para>
-
- <screenshot>
- <screeninfo>New Batch Button</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patroncards/newbatch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para> For a new batch a message pops up and directs you to select patrons to be
- processed in this batch.<screenshot>
- <screeninfo>No items in batch</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patroncards/noitemsbatch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
-
- <para>After choosing the 'Add item(s)' button the Patron Search window pops up.<screenshot>
- <screeninfo>Patron search</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patroncards/patronsearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>From here you can search for patrons to add to your batch by any part of their
- name, their category and/or library. Entering * in the search box will display all the
- patrons. <screenshot>
- <screeninfo>Patron search results</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patroncards/addpatrons.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>From the results you can add patrons to the batch by clicking the 'Add' button.
- After adding patrons from the results you can start over and perform another search or
- click 'Close' at the bottom of the screen to indicate that you are done. You will then
- be presented with your batch.<screenshot>
- <screeninfo>Patron batch</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patroncards/batchsummary.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>If you are satisfied with your batch you can proceed to export. If you want to
- correct or even delete that batch the buttons to do so can be found at the top of your
- screen. You can always come back here through the 'Manage > Card batches' button. </para>
- <para>If you would like to export all patron cards you can click 'Export card batch'
- otherwise you can choose specific patrons to print cards for by checking the box to
- the right of their names and then choose 'Export selected card(s)' at the top. </para>
- <para>The export menu will ask you to choose a template, a layout and starting position
- (where on the sheet should printing begin).<note>
- <para>For the starting position if the first 6 labels have already been used on your
- sheet you can start printing on label in position 7 on the sheet. The labels are
- numbered left to right from top to bottom.</para>
- </note><screenshot>
- <screeninfo>Export batch</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patroncards/export.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>Once you click 'Export' you will be presented with a PDF of your labels for printing<screenshot>
- <screeninfo>PDF Export</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patroncards/pdf.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>When you open the PDF you will see the cards for printing</para>
- <screenshot>
- <screeninfo>Final cards</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/patroncards/cards.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>The above image shows a layout that is made up of two textlines. The first one is
- just plain text, the second one is composed of the <firstname> <surname> fields.
- A patron image is printed (if available) and the barcode of patrons number is
- displayed in code 39. All this is printed on a template with three columns and 8 rows
- using position 1-3 here. When printing this PDF please take care that your printer
- doesn't rescale the PDF (e.g do not fit to paper size) otherwise the printer will not
- be able to print to the right place per your templates.</para>
- </section>
- </section>
-
- <section id="managecardimages">
- <title><link linkend="managecardimages">Manage Images</link></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>
-
- <note>
- <para>Pictures uploaded with this tool should be at least 300dpi
- which is the minimum quality for a printable image.</para>
- </note>
-
- <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><link linkend="anonpatrons">Patrons (anonymize, bulk-delete)</link></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 (they are only moved to the delete_borrowers
- table), but this tool does not provide as many checks as one may desire.</para>
- </important></para>
- <important>
- <para>Before using this tool it is recommended that you backup your database. Changes made
- here are permanent.</para>
- </important>
- <important>
- <para>The anonymization will fail quietly if <link linkend="AnonymousPatron">AnonymousPatron</link> preference does not contain a valid value.</para>
- </important>
-
- <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 'Verify' box on the task you would like to complete (Delete or
- Anonymize)</para>
- </listitem>
-
- <listitem>
- <para>Enter a date before which you want to alter the data</para>
- </listitem>
- <listitem>
- <para>If deleting patrons you can also choose to find patrons who<itemizedlist>
- <listitem>
- <para>have not borrowed since a specific date</para>
- </listitem>
- <listitem>
- <para>have accounts that will expire before a specific date</para>
- </listitem>
- <listitem>
- <para>are in a specific <link linkend="patcats">patron category</link></para>
- </listitem>
- <listitem>
- <para>are in a <link linkend="patronlists">patron list</link></para>
- </listitem>
- </itemizedlist></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="batchpatronmod">
- <title><link linkend="batchpatronmod">Batch patron modification</link></title>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Patrons
- and Circulation > Batch patron modification</para>
- </listitem>
- </itemizedlist>
-
- <para>With this tool you can make edits to a batch of patron records. Simply load in a file
- of cardnumbers (one per line), choose from a <link linkend="patronlists">list of
- patrons</link> or scan patron card numbers in to the box provided.</para>
-
- <screenshot>
- <screeninfo>Batch patron modification</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/batchpatron/batchmodify.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>Once you have the file loaded or the barcodes scanned click
- 'Continue.' You will be presented with a list of the patrons and the
- changes you can make.</para>
-
- <screenshot>
- <screeninfo>Patrons to modify</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/batchpatron/modifyform.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>To the left of each text box there is a checkbox. Clicking that
- checkbox will clear our the field values. <important>
- <para>If the field is mandatory you will not be able to clear the
- value in it.</para>
- </important></para>
-
- <para>If you have multiple patron attributes you can change them all
- by using the plus (+) sign to the right of the text box. This will
- allow you to add another attribute value.</para>
-
- <screenshot>
- <screeninfo>Editing patron attributes</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/batchpatron/attributes.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>Once you have made the changes you want, you can click 'Save'
- and Koha will present you with the changed patron records.</para>
- </section>
-
- <section id="tagsmoderation">
- <title><link linkend="tagsmoderation">Tag Moderation</link></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 module labels:</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 see all of the titles this tag was added to simply click on the term<screenshot>
- <screeninfo>Titles with a specific tag</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/tagging/taggedtitles.png"/>
- </imageobject>
- </mediaobject>
- </screenshot><itemizedlist>
- <listitem>
- <para>From this list of titles you can remove a tag without outright rejecting it
- from being used in the future by clicking the 'Remove tag' button to the right
- of the title.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>To approve a tag, you can either click the 'Approve' button in line 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 in
- line 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 Check list test search</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/tagging/tagblacklisttest-neither.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Finally you can find tags by using the filters on the left.</para>
- <screenshot>
- <screeninfo>Tag filters</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/tagging/tagfilters.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="uploadpatronimages">
- <title><link linkend="uploadpatronimages">Upload Patron Images</link></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 100K 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 id="rotatingcollections">
- <sectioninfo>
- <authorgroup>
- <author>
- <firstname>Cindy</firstname>
- <surname>Murdock Ames</surname>
- <affiliation>
- <orgname>Meadville Public Library | CCFLS</orgname>
- </affiliation>
- </author>
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- </editor>
- </authorgroup>
- <pubdate>2014</pubdate>
- </sectioninfo>
- <title><link linkend="rotatingcollections">Rotating Collections</link></title>
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Catalog > Rotating
- Collections</para>
- </listitem>
- </itemizedlist>
- <para>Rotating Collections is a tool for managing collections of materials that frequently
- get shifted from library to library. It adds the ability to store not only an item's home
- library and current location but also information about where it is supposed to be
- transferred to next to ensure that all items in the collection are sent to the correct
- library. When an item in a rotating collection is checked in, library staff is notified
- that the item is part of a rotating collection and which branch it should be sent to if it
- is not at the correct one.</para>
- <important>
- <para>The <link linkend="AutomaticItemReturn">AutomaticItemReturn</link> system preference
- must be set to "Don't automatically transfer items to their home library when they are
- returned" for Rotating Collections to function properly.</para>
- </important>
- <itemizedlist>
- <listitem>
- <para>To create a new rotating collection, click the "New Collection" button, fill in
- the Title and Description, and click Submit. Once submitted you'll see "Collection
- Name added successfully"; click "Return to rotating collections home" to return to the
- main Rotating Collections management page (or click Rotating Collections in the
- sidebar).</para>
- </listitem>
- <listitem>
- <para>To add items to a collection, click "Add or remove items" next to the collection's
- name in the list of collections. Under "Add or remove items" scan or type in the
- barcode of the item you wish to add to the collection, and hit Enter or click Submit
- if necessary.</para>
- </listitem>
- <listitem>
- <para>To remove an item from a collection, either click Remove next to the item's
- barcode in the list of items within the collection or check the "Remove item from
- collection" box next to the Barcode text box under "Add or remove items, and scan or
- type in the barcode, clicking Submit or hitting Enter if necessary. Note: The "Remove
- item from collection" checkbox will remain checked as long as you are on the "Add or
- remove items" page, unless you uncheck it, to facilitate quickly removing a number of
- items at a time by scanning their barcodes. </para>
- </listitem>
- </itemizedlist>
- <section id="transferrotatingcollection">
- <title><link linkend="transferrotatingcollection">Transfer a Rotating Collection</link></title>
- <para>Transferring a collection will:</para>
- <itemizedlist>
- <listitem>
- <para>Change the current location of the items in that collection to the library it is
- to be transferred to</para>
- </listitem>
- <listitem>
- <para>Initiate a transfer from its original current location/holding library to the
- current location/holding library it is to be rotated to. When a library receives a
- collection they will need to check in the items to complete the transfer.</para>
- </listitem>
- </itemizedlist>
- <para>You can transfer a collection in one of two ways:</para>
- <itemizedlist>
- <listitem>
- <para>From the main Rotating Collections page, click on Transfer next to the title of
- the collection you wish to transfer; choose the library you wish to transfer the
- collection to and click "Transfer collection".</para>
- </listitem>
- <listitem>
- <para>Or, from the "add or remove items" page for a collection, you can click the
- Transfer button, choose the library you wish to transfer the collection to and click
- "Transfer Collection".</para>
- </listitem>
- </itemizedlist>
- <important>
- <para>In order to complete the transfer process, the library receiving the rotating
- collection should check in all items from the collection as they receive them. This
- will clear the transfer so that the items are no longer shown as being "in
- transit".</para>
- </important>
- <para>If an item in a rotating collection is checked in at a library other than the one it
- is supposed to be transferred to, a notification will appear notifying library staff
- that the item is part of a rotating collection, also letting them know where the item
- needs to be sent.</para>
- <screenshot>
- <screeninfo>Rotating Collection Item Notification</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/rotatingcollections/rotatingcollectionnotice.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- </section>
- </section>
-
-
-
- <section id="catalogtools">
- <title><link linkend="catalogtools">Catalog</link></title>
-
- <para/>
-
- <section id="batchmodifyitems">
- <title><link linkend="batchmodifyitems">Batch item modification</link></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. You can also decide the items edited
- should be populated with the default values you have defined in your <link linkend="marcbibframeworks">default framework</link>.</para>
- <para>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.<note>
- <para>To uncheck all items thar are currently checked out you can click the 'Clear on
- loan' link at the top of the form.</para>
- </note></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>
-
- <note>
- <para>You can also edit items on one bib record in a batch by going
- to the bib record and clicking Edit > Edit items in batch</para>
- </note>
-
- <screenshot>
- <screeninfo>Edit items in a batch</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/batchmod/editinbatch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="batchdeleteitems">
- <title><link linkend="batchdeleteitems">Batch item deletion</link></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.' If you'd like you can delete
- the bibliogrphic record if you're deleting the last item by clicking the checkbox next to
- 'Delete records if no items remain'.</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="batchrecorddelete">
- <title><link linkend="batchrecorddelete">Batch record deletion</link></title>
- <para>This tool will take a batch of record numbers for either bibliographic records or
- authority records and allow you to delete all those records and any items attached to them
- in a batch. <screenshot>
- <screeninfo>Batch record deletion</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/batchrecorddel/tool.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>First you need to tell the tool if you're deleting bibliographic or authority records.
- Next you can load a file with biblionumbers or authids or enter a list of those numbers in
- the box provided. Once you submit the form you will be presented with a summary of the
- records you are trying to delete.<screenshot>
- <screeninfo>Summary</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/batchrecorddel/summary.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>If a record you want to delete can't be deleted it will be highlighted. </para>
- <para>Check the records you want to delete and click the 'Delete selected records' button to
- finish the process.</para>
- </section>
- <section id="batchrecordmod">
- <title><link linkend="batchrecordmod">Batch Record Modification</link></title>
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Catalog > Batch record
- modification</para>
- </listitem>
- </itemizedlist>
- <para>This tool will allow you to edit batches of bibliographic and/or authority records
- using <link linkend="marcmodtemplates">MARC Modification Templates</link>. Before visiting
- this tool you will want to set up at least one MARC modification template.</para>
- <screenshot>
- <screeninfo>Batch record modification</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/batchbibmod/batchbibmod.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>When you visit the tool it will ask you:</para>
- <itemizedlist>
- <listitem>
- <para>Choose whether you're editing bibliographic or authority records</para>
- </listitem>
- <listitem>
- <para>Enter the biblionumbers or authids<itemizedlist>
- <listitem>
- <para>You can upload a file of these numbers or</para>
- </listitem>
- <listitem>
- <para>Enter the numbers (one per line) in the box provided</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>Finally choose the MARC Modification Template you'd like to use to edit these
- records.</para>
- </listitem>
- </itemizedlist>
- <para>Once you've entered your critera click 'Continue'<screenshot>
- <screeninfo>Records to edit</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/batchbibmod/recordstoedit.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>You will be presented with a list of records that will be edited. Next to each one is
- a checkbox so you can uncheck any items you would rather not edit at this time. </para>
- <para>Clicking Preview MARC will allow you to see what edits will be made when you finalize
- the edit.<screenshot>
- <screeninfo>Modified MARC Preview</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/batchbibmod/marcpreview.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>Once you're sure everything is the way you want you can click the 'Modify selected
- records' button and your records will be modified.</para>
- </section>
- <section id="autoitemagemod">
- <title><link linkend="autoitemagemod">Automatic item modifications by age</link></title>
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Catalog > Automatic item
- modifications by age</para>
- </listitem>
- </itemizedlist>
- <para>This tool allows librarians to update item specific fields when an item reaches a
- certain age.</para>
- <para>
- <note>
- <para>Staff need the items_batchmod permission to access this tool</para>
- </note>
- </para>
- <para>
- <important>
- <para>The settings in this tool will be acted upon by the <link linkend="autoitemupdatecron">corresponding cron job</link></para>
- </important>
- </para>
- <para>If you haven't created any rules you will see the option to 'Add rules' on the Tool
- page. Click this button to create rules.<screenshot>
- <screeninfo>Automatic item modifications by age</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/autoitemmodage/newrule.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>If you have rules already there will be a button that reads 'Edit rules'. To create a
- new rule click the 'Edit rules' button at the top of the page</para>
- <screenshot>
- <screeninfo>List of rules</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/autoitemmodage/savedrule.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>You will be brought to a page where you can edit exisitng rules or create a new
- rule</para>
- <screenshot>
- <screeninfo>Add/Edit rules</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/autoitemmodage/addeditrules.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>In the form that appears you can set :<itemizedlist>
- <listitem>
- <para>the age in days at which the item will update (Age)</para>
- </listitem>
- <listitem>
- <para>what criteria is needed to trigger the update (Conditions)</para>
- </listitem>
- <listitem>
- <para>what changes are made when the script runs (Substitutions)</para>
- </listitem>
- </itemizedlist>
- </para>
- <screenshot>
- <screeninfo>New rule</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/autoitemmodage/ruleform.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Once you're done you can click the 'Add this rule' link and then add additional rules
- or you can click the 'Submit these rules' button to save your changes.</para>
- <screenshot>
- <screeninfo>List of rules</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/autoitemmodage/savedrule.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="exportbibs">
- <title><link linkend="exportbibs">Export Data (MARC & Authorities)</link></title>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Catalog
- > Export Data</para>
- </listitem>
- </itemizedlist>
-
- <para>Koha comes with a tool that will allow you to export your
- bibliographic, holdings and/or authority data in bulk. This can be
- used to send your records to fellow libraries, organizations or
- services; or simply for backup purposes.</para>
-
- <section id="exportmarc">
- <title><link linkend="exportmarc">Export Bibliographic Records</link></title>
-
- <para>At the top of the screen you need to pick what data you're
- exporting. If you're exporting bibliographic records with or without
- the holdings information you want to click the 'Export bibliographic
- records' tab.</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<itemizedlist>
- <listitem>
- <important>
- <para>This limit will use the type you have defined in the <link linkend="item-level_itypes">item-level_itypes</link> preference.
- If you have the item-level_itypes preference set to 'specific item'
- and you have no items attached to a bib record it will not be
- exported. To get all bib records of a specific type you will need
- your item-level_itypes preference set to 'biblio record'.</para>
- </important>
- </listitem>
- </itemizedlist></para>
- </listitem>
-
- <listitem>
- <para>Limit to a specific library or group of libraries</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>If you'd like you can load a file of biblionumbers for the records you would
- like to export</para>
- <screenshot>
- <screeninfo>File of Records to Export</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/exportmarc/fileexport.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </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 bibliographic records'</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="exportauthority">
- <title><link linkend="exportauthority">Export Authority Records</link></title>
-
- <para>At the top of the screen you need to pick what data you're
- exporting. If you're exporting authority records you want to click
- the 'Export authority records' tab.</para>
-
- <itemizedlist>
- <listitem>
- <para>Fill in the form in order to limit your export to a
- specific range or type of authority record (all fields are
- optional)</para>
-
- <screenshot>
- <screeninfo>Export authorities</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/exportmarc/authexport-pt1.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>Or you can choose a file of authids to export<screenshot>
- <screeninfo>Authorities file</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/exportmarc/authexport-pt1-5.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- <listitem>
- <para>Next choose fields that you would like to exclude from the export separated by a
- space (no commas)</para>
- <screenshot>
- <screeninfo>Authority export options</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/exportmarc/authexport-pt2.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <listitem>
- <para>If you'd like to exclude all subfields of the 200 for example just enter
- 200</para>
- </listitem>
- <listitem>
- <para>If you'd like to exclude a specific subfield enter it beside the field value
- 100a will exclude just the subfield 'a' of the 100</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>Finally choose the file type and file name</para>
-
- <screenshot>
- <screeninfo>Export format</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/exportmarc/authexport-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 authority records'</para>
- </listitem>
- </itemizedlist>
- </section>
- </section>
-
- <section id="inventory">
- <title><link linkend="inventory">Inventory/Stocktaking</link></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 then scroll
- to the very bottom and click 'Submit.'</para>
- </section>
-
- <section id="labelcreator">
- <title><link linkend="labelcreator">Label Creator</link></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>
-
- <section id="labeltemplates">
- <title><link linkend="labeltemplates">Templates</link></title>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Label Creator > Manage >
- Label 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><link linkend="addlabeltemplate">Add a Template</link></title>
-
- <para>To add a new template, you want to click on the 'New' button at the top of the
- Label Creator and choosing 'Label 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' area under 'Label
- templates'.</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><link linkend="labelprofiles">Profiles</link></title>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Label Creator > Manage >
- Printer 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><link linkend="addlabelprofile">Add a Profile</link></title>
-
- <para>To add a new profile, you want to click on the 'New' button at the top of the
- Label Creator tool and choose 'Printer 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' area under 'Printer
- profiles'.</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><link linkend="labellayouts">Layouts</link></title>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Label Creator > Manage >
- 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><link linkend="addlabellayout">Add a Layout</link></title>
-
- <para>To add a new layout, you want to click on the 'New' button at the top of the Label
- Creator tool and choose '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
- guidelines 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><link linkend="labelbatches">Batches</link></title>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Label Creator > Manage >
- Label 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><link linkend="addlabelbatch">Add a Batch</link></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 a box to scan barcodes or itemnumbers
- in to and an 'Add item(s)' button at the bottom of the page.</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 full batch' button. To print only some of
- the labels, click the 'Export selected 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><link linkend="quicklabelcreator">Quick Spine Label Creator</link></title>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Catalog
- > Quick Spine Label Creator</para>
- </listitem>
- </itemizedlist>
-
- <note>
- <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>
- </note>
-
- <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="marcmodtemplates">
- <title><link linkend="marcmodtemplates">MARC modification templates</link></title>
- <para>The MARC Modification Templates system gives Koha users the power to make alterations
- to MARC records automatically while staging MARC records for import. </para>
- <para>This tool is useful for altering MARC records from various venders/sources work with
- your MARC framework. The system essentially allows one to create a basic script using
- actions to Copy, Move, Add, Update and Delete fields. </para>
- <para>Start by adding a new template (a template can be made up of one or more actions) by
- entering a name and clicking 'Create template'.</para>
- <screenshot>
- <screeninfo>Add a new template</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/marcmodtemplates/addtemplate.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Next you can add actions to the template by filling in the Action box. For example if
- you're loading in a batch of files from your EBook vendor you might want to add the biblio
- item type of EBOOK to the 942$c.<screenshot>
- <screeninfo>Add action</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/marcmodtemplates/addaction.png"/>
- </imageobject>
- </mediaobject>
- </screenshot><itemizedlist>
- <listitem>
- <para>Choose 'Add/Update'</para>
- </listitem>
- <listitem>
- <para>Enter the field 942 and subfield c</para>
- </listitem>
- <listitem>
- <para>Enter the value of 'EBOOK' (or whatever your ebook item type code is)</para>
- </listitem>
- <listitem>
- <para>Provide a description so you can identify this action later</para>
- </listitem>
- <listitem>
- <para>Click 'Add action'</para>
- </listitem>
- </itemizedlist></para>
- <para>Each action can also have an optional condition to check the value or existance of
- another field. For example you might want to add the call number to the item record if
- it's not already there.</para>
- <screenshot>
- <screeninfo>Add conditional action</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/marcmodtemplates/ifexample.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <listitem>
- <para>Choose 'Copy'</para>
- </listitem>
- <listitem>
- <para>Decide if you want to copy the first occurance or all occurances of the
- field</para>
- </listitem>
- <listitem>
- <para>Enter the field 090 (or other biblio call number field) and subfield a to
- copy</para>
- </listitem>
- <listitem>
- <para>Enter the 952 field and o subfield to copy to</para>
- </listitem>
- <listitem>
- <para>Choose 'if'</para>
- </listitem>
- <listitem>
- <para>Enter the 952 field and o subfield</para>
- </listitem>
- <listitem>
- <para>Choose "doesn't exist"</para>
- </listitem>
- <listitem>
- <para>Provide a description so you can identify this action later</para>
- </listitem>
- <listitem>
- <para>Click 'Add action'</para>
- </listitem>
- </itemizedlist>
- <para>The Copy & Move actions also support Regular Expressions, which can be used to
- automatically modify field values during the copy/move. An example would be to strip out
- the '$' character in field 020$c.</para>
- <screenshot>
- <screeninfo>Add regex action</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/marcmodtemplates/regexexample.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <listitem>
- <para>Choose 'Copy and replace'</para>
- </listitem>
- <listitem>
- <para>Decide if you want to copy the first occurance or all occurances of the
- field</para>
- </listitem>
- <listitem>
- <para>Enter the field 020 and subfield c to copy</para>
- </listitem>
- <listitem>
- <para>Enter the 020 field and c subfield to copy to</para>
- </listitem>
- <listitem>
- <para>Check the 'RegEx' box and enter your regular expression (in this case s/\$//
- )</para>
- </listitem>
- <listitem>
- <para>Choose 'if'</para>
- </listitem>
- <listitem>
- <para>Enter the 020 field and c subfield</para>
- </listitem>
- <listitem>
- <para>Choose "matches"</para>
- </listitem>
- <listitem>
- <para>Check the 'RegEx' box and enter your regular expression (in this case m/^\$/
- )</para>
- </listitem>
- <listitem>
- <para>Provide a description so you can identify this action later</para>
- </listitem>
- <listitem>
- <para>Click 'Add action'</para>
- </listitem>
- </itemizedlist>
- <note>
- <para>The value for an update can include variables that change each time the template is
- used. Currently, the system supports two variables, __BRANCHCODE__ which is replaced
- with the branchcode of the library currently using the template, and __CURRENTDATE__
- which is replaced with the current date in ISO format ( YYYY-MM-DD ).</para>
- </note>
- <para>You could also use regular expressions to add your library's proxy URL in front of
- links in your MARC record.<screenshot>
- <screeninfo>Add proxy URL</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/marcmodtemplates/proxyurl.png"/>
- </imageobject>
- </mediaobject>
- </screenshot><itemizedlist>
- <listitem>
- <para>Choose 'Copy and replace'</para>
- </listitem>
- <listitem>
- <para>Decide if you want to copy the first occurance or all occurances of the
- field</para>
- </listitem>
- <listitem>
- <para>Enter the field 856 and subfield u to copy</para>
- </listitem>
- <listitem>
- <para>Enter the 856 field and u subfield to copy to</para>
- </listitem>
- <listitem>
- <para>Check the 'RegEx' box and enter your regular expression (in this case
- s/^/PROXY_URL/ )</para>
- </listitem>
- <listitem>
- <para>Provide a description so you can identify this action later</para>
- </listitem>
- <listitem>
- <para>Click 'Add action'</para>
- </listitem>
- </itemizedlist></para>
- <para>When choosing between 'Copy' and 'Copy and replace' keep the following example in
- mind:</para>
- <programlisting>245 _aThe art of computer programming _cDonald E. Knuth.
-300 _aA_exists _bB_exists </programlisting>
- <para>If we apply action (a) Copy the whole field 245 to 300, we get: </para>
- <programlisting>245 _aThe art of computer programming _cDonald E. Knuth.
-300 _aA_exists _bB_exists
-300 _aThe art of computer programming _cDonald E. Knuth. </programlisting>
- <para>If we apply action (b) Copy the subfield 245$a to 300$a, we get: </para>
- <programlisting>245 _aThe art of computer programming _cDonald E. Knuth.
-300 _aThe art of computer programming _bB_exists</programlisting>
- <para>Once your actions are saved you can view them at the top of the screen. Actions can be
- moved around using the arrows to the left of them. </para>
- <screenshot>
- <screeninfo>View actions</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/marcmodtemplates/viewactions.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Depending on your actions the order may be very important. For example you don't want
- to delete a field before you copy it to another field.</para>
- <para>To add another template you can either start fresh or click the 'Duplicate current
- template' checkbox to create a copy of an existing template to start with.</para>
- <screenshot>
- <screeninfo>Duplicate template</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/marcmodtemplates/duplicate.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Once your template is saved you will be able to pick it when using the <link linkend="stagemarc">Stage MARC Records for Import</link> tool.</para>
- <screenshot>
- <screeninfo>Choose template</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/marcmodtemplates/templatechoice.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="stagemarc">
- <title><link linkend="stagemarc">Stage MARC Records for Import</link></title>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Catalog
- > Stage MARC records for import</para>
- </listitem>
- </itemizedlist>
-
- <para>This tool can be used to import both bibliographic and authority
- records that are saved in MARC format. 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>Tell Koha which type of file this is, bibliographic or
- authority</para>
-
- <screenshot>
- <screeninfo>Record type</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/marcimport/recordtype.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>Choose the character encoding</para>
-
- <screenshot>
- <screeninfo>Chracter encoding</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/marcimport/encoding.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>Choose if you would like to use a <link linkend="marcmodtemplates">MARC
- Modification Template</link> to alter the data you're about to import</para>
- <screenshot>
- <screeninfo>Choose modification template</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/marcimport/templatechoice.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Choose whether or not you want to look for matching records</para>
- <screenshot>
- <screeninfo>Look for matches</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/marcimport/matches.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <listitem>
- <para>You can set up <link linkend="recordmatchingrules">record matching
- rules</link> through the administration area</para>
- <screenshot>
- <screeninfo>Matching rules</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/marcimport/matchrule.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <listitem>
- <para>When using the ISBN matching rule Koha will find only exact matches.
- If you find that the ISBN match is not working to your satisfaction you
- can change the <link linkend="AggressiveMatchOnISBN">AggressiveMatchOnISBN</link> preference to 'Do' and then run your
- import again.</para>
- </listitem>
- </itemizedlist>
- </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 (if the file you're loading is
- a bibliographic file)</para>
-
- <screenshot>
- <screeninfo>Import items</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/marcimport/checkitems.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <itemizedlist>
- <listitem><para>From here you can choose to always add items regardless of matching status, add them only if a
- matching bib was found, add items only if there was no matching bib record,
- replace items if a matching bib was found (The match will look at the
- itemnumbers and barcodes to match on for items. Itemnumbers take precendence
- over barcodes), or Ignore items and not add them.</para></listitem>
- </itemizedlist>
- </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">Manage Staged
- MARC Records Tool</link></para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="managestaged">
- <title><link linkend="managestaged">Staged MARC Record Management</link></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>
- <listitem>
- <para>Matches will appear with info under the 'Match details column'</para>
- <screenshot>
- <screeninfo>Matched record</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/marcimport/matchfound.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>and when clicking the 'View' link under 'Diff' you can see the difference
- between versions.</para>
- <screenshot>
- <screeninfo>Record differences</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/marcimport/stagediff.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </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><link linkend="uploadlocalimages">Upload Local Cover Image</link></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.<note>
- <para>Koha does not have a maximum file size limit for this tool, but Apache may limit
- the maximum size of uploads (talk to your sys admin).</para>
- </note><note>
- <para>When you want to upload multiple images onto a bib record, they will display left
- to right (then top to bottom, depending on screen real estate) in order of uploading,
- and the one on the left (the first one uploaded) will be the one used as a thumbnail
- cover in search results and on the detail page. There is no way to reorder cover
- images uploaded in this way, so be sure to upload them in the order you'd like them to appear.<screenshot>
- <screeninfo>Multiple cover images on one record</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/uploadlocalimg/multiplecovers.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </note></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>
-
- <important>
- <para>The source image is used to generate a 140 x 200 px thumbnail image and a 600 x 800
- px full-size image. The original sized image uploaded will not be stored by Koha</para>
- </important>
-
- <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>
- <para>If you would like to remove a cover image you can click 'Delete image' below the image
- if you have the <link linkend="toolspermissions">upload_local_cover_images
- permission</link>.</para>
- </section>
- </section>
-
- <section id="additionaltools">
- <title><link linkend="additionaltools">Additional Tools</link></title>
-
- <para/>
-
- <section id="calholidays">
- <title><link linkend="calholidays">Calendar</link></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><link linkend="addevents">Adding Events</link></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><link linkend="editevents">Editing Events</link></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. <itemizedlist>
- <listitem>
- <para>All actions require that you click 'Save' before the change will be
- made.</para>
- </listitem>
- </itemizedlist></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.<itemizedlist>
- <listitem>
- <para>All actions require that you click 'Save' before the change will be
- made.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="calendarhelp">
- <title><link linkend="calendarhelp">Additional Help</link></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><link linkend="csvprofiles">CSV Profiles</link></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><link linkend="addcsvprofile">Add CSV Profiles</link></title>
-
- <para>To add a CSV Profile</para>
-
- <itemizedlist>
- <listitem>
- <para>Click 'CSV Profiles' from the Tools menu</para>
- </listitem>
- <listitem>
- <para>The 'Profile type' determines what type of fields you plan to use (MARC or SQL)
- to define your profile<itemizedlist>
- <listitem>
- <para>If you choose MARC then you will need to enter MARC fields</para>
- </listitem>
- </itemizedlist></para>
- <screenshot>
- <screeninfo>MARC CSV Profile</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/csvprofiles/addcsv.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <listitem>
- <para>If you choose SQL then you will need to enter SQL database fields</para>
- <screenshot>
- <screeninfo>SQL CSV Profile</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/csvprofiles/addcsv-sql.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <listitem>
- <para>The 'Profile name' will appear on the export pull down list when choosing
- 'Download' from your cart or list</para>
- <screenshot>
- <screeninfo>Download List</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/csvprofiles/downloadcsv.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>The 'Profile description' is for your own benefit, but will also appear in
- the OPAC when patrons download content, so make sure it's clear to your patrons
- as well</para>
- </listitem>
- <listitem>
- <para>The 'CSV separator' is the character used to separate values and value groups<note>
- <para>The most common option here is comma because most spreadsheet
- applications know how to open files split by commas.</para>
- </note></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 and this is the character that
- will appear in between each one in the column</para>
- <screenshot>
- <screeninfo>Field separators in between multiple subjects</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/csvprofiles/csvfieldsep.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </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 MARC' or 'Profile SQL'
- field</para>
- <itemizedlist>
- <listitem>
- <para>Define which fields or subfields you want to export, separated by pipes.
- Example : 200|210$a|301 for MARC and biblio.title|biblio.author for
- SQL</para>
- </listitem>
- <listitem>
- <note>
- <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=100|title=245$a|300</para>
- </note>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- <para>When you have entered in all of the information for you profile, simply click
- 'Submit' and you will be presented with a confirmation that your profile has been saved.</para>
- <screenshot>
- <screeninfo>Confirmation of new CSV profile</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/csvprofiles/csvadded.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="editcsvprofile">
- <title><link linkend="editcsvprofile">Modify CSV Profiles</link></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>After submitting your changes you will be presented with a confirmation message
- at the top of the screen</para>
- <screenshot>
- <screeninfo>Confirmation of CSV modification</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/csvprofiles/csvmodified.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </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><link linkend="usecsvprofiles">Using CSV Profiles</link></title>
-
- <para>Your CSV Profiles will appear on the export list or cart menu under the 'Download'
- button in both the staff client and the OPAC</para>
-
- <screenshot>
- <screeninfo>CSV Profiles on Download Menu in the Staff Client</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/csvprofiles/exportlist.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- </section>
-
- <section id="logviewer">
- <title><link linkend="logviewer">Log Viewer</link></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>
- </section>
-
- <section id="newstool">
- <title><link linkend="newstool">News</link></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.<screenshot>
- <screeninfo>Display location</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/news/displaylocation.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
-
- <listitem>
- <para>Choose the library this news item will show for</para>
- </listitem>
- <listitem>
- <para>Choose a title for your entry</para>
- </listitem>
-
- <listitem>
- <para>Using the publication and expiration date fields you can
- control from which date and for how long your news
- item appears</para>
- <para>
- <itemizedlist>
- <listitem>
- <para>Examples: (these assume today's date as 07-May-2015)<itemizedlist>
- <listitem>
- <para>Publish on current date: set publication date as
- 07-May-2015</para>
- </listitem>
- <listitem>
- <para>Schedule for publishing in future: set date later than
- 07-May-2015</para>
- </listitem>
- <listitem>
- <para>Backdate the news item: set date earlier than 07-May-2015</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- </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>
- <itemizedlist>
- <listitem>
- <para>Below the news in the OPAC there will be an RSS icon allowing you to subscribe
- to library news<screenshot>
- <screeninfo>News RSS feed</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/news/newsrss.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist>
- </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>
- <listitem>
- <para>Depending on your choice for the <link linkend="NewsAuthorDisplay">NewsAuthorDisplay</link> preference you will also see the person who created the
- news item (this uses the logged in person)</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="taskscheduler">
- <title><link linkend="taskscheduler">Task Scheduler</link></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><link linkend="taskscedtroubleshoot">Troubleshooting</link></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 id="QOTDEditor">
- <title><link linkend="QOTDEditor">Quote of the Day (QOTD) Editor</link></title>
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Additional Tools > Edit
- quotes for QOTD feature</para>
- </listitem>
- </itemizedlist>
-
- <para>This tool will allow you to add and edit quotes to show on the
- OPAC if you're using the Quote of the Day (QOTD) feature.</para>
-
- <para>To turn this feature on set the <link linkend="QuoteOfTheDay">QuoteOfTheDay</link> preference to 'Enable and
- add at least one quote via the Quote of the Day Editor. Once these
- steps are complete you will see your quotes above the <link linkend="OpacMainUserBlock">OpacMainUserBlock</link> in the
- OPAC:</para>
-
- <screenshot>
- <screeninfo>Quote in the OPAC</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/qotd/quoteinopac.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <section id="addquote">
- <title><link linkend="addquote">Add a Quote</link></title>
-
- <para>To add a quote:</para>
-
- <itemizedlist>
- <listitem>
- <para>Click the 'Add quote' button in the toolbar and an empty
- quote entry will be added to the end of the current quote
- list.</para>
-
- <screenshot>
- <screeninfo>Add quote button</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/qotd/quotebuttons.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <itemizedlist>
- <listitem>
- <important>
- <para>Both the 'Source' and the 'Text' fields must be
- filled in in order to save the new quote.</para>
-
- <screenshot>
- <screeninfo>Add quote</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/qotd/addquote.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </important>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>When finished filling in both fields, press the
- <Enter> key on your keyboard to save the new quote.</para>
- </listitem>
-
- <listitem>
- <para>The list will update and the new quote should now be
- visible in the list.</para>
- </listitem>
- </itemizedlist>
-
- <note>
- <para>You may cancel the addition of a new quote any time prior to
- saving it simply by pressing the <Esc> key on your
- keyboard.</para>
- </note>
- </section>
-
- <section id="editquote">
- <title><link linkend="editquote">Edit/Delete a Quote</link></title>
-
- <para>Once the current quote pool has been loaded into the editing
- table, you may edit the quote source and text.</para>
-
- <itemizedlist>
- <listitem>
- <para>Edit either the 'Source' or 'Text' fields by clicking on
- the desired field.</para>
-
- <screenshot>
- <screeninfo>Edit quote</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/qotd/editquote.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>When you are finished editing a field, press the
- <Enter> key on your keyboard to save the changes.</para>
- </listitem>
- </itemizedlist>
-
- <para>The list will be updated, the edits saved, and visible.</para>
-
- <para>If you'd like you can also delete quote(s).</para>
-
- <itemizedlist>
- <listitem>
- <para>Select the quote(s) you desire to delete by clicking on
- the corresponding quote id.</para>
- </listitem>
-
- <listitem>
- <para>Once quote selection is finished, simply click the 'Delete
- quote(s)' button.</para>
- </listitem>
-
- <listitem>
- <para>You will be prompted to confirm the deletion.</para>
- </listitem>
-
- <listitem>
- <para>After confirming the deletion, the list will update and
- the quote(s) will no longer appear.</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="importquote">
- <title><link linkend="importquote">Import Quotes</link></title>
-
- <para>If you'd like you can import a batch of quotes as a CSV file.
- Your file must contain two columns in the form: "source","text" with
- no header row.</para>
-
- <note>
- <para>You will be prompted to confirm upload of files larger than
- 512KB.</para>
- </note>
-
- <itemizedlist>
- <listitem>
- <para>To start the import process click the 'Import quotes'
- button at the top of the screen</para>
-
- <screenshot>
- <screeninfo>Import quotes button</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/qotd/quotebuttons.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>Once on the import quotes screen you can browse your
- computer for the file you would like to import</para>
-
- <screenshot>
- <screeninfo>Import quotes</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/qotd/importquotes.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>After selecting the CSV file, click the 'Open' button and
- the file will be uploaded into a temporary editing table.</para>
-
- <screenshot>
- <screeninfo>Imported quotes</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/qotd/importedsummary.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>From the listing you can edit either the 'Source' or
- 'Text' fields by clicking on the desired field. When you are
- finished editing a field, press the <Enter> key on your
- keyboard to save the changes.</para>
-
- <screenshot>
- <screeninfo>Edit imported quote</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/qotd/editimported.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>You can also delete quotes from this listing before
- completing the import.</para>
-
- <itemizedlist>
- <listitem>
- <para>Select the quote(s) you desire to delete by clicking
- on the corresponding quote id.</para>
-
- <screenshot>
- <screeninfo>Selected for deletion</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/qotd/selectfordelete.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>Once quote selection is finished, simply click the
- 'Delete quote(s)' key.</para>
-
- <screenshot>
- <screeninfo>Delete quote(s)</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/qotd/importquotebuttons.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>You will be prompted to confirm the deletion.</para>
-
- <screenshot>
- <screeninfo>Confirm deletion</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/qotd/confirmdelete.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>After confirming the deletion, the list will update
- and the quote(s) will no longer appear.</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>Once you are satisfied with the quotes, click the 'Save
- quotes' button in the toolbar at the top and the quotes will be
- saved.</para>
-
- <screenshot>
- <screeninfo>Save quotes button</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/qotd/importquotebuttons.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- </section>
- </section>
- <section id="uploadtool">
- <title><link linkend="uploadtool">Upload</link></title>
- <para>
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Tools > Additional Tools >
- Upload</para>
- </listitem>
- </itemizedlist>
- </para>
- <para>This tool will allow you to upload files to your Koha system for selection from the
- <link linkend="uploadbibfile">Cataloging form</link>. </para>
- <section id="uploadfiles">
- <title><link linkend="uploadfiles">Upload Files</link></title>
- <para>When you first visit the Upload tool you might see a warning about missing a category.<screenshot>
- <screeninfo>Upload to temprorary</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/upload/uploadtemp.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>Categories are defined in the <link linkend="authorizedvalues">authorized
- value</link> in the UPLOAD category. If you do not have upload categories then your
- files will be temporary and will be deleted the next time the server is rebooted. Once
- you have a value in the UPLOAD authorized value category you will see a Category pull
- down below the 'Browse' button.<screenshot>
- <screeninfo>Upload to category</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/upload/upload.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>Browse your computer a file, choose a category and decide if the public will be able
- to download this file via the OPAC. Once your file is uploaded you will be presented
- with a confirmation.<screenshot>
- <screeninfo>Upload confirmation</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/upload/uploadresult.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </section>
- <section id="searchuploads">
- <title><link linkend="searchuploads">Search Files</link></title>
- <para>All uploaded files are searchable from below the upload form. Using the form you
- can search any part of the filename and/or the Hashvalue.<screenshot>
- <screeninfo>Search uploaded files</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/upload/uploadsearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>You will be presened with the results of your search.<screenshot>
- <screeninfo>Search results</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/tools/upload/uploadsearchresult.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></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><link linkend="addnewpatron">Add a new patron</link></title>
-
- <para>Patrons are added by going to the 'Patrons' module.<itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> Patrons</para>
- </listitem>
- </itemizedlist></para>
- <para>Once there you can add a new patron.</para>
-
- <itemizedlist>
- <listitem>
- <para>Click 'New patron'</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>
- <listitem>
- <note>
- <para>If you'd like to prevent full names from printing on <link linkend="notices">slips</link> and you're not using the Initials or Other name fields for
- anything else, you can use them for shortened versions of the name to then be
- printed on the slip. </para>
- <para>For example:
- <programlisting>Firstname: Nicole C.
-Surname: Engard
-Initials: NCE</programlisting></para>
- <para>Then on the slip you can have it print the <<borrowers.initials>>
- instead of the full name (NCE).</para>
- <para>Or you could do something like
- this:<programlisting>Firstname: Nicole
-Surname: Engard
-Initials: E</programlisting></para>
- <para>Then on the slip you can have it print the <<borrowers.initials>>,
- <<borrowers.firstname>> instead of the full name (E, Nicole).</para>
- </note>
- </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 (receipts, 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>
- <para>These notices are:</para>
- <itemizedlist>
- <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>
- <listitem>
- <para>Item checkout : A notice that lists all the of the items the patron has just
- checked out and/or renewed, this is an electronic form of the checkout
- receipt</para>
- </listitem>
- <listitem>
- <para>Hold filled : A notice when you have confirmed the hold is waiting for the
- patron</para>
- </listitem>
- <listitem>
- <para>Item due : A notice on the day and item is due back at the library</para>
- </listitem>
- <listitem>
- <para>Item check-in : A notice that lists all the of the items the patron has just
- checked in</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Patrons can choose to receive their notices as a digest by checking the 'Digest
- only?' box along with the delivery method. A digest is a combination of all the
- messages of that type (so all items due in 3 days in one email) in to one email
- instead of multiple emails for each alert.</para>
- </listitem>
- <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>
- <note>
- <para>A duplicate patron is detected if first and last names match and there is no date of
- birth populated or if first name, last name and date of birth fields are all populated. If
- two patrons have matching names, but one has a date of birth and the other does not they
- will not match as duplicates.</para>
- </note>
-
- <para>If you have set a minimum or upper age limit on the patron
- category and are requiring that the birth date be filled in, Koha will
- warn you if the patron you're adding is too old or young for the patron
- category you have selected:</para>
-
- <screenshot>
- <screeninfo>Patron age warning</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/patronagelimit.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="addstaffpatron">
- <title><link linkend="addstaffpatron">Add a Staff Patron</link></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><link linkend="addstatspatron">Add a Statistical Patron</link></title>
-
- <para>One way to track use of in house items is to "check out" the materials to a statistical
- patron. The "check out" process doesn’t check the book out, but instead tracks an in house
- use of the item. To use this method for tracking in house use you first 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>
-
- <para>To learn about other methods of tracking in house use visit the
- <link linkend="trackinhouse">Tracking inhouse use</link> section of this
- manual.</para>
- </section>
-
- <section id="duplicatepatron">
- <title><link linkend="duplicatepatron">Duplicate a Patron</link></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/patronedit.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>
- <note>
- <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>
- </note>
- </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="addpatronimages">
- <title><link linkend="addpatronimages">Add Patron Images</link></title>
- <para>If you would like you can add patron images to help identify patrons. To enable this
- feature you must first set the <link linkend="patronimages">patronimages</link> preference
- to 'Allow'.</para>
- <para>If the preference is set to 'Allow' you will see a placeholder image under the patron's
- name and box to upload a patron image below the basic contact information.</para>
- <screenshot>
- <screeninfo>Add patron image</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/addpatronimage.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>In the 'Upload Patron Image' box click 'Browse' to find the image on your computer and
- 'Upload' to load the image on to the patron record.</para>
- <screenshot>
- <screeninfo>Patron image</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/patronimage.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>
- <important>
- <para>There is a limit of 100K 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>
- </para>
- </section>
-
- <section id="editpatrons">
- <title><link linkend="editpatrons">Editing Patrons</link></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 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>
-
- <listitem>
- <para>If you would like to bar a patron from the library you can add a manual
- restriction</para>
- <screenshot>
- <screeninfo>Add manual restriction</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/addpatronrestriction.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <itemizedlist>
- <listitem>
- <note><para>This flag can automatically be set with the <link linkend="noticetriggers">Overdue/Notice Status
- Triggers</link></para></note>
- </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>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>Children patrons do not become adults automatically in Koha unless you have <link linkend="j2acron">Juvenile to Adult cron job</link> running. To upgrade a child patron
- to and adult patron category manually go to 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="mangepatronedits">
- <title><link linkend="mangepatronedits">Managing Patron Self Edits</link></title>
- <para>If you are allowing patrons to edit their accounts via the OPAC with the <link linkend="OPACPatronDetails">OPACPatronDetails</link> preference then you will need to
- approve all changes via the staff client before they're applied. If there are patron edits
- awaiting action they will appear on the staff client dashboard below the modules list (along
- with other items awaiting action).</para>
- <screenshot>
- <screeninfo>Patron requests waiting</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/pendingpatronrequest.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para><note>
- <para>Superlibrarians will see modifications for any branch, other staff will only see
- modifications for patrons who belong to their logged in branch.</para>
- </note>When you click the 'Patrons requesting modifications' link you will be brought to a
- list of patrons with requested changes.</para>
- <screenshot>
- <screeninfo>Manage patron updates</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/managepatronupdates.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>From here you can 'Approve' and apply the changes to the patron record, 'Delete' and
- remove the changes or 'Ignore' and keep the changes pending to review later.</para>
- <para>If you would like to see the entire patron record you can click the 'Patron details'
- links to the right of the buttons. This will open in a new tab.</para>
- </section>
-
- <section id="patronpermissions">
- <title><link linkend="patronpermissions">Patron Permissions</link></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><link linkend="setpatronperms">Setting Patron Permissions</link></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><link linkend="patronpermsdefined">Patron Permissions Defined</link></title>
-
- <para/>
-
- <itemizedlist>
- <listitem>
- <para>superlibrarian</para>
-
- <itemizedlist>
- <listitem>
- <para>Access to all librarian functions</para>
-
- <itemizedlist>
- <listitem>
- <note>
- <para>With this selected there is no need to choose any
- other permissions</para>
- </note>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>circulate</para>
-
- <itemizedlist>
- <listitem>
- <para>Check out and check in items</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><emphasis role="bold">Required for staff login.</emphasis> Staff access,
- allows viewing the catalogue in staff client<itemizedlist>
- <listitem>
- <important>
- <para>Must be given to all staff members to allow them to login to the staff
- client</para>
- </important>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>parameters</para>
-
- <itemizedlist>
- <listitem>
- <para>Manage Koha system systems (Administration panel)</para>
- </listitem>
-
- <listitem>
- <para>This section can be expanded (<link linkend="parameterpermissions">Learn
- more</link>)</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>borrowers</para>
-
- <itemizedlist>
- <listitem>
- <para>Add or modify patrons</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>permissions</para>
-
- <itemizedlist>
- <listitem>
- <para>Set user permissions</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>reserveforothers</para>
-
- <itemizedlist>
- <listitem>
- <para>Place and modify holds for patrons</para>
- </listitem>
-
- <listitem>
- <para>This section can be expanded (<link linkend="reservepermissions">Learn more</link>)</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>editcatalogue</para>
-
- <itemizedlist>
- <listitem>
- <para>Edit Catalog (Modify bibliographic/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 patrons fines and fees</para>
- </listitem>
- <listitem>
- <para>This section can be expanded (<link linkend="updatechargespermissions">Learn
- more</link>)</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>acquisition</para>
-
- <itemizedlist>
- <listitem>
- <para>Acquisition and/or suggestion management</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>Set library management params (deprecated)<itemizedlist>
- <listitem>
- <important>
- <para>This permission level no longer controls anything.</para>
- </important>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>tools</para>
-
- <itemizedlist>
- <listitem>
- <para>Use all tools</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>Edit Authorities</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>serials</para>
-
- <itemizedlist>
- <listitem>
- <para>Manage serial subscriptions</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</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>Allow staff members to modify permissions for other staff members</para>
- </listitem>
-
- <listitem>
- <important>
- <para>Requires the borrowers permission above</para>
- </important>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>plugins<itemizedlist>
- <listitem>
- <para>Koha plugins</para>
- </listitem>
- <listitem>
- <para>This section can be expanded (<link linkend="pluginpermissions">Learn
- more</link>)</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>lists<itemizedlist>
- <listitem>
- <para>Koha Lists</para>
- </listitem>
- <listitem>
- <para>
- <important>
- <para>All staff have permission to create and modify their own lists, this
- permission is only necessary if you'd like to give a staff member permission
- to delete public lists that they have not created.</para>
- </important>
- </para>
- </listitem>
- <listitem>
- <para>This section can be expanded (<link linkend="listspermissions">Learn
- more</link>)</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
-
- <section id="circpermissions">
- <title><link linkend="circpermissions">Granular Circulate Permissions</link></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>Remaining circulation permissions</para>
- </listitem>
- <listitem>
- <para>All circulation rights except those covered by permissions listed
- below</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>force_checkout<itemizedlist>
- <listitem>
- <para>Force checkout if a limitation exists</para>
- </listitem>
- <listitem>
- <para>With this permission a librarian will be allowed to override a check out
- restriction in the following cases: <itemizedlist>
- <listitem>
- <para>age restriction</para>
- </listitem>
- <listitem>
- <para>the item is issued to another patron</para>
- </listitem>
- <listitem>
- <para>the item is not for loan</para>
- </listitem>
- <listitem>
- <para>the patron has overdue items</para>
- </listitem>
- <listitem>
- <para>the item is lost </para>
- </listitem>
- <listitem>
- <para>the item is a high demand item</para>
- </listitem>
- <listitem>
- <para>the item is on hold</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist></para></listitem>
- <listitem><para>manage_restrictions<itemizedlist>
- <listitem>
- <para>Manage restrictions for accounts</para>
- </listitem>
- <listitem>
- <para>Grants permission to the staff member to lift a restriction that might be
- on the patron's record</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>overdues_report<itemizedlist>
- <listitem>
- <para> Execute overdue items report </para>
- </listitem>
- <listitem>
- <para>The permission to run the overdues reports found under Circulation</para>
- </listitem>
- </itemizedlist></para>
- </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="parameterpermissions">
- <title><link linkend="parameterpermissions">Granular Parameters Permissions</link></title>
-
- <para>If the staff member has 'parameters' permissions they have the
- ability to perform all of these actions. If you would like to
- control parameter permissions on a more granular level choose from
- these options:</para>
-
- <itemizedlist>
- <listitem>
- <para>manage_circ_rules</para>
-
- <itemizedlist>
- <listitem>
- <para>Manage circulation rules</para>
- </listitem>
- <listitem>
- <para>The ability to access the <link linkend="circfinerules">Circulation and
- fines rules</link> in the administration area</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>parameters_remaining_permissions</para>
-
- <itemizedlist>
- <listitem>
- <para>Remaining system parameters permissions</para>
- </listitem>
- <listitem>
- <para>The ability to access all areas in Administration (other than the
- Circulation and fine rules)</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="reservepermissions">
- <title><link linkend="reservepermissions">Granular Holds Permissions</link></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>Modify holds priority</para>
- </listitem>
- <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>Place holds for patrons</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="catpermissions">
- <title><link linkend="catpermissions">Granular Cataloging Permissions</link></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>delete_all_items<itemizedlist>
- <listitem>
- <para>Delete all items at once</para>
- </listitem>
- <listitem>
- <para>Ability to use the 'Delete all items' option found under the 'Edit' menu
- in cataloging</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>edit_catalogue</para>
-
- <itemizedlist>
- <listitem>
- <para>Edit catalog (Modify bibliographic/holdings data)</para>
- </listitem>
- <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>Edit items</para>
- </listitem>
- <listitem>
- <para>Ability to make <link linkend="editingitems">edits to item/holdings
- records</link>, but not bibliographic records</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem id="edit_items_restricted">
- <para>edit_items_restricted<itemizedlist>
- <listitem>
- <para>Limit item modification to subfields defined in the <link linkend="SubfieldsToAllowForRestrictedEditing">SubfieldsToAllowForRestrictedEditing</link> preference</para>
- </listitem>
- <listitem>
- <para>
- <note>
- <para>Please note that edit_items permission is still required</para>
- </note>
- </para>
- </listitem>
- </itemizedlist></para>
- </listitem>
-
- <listitem>
- <para id="fastaddpermissions">fast_cataloging</para>
-
- <itemizedlist>
- <listitem>
- <para>Fast cataloging</para>
- </listitem>
- <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="updatechargespermissions">
- <title><link linkend="updatechargespermissions">Granular Fines and Charges Permissions</link></title>
- <para>If a staff member has 'updatecharges' permission they have the ability to perform
- all of these actions. If you would like to control fines and charges permissions on a
- more granular level choose from these options:<itemizedlist>
- <listitem>
- <para>remaining_permissions<itemizedlist>
- <listitem>
- <para>Remaining permissions for managing fines and fees other than the ability
- to write off charges</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>writeoff<itemizedlist>
- <listitem>
- <para>Write off fines and fees</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist></para>
- </section>
-
- <section id="acqpermissions">
- <title><link linkend="acqpermissions">Granular Acquisitions Permissions</link></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>Add and delete budgets (but can't modify budgets)</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>budget_manage</para>
- <itemizedlist>
- <listitem>
- <para>Manage budgets</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>budget_manage_all <itemizedlist>
- <listitem>
- <para>Manage all budgets</para>
- </listitem>
- </itemizedlist></para>
- <para>budget_modify</para>
- <itemizedlist>
- <listitem>
- <para>Modify budget (can't create lines, but can modify existing ones)</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_manage_all<itemizedlist>
- <listitem>
- <para>Manage all orders and baskets, regardless of restrictions on them</para>
- </listitem>
- </itemizedlist></para>
- </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><link linkend="serpermissions">Granular Serials Permissions</link></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 <link linkend="serialexpiration">expiration of a
- serial</link></para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>claim_serials</para>
-
- <itemizedlist>
- <listitem>
- <para>Claim missing serials via the <link linkend="serialclaims">Claims
- section</link></para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>create_subscription</para>
-
- <itemizedlist>
- <listitem>
- <para>Create <link linkend="newsubscription">a new subscription</link></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 an existing subscription</para>
- </listitem>
- <listitem>
- <para>This permission does not include the ability to delete or create a
- subscription</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>receive_serials</para>
-
- <itemizedlist>
- <listitem>
- <para>Serials receiving</para>
- </listitem>
- <listitem>
- <para>Receive serials on existing subscriptions</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>renew_subscription</para>
-
- <itemizedlist>
- <listitem>
- <para>Renew a subscription</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>routing</para>
-
- <itemizedlist>
- <listitem>
- <para>Routing</para>
- </listitem>
- <listitem>
- <para>Manage <link linkend="routinglist">routing lists</link></para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>superserials<itemizedlist>
- <listitem>
- <para>Manage subscriptions from any branch (only applies when <link linkend="IndependentBranches">IndependantBranches</link> is used)</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="toolspermissions">
- <title><link linkend="toolspermissions">Granular Tools Permissions</link></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 </para>
- </listitem>
- <listitem>
- <para>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 (deletes
- borrower reading history)</para>
- </listitem>
- <listitem>
- <para>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 </para>
- </listitem>
- <listitem>
- <para>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 </para>
- </listitem>
- <listitem>
- <para>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 </para>
- </listitem>
- <listitem>
- <para>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 </para>
- </listitem>
- <listitem>
- <para>Access to the <link linkend="notices">Notices Tool</link></para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>export_catalog</para>
-
- <itemizedlist>
- <listitem>
- <para>Export bibliographic, authorities and holdings data </para>
- </listitem>
- <listitem>
- <para>Access to the <link linkend="exportbibs">Export Data Tool</link></para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>import_patrons</para>
-
- <itemizedlist>
- <listitem>
- <para>Import patron data </para>
- </listitem>
- <listitem>
- <para>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 </para>
- </listitem>
- <listitem>
- <para>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 </para>
- </listitem>
- <listitem>
- <para>Access to the <link linkend="batchdeleteitems">Batch Item Deletion
- Tool</link></para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>items_batchmod</para>
-
- <itemizedlist>
- <listitem>
- <para>Perform batch modification of items </para>
- </listitem>
- <listitem>
- <para>Access to the <link linkend="batchmodifyitems">Batch Item Modification
- Tool</link></para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem id="items_batchmod_restricted">
- <para>items_batchmod_restricted<itemizedlist>
- <listitem>
- <para>Limit <link linkend="batchmodifyitems">batch item modification</link> to
- subfields defined in the <link linkend="SubfieldsToAllowForRestrictedBatchmod">SubfieldsToAllowForRestrictedBatchmod</link> preference</para>
- </listitem>
- <listitem>
- <para>
- <note>
- <para>Please note that items_batchmod permission is still required</para>
- </note>
- </para>
- </listitem>
- </itemizedlist></para>
- </listitem>
-
- <listitem>
- <para>label_creator</para>
-
- <itemizedlist>
- <listitem>
- <para>Create printable labels and barcodes from catalog and patron data </para>
- </listitem>
- <listitem>
- <para>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>Manage CSV export profiles</para>
- </listitem>
- <listitem>
- <para>Access to the <link linkend="csvprofiles">CSV Profiles Tool</link></para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>manage_staged_marc</para>
-
- <itemizedlist>
- <listitem>
- <para>Manage staged MARC records, including completing and reversing imports </para>
- </listitem>
- <listitem>
- <para>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 </para>
- </listitem>
- <listitem>
- <para>Access to the <link linkend="comments">Comments Tool</link>
- </para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>moderate_tags<itemizedlist>
- <listitem>
- <para>Moderate patron tags</para>
- </listitem>
- <listitem>
- <para>Access to the <link linkend="tagsmoderation">Tags Tool</link></para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>records_batchdel<itemizedlist>
- <listitem>
- <para>Perform batch deletion of records (bibliographic or authority)</para>
- </listitem>
- <listitem>
- <para>Access to the <link linkend="batchrecorddelete">Batch Record Deletion
- Tool</link></para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>rotating_collections<itemizedlist>
- <listitem>
- <para>Manage rotating collections</para>
- </listitem>
- <listitem>
- <para>Access to the <link linkend="rotatingcollections">Rotating Collections
- Tool</link></para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>schedule_tasks</para>
- <itemizedlist>
- <listitem>
- <para>Schedule tasks to run </para>
- </listitem>
- <listitem>
- <para>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 </para>
- </listitem>
- <listitem>
- <para>Access to the <link linkend="stagemarc">Stage MARC Records
- Tool</link></para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>upload_general_files <itemizedlist>
- <listitem>
- <para>Upload any file</para>
- </listitem>
- <listitem>
- <para>Access to upload files via the <link linkend="uploadtool">Upload
- Tool</link></para>
- </listitem>
- </itemizedlist></para>
- </listitem>
-
- <listitem>
- <para>upload_local_cover_images</para>
-
- <itemizedlist>
- <listitem>
- <para>Upload local cover images </para>
- </listitem>
- <listitem>
- <para>Access to the <link linkend="uploadlocalimages">Upload Local Cover Image
- Tool</link> as well as permission to add and delete local cover images from
- the bib detail page</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>upload_manage <itemizedlist>
- <listitem><para>Manage uploaded files</para></listitem>
- <listitem>
- <para>Access to uploaded files via the <link linkend="uploadtool">Upload
- Tool</link>
- <note>
- <para>upload_general_files permission is required for this permission</para>
- </note></para>
- </listitem>
- </itemizedlist></para>
- </listitem>
-
- <listitem>
- <para>view_system_logs</para>
-
- <itemizedlist>
- <listitem>
- <para>Browse the system logs </para>
- </listitem>
- <listitem>
- <para>Access to the <link linkend="logviewer">Log Viewer Tool</link></para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="reportpermissions">
- <title><link linkend="reportpermissions">Granular Reports Permissions</link></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>Create SQL Reports</para>
- </listitem>
- <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>Execute SQL Reports</para>
- </listitem>
- <listitem>
- <para>The ability to run but not create or edit SQL reports </para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </section>
- <section id="pluginpermissions">
- <title><link linkend="pluginpermissions">Granular Plugins Permissions</link></title>
- <para>If the staff member has 'plugins' 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:<itemizedlist>
- <listitem>
- <para>configure<itemizedlist>
- <listitem>
- <para>Configure plugins</para>
- </listitem>
- <listitem>
- <para>The ability to run the 'configure' section of a plugin if it has
- one</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>manage<itemizedlist>
- <listitem>
- <para>Manage plugins </para>
- </listitem>
- <listitem>
- <para>The ability to install or uninstall plugins</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>report<itemizedlist>
- <listitem>
- <para>Use report plugins</para>
- </listitem>
- <listitem>
- <para>The ability to use report plugins</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>tool<itemizedlist>
- <listitem>
- <para>Use tool plugins</para>
- </listitem>
- <listitem>
- <para>The ability to use tool plugins</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="listspermissions">
- <title><link linkend="listspermissions">Granular Lists Permissions</link></title>
- <para>All staff members have permission to access lists. This section only needs to be
- checked off if you want to give permission to a staff member to delete public lists that
- they have no created themselves.<itemizedlist>
- <listitem>
- <para>delete_public_lists<itemizedlist>
- <listitem><para>Delete public lists</para></listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
- </section>
-
- <section id="patroninformation">
- <title><link linkend="patroninformation">Patron Information</link></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.<itemizedlist>
- <listitem>
- <para><emphasis role="italic">Get there:</emphasis> Patrons > Browse or search for
- patron > Click patron name</para>
- </listitem>
- </itemizedlist></para>
-
- <section id="patcheckout">
- <title><link linkend="patcheckout">Check Out</link></title>
-
- <para>For instruction on checking items out, view the <link linkend="checkingout">Checking Out</link> section of this
- manual.</para>
- <para>Staff members can access their own check out screen by clicking their username in the
- top right of the staff client and choosing 'My checkouts'<screenshot>
- <screeninfo>My checkouts</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/mycheckouts.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </section>
-
- <section id="patrondetails">
- <title><link linkend="patrondetails">Details</link></title>
- <para>Staff members can access their own account details by clicking their username in the
- top right of the staff client and choosing 'My account'</para>
- <screenshot>
- <screeninfo>My account</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/myaccount.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <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><link linkend="patcircsummary">Circulation Summary</link></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>
- <para>The Restrictions tab will show for all patrons. If the patron has no restrictions
- you will see that on the tab.</para>
- <screenshot>
- <screeninfo>Patron restrictions</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/patronrestrictions-none.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If the patron has restrictions on their account the tab will show the number and the
- description.</para>
- <screenshot>
- <screeninfo>Patron restrictions</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/patronrestrictions.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Using the 'Add manual restriction' button you can add a restriction to the patron
- record from here.</para>
- <screenshot>
- <screeninfo>Add restriction</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/addrestriction.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- </section>
-
- <section id="patronfines">
- <title><link linkend="patronfines">Fines</link></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>
-
- <para>The table will show you the following columns:</para>
-
- <itemizedlist>
- <listitem>
- <para>Date: the date the charge/payment was posted</para>
-
- <itemizedlist>
- <listitem>
- <para>In the case of fines this will be the last day that the
- fine was accrued</para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>Description: a description of the charges including the due
- date for overdue items and a link to the item record where one is
- available</para>
- </listitem>
-
- <listitem>
- <para>Note: any notes about this charge/payment<itemizedlist>
- <listitem>
- <para>If you're allowing patrons to pay fines via the OPAC with PayPal (<link linkend="EnablePayPalOpacPayments">EnablePayPalOpacPayments</link>) you will
- see a Note that says 'PayPal' for items paid this way<screenshot>
- <screeninfo>PayPal Fines</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/paypalpaid.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist></para>
- </listitem>
-
- <listitem>
- <para>Amount: the total amount of the payment or charge</para>
- </listitem>
-
- <listitem>
- <para>Outstanding: the amount still due on charge</para>
- </listitem>
- <listitem>
- <para>The ability to reverse a payment</para>
- </listitem>
- <listitem>
- <para>A link to print a receipt for that line item</para>
- </listitem>
- </itemizedlist>
- <para>At the top of the table you can click the 'Filter paid transaction' to hide all
- completed transaction and above that you can use the search box to find a specific charge
- or payment.</para>
-
- <section id="chargefines">
- <title><link linkend="chargefines">Charging Fines/Fees</link></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><link linkend="payfines">Pay/Reverse Fines</link></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>If you have a note about the payment please type that first then move
- on</para>
- </listitem>
- <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><link linkend="manualinvoice">Creating Manual Invoices</link></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>
- <listitem>
- <para>
- <important>
- <para>The value set as the Authorized Value for the MANUAL_INV authorized
- value category will appear as the Description and the Authorized Value
- Description will be used as the amount.</para>
- </important>
- </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><link linkend="manualcredit">Creating Manual Credits</link></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><link linkend="printinglineitems">Printing Invoices</link></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="patronroutingtab">
- <title><link linkend="patronroutingtab">Routing Lists</link></title>
-
- <para>A list of all of the serial routing lists the patron belongs to
- will be accessible via the 'Routing Lists' tab on the patron
- record.</para>
-
- <screenshot>
- <screeninfo>Routing Lists</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/routinglisttab.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>On this tab you will be able to see and edit all of the routing
- lists that this patron is on.</para>
-
- <screenshot>
- <screeninfo>Patron's routing lists</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/patronroutinglists.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="circhistory">
- <title><link linkend="circhistory">Circulation History</link></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><link linkend="patmodlog">Modification Log</link></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
- when changes were made to the patron record. If you also have turned
- on the <link linkend="IssueLog">IssueLog</link> and <link linkend="ReturnLog">ReturnLog</link> you will see checkins and outs on
- this screen as well.</para>
-
- <screenshot>
- <screeninfo>Changes to Patron</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 module lists 'MEMBERS' for the patron module</para>
- </listitem>
-
- <listitem>
- <para>The action will tell you what action was being logged</para>
- </listitem>
-
- <listitem>
- <para>The Object field lists the borrowernumber that is being
- modified (in the example above, it was my changing my own
- record)</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="patnotices">
- <title><link linkend="patnotices">Notices</link></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>
- <para>If the message has a status of sent or failed you will have the option to 'resend' the
- message to the patron by clicking the 'resentd button found under the status.</para>
- <screenshot>
- <screeninfo>Resend notice</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/resendnotice.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="patronstatstab">
- <title><link linkend="patronstatstab">Statistics</link></title>
-
- <para>Depending on what you set for the values of your <link linkend="StatisticsFields">StatisticsFields</link> system preference,
- you can see statistics for one patron's circulation actions.</para>
-
- <screenshot>
- <screeninfo>Patron's Statistics</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/patronstats.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="patronfiles">
- <title><link linkend="patronfiles">Files</link></title>
-
- <para>If you set the <link linkend="EnableBorrowerFiles">EnableBorrowerFiles</link> preference to
- 'Do' the Files tab will be visible on the patron information
- page.</para>
-
- <screenshot>
- <screeninfo>Patron Files Tab</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/patronfilestab.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>From here you can upload files to attach to the patron
- record.</para>
-
- <screenshot>
- <screeninfo>Upload patron files</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/nopatronfiles.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>All files that are uploaded will appear above a form where
- additional files can be uploaded from.</para>
-
- <screenshot>
- <screeninfo>List of files on the patron record</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/patronfileslist.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- <section id="patronsuggestions">
- <title><link linkend="patronsuggestions">Purchase Suggestions</link></title>
- <para>If the patron has made any purchase suggestions you will see a purchase suggestions
- tab on the patron record.<screenshot>
- <screeninfo>Patron purchase suggestions</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/purchasesuggestions.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>From here you can see all suggestions made by the patron and their status, you can
- also create a purchase suggestion on the patron's behalf by clicking the 'New purchase
- suggestion' button at the top.</para>
- <para>Learn more about <link linkend="purchasesuggest">Purchase suggestions</link> in the
- <link linkend="acqmodule">Acquisitions</link> chapter of this manual.</para>
- </section>
- <section id="patrondischarge">
- <title><link linkend="patrondischarge">Patron discharges</link></title>
- <para>A discharge is a certificate that says the patron has no current checkouts, no holds
- and owe no money. To enable this option on the patron record you need to set the <link linkend="useDischarge">useDischarge</link> system preference to 'Allow'.</para>
- <note>
- <para>In France a "quitus" ("discharge") is needed if you want to register for an
- account in a library or a university). </para>
- </note>
- <note>
- <para>Academic libraries often require that you have a clear record at the library
- before you can graduate.</para>
- </note>
- <para>Patrons can <link linkend="opacdischarge">request discharges via the OPAC</link>. Any
- pending discharges will be listed below the menu buttons on the main staff client page<screenshot>
- <screeninfo>Pending discharges</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/dischargepending.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>Clicking the pending requests will open a screen where you can allow those discharges<screenshot>
- <screeninfo>Pending discharges</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/dischargependingapprove.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>To generate a discharge for a specific patron click the 'Discharge' tab on the left of
- the patron record<screenshot>
- <screeninfo>Discharge</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/discharge.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>If the patron can have a discharge generated then it will have a button that says
- 'Generate discharge'</para>
- <screenshot>
- <screeninfo>Generate discharge</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/generatedischarge.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If not then you'll see an error explaining why you can't discharge the patron.</para>
- <screenshot>
- <screeninfo>Cannot discharge</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/cantdischarge.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Once the letter is generated you will have a PDF to download</para>
- <screenshot>
- <screeninfo>Discharge letter</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/dischargeletter.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <note>
- <para>You can style the PDF using the <link linkend="NoticeCSS">NoticeCSS</link>
- preference.</para>
- </note>
- <para>The patron will have a restriction added to their account<screenshot>
- <screeninfo>Discharge restriction</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/dischargerestrict.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>And a history of discharges will be added to the 'Discharge' tab<screenshot>
- <screeninfo>Discharge history</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/dischargehistory.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
-
-
- </section>
- </section>
-
- <section id="patronsearch">
- <title><link linkend="patronsearch">Patron Search</link></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 by any part of their name or their card
- number.</para>
-
- <screenshot>
- <screeninfo>Patron Search</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/patronsearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Clicking the small plus sign [+] to the right of the search box will open up an advanced
- patron search with more filters including the ability to limit to a specific category and/or library.</para>
- <screenshot>
- <screeninfo>Expanded patron search</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/patronsearchexpand.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>You can also filter your patron results using the search options on the left hand side
- of the page.<screenshot>
- <screeninfo>Patron search filters</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/patronsearchfilters.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
-
- <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 and choose 'Contains' instead of 'Starts
- with'</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>
-
- <listitem>
- <para>Street address:</para>
-
- <itemizedlist>
- <listitem>
- <para>Enter any part of the patron's address (includes all address fields) and choose
- 'Contains' instead of 'Starts with' to find the string anywhere in the
- address</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Date of birth<itemizedlist>
- <listitem>
- <para>Birth dates should be entered using the format set forth in the <link linkend="dateformat">dateformat</link> preference. </para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>Sort field 1<itemizedlist>
- <listitem>
- <para>This is a custom field that libraries can use for any type of data about the
- patron.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>Sort field 2<itemizedlist>
- <listitem>
- <para>This is a custom field that libraries can use for any type of data about the
- patron.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- <para>You can also choose to either search for fields that start with the string you entered
- or contain the string. Choosing 'Contains' will work like a wildcard search.</para>
- <screenshot>
- <screeninfo>Contains or Starts with Search</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/patrons/patronsearchcontains.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><note>
- <para>Mac users use the OPTION button in place of ALT</para>
- </note></para>
-
- <section id="checkingout">
- <title><link linkend="checkingout">Check Out (Issuing)</link></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>If you have enabled <link linkend="batchcheckoutprefs">batch checkouts</link> then
- click the batch check out option on the patron record<screenshot>
- <screeninfo>Batch checkout</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/batchcheckout.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </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><link linkend="checkitemout">Checking Items Out</link></title>
-
- <para>To check an item out to a patron, first search for that patron using one of the many
- options listed above. You will then be presented with the checkout screen.</para>
- <screenshot>
- <screeninfo>Check Out Screen</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/checkingout-noshow.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If you have chosen to 'Always show checkouts immediately' then you will see the list
- of checkouts below the check out box.</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>
- <listitem>
- <para>If you have <link linkend="itemBarcodeFallbackSearch">itemBarcodeFallbackSearch</link> set to 'Enable' then you can enter a keyword
- search in this box instead of just a barcode (this will make it possible to check out
- using title and/or call number).</para>
- </listitem>
- </itemizedlist>
- <para>To see more checkout options click the 'Checkout settings' link to expand the checkout area.<screenshot>
- <screeninfo>Checkout settings</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/checkoutsettings.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
-
- <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>Below the box for the barcode you will see a checkbox for 'Automatic renewal'. This
- will allow this item to automatically renew if the <link linkend="autorenewcron"
- >appropriate cron job</link> is running and there are no holds on the item.</para>
- <para>Next is an option to no decrease the loan length based on holds. This overrides the
- <link linkend="decreaseLoanHighHolds">decreaseLoanHighHolds</link> preference.</para>
- <para>If you're allowing the <link linkend="OnSiteCheckouts">checkout of items on
- site</link> to patrons (these are usually items that are not for loan that you would
- like to check for in library use) then you will see the 'On-site checkout' checkbox after
- clicking the 'Checkout settings' link to expand your circulation options.<screenshot>
- <screeninfo>On-site checkout</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/allowonsitecheckout.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
-
- <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>
-
- <note>
- <para>Items that are hourly loan items will include the time with the due date.</para>
- </note>
-
- <screenshot>
- <screeninfo>Patron's checkout summary</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/checkoutsummary.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If you checked out an item for on site use you will see that highlighted in red in the
- checkout summary.</para>
- <screenshot>
- <screeninfo>Patron's on-site checkout </screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/onsitecheckout.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If you have set your <link linkend="ExportWithCsvProfile">ExportWithCsvProfile</link>
- preference, you will also see the option to export the patron's current checkout
- information using a CSV Profile or ISO2709 (MARC21) format.</para>
- <screenshot>
- <screeninfo>Export patron's checkout information</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/exportcheckouts.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>
- <para>The details of the checkouts will appear on the bib detail page in the staff client as
- well.</para>
- <screenshot>
- <screeninfo>Circulation information on holdings tab</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/circonholdings.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <section id="printcircreceipt">
- <title><link linkend="printcircreceipt">Printing Receipts</link></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>'Print summary' will generate a full page summary for the patron's circulation
- information and 'Print overdues' will print out a slip that lists all items that are
- overdue.</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><link linkend="clearpatroninfo">Clear Patron Information</link></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="batchcheckout">
- <title><link linkend="batchcheckout">Batch Checkouts</link></title>
- <para>If you would like to perform a batch check out you can do so by turning on the <link linkend="BatchCheckouts">BatchCheckouts</link> system preference and assigning the
- proper patron categories via the <link linkend="BatchCheckoutsValidCategories">BatchCheckoutsValidCategories</link> preference. This will allow you to use an RFID
- pad that reads multiple barcodes or perform a batch check out for training internal use.<screenshot>
- <screeninfo>Batch checkouts</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/batchcheckoutscan.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>From this screen you can scan several barcodes or load a file of barcodes. If those
- items cannot be checked out they will provide a warning on the following screen</para>
- <screenshot>
- <screeninfo>Batch checkout warnings</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/batchcheckoutwarn.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If you are using a statistical patron type then you'll see that local use was recorded
- for each item you scanned.</para>
- <screenshot>
- <screeninfo>Batch local use</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/batchlocaluse.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="checkoutmsg">
- <title><link linkend="checkoutmsg">Check Out Messages</link></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 a restriction on their account</para>
-
- <screenshot>
- <screeninfo>Patron account restricted</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">restriction</link> or by the <link linkend="noticetriggers">Overdue/Notice Status Triggers</link></para>
- </listitem>
- <listitem>
- <para>If the staff member has the right permission they can override the restriction
- temporarily</para>
- <screenshot>
- <screeninfo>Patron account restricted</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/overridetemporarily.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </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><link linkend="checkoutwarn">Check Out Warnings</link></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>
- <itemizedlist>
- <listitem>
- <para>This warning will allow you to place a hold on the item for the patron you're
- trying to check it out to.</para>
- </listitem>
- </itemizedlist>
- </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 and <link linkend="AllowTooManyOverride">AllowTooManyOverride</link> is set to 'Allow'</para>
-
- <screenshot>
- <screeninfo>Too many checkouts</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/warnings/toomanycheckouts.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Patron has too many things checked out and <link linkend="AllowTooManyOverride">AllowTooManyOverride</link> is set to "Don't allow"</para>
- <screenshot>
- <screeninfo>Too many checkouts</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/warnings/toomanycheckouts-no.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>
-
- <listitem>
- <para>Item being checked out is marked as 'lost'</para>
-
- <itemizedlist>
- <listitem>
- <para>Depending on the value in your <link linkend="IssueLostItem">IssueLostItem</link> preference, you
- may just see a warning</para>
-
- <screenshot>
- <screeninfo>Warning that item is lost</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/lostitemmsg.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>or a confirmation box</para>
-
- <screenshot>
- <screeninfo>Confirm checkout of lost item</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/lostitemconfirm.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>Item being checked out is not recommended for a patron of
- this age</para>
-
- <screenshot>
- <screeninfo>Age warning</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/warnings/agewarning.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Item being checked out meets the <link linkend="decreaseLoanHighHolds">decreaseLoanHighHolds</link> system preference criteria</para>
- <screenshot>
- <screeninfo>Too many holds</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/warnings/decreaseLoanHighHoldsDuration.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- </section>
- </section>
-
- <section id="circrenew">
- <title><link linkend="circrenew">Renewing</link></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>. </para>
- <para>If <link linkend="OpacRenewalAllowed">you allow it</link>, 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. </para>
- <para>To renew items checked out to a patron, you can do one of two things. </para>
- <para>The first is to 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>
- <para>The second option is to visit the 'Renew' page found under the Circulation menu.</para>
- <screenshot>
- <screeninfo>Renew</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/renewcirc.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>And scan the barcodes of the items you would like to renew.</para>
- <screenshot>
- <screeninfo>Barcode to renew</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/renewbarcode.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If the item is renewed you will receive a confirmation message.</para>
- <screenshot>
- <screeninfo>Item renewed</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/renewed.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If the barcode is not found you will be presented with an error.</para>
- <screenshot>
- <screeninfo>No barcode found</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/renewnomatch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If the item is not actually checked out you will also receive an error.</para>
- <screenshot>
- <screeninfo>Item not checked out</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/renewnotchecked.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="checkingin">
- <title><link linkend="checkingin">Check In (Returning)</link></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</para>
- <screenshot>
- <screeninfo>Check in tab on quick search bar</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/checkinquickbox.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </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><link linkend="checkitemin">Checking Items In</link></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 book drop while the library was
- closed you can check the 'Book drop 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>
- <para>If you have the <link linkend="SpecifyReturnDate">SpecifyReturnDate</link> preference
- set to 'Allow' you will be able to arbitrarily set the return date from below the check in box.<screenshot>
- <screeninfo>Specify check in date</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/SpecifyReturnDate.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </section>
-
- <section id="checkinmsg">
- <title><link linkend="checkinmsg">Check In Messages</link></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><link linkend="circmessages">Circulation Messages</link></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><link linkend="setcircmsg">Setting up Messages</link></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><link linkend="addcircmsg">Adding a Message</link></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 and a button at the top to 'Add message'.</para>
-
- <screenshot>
- <screeninfo>Circulation Message in Staff Client</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/staffmessages.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>When you click either of these options 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><link linkend="viewcircmsg">Viewing Messages</link></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><link linkend="holds">Holds</link></title>
-
- <para>Koha allows patrons to put things on hold. A 'Hold' is a way to reserve an item.
- Depending on your <link linkend="circfinerules">circulation and fine rules</link> and <link linkend="circholdspolicy">hold preference</link> settings patrons will be able to place
- items on hold for pickup at the library at a later date/time.</para>
-
- <section id="holdsinstaff">
- <title><link linkend="holdsinstaff">Placing Holds in Staff Client</link></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 you have the <link linkend="AllowHoldItemTypeSelection">AllowHoldItemTypeSelection</link> preference set to 'Allow' and the record had more
- than one item type attached you will see an option to choose to limit the hold to a
- specific item type<screenshot>
- <screeninfo>AllowHoldItemTypeSelection</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/AllowHoldItemTypeSelection.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></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><link linkend="manageholds">Managing Holds</link></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>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>To delete or cancel a hold click the red 'X' to the right of the
- hold line. To delete/cancel a bunch of holds you can choose 'del' from
- pull down to the left of each line and then click 'Update hold(s)' at
- the bottom of the list.</para>
-
- <screenshot>
- <screeninfo>Cancel Holds</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/cancelholds.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="receiveholds">
- <title><link linkend="receiveholds">Receiving Holds</link></title>
-
- <para>When items that are on hold are <link linkend="checkingin">checked in</link> or <link linkend="checkingout">out</link> the system will remind the circulation librarian that
- 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>From here if the patron would like you suspend their holds you can do so one by one or
- in bulk.</para>
-
- <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><link linkend="transfers">Transfers</link></title>
-
- <para>If you work in a multi-branch system you can transfer items from one library to another
- by using the Transfer tool.<itemizedlist>
- <listitem>
- <para><emphasis role="italic">Get there</emphasis>: Circulation > Transfer</para>
- </listitem>
- </itemizedlist></para>
- <para>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><link linkend="setlibrary">Set Library</link></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><link linkend="fastaddcat">Fast Add Cataloging</link></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><link linkend="circreports">Circulation Reports</link></title>
-
- <para>Most reports can be found via the Reports module, but some of the more common
- circulation reports are available right from the Circulation module.<itemizedlist>
- <listitem>
- <para><emphasis role="italic">Get there</emphasis>: Circulation > Circulation
- reports</para>
- </listitem>
- </itemizedlist></para>
-
- <section id="holdsqueue">
- <title><link linkend="holdsqueue">Holds Queue</link></title>
-
- <para>This report will show you all of the holds at your
- library.</para>
-
- <screenshot>
- <screeninfo>Sample Holds Queue</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/holdsqueue.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>To generate this report, you must have the <link linkend="buildholdscron">Build Holds Queue cron job</link> running.
- This cron job is a script that should be run periodically if your
- library system allows borrowers to place on-shelf holds. This script
- decides which library should be responsible for fulfilling a given
- hold request.</para>
-
- <para>It's behavior is controlled by the system preferences <link linkend="holdqueueweight">StaticHoldsQueueWeight</link> and <link linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
-
- <para>If you do not want all of your libraries to participate in the on-shelf holds
- fulfillment process, you should list the libraries that *do* participate in the process
- here by inputting all the participating library's branchcodes, separated by commas ( e.g.
- "MPL,CPL,SPL,BML" etc. ).</para>
-
- <para>By default, the holds queue will be generated such that the
- system will first attempt to hold fulfillment using items already at
- the pickup library if possible. If there are no items available at the
- pickup library to fill a hold, build_holds_queue.pl will then use the
- list of libraries defined in StaticHoldsQueueWeight. If
- RandomizeHoldsQueueWeight is disabled ( which it is by default ), the
- script will assign fulfillment requests in the order the branches are
- placed in the StaticHoldsQueueWeight system preference.</para>
-
- <para>For example, if your system has three libraries, of varying
- sizes ( small, medium and large ) and you want the burden of holds
- fulfillment to be on larger libraries before smaller libraries, you
- would want StaticHoldsQueueWeight to look something like
- "LRG,MED,SML".</para>
-
- <para>If you want the burden of holds fulfillment to be spread out
- equally throughout your library system, simply enable
- RandomizeHoldsQueueWeight. When this system preference is enabled, the
- order in which libraries will be requested to fulfill an on-shelf hold
- will be randomized each time the list is regenerated.</para>
-
- <para>Leaving StaticHoldsQueueWeight empty is contraindicated at this
- time. Doing so will cause the build_holds_queue script to ignore
- RandomizeHoldsQueueWeight, causing the script to request hold
- fulfillment not randomly, but by alphabetical order.</para>
- </section>
-
- <section id="holdspull">
- <title><link linkend="holdspull">Holds to pull</link></title>
-
- <para>This report will show you all of the items that have holds on
- them that are available at the library for pulling. If the items are
- available at multiple branches then all branches with that item
- available will see the hold to pull until one library triggers the
- hold.</para>
-
- <screenshot>
- <screeninfo>Holds to Pull</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/holdstopull.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <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><link linkend="holdspickup">Holds awaiting pickup</link></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><link linkend="holdratios">Hold ratios</link></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><link linkend="transferstoreceive">Transfers to receive</link></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><link linkend="overduesreport">Overdues</link></title>
-
- <important>
- <para>For libraries with a large patron base, this report may take a
- significant amount of time to run.</para>
- </important>
-
- <note>
- <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>
- </note>
-
- <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.<note>
- <para>The 'Show any items currently checked out' checkbox basically switches this from a
- report of overdues to a report of checkouts. It will show all titles checked out
- regardless of due date.</para>
- </note></para>
- </section>
-
- <section id="overduesfines">
- <title><link linkend="overduesfines">Overdues with fines</link></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 id="pendingonsite">
- <title><link linkend="pendingonsite">Pending on-site checkouts</link></title>
- <para>If you are using the on site checkouts functionality (<link linkend="OnSiteCheckouts">OnSiteCheckouts</link>) then you'll have a report to view all items that are currently
- checked out on site.<screenshot>
- <screeninfo>Pending onsite checkouts</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/pendingonsite.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>This will list the due date (overdues in red), who has the item, item information and
- what library the item is at.</para>
- </section>
- </section>
-
- <section id="trackinhouse">
- <title><link linkend="trackinhouse">Tracking In house Use</link></title>
-
- <para>Many libraries track the use of items within the library. <note>
- <para>This is different from tracking on site usage. In house use is the use of items in
- the library by patrons without them having to check them out. On site use is the use of
- items on site that must first be checked out. To learn more about on site usage please
- review the <link linkend="OnSiteCheckouts">OnSiteCheckouts</link> preference.</para>
- </note></para>
- <para>Tracking the use of items in the library without checking them out 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>
-
- <note>
- <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>
- </note>
- </section>
-
- <section id="processinglocations">
- <title><link linkend="processinglocations">In Processing / Book Cart Locations</link></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>When creating items you enter in their desired final shelving location and Koha will
- temporarily change that to PROC. If <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link> is set to "Don't move" then when an item with a
- location of PROC is checked in it will either automatically update the item to use the
- permanent location. If <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link> is set to "Move" then when an item is checked in the
- location is changed from PROC to CART.</para>
-
- <para>A <link linkend="proccartcron">cron job</link> is then set to run 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>
- <note>
- <para>If the <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
- system preference is set to "Move", any newly checked-in item is also automatically
- put into the shelving cart, to be covered by the same script run.</para>
- </note>
- </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>
- </section>
-
- <section id="selfcheckout">
- <title><link linkend="selfcheckout">Self Checkout</link></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>
-
- <note>
- <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>
- </note>
-
- <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>
-
- <important>
- <para>The code above has line breaks added to make it more readable,
- please be sure to enter the above as one line in when putting it in
- the system preference.</para>
- </important>
-
- <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 'Finish' button. This
- will prompt you to print a receipt and log you out of the self check module.</para>
- <screenshot>
- <screeninfo>Self Checkout Receipt</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/selfreceiptprint.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <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><link linkend="offlinecirc">Offline Circulation Utilities</link></title>
- <para>Koha allows for you to continue circulation actions while offline by using any one of
- three utilities.</para>
- <section id="kohaofflinecirc">
- <title><link linkend="kohaofflinecirc">Offline Circulation in Koha</link></title>
- <para>If the <link linkend="AllowOfflineCirculation">AllowOfflineCirculation</link>
- preference is set to 'Enable' the library staff can continue to perform circulation
- actions within Koha when the system is offline. You will want to visit
- http://your-koha-staff-client-url/cgi-bin/koha/circ/offline.pl at least once while online
- and bookmark that page. That is the page you will go to when you are offline.</para>
- <important>
- <para>The offline interface uses HTML LocalStorage, which depending on the browser and
- user setting, is limited to 2.5MB or 5MB per domain. This means that larger systems will
- not be able to synchronize their data and are recommended to use either the <link linkend="firefoxofflinecirc">Firefox</link> or <link linkend="windowsofflinecirc">Windows</link> application for offline circulation.</para>
- </important>
- <section id="kohaofflinesetup">
- <title id="offlinesetup"><link linkend="kohaofflinesetup">Setup</link></title>
- <para>Before the first time the system goes offline go to Circulation and choose 'Built-in
- offline circulation interface'</para>
- <screenshot>
- <screeninfo>Built-in offline circulation interface</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/offlinecirc.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>And synchronize your data on every circulation computer by clicking the
- 'Synchronize' link on the right of the screen.</para>
- <screenshot>
- <screeninfo>Synchronize data</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/syncoffline.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <important>
- <para>The offline interface uses HTML LocalStorage, which depending on the browser and
- user setting, is limited to 2.5MB or 5MB per domain. This means that larger systems
- will not be able to synchronize their data and are recommended to use either the <link linkend="firefoxofflinecirc">Firefox</link> or <link linkend="windowsofflinecirc">Windows</link> application for offline circulation.</para>
- </important>
- <para>This will allow you download a local copy of your patrons and circulation data.
- Click the 'Download records' link at the top of the page to synchronize your data.</para>
- <screenshot>
- <screeninfo>Download records for offline use</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/downloadoffline.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Once your data is downloaded you will see the dates your data was last synced to the
- right of each data set.<screenshot>
- <screeninfo>Synced offline data</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/syncedoffline.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>This should be done regularly in preparation for any unexpected connection
- losses.</para>
- </section>
- <section id="kohaofflinecirculating">
- <title id="offlinecirculating"><link linkend="kohaofflinecirculating">Circulating</link></title>
- <para>When your system goes offline visit the Offline Circulation page
- (http://your-koha-staff-client-url/cgi-bin/koha/circ/offline.pl) in Koha and click
- 'Check out' or 'Check in' to perform offline actions.</para>
- <para>Checking out is done by searching for the patron by barcode or name at the top of
- the 'Check out' screen. After selecting a patron you will be presented with the synced
- patron info, including fines and check outs.</para>
- <screenshot>
- <screeninfo>Check out offline</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/offlinecheckout.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Scan the barcode of the item you would like to check out and enter a due date. If
- you don't enter a due date Koha will prompt you for one.</para>
- <screenshot>
- <screeninfo>Offline due date</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/offlineduedate.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Once the item is checked out it will appear below the patron's info.</para>
- <screenshot>
- <screeninfo>Offline checkouts</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/offlinecheckouts.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para/>
- </section>
- <section id="kohaofflineupload">
- <title><link linkend="kohaofflineupload">Koha Offline Uploading</link></title>
- <para>Once the system is back online visit the Synchronize page on the Offline Circulation
- module and click 'Upload transactions'</para>
- <screenshot>
- <screeninfo>Upload transactions</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/offlineupload.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>After the files are uploaded you can click 'View pending offline circulation
- actions' on the right.</para>
- <screenshot>
- <screeninfo>View pending offline circulation actions</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/viewkohaoffline.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>After clicking 'View pending offline circulation actions' you will be brought to a
- summary of all of the actions you loaded in to Koha in your *.koc file.</para>
- <screenshot>
- <screeninfo>Offline Circulation</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/offlinecirclog.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <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 stored transaction one by
- one. For each transaction, the status will change to:<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></para>
- </listitem>
- </itemizedlist>
- <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>
- </section>
- </section>
-
- <section id="firefoxofflinecirc">
- <sectioninfo>
- <authorgroup>
- <author>
- <firstname>Franois</firstname>
- <surname>Charbonnier</surname>
- <affiliation>
- <orgname>BibLibre</orgname>
- </affiliation>
- </author>
-
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- <contrib>Changed/edited content where necessary.</contrib>
- </editor>
- </authorgroup>
-
- <pubdate>2012</pubdate>
- </sectioninfo>
- <title><link linkend="firefoxofflinecirc">Firefox Plugin</link></title>
-
- <para>There is an offline circulation tool that you can add to your Firefox browser as an
- 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 plugins and restarted Firefox, you will see the Koha logo
- in the download 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><note>
- <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>
- </note>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><note>
- <para>The status will be "Local." as long as you are offline and
- don't process the transactions into Koha.</para>
- </note>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 > Pending offline circulation
- actions</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 stored 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 Offline 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 Offline Circulation Tool Warning</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/koctwarn.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="windowsofflinecirc">
- <title><link linkend="windowsofflinecirc">Offline Circ Tool for Windows</link></title>
-
- <para>The Offline Circulation Utility can be downloaded at: <ulink url="https://github.com/bywatersolutions/koha-offline-circulation/releases">https://github.com/bywatersolutions/koha-offline-circulation/releases</ulink></para>
- <para>To generate a borrowers.db file for loading in to the Windows tool you will need to
- run the <link linkend="offlinecirccron">file generator via a cron job</link>.</para>
- <section id="uploadofflinecirc">
- <title><link linkend="uploadofflinecirc">Upload Offline Circ File</link></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 'Upload offline circulation file (.koc)'</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 be able to upload another file or tend to pending
- offline circulation actions.</para>
- <screenshot>
- <screeninfo>Summary of offline actions</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/offlinesummary.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>After clicking 'View pending offline circulation actions' you will be brought to a
- summary of all of the actions you loaded in to Koha in your *.koc file.</para>
- <screenshot>
- <screeninfo>Offline Circulation</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/circ/offlinecirclog.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <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 stored transaction one by
- one. For each transaction, the status will change to:<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></para>
- </listitem>
- </itemizedlist>
- <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>
- </section>
- </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>
- <para>You can also use OCLC Connexion to send records directly in to Koha. For more information
- on that please review the <link linkend="oclcappendix">OCLC Connexion Setup
- appendix</link>.</para>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Cataloging</para>
- </listitem>
- </itemizedlist>
-
- <section id="catbibs">
- <title><link linkend="catbibs">Bibliographic Records</link></title>
-
- <para>In Koha the bibliographic record contains the main information
- related to the material. This includes things like the title, author,
- ISBN, etc. This information is stored in Koha in Marc (different flavors
- of Marc are supported in Koha). Once this information is saved, <link linkend="catitems">items or holdings</link> can be attached.</para>
-
- <section id="addbibrec">
- <title><link linkend="addbibrec">Adding Records</link></title>
-
- <para>Records can be added to Koha via original or copy cataloging. You can also choose to
- use the basic or advanced cataloging interface for all of your work. </para>
- <para>If you would like to catalog a record using a blank template in the basic
- editor</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 would like to catalog a record using a blank template in the advanced editor<itemizedlist>
- <listitem>
- <para>Enable the <link linkend="EnableAdvancedCatalogingEditor">EnableAdvancedCatalogingEditor</link> preference</para>
- </listitem>
- <listitem>
- <para>Click the 'Advanced editor' button<screenshot>
- <screeninfo>Advanced editor button</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/advanceditorbtn.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist></para>
-
- <para>If you want to catalog a record based on an existing record at another library in the
- editor you last used (basic or advanced)</para>
-
- <itemizedlist>
- <listitem>
- <para>Click 'New from Z39.50/SRU'</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>
- <note>
- <para>If no results are found, try searching for fewer
- fields, not all Z39.50 targets can search all of the
- fields above.</para>
- </note>
- </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>
- <section id="basicatalog">
- <title><link linkend="basicatalog">Basic Editor Cataloging</link></title>
- <para>In the basic editor 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>If you would rather not see the MARC tag numbers you can change the value in
- your <link linkend="hide_marc">hide_marc</link> system preference or each user can
- check the box next to 'Show tags' found under 'Settings'.</para>
- </listitem>
- <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 found
- under 'Settings' </para>
- </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>Choosing 'Save and view record' will bring you right to the record you just
- cataloged</para>
- </listitem>
- <listitem>
- <para>Choosing 'Save and edit items' will bring you to the add/edit item form
- after saving the bib record so that you can attach holdings</para>
- </listitem>
- <listitem>
- <para>Choosing 'Save and continute editing' will allow you to save your work so
- far and keep you in the editor to continue working</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <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>
- </section>
- <section id="advancededitor">
- <title><link linkend="advancededitor">Advanced Editor Cataloging</link></title>
- <para>In order to use the Advanced cataloging editor you need to enable the <link linkend="EnableAdvancedCatalogingEditor">EnableAdvancedCatalogingEditor</link>
- preference.</para>
- <para>
- <important>
- <para>This feature is currently experimental, and may have bugs that cause corruption
- of records. It also does not include any support for UNIMARC or NORMARC fixed
- fields. Please help us test it and report any bugs, but do so at your own risk.
- </para>
- </important>
- </para><para>In the advanced editor once you've opened a blank framework or imported a record
- via Z39.50 you will be presented with the form to continue cataloging<screenshot>
- <screeninfo>Advanced cataloging editor</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/advancededitor.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>Using the search box on the left you can perform Z39.50 searches</para>
- <screenshot>
- <screeninfo>Advanced Z39.50 results</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/advancedzresults.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>And from those Z39.50 results you can view the marc record by clicking the link to
- the right</para>
- <screenshot>
- <screeninfo>Advanced Z39.50 results</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/advancedzviewmarc.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Clicking 'Import' will bring the record in to the editor where you can perform your
- edits</para>
- <screenshot>
- <screeninfo>Advanced Cataloging</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/advancedcataloging.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <note>
- <para>When adding a new field in the Advanced Editor, you need to key underscores for a
- blank indicator, and surround the indicators with spaces. </para>
- </note>
- <note>
- <para>You need to key a space before the first subfield delimiter, but not before or
- after other subfield delimiters in the field. </para>
- </note>
- <para>At the bottom of the editor you will see help from the Library of Congress for the
- field you are on. In cases where your MARC is invalid you will see red highlighting. To
- edit the record using only keyboard functions the Keyboard shortcuts button will inform
- you of the necessary commands</para>
- <screenshot>
- <screeninfo>Advanced Z39.50 results</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/advancedkeyshort.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <section id="advancedkeyshortcuts">
- <title><link linkend="advancedkeyshortcuts">Advanced Cataloging Keyboard Shortcuts</link></title>
- <para>The following keyboard shortcuts can be used in the advanced cataloging module to
- save time and clicking.</para>
- <informaltable class="table table-condensed">
- <tgroup cols="2">
- <colspec colnum="1" colname="col1"/>
- <colspec colnum="2" colname="col2"/>
- <thead>
- <row>
- <entry>Shortcut</entry>
- <entry>Behavior</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Ctrl-D</entry>
- <entry>Insert delimiter (‡)</entry>
- </row>
- <row>
- <entry>Ctrl-H</entry>
- <entry>Get help on current subfield</entry>
- </row>
- <row>
- <entry>Ctrl-S</entry>
- <entry>Save record</entry>
- </row>
- <row>
- <entry>Ctrl-X</entry>
- <entry>Delete current field</entry>
- </row>
- <row>
- <entry>Ctrl-Shift-X</entry>
- <entry>Delete current subfield</entry>
- </row>
- <row>
- <entry>Enter</entry>
- <entry>New field on next line</entry>
- </row>
- <row>
- <entry>Shift-Enter</entry>
- <entry>Insert line break</entry>
- </row>
- <row>
- <entry>Tab</entry>
- <entry>Move to next position</entry>
- </row>
- <row>
- <entry>Shift-Tab</entry>
- <entry>Move to previous position</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section id="macroscataloging">
- <title><link linkend="macroscataloging">Macros in Advanced Cataloging</link></title>
- <para>To record a new macro:<itemizedlist>
- <listitem>
- <para>Select the "> Macros..." button</para>
- </listitem>
- <listitem>
- <para>A window will pop up. In this window, select "New macro...," key the new
- macro's name in the pop-up box and select OK.</para>
- </listitem>
- <listitem>
- <para>Now click to the right of the little number 1, and key the first line of
- your macro. For a multi-line, i.e., multi-field macro, hit the return key so
- that a little number 2 appears, and key the second line/field, etc.</para>
- </listitem>
- <listitem>
- <para>Your macros will be automatically saved. When finished you can select the
- "x" to close the window, or select a macro to run on the record that you're
- editing, or select another macro to run.</para>
- </listitem>
- </itemizedlist></para>
- <para>To edit an existing macro:<itemizedlist>
- <listitem>
- <para>Select the "> Macros..." button</para>
- </listitem>
- <listitem>
- <para>A window will pop up. In this window, select the macro that you wish to edit
- & make your changes. </para>
- </listitem>
- <listitem>
- <para>Your work will automatically be saved, and when finished you can select the
- "x" to close the window, or select a macro to run on the record that you're
- editing, or select another macro to run.</para>
- </listitem>
- </itemizedlist></para>
- <para>The basic syntax of the macro language:</para>
- <para>
- <itemizedlist>
- <listitem>
- <para>new 500=‡aEdited with Rancor<itemizedlist>
- <listitem>
- <para>Creates a new 500 with a ‡a subfield and sets it to "Edited with
- Rancor".</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>245c= by J.K. Rowling.<itemizedlist>
- <listitem>
- <para>Sets the first ‡c subfield of the first 245 tag in the record to " by
- J.K. Rowling", creating it if necessary.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>082a={084a}<itemizedlist>
- <listitem>
- <para>Sets the ‡a subfield of the first 082 tag (creating the subfield if
- necessary) to the contents of the first 084‡a.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para> indicators=_1<itemizedlist>
- <listitem>
- <para>Sets the indicators of the last mentioned tag (in this case, 082) to
- "_" and "1".</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para> new 090a=Z674.75.W67<itemizedlist>
- <listitem>
- <para>Creates a new ‡a subfield on the first 090 (but only if that field
- already exists) and sets it to Z674.75.W67.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>new 090a at end=Z674.75.W67<itemizedlist>
- <listitem>
- <para>Same as above.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>new 245b after a= a tale of might and magic / <itemizedlist>
- <listitem>
- <para>Creates a new ‡b after the first a subfield and sets it to " a tale of
- might and magic /".</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>delete 245b<itemizedlist>
- <listitem>
- <para>Deletes the first ‡b subfield on the first 245 to ‡b</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- </para>
- </section>
- </section>
- </section>
-
- <section id="cataloganalytics">
- <title><link linkend="cataloganalytics">Adding Analytic Records</link></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 there are two options. One is to use the
- <link linkend="catalogeasyanalytics">Easy Analytics</link> funtion; the other is the
- <link linkend="catalogenhanceanalytics">Analytics Enhanced Workflow</link>.</para>
- <section id="catalogeasyanalytics">
- <title><link linkend="catalogeasyanalytics">Easy Analytics</link></title>
- <para>The Easy Analytics feature makes linking analytic records together easier. The
- first thing you need to do is set the <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> preference to 'Display' and the <link linkend="UseControlNumber">UseControlNumber</link> preference to 'Don't use.' </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>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>
- <note>
- <para>It is also possible to create analytic records from this screen by clicking on
- "Create Analytics"</para>
- </note>
- <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>
- <para>When looking at the anaytic record you will also see a link to the host item under
- the 'Host records' column in the holdings table when viewing the 'Analtyics' tab.</para>
- <screenshot>
- <screeninfo>Host Record</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/hostrecords.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- <section id="catalogenhanceanalytics">
- <title><link linkend="catalogenhanceanalytics">Analytics Enhanced Workflow </link></title>
- <para>To use the Enhanced Workflow method of adding analytics, the first thing you need to
- do is set the <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link>
- preference to 'Don't display' and the <link linkend="UseControlNumber">UseControlNumber</link> preference to 'Use.' </para>
- <para>After cataloging your original record (see <link linkend="addbibrec">Adding
- Records</link> for more on creating records) click 'New' from the normal view and
- choose to 'New child record.'</para>
- <screenshot>
- <screeninfo>New child record</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/analyticschildlink.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>This will open a new blank record for cataloging. The blank record will only have
- the 773 field filled in properly to complete the link once the record is saved.</para>
- <screenshot>
- <screeninfo>773</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/analytics773child.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <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>
- <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>
- <para>When looking at the anaytic record you will also see a link to the host item under
- the 'Host records' column in the holdings table when viewing the 'Analtyics' tab.</para>
- <screenshot>
- <screeninfo>Host Record</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/hostrecords.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- <section id="analyticediting">
- <title><link linkend="analyticediting">Editing Analytics</link></title>
- <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>
- </section>
- </section>
-
- <section id="editbibrec">
- <title><link linkend="editbibrec">Editing Records</link></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><link linkend="dupbibrec">Duplicating Records</link></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="uploadbibfile">
- <title><link linkend="uploadbibfile">Attaching files to Records</link></title>
- <para>If you would like to upload files to Koha you can do so with a few settings.<itemizedlist>
- <listitem>
- <para>You will need to ask your system administrator to set the 'upload_path' config
- variable to point to where the files will be stored<itemizedlist>
- <listitem>
- <para>You can see if your upload path is set correctly by visiting About Koha >
- System Information. If there is an error you will see it there.<screenshot>
- <screeninfo>Upload Path Warning</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/uploadwarning.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>You will want to be sure that your <link linkend="OPACBaseURL">OPACBaseURL</link> system preference is set appropriately </para>
- </listitem>
- <listitem>
- <para>You will want to add the upload.pl plugin to the 856$u subfield in one (or
- multiple) of your <link linkend="editsubfields">frameworks</link></para>
- </listitem>
- </itemizedlist></para>
- <para>Once you are all set up you can continue with cataloging as regular. You will see a
- plugin icon next to the 856$u that will open up the upload and/or search window<screenshot>
- <screeninfo>Upload file to record</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/uploadfilebib.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>From this menu you can click browse to find a file and attach it, or you can search
- files you have uploaded previously using the search box. From the search results you can
- choose which file to attach.<screenshot>
- <screeninfo>Uploaded files</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/uploadedfiles.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>Once the file is chosen it will appear as a link in the MARC record and on the detail
- display.</para>
- </section>
-
- <section id="mergebibs">
- <title><link linkend="mergebibs">Merging Records</link></title>
- <para>To merge bibliographic records together you will want to go to the Cataloging module
- and perform a search. </para>
- <para>If you see duplicates on that search results screen you can check the boxes next to
- the duplicates and click the 'Merge selected' button at the top of the results. </para>
- <para>Once you have selected the records you want to merge, click the 'Merge selected'
- button at the top of the list. You will be asked which of the 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 all 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>Below the records you are merging is an option to enter fields to report on. This will
- allow you to control what fields you see on the merge confirmation page:</para>
- <screenshot>
- <screeninfo>Merge report fields</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/lists/mergereportvalues.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If you enter nothing you will be presented with a confirmation of biblionumbers
- only</para>
- <screenshot>
- <screeninfo>Merge report</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/lists/mergeblankreport.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If you enter fields you will see those on the confirmation page (you can set defaults
- with the <link linkend="MergeReportFields">MergeReportFields</link> preference)</para>
- <screenshot>
- <screeninfo>Merge report</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/lists/mergereport.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Once you have completed your selections click the 'merge' button. The primary
- record will now CONTAIN 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>
-
- <para>
- <note>
- <para>If you would like you can also use the <link linkend="lists">Lists</link> tool for
- merging records together. <link linkend="mergebibrecs">Learn more here</link>.</para>
- </note>
- </para>
- </section>
- <section id="deleterecord">
- <title><link linkend="deleterecord">Deleting Records</link></title>
- <para>To delete a bibliographic record simply choose the 'Edit' button and select 'Delete record'</para>
- <screenshot>
- <screeninfo>Delete record</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/deleterecord.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Bibliographic records can only be deleted one all items have been deleted. If you try
- to delete a bibliographic record with items still attached you will see that the delete
- option is grayed out.</para>
- <screenshot>
- <screeninfo>Record with items still attached</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/nodeleterecord.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- </section>
-
- <section id="catitems">
- <title><link linkend="catitems">Item Records</link></title>
-
- <para>In Koha each bibliographic record can have one or more items
- attached. These items are sometimes referred to as holdings. Each item
- includes information to the physical copy the library has.</para>
-
- <section id="addingitems">
- <title><link linkend="addingitems">Adding Items</link></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/Edit Items' from the
- cataloging search results</para>
-
- <screenshot>
- <screeninfo>Add/Edit Items 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<itemizedlist>
- <listitem>
- <para>If you'd like you can use the <link linkend="cnbrowseplugin">call number
- browser plugin</link> for this field. If it's enabled you'll see a ... to the
- right of the field. When clicked that will open a call number browser window if
- the row is highlighted in Red then the call number is in use, if there is a thin
- Green line instead then the call number can be used.<screenshot>
- <screeninfo>Call number browser</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/cnbrowser.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist></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>
- <note>
- <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>
- </note>
- </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 items will ask how many items and will then add that number of items
- 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 <link linkend="SpineLabelShowPrintOnBibDetails">SpineLabelShowPrintOnBibDetails</link>
- 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>
- <para>You can also filter the contents of your holdings table by clicking the 'Activate
- filters' links. This will show a row at the top where you can type in any column to
- filter the results in the table.</para>
- <screenshot>
- <screeninfo>Filter holdings</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/items-activatefilters.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="editingitems">
- <title><link linkend="editingitems">Editing Items</link></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>
-
- <para>Which will open up a list of items where you can click the 'Actions' button to the
- left of the specific item you would like to edit and choose 'Edit'.</para>
-
- <screenshot>
- <screeninfo>Edit individual items</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/edititemlink.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>
-
- <para>Which will open up the editor on the item you'd like to edit</para>
-
- <screenshot>
- <screeninfo>Edit individual items</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/edititemlinkfromtab.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>Clicking 'Edit' and then 'Edit items in batch'</para>
-
- <screenshot>
- <screeninfo>Edit items in a batch</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/editinbatch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>This will open up the <link linkend="batchmodifyitems">batch
- item modification tool</link> where you can edit all of the items
- on this record as a batch.</para></listitem>
- <listitem><para>You can also enable <link linkend="StaffDetailItemSelection">StaffDetailItemSelection
- </link> to have checkboxes appear to the left of each item
- on the detail display. You can then check off the items you would like to edit and
- click 'Modify selected items' at the top of the list.</para>
- <screenshot>
- <screeninfo>Editing selected items</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/editwithitemchecks.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>You can click 'Edit' to the right of each item in the Holdings tab<screenshot>
- <screeninfo>Edit individual items</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/editindividual.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- <listitem>
- <para>There is also a link to Edit items from the search results in the staff client<screenshot>
- <screeninfo>Edit item on the search results</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/edititemssearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- <listitem>
- <para>Finally you can use the <link linkend="batchmodifyitems">Batch Item
- Modification</link> tool</para>
- </listitem>
- </itemizedlist>
-
- <section id="itemquickedit">
- <title><link linkend="itemquickedit">Quick Item Status Updates</link></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 id="duplicateitem">
- <title><link linkend="duplicateitem">Duplicating Items</link></title>
- <para>You can easily duplicate each item by clicking the 'Action' button the left of each
- item on the edit items screen</para>
- <screenshot>
- <screeninfo>Edit individual items</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/edititemlink.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>From here you can choose to 'Duplicate' the item and this will populate the form
- with the values from the item you chose.</para>
- </section>
- </section>
-
- <section id="iteminfo">
- <title><link linkend="iteminfo">Item Information</link></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/quickitemedit.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>Clicking that tab will give you basic information about the items. From here you can
- see basic information about the item such as the home library, item type, collection code,
- call number and replacement price. You can also see and edit the status information. If
- an item is marked lost or withdrawn you will also see the date that status was applied.<screenshot>
- <screeninfo/>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/itemstatuses.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>In the History section you will see infomration about the check out history of the
- item and if you ordered the item via the acquisitions module then this 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><link linkend="moveitemrec">Moving Items</link></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><link linkend="deleteitems">Deleting Items</link></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>You can also enable <link linkend="StaffDetailItemSelection">StaffDetailItemSelection</link>
- to have checkboxes appear to the left of each item on
- the detail display. You can then check off the items you would like to delete and click
- 'Delete selected items' at the top of the list.</para>
- <screenshot>
- <screeninfo>Deleting selected items</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/editwithitemchecks.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <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><link linkend="itemcirchistory">Item Specific Circulation History</link></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><link linkend="catauthorities">Authorities</link></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><link linkend="addauthorities">Adding Authorities</link></title>
-
- <para>To add a new authority record you can either choose the authority type from the 'New
- Authority' button or search another library by clicking the 'New from Z39.50'
- button.</para>
-
- <screenshot>
- <screeninfo>New Authority Record Options</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/newauthtypes.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>If you choose to enter a new authority from scratch, 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. To duplicate a field or subfield just click the
- plus sign (+) to the right of the label. To use field helper plugins
- simply click the ellipsis (...) to the right of the field.</para>
-
- <para>When linking authorities to other headings, you can use the
- authority finder plugin by clicking the ellipsis (...) to the right of
- the field.</para>
-
- <screenshot>
- <screeninfo>Authority search plugin</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/creatnewauthfromlink.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>From there you can search your authority file for the authority
- to link. If you can't find the authority to link, you can click the
- 'Create new' button and add the necessary authority for the link. This
- plugin also allows for you to choose the link relationship between the
- authorities.</para>
-
- <screenshot>
- <screeninfo>Authority relationships</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/authrelationships.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If you choose to search another library for the authority record you will be presented
- with a search box</para>
- <screenshot>
- <screeninfo>Authority Z39.50 Search</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/authzsearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>From the results you can choose the 'Import' link to the right of the record you would
- like to add to Koha</para>
- <screenshot>
- <screeninfo>Authority Z39.50 Results</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/authimport.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>You will then be presented with the form to edit the authority before saving it to
- your system</para>
- <screenshot>
- <screeninfo>Imported Authority</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/authorityimported.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="searchauthorities">
- <title><link linkend="searchauthorities">Searching Authorities</link></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, an 'Actions' menu that includes the ability to <link
- linkend="editauthorities">edit</link>, <link linkend="authoritymerge">merge</link> and
- <link linkend="editauthorities">delete</link> (if there are no 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 Details link to the right of 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>
-
- <para>If the authority has See Alsos in it you will see those broken
- out on the search results, clicking the linked headings will run a
- search for that heading instead.</para>
-
- <screenshot>
- <screeninfo>See Also in Authorities</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/authoritiesseealso.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="editauthorities">
- <title><link linkend="editauthorities">Editing Authorities</link></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. Or by clicking on the 'Edit' link to
- the left of the authority on the search results.</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 <link linkend="dontmerge">dontmerge</link> is set to 'Do', Koha will immediately update all of
- the bib records linked to the authority with the new authority record's data. If dontmerge
- is set to "Don't" then Koha won't edit bib records when changes are made to authorities,
- rather, this is done later by the <link linkend="mergeauthcron">merge_authority.pl
- cronjob</link>.</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 id="authoritymerge">
- <title><link linkend="authoritymerge">Merging Authorities</link></title>
- <para>If you have duplicate authority records you can merge them together by clicking the
- 'Merge' link, found in the actions menu, next to two results on an authority search. </para>
- <screenshot>
- <screeninfo>Duplicate authorities results</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/dupauth.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>After clicking 'Merge' on the first result you will see that authority listed at the
- top of the results.</para>
- <screenshot>
- <screeninfo>Merging authorities results</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/authmergesearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Next you need to click 'Merge' next to the second result you'd like to merge. </para>
- <para>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.</para>
- <screenshot>
- <screeninfo>Merging authorities</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/authmergechoice.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>You will be presented with the MARC for both of the records (each accessible by tabs
- labeled with the authority 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>Authorities to merge</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/authmerging.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Once you have completed your selections click the 'Merge' button. The primary record
- will now contain the data you chose for it and the second record will be deleted.</para>
- <screenshot>
- <screeninfo>Merged authority</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/authmerged.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- </section>
-
- <section id="catguides">
- <title><link linkend="catguides">Cataloging Guides</link></title>
-
- <para/>
-
- <section id="bibcatcheatsheet">
- <sectioninfo>
- <authorgroup>
- <author>
- <firstname>Jared</firstname>
- <surname>Camins-Esakov</surname>
- <affiliation>
- <orgname>American Numismatic Society</orgname>
- </affiliation>
- </author>
-
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- <contrib>Changed/edited content where necessary.</contrib>
- </editor>
- </authorgroup>
-
- <pubdate>2010</pubdate>
- </sectioninfo>
- <title><link linkend="bibcatcheatsheet">Bibliographic Record Cataloging Cheat Sheet</link></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><link linkend="itemcatguide">Item/Holdings Record Cataloging Guide</link></title>
-
- <para>This table represents the default embedded holdings data in Koha. 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 Acquisitions 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$u</para>
- </entry>
- <entry>
- <para>Uniform Resource Identifier </para>
- </entry>
- <entry>
- <para>Item specific URL</para>
- </entry>
- <entry>
- <para>Full URL starting with http:// Only needed if your item has its own URL, not
- necessary if the bib record has a 856$u that applies to all items on the record.
- </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$x</para>
- </entry>
- <entry>
- <para>Nonpublic note</para>
- </entry>
- <entry>
- <para/>
- </entry>
- <entry>This is a note field for notes that will not appear in the OPAC. Right now
- this note does not appear anywhere but in the item edit screen in the staff
- client.</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><link linkend="onorderitemholds">Handling On Order Items and Holds</link></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://marcedit.reeset.net/">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>
-
- <note>
- <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>
- </note>
- </section>
- </section>
- </chapter>
- <chapter id="coursereserves">
- <title>Course Reserves</title>
- <para>The course reserves module in Koha allows you to temporarily move items to 'reserve' and
- assign different circulation rules to these items while they are being used for a specific
- course.</para>
- <section id="coursesetup">
- <title><link linkend="coursesetup">Course Reserves Setup</link></title>
- <para>Before using Course Reserves you will need to do some set up. </para>
- <para>First you will need to enable course reserves by setting the <link linkend="UseCourseReserves">UseCourseReserves</link> preference to 'Use'.</para>
- <para>Next you will need to have all of your course instructors <link linkend="addnewpatron">added as patrons</link>.</para>
- <para>Next you will want to add a couple of new <link linkend="newauthval">authorized
- values</link> for Departments and Terms. </para>
- <para>You may also want to create new <link linkend="additemtype">item types</link>, <link linkend="ccode">collection codes</link> and/or <link linkend="shelvelocvals">shelving
- locations</link> to make it clear that the items are on reserve to your patrons. You will
- also want to be sure to confirm that your <link linkend="circfinerules">circulation and fine
- rules</link> are right for your new item types (whether they be hourly or daily
- loans).</para>
- </section>
- <section id="addingcourses">
- <title><link linkend="addingcourses">Adding Courses</link></title>
- <para>Once you have completed your set up for Course Reserves you can start creating courses
- and adding titles to the reserve list.</para>
- <screenshot>
- <screeninfo>Course Reserves Admin</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/coursereserves/coursesblank.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>From the main course reserves page you can add a new course by clicking the 'New course'
- button at the top left.</para>
- <screenshot>
- <screeninfo>Add a new course</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/coursereserves/newcourse.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Your new course will need a Department, Number and Name at the bare minimum. You can
- also add in additional details like course section number and term. To link an instructor to
- this course simply start typing their name and Koha will search your patron database to find
- you the right person.</para>
- <screenshot>
- <screeninfo>Instrcutor search</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/coursereserves/instructorsearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Once the instructor you want appears just click their name and they will be added. You
- can repeat this for all instructors on this course. Each instructor will appear above the
- search box and can be removed by clicking the 'Remove' link to the right of their name.</para>
- <screenshot>
- <screeninfo>Instructors</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/coursereserves/instructorremove.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If you would like your course to show publicly you'll want to be sure to check the
- 'Enabled?' box before saving your new course.</para>
- <para>Once your course is saved it will show on the main course reserves page and be
- searchable by any field in the course.</para>
- <screenshot>
- <screeninfo>Courses</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/coursereserves/courses.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- <section id="addreserves">
- <title><link linkend="addreserves">Adding Reserve Materials </link></title>
- <para>Before adding reserve materials you will need at least one course to add them to. To
- add materials visit the Course Reserves module.</para>
- <screenshot>
- <screeninfo>Courses</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/coursereserves/courses.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Click on the title of the course you would like to add materials to.</para>
- <screenshot>
- <screeninfo>Course administration</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/coursereserves/courseadmin.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>At the top of the course description click the 'Add reserves' button to add titles to
- this reserve list. You will be asked to enter the barcode for the reserve item.</para>
- <screenshot>
- <screeninfo>Add item to reserve</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/coursereserves/addbarcode.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>After you are done scanning the barcodes to add to the course you can see them on the
- course page</para>
- <screenshot>
- <screeninfo>Course with reserves</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/coursereserves/coursewithreserves.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- <section id="opaccoursereserves">
- <title><link linkend="opaccoursereserves">Course Reserves in the OPAC</link></title>
- <para>Once you have enabled Course Reserves and added courses you will see a link to Course
- Reserves below your search box in the OPAC.</para>
- <screenshot>
- <screeninfo>Course Reserves Link</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/coursereserves/courselinkopac.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Clicking that link will show you your list of enabled courses (if you have only one
- course you will just see the contents of that one course).</para>
- <screenshot>
- <screeninfo>Course list in the OPAC</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/coursereserves/coursesopac.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>You can search course reserves by any field (course number, course name, instructor
- name, department) that is visible in the list of courses. Clicking a course name will show
- you the details and reserve items.</para>
- <screenshot>
- <screeninfo>Course listing</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/coursereserves/courseopac.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </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>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Serials</para>
- </listitem>
- </itemizedlist>
- <section id="serialfreq">
- <title><link linkend="serialfreq">Manage Serial Frequencies</link></title>
- <para>Koha keeps a record of publication frequencies for easy management and
- duplication.</para>
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Serials > Manage frequencies</para>
- </listitem>
- </itemizedlist>
- <para>From this page you can view all of the existing frequencies in your system</para>
- <screenshot>
- <screeninfo>Frequencies</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/frequencies.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>and create new ones.</para>
- <screenshot>
- <screeninfo>New frequency</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/newfrequency.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- <section id="serialpatterns">
- <title><link linkend="serialpatterns">Manage Serial Numbering Patterns</link></title>
- <para>Everytime you create a new numbering pattern in serials you can save it for later use.
- These patters are accessible via the Manage numbering patterns page.</para>
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Serials > Manage numbering patterns</para>
- </listitem>
- </itemizedlist>
- <para>This page will list for you the numbering patterns you have saved in the past as well as
- a few canned patterns.</para>
- <screenshot>
- <screeninfo>Number patterns</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/numpatterns.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para><note>
- <para>If you have upgraded from a previous version of Koha you will see 'Backup patterns'
- listed for patterns used in version before Koha 3.14. This is how Koha saved your old
- numbering patterns. You can edit these to give them more meaningful names from
- here.</para>
- </note>It will also allow you to create a new numbering pattern without first adding a
- subscription. To add new new pattern click 'New numbering pattern' at the top of the list of
- patterns.</para>
- <screenshot>
- <screeninfo>New number pattern</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/newnumpattern.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- <section id="serialfields">
- <title><link linkend="serialfields">Custom Subscription Fields</link></title>
- <para>This module will allow you to add custom fields to your serial subscriptions for
- reporting and searching.</para>
- <para>
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> Serials > Add subscription fields</para>
- </listitem>
- </itemizedlist>
- </para>
- <para>To add custom fields simply click the 'Add subscription fields' link on the left of the
- Serial page and choose the 'New field' button<screenshot>
- <screeninfo>Add subscription fields</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/newfield.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>The form that appears will ask for either an authorized value or a marc field to
- populate the field with</para>
- <para>
- <screenshot>
- <screeninfo>Add field</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/addfield.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </para>
- <para>For example you might want to track which department you're ordering for or the
- collection code for this serial<screenshot>
- <screeninfo>Add department</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/adddept.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>This data will then show when you are adding a subscription<screenshot>
- <screeninfo>Add field value</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/addingfieldvalues.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>and when you view the subscription<screenshot>
- <screeninfo>Show field</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/showfields.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>and when you search subscriptions (if you chose to make it 'searchable')<screenshot>
- <screeninfo>Searchable field</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/searchfield.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </section>
-
- <section id="newsubscription">
- <title><link linkend="newsubscription">Add a subscription</link></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 (1/2)</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 (if you
- barcode issues you'll want to create an item at this time)</para>
- </listitem>
- <listitem>
- <para>In order to determine how to handle irregularities in your subscription answer 'When
- there is an irregular issue', if the numbers are always sequential you'll want to pick
- 'Keep issue number'</para>
- </listitem>
- <listitem>
- <para>Checking the 'Manual history' box will allow you to enter serials outside the
- prediction pattern once the subscription is saved by going to the 'Planning' tab on the
- subscription detail page.<screenshot>
- <screeninfo>Manual History</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/manualhistory.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- <listitem>
- <para>'Call Number' is for your item's call number or 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>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>The 'Patron notification' option lets you pick a notice to send to patrons who
- subscribe to updates on this serial via the OPAC.</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>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>'Location' is for the shelving location</para>
- </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>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>
- </itemizedlist>
- <para>Once that data is filled in you can click 'Next' to enter the prediction pattern information.</para>
- <screenshot>
- <screeninfo>Add a new subscription (2/2)</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/addsub2.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-<itemizedlist>
- <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 all of
- which are visible alongside your own custom frequencies by visiting '<link linkend="serialfreq">Manage frequencies</link>'</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>'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 start date' is the date at which the subscription begins. This is 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>'Numbering pattern' will help you determine how the numbers are printed for each
- issue. Patterns entered here are saved and editable at any time by visiting '<link linkend="serialpatterns">Manage numbering patterns</link>'</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>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>
- <screenshot>
- <screeninfo>Advanced prediction pattern</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/advancedpattern.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>The 'Locale' option is useful when you want to display days, month or season. For
- example, if you have a German serial, you can use the German locale option to display
- days, etc. in German.</para>
- </listitem>
-
- <listitem>
- <para>Once a 'Numbering pattern' is chosen the number formula will appear.<screenshot>
- <screeninfo>Numbering Forumla</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/numberonly.png"/>
- </imageobject>
- </mediaobject>
- </screenshot><itemizedlist>
- <listitem>
- <para>The 'Begins with' number is the number of the issue you're holding in your
- hand.</para>
- </listitem>
- <listitem>
- <para>The 'Inner counter' is used to tell Koha where the "receiving cycle" starts<itemizedlist>
- <listitem>
- <para>For example: If the first issue to receive is "vol. 4, no. 1, iss. 796",
- you need to set up "inner counter = 0" But if it's "vol. 4, no. 2, iss.
- 797", the inner counter should be "1".</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>After filling in this data click the 'Test prediction pattern' button to see
- what issues the system will generate, if there are irregularities you can choose
- which issues don't exist from the list presented.</para>
- <screenshot>
- <screeninfo>Prediction pattern</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/predictionpattern.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>If you have added a <link linkend="serialfields">custom subscription field</link>,
- it will be editable above the buttons at the bottom of the screen<screenshot>
- <screeninfo>Show field</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/addingfieldvalues.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></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><link linkend="receiveissues">Receive Issues</link></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 after choosing 'Arrived'</para>
- <screenshot>
- <screeninfo>Serial item record</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/serialitem.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
-
- <listitem>
- <para>If your issue has a supplemental issue with it, fill in the Supplemental Issue information.<itemizedlist>
- <listitem>
- <para>Key the entire numbering in the box after "Supplemental issue" no numbering
- will be inherited/auto-filled from the main issue, and exactly what you key in the
- box after "Supplemental issue" will be auto-filled in the item record's Serial
- enumeration/chronology [MARC21 952$h] (if you create item records). <itemizedlist>
- <listitem>
- <para>E.g., key this in its entirety if it's what you would like displayed:
- "v.69 no.3 (Mar. 2015) suppl." </para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist></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><link linkend="routinglist">Create a Routing List</link></title>
-
- <para>A routing list is a list of people who receive the serial before it goes to the shelf.
- To enable routing lists you want to set your <link linkend="RoutingSerials">RoutingSerials</link> preference to 'Add'.</para>
-
- <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>
-
- <para>To see a list of all of the routing lists a specific patron is on visit the <link linkend="patronroutingtab">Routing Lists tab</link> on their patron record.</para>
- </section>
-
- <section id="serialsubinstaff">
- <title><link linkend="serialsubinstaff">Subscriptions in Staff Client</link></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>
- <para>If you are using the <link linkend="acqmodule">Acquisitions</link> module to keep <link linkend="ordersubscription">track of serial subscriptions</link> you will see that info
- before your subscription details.</para>
- <screenshot>
- <screeninfo>Acquisitions information for subscription</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/subdetails.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="serialsubinopac">
- <title><link linkend="serialsubinopac">Subscriptions in OPAC</link></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 be notified of new issues as they are
- released by clicking the 'Subscribe to email notifications of new issues' button. For this
- link to appear you will want to have chosen to notify patrons <link linkend="newsubscription">on the subscription</link> itself.</para>
-
- <screenshot>
- <screeninfo>Subscribe link in the OPAC</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/opacroutingsubscribe.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>You can see thos who subscribe to new issue alerts by going to the subscription page in
- the staff client and looking on the right of the 'Information' tab.<screenshot>
- <screeninfo>Serial notification subscribers</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/subscribers.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
-
- <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><link linkend="serialclaims">Claim Late Serials</link></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><link linkend="serialexpiration">Check Serial Expiration</link></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><link linkend="serialrenew">Renewing Serials</link></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>
-
- <section id="serialsearch">
- <title><link linkend="serialsearch">Searching Serials</link></title>
-
- <para>Once in the Serials module there is basic search box at the top
- that you can use to find subscriptions using any part of the ISSN and/or
- title.</para>
-
- <screenshot>
- <screeninfo>Basic Serials Search</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/serialsearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>You can also click the 'Advanced Search' link to the right of the
- 'Submit' button to do a more thorough search of your serials.</para>
-
- <screenshot>
- <screeninfo>Advanced Serials Search</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/advanceserialsearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>From your results you can filter by using the search boxes at the
- bottom of each column and adjust the number of resutls using the toolbar
- at the top of the results set.</para>
-
- <screenshot>
- <screeninfo>Serial Search Results</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serials/serialsearchresults.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- </chapter>
-
- <chapter id="acqmodule">
- <title>Acquisitions</title>
-
- <para>The Koha Acquisitions module provides a way for the library to
- record orders placed with vendors and manage purchase budgets.</para>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Acquisitions</para>
- </listitem>
- </itemizedlist>
-
- <section id="acqsetup">
- <title><link linkend="acqsetup">Setup</link></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. Before setting your <link linkend="ediaccounts">EDI Accounts</link> and <link
- linkend="libraryeans">Library EANs</link> you will need to have <link
- linkend="addacqvendor">entered your vendors</link>.</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><note>
- <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>
- </note></para>
-
- <para>To see all active funds you can click the checkbox next to 'Show active and inactive'
- above 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><link linkend="acqvendors">Vendors</link></title>
-
- <para>Before any orders can be places you must first enter at least one
- vendor.</para>
-
- <section id="addacqvendor">
- <title><link linkend="addacqvendor">Add a Vendor</link></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><link linkend="editacqvendor">View/Edit a Vendor</link></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 vendor' button.</para>
-
- <para>If the vendor has no baskets attached to it then a 'Delete vendor' button will also be
- visible and the vendor can be deleted. Otherwise you will see a 'Receive shipment'
- button.</para>
-
- <screenshot>
- <screeninfo>Receive shipment button</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/receivebutton.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="vendorcontracts">
- <title><link linkend="vendorcontracts">Vendor Contracts</link></title>
-
- <para>You can define contracts (with a start and end date) and attach
- them 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><link linkend="addvendorcontract">Add a Contract</link></title>
-
- <para>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 cannot 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><link linkend="managesuggest">Managing Suggestions</link></title>
-
- <para>Purchase suggestions can be generated in one of two ways. You can create suggestions via
- the staff client either for the library or <link linkend="patronsuggestions">on the patron's
- behalf</link> from their record. Depending on your settings in the <link linkend="suggestionspref">suggestion</link> system preference, patrons may also 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>An 'Accepted' suggestion is one that you have marked as 'Accepted' using the form below
- the suggestions. A 'Pending' suggestion is one that is awaiting action from the library. A
- 'Checked' suggestion is one that has been marked as 'Checked' using the form before the
- suggestions. An 'Ordered' suggestion is on that has been ordered using the '<link linkend="orderfromsuggestion">From a purchase suggestion</link>' link in your basket. A
- 'Rejected' suggestion is one that you have marked at 'Rejected' using the form below the
- list of suggestions.</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.<note>
- <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>
- </note></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 or at the to pof the suggestion
- detail page 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>You can also assign this suggestion to a fund. <screenshot>
- <screeninfo>Edit suggestion fund</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/suggestfund.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>This edit can trigger a notice (defined in the <link linkend="notices">Notices &
- Slips</link> tool with the <link linkend="toprocessnotice">TO_PROCESS</link> notice) to
- the fund owner that there is a suggestion ready for them to manage if you have turned on the
- <link linkend="emailsuggestfund">cron job to generate these notices</link>.</para>
-
- <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><link linkend="placingacqorder">Placing Orders</link></title>
-
- <para>To place an order you must first search for the vendor or bookseller you want to send
- the order to. <important>
- <para>If you are planning on using EDIFACT to submit your order you will need to first set
- up your library's <link linkend="ediaccounts">EDI Accounts</link> and <link
- linkend="libraryeans">EANs</link>.</para>
- </important></para>
-
- <section id="createacqbasket">
- <title><link linkend="createacqbasket">Create a basket</link></title>
- <para>
- <note>
- <para>If you're using EDI for ordering you will want to download your order record from
- your vendor before starting the process in Koha.</para>
- </note>
- </para>
-
- <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>And click the 'New basket' button to the right of the vendor name.<note>
- <para>You can also add to an existing basket by clicking the 'Add to basket' link to the
- far right of each basket's information in the results table. </para>
- </note></para>
- <para>After clicking 'New basket' you will be asked to enter some information about the
- order:</para>
-
- <screenshot>
- <screeninfo>Add Basket Form</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/addbasket.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <itemizedlist>
- <listitem>
- <para>When adding a basket you want to give it a name that will
- help you identify it later</para>
- </listitem>
-
- <listitem>
- <para>Enter in the Billing Place and Delivery Place (this will
- default the library you're logged in at)</para>
- </listitem>
-
- <listitem>
- <para>If you would like to change the vendor you're ordering from
- you can use the Vendor pull down menu</para>
- </listitem>
-
- <listitem>
- <para>The notes fields are optional and can contain any type of
- information</para>
- </listitem>
- <listitem>
- <para>If you're ordering standing items (items which arrive regularly) then you will
- want to check the 'Orders are standing' box for this basket</para>
- </listitem>
- </itemizedlist>
-
- <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 id="orderfromsuggestion">
- <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. In order to keep track of suggestions
- that have been ordered and received you must place the order using this link. </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>
- <listitem>
- <para>Orders added to the basket in this way will notify the patron via email that
- their suggestion has been ordered and will update the patron's '<link linkend="opacmysuggestions">My purchase suggestions</link>' page in the
- OPAC.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem id="ordersubscription">
- <para>If you're using the <link linkend="serials">Serials</link> module you can link
- your subscription order information to acquisitions by choosing to order 'From a subscription'<itemizedlist>
- <listitem>
- <para>After clicking the order link you will be brought to a search page that will
- help you find your subscription</para>
- <screenshot>
- <screeninfo>Subscription order search</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/subordersearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Your results will appear to the right of the form and each subscription will
- have an 'Order' link to the right</para>
- <screenshot>
- <screeninfo>Subscription results</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/suborderresults.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Clicking 'Order' will bring the subscription info in to the order form
- without an 'Add item' section since you are just ordering a subscription and an
- item isn't needed</para>
- <screenshot>
- <screeninfo>Order from subscription</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/suborder.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </itemizedlist></para>
- </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 that
- 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 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 id="orderfromstagedfile">
- <para>The next option for ordering is to order from a staged record (<link
- linkend="stagemarc">learn more about staging records</link>). <note>
- <para>This is the option you will choose if you have an order file from your
- vendor.</para>
- </note></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 to
- add the records in the staged file to your order. <screenshot>
- <screeninfo>Staged records</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/importallstaged.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- <listitem>
- <para>Next to each title is a checkbox, check the items you would like to order, or
- choose 'Check all' at the top. Depending on your settings in the <link linkend="MarcFieldsToOrder">MarcFieldsToOrder</link> preference Koha will
- populate the next screen with with the relevant Quantity, Price, Fund, Statistic
- 1, and Statistic 2 found within the staged file.<screenshot>
- <screeninfo>Add orders from staged file</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/selecttoimport.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- <listitem>
- <para>In the 'Item Information' tab you can enter information that will be added to
- every ordered item such as item type, collection code and not for loan status.<screenshot>
- <screeninfo>Item information</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/itemfromstaged.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- <listitem>
- <para>If no information is imported from the MARC record regarding fund information
- the 'Default accounting details' tab can be used to apply values related to the accounting.<screenshot>
- <screeninfo>Accounting details</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/stagedaccounting.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>The final option for ordering is to order from a list of titles with the highest
- hold ratios<itemizedlist>
- <listitem>
- <para>This option will take you to the Holds Ratio report where you can find items
- with a high hold ratio and order additional copies. Next to each title will be
- a link with the number of items to order, click that and it will add the item to
- your basket.<screenshot>
- <screeninfo>Holds Ratio Order</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/highestholdratio.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- <para>With any of the above ordering options you're presented with an option to notify
- patrons of the new item when it's received. The contents of that notification can be
- edited in the <link linkend="notices">Notices & Slips</link> tool and will have the
- code of ACQ_NOTIF_ON_RECEIV. In the 'Patrons' section you will see an option to 'Add
- user'. Click that button to add patrons who will be notified of the new issue. </para>
- <para>
- <screenshot>
- <screeninfo>Patron notification search</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/patronstonotify.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <listitem>
- <para>In the window that pops up search for the patrons you'd like to notify and
- click 'Select'</para>
- </listitem>
- <listitem>
- <para>Once you're done you can close the window and you'll see the list of patrons
- under the 'Patrons' section<screenshot>
- <screeninfo>Patrons</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/patronslist.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>After bringing in the bib information (for all import methods except for the staged
- file), 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 the 'Add item' button below the item record 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.<itemizedlist>
- <listitem>
- <important>
- <para>You cannot edit the quantity manually, you must click 'Add' below the item
- form to add as many items as you're ordering.</para>
- </important>
- </listitem>
- </itemizedlist></para>
- </listitem>
-
- <listitem>
- <para>The list of funds is populated by the <link linkend="funds">funds</link> you have assigned in the Acquisitions
- Administration 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 is the price before any taxes or discounts
- are applied.</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 are charged sales tax, choose that from the gstrate
- field</para>
- </listitem>
-
- <listitem>
- <para>Enter the percentage discount you're receiving on this
- order, once you enter this, hit tab and Koha will populate the
- rest of the cost fields below.</para>
- </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 you have filled in all of the fields click 'Save' to add the item to your basket.
- If your price goes over the amount availalbe in the fund you will be presented with a
- confirmation.</para>
- <screenshot>
- <screeninfo>Fund warning</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/fundconfirmation.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>The confirmation warning will allow you order past your fund amount if you so
- choose.</para>
-
- <para>After 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>If you would like to see more details you can check the 'Show
- all details' checkbox</para>
-
- <screenshot>
- <screeninfo>Show all details</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/showalldetails.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>From here, you can edit or remove the items that you have
- added.</para>
-
- <itemizedlist>
- <listitem>
- <para>Choosing to 'Delete the order' will delete the order line
- but leave the record in the catalog.</para>
- </listitem>
-
- <listitem>
- <para>Choosing to 'Delete order and catalog record' removes 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 explaining 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>On the summary page, you also have the option to edit the
- information that you entered about the basket by clicking the 'Edit
- basket header information' button, to delete the basket altogether by
- clicking the 'Delete this basket' button, or to export 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>If you're using EDI for your order you can click the 'Create EDIFACT order' button
- when you're done to send the file to the vendor and close the basket.<screenshot>
- <screeninfo>EDIFACT Order</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/edifactorder.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <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. </para>
- <important>
- <para>You must close the basket to be able to <link linkend="receiveacqorder">receive
- items</link> when they arrive. Only items in closed baskets will show as ready to
- receive.</para>
- </important>
- <para>If you have your <link linkend="BasketConfirmations">BasketConfirmations</link>
- preference set to show a confirmation, you will be asked if you are 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 item 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 call up a list of
- items with uncertain prices to quick editing. 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 with
- uncertain prices for that vendor.</para>
- </important>
- <para>Once your order is entered you can search for it through acquisitions or view the
- information on the biblio detail page in the staff client (if the <link linkend="AcquisitionDetails">AcquisitionDetails</link> preference is set to 'Display).<screenshot>
- <screeninfo>Acquisitions details</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/AcquisitionDetails.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </section>
-
- <section id="acqbasketgroup">
- <title><link linkend="acqbasketgroup">Create a basket group</link></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><link linkend="printacqbasket">Printing baskets</link></title>
-
- <para>When you are finished adding items to your basket, 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 'Attach this basket to a new basket group with the
- same name'. A basket group is necessary if you want to be able to print PDFs of your
- orders.</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 printing or further modification.</para>
-
- <screenshot>
- <screeninfo>Basket Grouping</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/basketgroup.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If you closed the basket before generating the EDIFACT order you can do so from the
- basket grouping page.</para>
- <para>
- <screenshot>
- <screeninfo>Basket Grouping EDIFACT</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/basketgroupedi.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </para>
-
- <para>Clicking the 'Print' button next to your order will generate a PDF for printing, which
- 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><link linkend="receiveacqorder">Receiving Orders</link></title>
- <important>
- <para>You must close the basket to be able to <link linkend="receiveacqorder">receive
- items</link> when they arrive. Only items in closed baskets will show as ready to
- receive.</para>
- </important>
-
- <para>Orders can be received from the vendor information page</para>
-
- <screenshot>
- <screeninfo>Receive from Vendor Information</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/receivebutton.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, a
- shipment received date, a shipping cost and a budget to subtract that shipping amount
- from.</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 checking only the boxes next to the items on
- the left that you want to receive. 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>You can also make edits to the item record from this form by clicking the 'Edit' link
- next to each item. This will allow you to enter in accurate call numbers and barcodes if
- you'd like to do that at the point of receipt. Once you have made any changes necessary (to
- the order and/or items, click 'Save' to mark the item(s) as received.<note>
- <para>If you have your <link linkend="AcqItemSetSubfieldsWhenReceived">AcqItemSetSubfieldsWhenReceived</link> preference set to add or change values on
- received items those changes will take place after you hit 'Save'. </para>
- </note></para>
-
- <screenshot>
- <screeninfo>Already Received Items</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/received.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If the item is no longer available from this vendor you can transfer the order to
- another vendor's basket by clicking the 'Transfer' link to the right of the title. This will
- pop up a vendor search box.</para>
- <screenshot>
- <screeninfo>Transfer search</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/transfersearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>From the results you can click 'Choose' to the right of the vendor you would like to
- reorder this item from.</para>
- <screenshot>
- <screeninfo>Transfer vendor</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/transfervendor.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>You will then be presented with the open baskets for that vendor to choose from. To move
- the item simply click 'Choose' to the right of the basket you would like to add the item
- to.</para>
- <screenshot>
- <screeninfo>Basket choice</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/transferbasket.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Once you have chosen you will be presented with a confirmation message.</para>
- <screenshot>
- <screeninfo>Confirm transfer</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/transferconfirm.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>If the item cannot be found anywhere you can cancel the order by clicking 'Delete order'
- to the far right. This will prompt you to enter your reason and confirm cancellation.<screenshot>
- <screeninfo>Cancel order</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/cancelorder.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></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="acqinvoices">
- <title><link linkend="acqinvoices">Invoices</link></title>
- <para>When orders are received invoices are generated. Invoices can be searched by clicking
- on 'Invoices' in the left of the Acquisitions page.</para>
- <screenshot>
- <screeninfo>Invoices page</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/invoicesearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>After searching, your results will appear to the right of the search options.</para>
- <screenshot>
- <screeninfo>Invoice search results</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/invoices.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>From the results you can click the 'Details' link to see the full invoice or 'Close' to
- note that the invoice is closed/paid for.</para>
- <screenshot>
- <screeninfo>Invoice details</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/invoice.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If you're allowing the uploading of acquisitions files with the <link linkend="AcqEnableFiles">AcqEnableFiles</link> preference you will see the option to
- manage invoice files next to the link to 'Go to receipt page'<screenshot>
- <screeninfo>AcqEnableFiles</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/AcqEnableFiles.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>To see or attach new files click the 'Manage invoice files' link</para>
- <screenshot>
- <screeninfo>No invoice files</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/noinvoicefiles.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>From here you can find a file to upload and/or see the files you have already
- attached.</para>
- <screenshot>
- <screeninfo>Invoice files</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/invoicefiles.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>From the invoice search results you can also merge together two invoices should you need
- to. Simply click the checkbox to the left of the invoices you would like to merge and click
- the 'Merge selected invoices' button at the bottom of the page. You will be presented with a
- confirmation screen:</para>
- <screenshot>
- <screeninfo>Merge invoices</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/mergeinvoices.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Click on the row of the invoice number you would like to keep and it will be highlighted
- in yellow. Enter any different billing information in the fields provided and click
- 'Merge'. The two invoices will become one.</para>
- </section>
-
- <section id="acqclaims">
- <title><link linkend="acqclaims">Claims & Late Orders</link></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><link linkend="acqsearch">Acquisition Searches</link></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><link linkend="fundtracking">Budget/Fund Tracking</link></title>
-
- <para>On the main acquisitions page there will be a table 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/acqfunds.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>Clicking on the linked amounts under spent or ordered will show you a summary of the
- titles ordered/received on that budget.</para>
-
- <screenshot>
- <screeninfo>Titles Spent</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/spent.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- <section id="ediprocess">
- <title><link linkend="ediprocess">EDI Process</link></title>
- <para>Previous sections explain all ordering options, this section pulls out the parts related
- to EDI or EDIFACT ordering to help those who are only using EDI for ordering. <important>
- <para>Koha uses the EDIFACT standard not the X12 standard for electronic ordering.</para>
- </important></para>
- <section id="ediquestions">
- <title><link linkend="ediquestions">EDI Questions for Vendors</link></title>
- <para>You will want to gather the following information from your vendors before beginning
- the set up process in Koha.</para>
- <para><emphasis role="bold">EDI Accounts:</emphasis> <emphasis role="italic">This is the
- basic connection information for your vendor. This will be used to fill in the <link
- linkend="ediaccounts">EDI Accounts</link> section.</emphasis></para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Vendor:</emphasis> The name of the vendor</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Description:</emphasis> A short description if additional
- explanation is needed ( especially if you have multiple accounts for one vendor
- ).</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Transport:</emphasis> Does the vendor transmit EDI files via
- FTP, SFTP, or something else the requires special processing?</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Remote host:</emphasis> The URL or IP address of the
- FTP/SFTP server</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Username:</emphasis> The username for the above
- server</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Password:</emphasis> The password for the above
- server</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Download directory:</emphasis> The path on the server that
- contains files for Koha to download and process</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Upload directory:</emphasis> The path on the server that
- Koha will upload files to for your vendor to process</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Qualifier:</emphasis> Who assigned the SAN below?</para>
- <itemizedlist>
- <listitem>
- <para> Choose one of the following:</para>
- <para> (14) EAN International</para>
- <para> (31B) US SAN Agency</para>
- <para> (91) Assigned by supplier</para>
- <para> (92) Assigned by buyer</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para><emphasis role="bold">SAN:</emphasis> The identifier for the vendor</para>
- <para><emphasis role="italic">Buyer qualifier and SAN are optional. Some vendors require
- a second buyer identifier in addition to the account EAN</emphasis>.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Buyer qualifier:</emphasis> Who assigned the SAN
- below?</para>
- <itemizedlist>
- <listitem>
- <para> Choose one of the following:</para>
- <para> (14) EAN International</para>
- <para> (31B) US SAN Agency</para>
- <para> (91) Assigned by supplier</para>
- <para> (92) Assigned by buyer</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Buyer SAN:</emphasis> The identifier for the library</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Quotes enabled:</emphasis> [y/n] Does this vendor support
- sending and receiving quotes via EDIfact and do you want to send and receive quotes
- via EDIfact?</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Orders enabled:</emphasis> [y/n] Does this vendor support
- sending and receiving orders via EDIfact and do you want to send and receive orders
- via EDIfact?</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Invoices enabled: </emphasis>[y/n] Does this vendor support
- sending and receiving invoices via EDIfact and do you want to send and receive
- invoices via EDIfact?</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Order file suffix:</emphasis> The file suffix for order
- files</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Quote file suffix:</emphasis> The file suffix for quote
- files</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Invoice file suffix:</emphasis> The file suffix for invoice
- files</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Account number(s):</emphasis> (list them all)</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Account description(s):</emphasis> (the summary of what this
- number is for)</para>
- </listitem>
- </itemizedlist>
- <para><emphasis role="bold">EANs:</emphasis> <emphasis role="italic">Each library using
- EDIfact needs to specify a buyer identifier know as a SAN or EAN. This will fill in the
- <link linkend="libraryeans">Library EANs</link> setting.</emphasis></para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Library</emphasis></para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">EAN</emphasis></para>
- <itemizedlist>
- <listitem>
- <para> Choose one of the following:</para>
- <para> (14) EAN International</para>
- <para> (31B) US SAN Agency</para>
- <para> (91) Assigned by supplier</para>
- <para> (92) Assigned by buyer</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- <para><emphasis role="bold">MARC Order Fields or Grid Ordering:</emphasis> <emphasis
- role="italic">These values will fill in the <link linkend="MarcFieldsToOrder"
- >MarcFieldsToOrder</link> preference.</emphasis></para>
- <para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">price:</emphasis> MARC21 field that contains the item
- price</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">quantity:</emphasis> MARC21 field that contains the number
- of items for the given record</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">budget_code:</emphasis> MARC21 field that contains the
- Koha budget code to be debited</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">discount:</emphasis> MARC21 field the contains the
- discount as a percentage the the price will be discounted by</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">sort2:</emphasis> MARC21 field that will populate custom
- field sort1</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">sort2:</emphasis> MARC21 field that will populate custom
- field sort2</para>
- </listitem>
- </itemizedlist>
- </para>
- </section>
- <section id="edisetup">
- <title><link linkend="edisetup">EDI Setup</link></title>
- <para>Before you begin ordering using EDI you will want to take the following steps:<itemizedlist>
- <listitem>
- <para>Ask your vendor/bookseller/jobber for <link linkend="ediquestions">connection
- information</link><itemizedlist>
- <listitem>
- <para>It might also be beneficial to ask for a few sample EDIFACT files from the
- vendor</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>Share with your vendor/bookseller/jobber your <link linkend="libsgroups">library
- codes</link>, <link linkend="itemtypeadmin">item type codes</link>, <link
- linkend="funds">fund codes</link>, and any other codes or <link
- linkend="authorizedvalues">authorized values</link> they might need for creating
- your MARC order records</para>
- </listitem>
- <listitem>
- <para>Communicate with your support provider or the community about whether you will
- need a plugin based on your vendor's answers<itemizedlist>
- <listitem>
- <para>For example ByWater Solutions has published plugins for specific vendors
- here: <ulink
- url="https://github.com/bywatersolutions/koha-plugin-edifact-enhanced"
- >https://github.com/bywatersolutions/koha-plugin-edifact-enhanced</ulink></para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para><link linkend="addacqvendor">Enter the vendor/bookseller/jobber</link> in
- Acquisitions</para>
- </listitem>
- <listitem>
- <para>Review your <link linkend="acqprefs">Acquisitions system preferences</link><itemizedlist>
- <listitem>
- <para>Be sure to fill in the <link linkend="MarcFieldsToOrder"
- >MarcFieldsToOrder</link> preference with values for order files</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>Enter your <link linkend="ediaccounts">EDI Accounts</link></para>
- </listitem>
- <listitem>
- <para>Enter your <link linkend="libraryeans">Library EANs</link></para>
- </listitem>
- <listitem>
- <para>Turn on the <link linkend="edicron">EDI Cron</link> so that it can process
- files</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="ediordering">
- <title><link linkend="ediordering">EDI Ordering</link></title>
- <para>The first step in ordering using EDI happens on the book vendor's website. Each
- seller will use different language, but you will need to place your order on their site
- and then download the MARC order file. Some language that you might see included "basket",
- "order", "cart", and/or "MARC order." Once you have this MARC file downloaded to your
- computer you will want to log in to Koha and continue the process there.</para>
- <para>Visit the <link linkend="stagemarc">Stage MARC Records for Import</link> tool and
- upload your file. Once presented with the confirmation screen proceed to
- Acquisitions.</para>
- <para>In Acquisitions <link linkend="createacqbasket">create a basket</link> for the vendor
- you ordered from. From the basket, choose to <link linkend="orderfromstagedfile">order
- from a staged file</link> and click 'Order' next to the file you downloaded from your
- vendor and staged in Koha.</para>
- <para>From the confirmation screen you will see all of the data in the MARC file related to
- your order. If you are not seeing fields such as fund and quanity filled in then be sure
- to confirm that your <link linkend="MarcFieldsToOrder">MarcFieldsToOrder</link> preference
- is set right.</para>
- <para>Once you have added all of the items to the basket you can click the 'Create EDIFACT
- order' button.</para>
- <para>
- <screenshot>
- <screeninfo>EDIFACT Order</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/edifactorder.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </para>
- <para>This will generate a pending file in the <link linkend="edifactmsg">EDIFACT
- Messages</link> in Koha. The pending files will be processed by the <link
- linkend="edicron">EDI Cron Job</link> and sent to your vendor. </para>
- </section>
- <section id="ediinvoice">
- <title><link linkend="ediinvoice">EDI Invoicing</link></title>
- <para>When the book vendor is done processing your files they will send an invoice via EDI
- as well. The <link linkend="edicron">EDI Cron Job</link> will grab invoices and mark
- items found in the invoice as received and update your funds without any need for manual
- intervention.</para>
- </section>
- </section>
- <section id="edifactmsg">
- <title><link linkend="edifactmsg">EDIFACT Messages</link></title>
- <para>A log of all messages sent and received via EDIFACT can be found under EDIFACT Messages. <screenshot>
- <screeninfo>EDIFACT Messages</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/acquisitions/edifactmsg.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </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>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Lists</para>
- </listitem>
- </itemizedlist>
-
- <section id="lists">
- <title><link linkend="lists">Lists</link></title>
-
- <para/>
-
- <section id="createlist">
- <title><link linkend="createlist">Create a List</link></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>Next decide if your list is going to be private or public</para>
- <itemizedlist>
- <listitem>
- <para>A Private List is managed by you and can be seen only by you (depending on
- your permissions settings below)</para>
- </listitem>
- <listitem>
- <para>A Public List can be seen by everybody, but managed only by you (depending on
- your permissions settings below)</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Finally decide what your permissions will be on the list. You can all or disallow:<itemizedlist>
- <listitem>
- <para>anyone else to add entries</para>
- </listitem>
- <listitem>
- <para>anyone to remove his own contributed entries<itemizedlist>
- <listitem>
- <note>
- <para>The owner of a list is always allowed to add entries, but needs
- permission to remove.</para>
- </note>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>anyone to remove other contributed entries </para>
- </listitem>
- </itemizedlist></para>
- </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><link linkend="addtolist">Add to a List</link></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>To open a list you can click the list name.</para>
-
- <para>From that 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><link linkend="viewlist">Viewing Lists</link></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>
- <para>From this list of items you can perform several actions</para>
- <itemizedlist>
- <listitem>
- <para>'New list' will allow you to create another list</para>
- </listitem>
- <listitem>
- <para>'Edit' will allow you to edit the description and permissions for this list</para>
- </listitem>
- <listitem>
- <para>'Send list' will send the list to the email address you enter (<link linkend="examplelistemail">view sample List email</link>)</para>
- </listitem>
- <listitem>
- <para>'Download list' 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 list' will present you with a printable version of the list</para>
- </listitem>
- </itemizedlist>
- <para>Using the filters at the top of each column you can find specific items in your
- list.</para>
- </section>
-
- <section id="mergebibrecs">
- <title><link linkend="mergebibrecs">Merging Bibliographic Records Via Lists</link></title>
- <para>One 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>Once you have selected the records to merge together the process is the same as if you
- had chosen to <link linkend="mergebibs">merge via cataloging</link>.</para>
- </section>
- </section>
-
- <section id="cart">
- <title><link linkend="cart">Cart</link></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>
- <para>From this list of items you can perform several actions</para>
-
- <itemizedlist>
- <listitem>
- <para>'More details' will show more information about the items in the cart</para>
- </listitem>
-
- <listitem>
- <para>'Send' will send the list to the email address you enter (<link linkend="examplecartemail">view sample Cart email</link>)</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>Reports in Koha are a way to gather data. Reports are used to
- generate statistics, member lists, shelving lists, or any list of data in
- your database.</para>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > Reports</para>
- </listitem>
- </itemizedlist>
-
- <section id="customreports">
- <title><link linkend="customreports">Custom Reports</link></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><link linkend="customreport">Add Custom Report</link></title>
-
- <para/>
-
- <section id="quidedreportwizard">
- <title><link linkend="quidedreportwizard">Guided Report Wizard</link></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>
-
- <para>'Report is public' should be left to the default of 'No' in
- most cases. A report can be made public if you intend to allow
- access to it through the JSON webservice interface. This is a system
- that can be used by developers to make custom presentations of the
- data from the report, for example displaying it using a graphing
- API. To learn more speak to your local developer.</para>
-
- <itemizedlist>
- <listitem>
- <para>A public report is accessible via a URL that looks like
- this: http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</para>
- </listitem>
- </itemizedlist>
-
- <screenshot>
- <screeninfo>Chose Module for Report</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reports/report1.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <note>
- <para>If your system administrator has set up memcache on your server you might see one
- more option for the Cache expiry. This is related to your public reports. If you make
- the report public then it's constantly running and will cause a large load on your
- system. Setting this value prevents that.<screenshot>
- <screeninfo>Cache expiry</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reports/cacheexiprywizard.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </note>
- <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, sort it in
- to groups and subgroups 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 or use the
- tabs to find reports based on your custom groups.</para>
- </section>
-
- <section id="reportfromsql">
- <title><link linkend="reportfromsql">Report from SQL</link></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 report' 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>You can use the 'Report group' to organize your reports so that you can easily
- filter reports by groups. Report groups are set in the <link linkend="reportgroup">REPORT_GROUP</link> authorized value category or can be added on the fly when
- creating the report by choosing the 'or create' radio button.<screenshot>
- <screeninfo>Report group</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reports/reportgroup.png"/>
- </imageobject>
- </mediaobject>
- </screenshot><itemizedlist>
- <listitem>
- <para>
- <note>
- <para>If you're adding a report group on the fly, remember that you code
- should be fewer than 10 characters and should not include special
- characters or spaces.</para>
- </note>
- </para>
- </listitem>
- </itemizedlist></para>
- </listitem>
-
- <listitem>
- <para>You can use 'Report subgroup' to further organize your reports so that you can
- easily filter reports by groups and subgroups. Report subgroups are set in the <link linkend="reportsubgroup">REPORT_SUBGROUP</link> authorized value category or can
- be added on the fly when creating the report by choosing the 'or create' radio
- button.</para>
- <screenshot>
- <screeninfo>Report subgroup</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reports/reportsubgroup.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <listitem>
- <para>
- <note>
- <para>If you're adding a report subgroup on the fly, remember that you code
- should be fewer than 10 characters and should not include special characters
- or spaces.</para>
- </note>
- </para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem id="publicreport">
- <para>'Report is public' should be left to the default of 'No' in most cases. A report
- can be made public if you intend to allow access to it through the JSON webservice
- interface. This is a system that can be used by developers to make custom
- presentations of the data from the report, for example displaying it using a
- graphing API. To learn more speak to your local developer.</para>
- <itemizedlist>
- <listitem>
- <para>A public report is accessible via a URL that looks like this:
- http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</para>
- </listitem>
- </itemizedlist>
- </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 or
- biblio_framework, 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>
- <listitem>
- <para>SELECT title , author FROM biblio WHERE frameworkcode=<<Enter the
- frameworkcode|biblio_framework>> </para>
- </listitem>
- </itemizedlist>
-
- <note>
- <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>
- </note>
-
- <note>
- <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>
- </note>
-
- <para><important>
- <para>In addition to using any authorized value code to generate a dropdown, you
- can use the following values as well: Framework codes (biblio_framework),
- 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>
- <note>
- <para>If your system administrator has set up memcache on your server you might see one
- more option for the Cache expiry. This is related to your public reports. If you make
- the report public then it's constantly running and will cause a large load on your
- system. Setting this value prevents that.<screenshot>
- <screeninfo>Cache expiry</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reports/cacheexpiry.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></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 id="duplicatereport">
- <title><link linkend="duplicatereport">Duplicate Report</link></title>
- <para>Reports can also be added by duplicating an existing report. Visit the 'Saved
- reports' page to see all of the reports listed on your system already.</para>
- <screenshot>
- <screeninfo>Saved Reports</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reports/duplicatereport.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>To the right of every report there is an 'Actions' pull down. Clickin that and
- choose 'Duplicate' to use an existing report as the basis for your new report. That will
- populate the new report form with the existing SQL for easy editing and resaving.</para>
- </section>
- </section>
-
- <section id="editcustomreports">
- <title><link linkend="editcustomreports">Edit Custom Reports</link></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 or use the tabs to find reports based on your custom groups.</para>
-
- <para>From this list you can edit any custom report by clicking 'Actions' to the right of
- the report and choosing 'Edit' from the menu that appears.</para>
- <screenshot>
- <screeninfo>Edit Report Option</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reports/editreportoption.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>The form to edit the report will appear.</para>
-
- <screenshot>
- <screeninfo>Edit SQL Form</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reports/editreport.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="runcustomreport">
- <title><link linkend="runcustomreport">Running Custom Reports</link></title>
-
- <para>Once custom reports are saved to Koha, you can run them by going to the Saved Reports
- page and clicking the 'Actions' button to the right of the report and choosing
- 'Run'.</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 report' 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.'<note>
- <para>A Comma Separated Text file is a CSV file and it can be
- opened by any spreadsheet application.</para>
- </note></para>
- </section>
- </section>
-
- <section id="statsreports">
- <title><link linkend="statsreports">Statistics Reports</link></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><link linkend="acqstats">Acquisitions Statistics</link></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><link linkend="patstats">Patron Statistics</link></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><link linkend="catstats">Catalog Statistics</link></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><link linkend="circstats">Circulation Statistics</link></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.<note>
- <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>
- </note></para>
-
- <section id="inhouseuse">
- <title><link linkend="inhouseuse">Tracking in house use</link></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><link linkend="serialstats">Serials Statistics</link></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><link linkend="holdstats">Holds Statistics</link></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><link linkend="mostcheckouts">Patrons with the most checkouts</link></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><link linkend="mostcirculated">Most Circulated Items</link></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><link linkend="patnocheckouts">Patrons with no checkouts</link></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><link linkend="itemnocheckouts">Items with no checkouts</link></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><link linkend="catbyitem">Catalog by Item Type</link></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><link linkend="lostreport">Lost Items</link></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><link linkend="avloantime">Average Loan Time</link></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><link linkend="reportdic">Report Dictionary</link></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="opacthemes">opacthemes</link> = bootstrap</para>
- </listitem>
- <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="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>
-
- <listitem>
- <para><link linkend="OPACShowBarcode">OPACShowBarcode</link> = Don't show</para>
- </listitem>
- <listitem>
- <para><link linkend="OpacSeparateHoldings">OpacSeparateHoldings</link> = Don't
- separate</para>
- </listitem>
- <listitem>
- <para><link linkend="OpacSeparateHoldings">OpacSeparateHoldingsBranch</link> = home
- library</para>
- </listitem>
- <listitem>
- <para><link linkend="DisplayLibraryFacets">DisplayLibraryFacets</link> = holding
- library</para>
- </listitem>
- </itemizedlist>
-
- <para>If your system preferences are set differently your displays may
- differ.</para>
-
- <section id="opacsearchresults">
- <title><link linkend="opacsearchresults">Search Results</link></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><link linkend="opacresultsoverview">Results Overview</link></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 fixed fields.
- This can be turned on or off with the <link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> system preference.</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>
- <para>Even if you filtered on one library location all locations that hold the item will
- appear on the search results.</para>
- </note><important>
- <para>An item's hold status doesn't not affect whether or not the item is 'available'
- until the item is in 'waiting' status. Items with on-shelf holds will show as
- available until a librarian has pulled them from the shelf and checked the item in
- make it show 'waiting'.</para>
- </important></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>
- <para>If you have set your <link linkend="didyoumean">Did you mean?</link> options you will
- see a yellow bar across the top of your results will other related searches.</para>
- <screenshot>
- <screeninfo>Did you mean?</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/didyoumeanopac.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If you performed an advanced search you see an option to go back and edit your
- advanced search blow the list of results pages.<screenshot>
- <screeninfo>Return to the last advanced search</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/editadvanced.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </section>
-
- <section id="opacfilter">
- <title><link linkend="opacfilter">Filters</link></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>
- <para>Depending on your setting for the <link linkend="DisplayLibraryFacets">DisplayLibraryFacets</link> system preference you will see filters for your home,
- holding or both libraries.<screenshot>
- <screeninfo>Library Facet</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/locationfacet.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>After clicking a facet you can remove that filter from your results by clicking the
- small 'x' that appears to the right of the facet.<screenshot>
- <screeninfo>Remove library facet</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/removefilter.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </section>
-
- <section id="searchrss">
- <title><link linkend="searchrss">Search RSS Feeds</link></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><link linkend="opacbibrec">Bibliographic Record</link></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. Clicking the author will run a search for other
- titles with that author.</para>
-
- <screenshot>
- <screeninfo>Author Display</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/bibdetail/bibauthor.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>If you have an authority file you will see a magnifying glass to
- the right of author (and other) authorities. Clicking that magnifying
- glass will take you directly to the authority record.</para>
-
- <screenshot>
- <screeninfo>Authority link</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/bibdetail/authoritylink.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><link linkend="opaclistscart">Lists & Cart</link></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><link linkend="opaclists">Lists</link></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><link linkend="opacaddlists">Creating Lists</link></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/publiclistpermissions.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.<itemizedlist>
- <listitem>
- <para>A Private List is managed by you and can be seen only by you (depending on
- your permissions settings below)</para>
- </listitem>
- <listitem>
- <para>A Public List can be seen by everybody, but managed only by you (depending on
- your permissions settings below)</para>
- </listitem>
- </itemizedlist><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>
- <screenshot>
- <screeninfo>Create a new private list</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/newlist.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </important></para>
- <itemizedlist>
- <listitem>
- <para>Finally decide what your permissions will be on the list. You can all or disallow:<itemizedlist>
- <listitem>
- <para>anyone else to add entries</para>
- </listitem>
- <listitem>
- <para>anyone to remove his own contributed entries<itemizedlist>
- <listitem>
- <note>
- <para>The owner of a list is always allowed to add entries, but needs
- permission to remove.</para>
- </note>
- </listitem>
- </itemizedlist></para>
- </listitem>
- <listitem>
- <para>anyone to remove other contributed entries </para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="opacaddtolists">
- <title><link linkend="opacaddtolists">Adding titles to Lists</link></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><link linkend="listscontent">Viewing Lists Contents</link></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>To the right of the list title there is an RSS icon that will allow you to subscribe
- to updates to the list.</para>
-
- <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>
- </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 (<link linkend="examplelistemail">view a
- sample Lists email</link>)</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><link linkend="opacmanagelists">Managing Lists</link></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>If the library is allowing you to share private lists with the <link linkend="OpacAllowSharingPrivateLists">OpacAllowSharingPrivateLists</link> preference
- then you will see the 'Share' link on your list of lists and the 'Share list' link at
- the top of each individual list. Clicking this will ask you to enter the email address
- of a patron.<screenshot>
- <screeninfo>Share list</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/sharelist.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>Once the email address is entered Koha will present you with a confirmation message </para>
- <screenshot>
- <screeninfo>Share list confirmation</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/shareconfirmation.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>and will send a message to that patron.</para>
- </section>
- </section>
-
- <section id="opaccart">
- <title><link linkend="opaccart">Cart</link></title>
-
- <para/>
-
- <section id="opacaddtocart">
- <title><link linkend="opacaddtocart">Adding titles to the Cart</link></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>
- <para>From the results you will see which items are in your cart and will be able to
- remove those items by clicking '(remove)'.<screenshot>
- <screeninfo>Item in your cart</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/iteminyourcart.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </section>
-
- <section id="manageopaccart">
- <title><link linkend="manageopaccart">Managing the Cart</link></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. 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).<screenshot>
- <screeninfo>More details in the cart</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/cartmoredetails.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></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.
- <link linkend="examplecartemail">View a sample Cart email</link>.</para>
-
- <screenshot>
- <screeninfo>Email Cart</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/emailcart.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <important>
- <para>The cart can only be emailed by logged in users. This will prevent your cart email
- function from being used for spamming.</para>
- </important>
-
- <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><link linkend="opacplacehold">Placing Holds</link></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="OPACAllowUserToChooseBranch">OPACAllowUserToChooseBranch</link> preference the patron can choose where they'd like
- to pick up their hold</para>
- </listitem>
- <listitem>
- <para>If you would like to see more options you can click 'Show more options'</para>
-
-
- <para>
- <screenshot>
- <screeninfo>Place Hold Form with More Options</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/opacplaceholdmore.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </para>
- <itemizedlist>
- <listitem>
- <para>If you have the <link linkend="AllowHoldItemTypeSelection">AllowHoldItemTypeSelection</link> preference set to 'Allow' and the record had
- more than one item type attached you will see an option to choose to limit the hold
- to a specific item type<screenshot>
- <screeninfo>AllowHoldItemTypeSelection</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/AllowHoldItemTypeSelection.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </listitem>
- </itemizedlist>
- </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 the <link linkend="OpacHoldNotes">OpacHoldNotes</link> preference then
- patrons can leave notes about their holds for the library by clicking the 'Edit notes' button</para>
- <screenshot>
- <screeninfo>Hold notes</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/holdnote.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Depending on the rules you set regarding item specific holds in your <link linkend="circfinerules">circulation and fines rules</link> the patron will be allowed
- to choose whether to place the hold on the next available copy and/or a specific
- copy</para>
- <screenshot>
- <screeninfo>Specific Copy Hold</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/opacplaceholdspecific.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </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><link linkend="opacenhancedcontent">Enhanced Content</link></title>
-
- <para/>
-
- <section id="opactagging">
- <title><link linkend="opactagging">Tagging</link></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><link linkend="opaccomments">Comments</link></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 their comment labeled amongst the other comments. If you have set your
- <link linkend="ShowReviewerPhoto">ShowReviewerPhoto</link> preference to 'Show' then
- you'll see the patron's photo pulled from the <ulink url="https://www.libravatar.org">Libravatar</ulink> library.</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 have your <link linkend="OpacShowRecentComments">OpacShowRecentComments</link>
- set to show then you'll see the approved comments on that page.</para>
-
- <screenshot>
- <screeninfo>Recent Comments List</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/recentcomments.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>From this page patrons can subscribe to the recent comments using RSS if they would
- like.</para>
- </section>
-
- <section id="zotero">
- <title><link linkend="zotero">Zotero</link></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><link linkend="customrss">Custom RSS Feeds</link></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 rss.pl cron job.</para>
- </important></para>
- </section>
- </section>
- <section id="selfregistration">
- <title><link linkend="selfregistration">OPAC Self Registration</link></title>
- <para>If you allow it, patrons can register for their own accounts via the OPAC. If you have
- the <link linkend="PatronSelfRegistration">PatronSelfRegistration</link> preference set to
- 'Allow' then patrons will see a link to register below the log in box on the right of the
- main OPAC page.</para>
- <screenshot>
- <screeninfo>Registration link in OPAC</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/PatronSelfRegistration.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>When the patron clicks the 'Register here' link they will be brough to a registration
- page. The options on the registration page can be conrolled by editing the <link linkend="PatronSelfRegistrationBorrowerMandatoryField">PatronSelfRegistrationBorrowerMandatoryField</link> and the <link linkend="PatronSelfRegistrationBorrowerUnwantedField">PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
- <screenshot>
- <screeninfo>Registration form</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/patronregistration.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Once the patron has confirmed submitted their registration they will either be sent an
- email to confirm their account (if you have the <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link>
- preference to require this) or presented with their new username and password.</para>
- <screenshot>
- <screeninfo>New account confirmation</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/patronregistrationcomplete.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Patrons registered in this way will not have a cardnumber until assigned one by the
- library, but will have access to all OPAC functionality immediately. For this reason it is
- recommended that you:<itemizedlist>
- <listitem>
- <para>set up a provisional <link linkend="addingpatroncat">patron category</link> for
- self registered patrons (such as 'Self Registered) instead of using an existing patron
- category and set that value in the <link linkend="PatronSelfRegistrationDefaultCategory">PatronSelfRegistrationDefaultCategory</link> preference</para>
- </listitem>
- <listitem>
- <para>give this patron category minimal circulation privileges in the <link linkend="circfinerules">Circulation and Fine Rules</link> (such as allowing a couple
- holds, but no check outs)</para>
- </listitem>
- </itemizedlist>That way patrons will either have to come in to the library to verify their
- identity before given a cardnumber and the ability to check items out or the library will
- have to come up with internal policy on generating cardnumbers before providing them to self
- registered patrons. Once this is done the library can change the category to one that is
- more appropriate (be it an adult, resident, non resident, student, etc) and add a
- cardnumber/barcode.</para>
- </section>
-
- <section id="opacmyaccount">
- <title><link linkend="opacmyaccount">My Account</link></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="resetpwopac">
- <title><link linkend="resetpwopac">Resetting your password</link></title>
- <para>If you have the <link linkend="OpacResetPassword">OpacResetPassword</link> set to
- allow patrons to reset their password they can click 'Forgot your password?' link found
- under the log in box to reset their passwords.</para>
- <screenshot>
- <screeninfo>'Forgot your password?' link</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/forgotpwlink.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Once clicked they will be presented with a form asking for their username and their
- email address (patrons must have an email address on file to reset their password).<screenshot>
- <screeninfo>Recover password</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/resetpw.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>The system will then email the patron instructions for resetting their password.<screenshot>
- <screeninfo>Reset password confirmation</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/resetconfirm.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </section>
-
- <section id="opacmysummary">
- <title><link linkend="opacmysummary">My Summary</link></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 id="barcodeattribute">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>If their guarantee has allowed it via <link linkend="opacmyprivacy">their
- privacy</link>, when the guarantor logs in they will see a tab labeled "Relatives'
- checkouts" on their summary tab.<screenshot>
- <screeninfo>Relatives' checkouts</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/relativecheckouts.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
-
- <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. </para>
-
- <screenshot>
- <screeninfo>Patron holds status</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/myholds.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>Patrons can cancel or suspend (depending on the value of your <link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> system preference) their own holds if
- they are not in transit or already waiting for them. When they click 'Suspend' they will
- be presented with the option to choose a date for their hold to resume.<screenshot>
- <screeninfo>Suspend until</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/suspenduntil.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>They can also suspend all of their holds 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><link linkend="opacmyaccount-flags">Patron Flags</link></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><link linkend="opacmyfines">My Fines</link></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>
- <para>If you are allowing patrons to pay their fines using PayPal with the <link linkend="EnablePayPalOpacPayments">EnablePayPalOpacPayments</link> preference there will
- be checkboxes to the left of each fine with an outstanding amount.<screenshot>
- <screeninfo>Fines with checkboxes</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/finescheckboxes.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>At the bottom the patron will see the option to pay with PayPal for the items they
- have checked.</para>
- <screenshot>
- <screeninfo>PayPal Payment</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/paypaypal.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>After paying they will be presented with a confirmation<screenshot>
- <screeninfo>PayPal Confirmation</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/paypalconfirm.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>And you will see that the fine was paid using PayPal on the staff side.<screenshot>
- <screeninfo>Staff side fines</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/staffpaypal.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </section>
-
- <section id="opacmydetails">
- <title><link linkend="opacmydetails">My Details</link></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. You can control what fields patrons see and
- can modify via the OPAC by setting the <link linkend="PatronSelfRegistrationBorrowerMandatoryField">PatronSelfRegistrationBorrowerMandatoryField</link>
- <link linkend="PatronSelfRegistrationBorrowerUnwantedField">PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</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. Staff will see all
- patrons requesting modification to their record listed below the modules on the main
- dashboard along with anything else awaiting library attention.</para>
- <screenshot>
- <screeninfo>Patron requests waiting review</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/patronrequestwaiting.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>If the <link linkend="OPACPatronDetails">OPACPatronDetails</link> preference is set to
- 'Don't allow' then patrons will simply see their details and a message stating that they
- should contact the library for changes.</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><link linkend="opacmytags">My Tags</link></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><link linkend="opacmypassword">Change My Password</link></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><link linkend="opacmysearchistory">My Search History</link></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><link linkend="opacmyhistory">My Reading History</link></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>
- <para>If you have HTML entered in the <link linkend="OPACMySummaryHTML">OPACMySummaryHTML</link> preference then you will see that to the right of the 'Date'
- column.</para>
- </section>
-
- <section id="opacmyprivacy">
- <title><link linkend="opacmyprivacy">My Privacy</link></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.<important>
- <para>In order for the patron to be able to delete their reading history you must have
- the <link linkend="AnonymousPatron">AnonymousPatron</link> preference set.</para>
- </important></para>
- <para>If you're allowing guarantees to grand permission to their guarantors to view their
- current checkouts with the <link linkend="AllowPatronToSetCheckoutsVisibilityForGuarantor">AllowPatronToSetCheckoutsVisibilityForGuarantor</link> preference they will see that
- option on this screen.<screenshot>
- <screeninfo>AllowPatronToSetCheckoutsVisibilityForGuarantor</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/AllowPatronToSetCheckoutsVisibilityForGuarantor.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>When the guarantor logs in they will see a tab labeled "Relatives' checkouts" on their
- summary tab.<screenshot>
- <screeninfo>Relatives' checkouts</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/relativecheckouts.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </section>
-
- <section id="opacmysuggestions">
- <title><link linkend="opacmysuggestions">My Purchase Suggestions</link></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>
- <para>If you have <link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link>
- set to 'Show' then patrons will be able to search suggestions from the top of this
- list.</para>
- </section>
-
- <section id="opacmymsgs">
- <title><link linkend="opacmymsgs">My Messaging</link></title>
-
- <para>If your library has the <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link> and the <link linkend="EnhancedMessagingPreferencesOPAC">EnhancedMessagingPreferencesOPAC</link>
- preferences 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 use an outside driver for sending text messages set 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>
- <para>If you are using the Email protocol for sending text messages set with the <link linkend="SMSSendDriver">SMSSendDriver</link> preference, you will see an additional
- column to receive these messages as SMS (or text messages), a field for a cell (or SMS)
- number, and a pull down listing <link linkend="smsadmin">cellular providers entered in
- administration</link>.</para>
- <screenshot>
- <screeninfo>SMSSendDriver in the OPAC</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/smsopac.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>If you are using the <link linkend="TalkingTechItivaPhoneNotification">Itiva Talking
- Tech</link> service you will see an additional column to receive these messages via Phone.<screenshot>
- <screeninfo>Phone messaging preferences in the OPAC</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/opacphonemsg.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <itemizedlist>
- <listitem>
- <para>These notices are:</para>
- <itemizedlist>
- <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>
- <listitem>
- <para>Item checkout : A notice that lists all the of the items the patron has just
- checked out and/or renewed, this is an electronic form of the checkout
- receipt</para>
- </listitem>
- <listitem>
- <para>Hold filled : A notice when you have confirmed the hold is waiting for the
- patron</para>
- </listitem>
- <listitem>
- <para>Item due : A notice on the day and item is due back at the library</para>
- </listitem>
- <listitem>
- <para>Item check-in : A notice that lists all the of the items the patron has just
- checked in</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- <para>Patrons can choose to receive their notices as a digest by checking the 'Digest only?'
- box along with the delivery method. A digest is a combination of all the messages of that
- type (so all items due in 3 days in one email) in to one email instead of multiple emails
- for each alert.</para>
- <important>
- <para>You must choose a delivery method (SMS or Email or Phone) along with 'Digest only?'
- if you would like to receive a digest of the messages.</para>
- </important>
- </section>
-
- <section id="opacmylists">
- <title><link linkend="opacmylists">My Lists</link></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 id="opacdischarge">
- <title><link linkend="opacdischarge">Ask for a Discharge</link></title>
- <para>If you have enabled the <link linkend="useDischarge">useDischarge</link> preference
- then patrons will be able to request a discharge via the OPAC.<screenshot>
- <screeninfo>Discharge tab</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/dischargetab.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>From here patrons can request a discharge</para>
- <screenshot>
- <screeninfo>Request discharge</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/dischargeopac.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>And will receive confirmation of their request.</para>
- <screenshot>
- <screeninfo>Discharge confirmation</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/opac/dischargeopac-confirm.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- </section>
-
- <section id="purchasesuggest">
- <title><link linkend="purchasesuggest">Purchase Suggestions</link></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>If you are allowing everyone to see the purchase suggestions made by others with the
- <link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link> preference,
- then 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>The Item type list can be edited by editing the SUGGEST_FORMAT <link linkend="authorizedvalues">authorized value</link>.</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><link linkend="searchprefixes">Advanced Search Prefixes</link></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:cooking</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>
- <authorgroup>
- <author>
- <firstname>Becky</firstname>
- <surname>Bell</surname>
- <affiliation>
- <orgname>WALDO</orgname>
- </affiliation>
- </author>
-
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- <contrib>Fixed typos, changed content where necessary and added new
- screenshots.</contrib>
- </editor>
- </authorgroup>
-
- <pubdate>October 2008</pubdate>
- </sectioninfo>
- <title><link linkend="searchguide">Guide to Searching</link></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><link linkend="searchguide-indexing">Indexing and Searching Description</link></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><link linkend="searchguide-indexconfig">Indexing Configuration</link></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 is etc/zebradb/marc_defs/[marc21|unimarc]/biblios/record.abs if you
- use grs1 indexing [the default until 3.16] or
- etc/zebradb/marc_defs/[marc21|unimarc]/biblios/biblio-koha-indexdefs.xml if you use dom
- indexing [the default from 3.18]. Either files contains the abstract syntax which maps the
- MARC21 tags to the set of Use Attributes you choose to use. To be more precise the xml
- file to be activate needs to be transform into biblio-zebra-indexdefs.xsl, read the head
- of biblio-zebra-indexdefs.xsl to know more about this topic. 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 <link linkend="kohasearchindexes">Koha Indexing Chart</link> 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><link linkend="searchguide-basics">Basic Searching</link></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><link linkend="searchguide-advanced">Advanced Searching</link></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 (which uses the information on total issues
- found in the items table). 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-itemsearch">
- <title><link linkend="searchguide-itemsearch">Item Searching</link></title>
- <para>If you are looking for specific items you can use the item search engine in the staff
- client to find them. <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> Search > Go to item search</para>
- </listitem>
- </itemizedlist></para>
- <para>At the top of the advanced search page in the staff client you will see a link to 'Go
- to item search'<screenshot>
- <screeninfo>Item search link</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/searching/itemsearchlink.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>Clicking that link will open up a item specific search engine.<screenshot>
- <screeninfo>Item search</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/searching/itemsearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>Using the search form that is presented you can find a list of specific items that can
- be output to the screen or to a CSV file. If your results are printed to the screen you
- will have the option to narrow your search further using filters at the top.<screenshot>
- <screeninfo>Item search results</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/searching/itemsearchresults.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </section>
-
- <section id="searchguide-ccl">
- <title><link linkend="searchguide-ccl">Common Command Language Searching</link></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><link linkend="searchguide-indexes">Indexes</link></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 <link linkend="kohasearchindexes">Koha Indexing Chart</link> for the
- MARC21 tags mapped to each Bib-1 Attribute and index combination.</para>
-
- <section id="search-audexamp">
- <title><link linkend="search-audexamp">Audience Examples</link></title>
-
- <itemizedlist>
- <listitem>
- <para>aud:a Preschool</para>
- </listitem>
- <listitem>
- <para>aud:b Primary</para>
- </listitem>
- <listitem>
- <para>aud:c Pre-Adolescent</para>
- </listitem>
- <listitem>
- <para>aud:d Adolescent</para>
- </listitem>
-
- <listitem>
- <para>aud:e Adult</para>
- </listitem>
- <listitem>
- <para>aud:f Specialized</para>
- </listitem>
- <listitem>
- <para>aud:g General</para>
- </listitem>
- <listitem>
- <para>aud:j Juvenile</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="search-contentsexamp">
- <title><link linkend="search-contentsexamp">Contents Examples</link></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><link linkend="searchguide-syntax">Search Syntax</link></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 phrase 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><link linkend="kohasearchindexes">Koha Search Indexes</link></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>Leader/06</entry>
- <entry>Record-type, rtype</entry>
- </row>
- <row>
- <entry>Leader/07</entry>
- <entry>Bib-level</entry>
- </row>
- <row>
- <entry>Leader/06-07</entry>
- <entry>Material-type</entry>
- </row>
- <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, dtlm, 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>041$a</entry>
- <entry>ln-audio</entry>
- </row>
- <row>
- <entry>041$h</entry>
- <entry>language-original</entry>
- </row>
- <row>
- <entry>041$j</entry>
- <entry>ln-subtitle</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>Provider, pl</para></entry>
- </row>
- <row>
- <entry>264</entry>
- <entry>Provider</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>780$w</entry>
- <entry>Record-control-number</entry>
- </row>
-
- <row>
- <entry><para>780</para></entry>
-
- <entry><para>Title, Title-former,
- Related-periodical</para></entry>
- </row>
- <row>
- <entry>785$w</entry>
- <entry>Record-control-number</entry>
- </row>
-
- <row>
- <entry><para>785</para></entry>
-
- <entry><para>Related-periodical</para></entry>
- </row>
- <row>
- <entry>787$w</entry>
- <entry>Record-control-number</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>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>
- <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>
- </tbody>
- </tgroup>
- </table>
- </section>
- </chapter>
- <chapter id="pluginsystem">
- <title>Plugin System</title>
- <para>Koha's Plugin System allows for you to add additional tools and reports to Koha that are
- specific to your library. Plugins are installed by uploading KPZ ( Koha Plugin Zip ) packages.
- A KPZ file is just a zip file containing the perl files, template files, and any other files
- necessary to make the plugin work.</para>
- <para>The plugin system needs to be turned on by a system administrator. </para>
- <section id="pluginsetup">
- <title><link linkend="pluginsetup">Set up</link></title>
- <para>To set up the Koha plugin system you must first make some changes to your install.<itemizedlist>
- <listitem>
- <para>Change <enable_plugins>0</enable_plugins> to
- <enable_plugins>1</enable_plugins> in your koha-conf.xml file</para>
- </listitem>
- <listitem>
- <para>Restart your webserver</para>
- </listitem>
- </itemizedlist>Once set up is complete you will need to alter your <link linkend="UseKohaPlugins">UseKohaPlugins</link> system preference. On the Tools page you
- will see the Tools Plugins and on the Reports page you will see the Reports Plugins.</para>
- </section>
- </chapter>
- <chapter id="staffsearchhistory">
- <title>Search History</title>
- <para>If you have your <link linkend="EnableSearchHistory">EnableSearchHistory</link> preference
- set to keep your search history then you can access this information by clicking on your
- username in the top right of the staff client and choosing 'Search history'.</para>
- <screenshot>
- <screeninfo>Search history</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/searchhistory/searchhistory.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>From this page you will see your bibliographic search history </para>
- <screenshot>
- <screeninfo>Bibliographic search history</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/searchhistory/bibsearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>And your authority search history.</para>
- <screenshot>
- <screeninfo>Authority search history</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/searchhistory/authsearch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </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>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Get there:</emphasis> More > About Koha</para>
- </listitem>
- </itemizedlist>
-
- <section id="aboutserver">
- <title><link linkend="aboutserver">Server Information</link></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><link linkend="aboutserverperl">Perl Modules</link></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>
-
- <section id="aboutsystem">
- <title><link linkend="aboutsystem">System Information</link></title>
-
- <para>This tab will provide you with warnings if you are using system
- preferences that have since been deprecated or system preferences that
- you have set without other required preferences</para>
-
- <screenshot>
- <screeninfo>System Information</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/about/systeminfo.jpg"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </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><link linkend="imp-migration">Data Migration</link></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 your 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="damageauth">damaged</link>, <link linkend="withdrawnauth">withdrawn</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/State/Postal Code</link> combos </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><link linkend="impadmin">Admin Configuration</link></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="AutoLocation">AutoLocation</link> : Require
- staff to log in to the staff client from a specific IP
- range</para>
- </listitem>
-
- <listitem>
- <para><link linkend="IndependentBranches">IndependentBranches</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>
- <listitem>
- <para>Decide if you'd like to share your library's information with the Koha community by
- setting the <link linkend="heaprefs">Sharing system preferences</link>.</para>
- </listitem>
- <listitem>
- <para>Decide what <link linkend="cronjobsch">cron jobs</link> you need to run and when.<itemizedlist>
- <listitem>
- <para>If you're using the long overdue cron job be sure to set your <link linkend="DefaultLongOverdueChargeValue">DefaultLongOverdueChargeValue</link>,
- <link linkend="DefaultLongOverdueLostValue">DefaultLongOverdueLostValue</link>
- & <link linkend="DefaultLongOverdueLostValue">DefaultLongOverdueDays</link>
- preferences.</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="implocal">
- <title><link linkend="implocal">Localization Configuration</link></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><link linkend="impcirc">Circulation Configuration</link></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 your <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="SpecifyReturnDate">SpecifyReturnDate</link> : Decide if you want
- to let the staff specify an arbitrary return date on checkin</para>
- </listitem>
- <listitem>
- <para><link linkend="itemBarcodeFallbackSearch">itemBarcodeFallbackSearch</link> :
- Decide if you want staff to be able to checkout using a keyword search (title, call
- number, etc)</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="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="AllowTooManyOverride">AllowTooManyOverride</link> : Descide if
- you want staff to be able to check out more than the limit to a patron</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="AudioAlerts">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 automatically resume on the date entered by the staff
- and/or patron</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para><link linkend="OnSiteCheckouts">OnSiteCheckouts</link> : Decide if you want to
- allow items to be checked out for use within the library</para>
- </listitem>
- <listitem>
- <para><link linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link> : Set this
- to record local use of items when you check them in</para>
- </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>
- <listitem>
- <para>If you're allowing automatic renewal of items <link linkend="autorenewcron">set
- them to renew</link> (nightly)</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="imppratrons">
- <title><link linkend="imppratrons">Patron Configuration</link></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="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 staff can choose from a series of notices (other than overdues) for
- patrons</para>
- </listitem>
- <listitem>
- <para><link linkend="EnhancedMessagingPreferencesOPAC">EnhancedMessagingPreferencesOPAC</link>: Decide if patrons can choose from a
- series of notices (other than ovedues) for themselves</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 what fields your library doesn't need to see on the
- patron entry form</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Set up your <link linkend="cronjobs">cron jobs</link><itemizedlist>
- <listitem>
- <para>Decide if you would like <link linkend="j2acron">children to automatically be
- come adults</link></para>
- </listitem>
- </itemizedlist></para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="impcatalog">
- <title><link linkend="impcatalog">Cataloging Configuration</link></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><link linkend="impauthorities">Authorities Configuration</link></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><link linkend="impsearching">Searching Configuration</link></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="AdvancedSearchLanguages">AdvancedSearchLanguages</link> : Decide
- which languages you want people to be able to limit to via the search engine</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><link linkend="impopac">OPAC Configuration</link></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="OPACBaseURL">OPACBaseURL</link> : Enter your library's url
- </para>
- </listitem>
- <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="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="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="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="OpacNavRight">OpacNavRight</link> : Enter
- HTML that will appear below the login box on the right</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>
- </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 (French libraries only)</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>
- (French libraries only)</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><link linkend="editableopac">Editable OPAC Regions</link></title>
-
- <para>Using the OPAC system preferences you can customize various regions, the following
- graphic will define what preferences update each of the regions in the Bootstrap
- theme.</para>
-
- <screenshot>
- <screeninfo>OPAC Editable Regions</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/appendix-opac/opaccustomregions.jpg"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- </section>
-
- <section id="impenhanced">
- <title><link linkend="impenhanced">Enhanced Content Configuration</link></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 cover
- images from Amazon.</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="html5">HTML5 Media</link><itemizedlist>
- <listitem>
- <para>This allows libraries to embed streaming media in their catalog</para>
- </listitem>
- </itemizedlist></para>
- </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="IDreamLibraries">I Deam Books</link><itemizedlist>
- <listitem>
- <para>This is a free service that compiles reviews for popular titles from many
- different sources.</para>
- </listitem>
- </itemizedlist></para>
- </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="OpenLibraryPrefs">Open Library</link><itemizedlist>
- <listitem>
- <para>Open Library project is an open system that you can pull cover images (and in
- the future additional content) from</para>
- </listitem>
- </itemizedlist></para>
- </listitem>
-
- <listitem>
- <para><link linkend="overdriveprefs">Overdrive</link><itemizedlist>
- <listitem>
- <para>This is a pay service that libraries can subscribe to for ebook content. If
- the library subscribes to Overdrive they can integrate that content in to Koha for
- free.</para>
- </listitem>
- </itemizedlist></para>
- </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><link linkend="impacq">Acquisitions Configuration</link></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><link linkend="impserials">Serials Configuration</link></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><link linkend="impgolive">Planning for Go-Live</link></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="sopacintro">
- <sectioninfo>
- <authorgroup>
- <author>
- <firstname>Jean-André</firstname>
- <surname>Santoni</surname>
- <affiliation>
- <orgname>BibLibre</orgname>
- </affiliation>
- </author>
-
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- <contrib>Translation and minor edits.</contrib>
- </editor>
- </authorgroup>
-
- <pubdate>August 2009</pubdate>
- </sectioninfo>
- <title><link linkend="sopacintro">Introduction</link></title>
-
- <para>This is an installation guide for SOPAC2 and its Koha connector. It
- has been tested on Debian Lenny and Ubuntu Jaunty with Drupal 6.12 and Koha
- 3.0.x. It does not cover the installation of Koha and Drupal, only
- SOPAC, its dependencies and the connector.</para>
- </section>
-
- <section id="sopacinstall">
- <title><link linkend="sopacinstall">Installation of Locum and Insurge</link></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><link linkend="sopacdepend">Dependencies</link></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><link linkend="sopacdownload">Download</link></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><link linkend="sopaccreatedb">Creation of the Database</link></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><link linkend="sopacdsn">Sync DSN</link></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><link linkend="sopacinstallinsurge">Installation of Insurge</link></title>
-
- <para>If you customize the name of the database, remember to edit 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><link linkend="sopacinstallocum">Installation of Locum</link></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 information for 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 Koha configuration.</para>
- </section>
- </section>
-
- <section id="sopackoha">
- <title><link linkend="sopackoha">Installation of Koha Connector</link></title>
-
- <para>Download the Koha connector using 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><link linkend="sopacharvest">Harvest Records</link></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><link linkend="sopacphinx">Installation of Sphinx</link></title>
-
- <para>Sphinx is the indexer for the database used by Locum and
- Insurge.</para>
-
- <section id="sphinxdepend">
- <title><link linkend="sphinxdepend">Dependencies</link></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><link linkend="sphinxdownload">Download and Compile</link></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><link linkend="sphinxuser">Creation of User and Group</link></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><link linkend="demonsphinx">The Sphinx daemon</link></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 to the default boot services:</para>
-
- <programlisting># update-rc.d sphinx defaults</programlisting>
- </section>
-
- <section id="sphinxconfig">
- <title><link linkend="sphinxconfig">Configuration</link></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 database:</para>
-
- <programlisting># sed 's/scas/MY_DB/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
- </section>
-
- <section id="sphinxindexing">
- <title><link linkend="sphinxindexing">Indexing documents</link></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 daemon:</para>
-
- <programlisting># /etc/init.d/sphinx start</programlisting>
-
- <para>When the daemon is running, you can update the index with:</para>
-
- <programlisting>$ /usr/local/sphinx/bin/indexer --all --rotate</programlisting>
- </section>
- </section>
-
- <section id="installsopac">
- <title><link linkend="installsopac">Installation of SOPAC2</link></title>
-
- <para>Now to the SOPAC software itself:</para>
-
- <section id="downloadsopac">
- <title><link linkend="downloadsopac">Download</link></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><link linkend="sopacinstallation">Installation</link></title>
-
- <para>In Drupal's administration settings, activate the module.
- Also, enable 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><link linkend="configsopac">Configuration</link></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>Remember to empty Drupal's cache when something does not
- work.</para>
-
- <para>Drupal offers a few blocks, which are not configured by default.
- You must specify on which page they should appear.</para>
- </section>
- </section>
- </chapter>
-
- <chapter id="cronjobsch">
- <title>Cron Jobs</title>
-
- <para>A cron job is a Linux command for scheduling a command or script on your server to
- complete repetitive tasks automatically. Scripts executed as a cron job are typically used to
- modify files or databases; however, they can perform other tasks that do not modify data on
- the server, like sending out email notifications. Koha has many cron jobs in place that you
- can enable (search engine indexing, overdue notice generation, data cleanup and more), this
- chapter will explain those for you.</para>
-
- <section id="cronjobs">
- <title><link linkend="cronjobs">Cron Jobs</link></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><link linkend="searchcron">Search</link></title>
-
- <para/>
-
- <section id="rebuildsearchcron">
- <title><link linkend="rebuildsearchcron">Rebuild Index</link></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><link linkend="circcron">Circulation</link></title>
-
- <section id="buildholdscron">
- <title><link linkend="buildholdscron">Holds Queue</link></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>
-
- <para>Description:</para>
-
- <itemizedlist>
- <listitem>
- <para>A script that should be run periodically if your library
- system allows borrowers to place on-shelf holds. This script
- decides which library should be responsible for fulfilling a
- given hold request.</para>
-
- <para>It's behavior is controlled by the system preferences
- <link linkend="holdqueueweight">StaticHoldsQueueWeight</link>
- and <link linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
-
- <para>If you do not want all of your libraries to participate in
- the on-shelf holds fulfillment process, you should list the the
- libraries that *do* participate in the process here by inputting
- all the participating library's branchcodes, separated by commas
- ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
-
- <para>By default, the holds queue will be generated such that
- the system will first attempt to hold fulfillment using items
- already at the pickup library if possible. If there are no items
- available at the pickup library to fill a hold,
- build_holds_queue.pl will then use the list of libraries defined
- in StaticHoldsQueueWeight. If RandomizeHoldsQueueWeight is
- disabled ( which it is by default ), the script will assign
- fulfillment requests in the order the branches are placed in the
- StaticHoldsQueueWeight system preference.</para>
-
- <para>For example, if your system has three libraries, of
- varying sizes ( small, medium and large ) and you want the
- burden of holds fulfillment to be on larger libraries before
- smaller libraries, you would want StaticHoldsQueueWeight to look
- something like "LRG,MED,SML".</para>
-
- <para>If you want the burden of holds fulfillment to be spread
- out equally throughout your library system, simply enable
- RandomizeHoldsQueueWeight. When this system preference is
- enabled, the order in which libraries will be requested to
- fulfill an on-shelf hold will be randomized each time the list
- is regenerated.</para>
-
- <para>Leaving StaticHoldsQueueWeight empty is contraindicated at
- this time. Doing so will cause the build_holds_queue script to
- ignore RandomizeHoldsQueueWeight, causing the script to request
- hold fulfillment not randomly, but by alphabetical order.</para>
- </listitem>
- </itemizedlist>
-
- <section id="buildholdscronperl">
- <title><link linkend="buildholdscronperl">Perl Documentation</link></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><link linkend="expiredholdscron">Expired Holds</link></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><link linkend="unsuspendholdcron">Unsuspend Holds</link></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><link linkend="finescronjob">Fines</link></title>
-
- <para>Script path: misc/cronjobs/fines.pl</para>
- <para>Does: Calculates and posts fines to patron accounts.</para>
-
- <para>Required by: <link linkend="finesMode">finesMode</link> system
- preference</para>
-
- <para>Frequency suggestion: nightly</para>
- </section>
-
- <section id="longoverduecron">
- <title><link linkend="longoverduecron">Long Overdues</link></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 using the
- replacement price listed on the item record.</para>
-
- <para>Frequency suggestion: nightly<note>
- <para>Staff can control some of the parameters for the longoverdue cron job with the
- <link linkend="DefaultLongOverdueLostValue">DefaultLongOverdueLostValue</link> and
- <link linkend="DefaultLongOverdueChargeValue">DefaultLongOverdueChargeValue</link>
- preferences.</para>
- </note></para>
-
- <section id="longoverduecronperl">
- <title><link linkend="longoverduecronperl">Perl Documentation</link></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>
- <para><emphasis role="bold">DESCRIPTION</emphasis></para>
- <para> --lost | -l </para>
- <para>This option takes the form of n=lv, where n is num days overdue, and lv is the
- lost value. See warning below.</para>
- <para> --charge | -c </para>
- <para>This specifies what lost value triggers Koha to charge the account for the lost
- item. Replacement costs are not charged if this is not specified. </para>
- <para>--verbose | v </para>
- <para>verbose. </para>
- <para>--confirm </para>
- <para>confirm. without this option, the script will report the number of affected items
- and return without modifying any records. </para>
- <para>--quiet </para>
- <para>suppress summary output. </para>
- <para>--maxdays </para>
- <para>Specifies the end of the range of overdue days to deal with (defaults to 366).
- This value is universal to all lost num days overdue passed. </para>
- <para>--mark-returned </para>
- <para>When an item is marked lost, remove it from the borrowers issued items.</para>
- </section>
- </section>
-
- <section id="updateissuescron">
- <title><link linkend="updateissuescron">Track total checkouts</link></title>
-
- <para>Script path: misc/cronjobs/update_totalissues.pl</para>
-
- <para>Does: updates the biblioitems.totalissues field in the
- database with the latest tally of checkouts.</para>
-
- <para>Frequency suggestion: nightly</para>
- <section id="updateissuesperldoc">
- <title><link linkend="updateissuesperldoc">Perl Documentation</link></title>
- <para><emphasis role="bold">NAME</emphasis>
- </para>
- <para>update_totalissues.pl </para>
- <para><emphasis role="bold">SYNOPSIS</emphasis>
- </para>
- <para>update_totalissues.pl --use-stats </para>
- <para>update_totalissues.pl --use-items </para>
- <para>update_totalissues.pl --commit=1000 </para>
- <para>update_totalissues.pl --since='2012-01-01' </para>
- <para>update_totalissues.pl --interval=30d </para>
- <para><emphasis role="bold">DESCRIPTION</emphasis>
- </para>
- <para>This batch job populates bibliographic records' total issues count based on
- historical issue statistics. </para>
- <para>--help Prints this help </para>
- <para>-v|--verbose </para>
- <para>Provide verbose log information (list every bib modified). </para>
- <para>--use-stats </para>
- <para>Use the data in the statistics table for populating total issues. </para>
- <para>--use-items </para>
- <para>Use items.issues data for populating total issues. Note that issues data from the
- items table does not respect the --since or --interval options, by definition. Also
- note that if both --use-stats and --use-items are specified, the count of biblios
- processed will be misleading. </para>
- <para>-s|--since=DATE </para>
- <para>Only process issues recorded in the statistics table since DATE. </para>
- <para>-i|--interval=S </para>
- <para>Only process issues recorded in the statistics table in the last N units of time.
- The interval should consist of a number with a one- letter unit suffix. The valid
- suffixes are h (hours), d (days), w (weeks), m (months), and y (years). The default
- unit is days. </para>
- <para>--incremental </para>
- <para>Add the number of issues found in the statistics table to the existing total
- issues count. Intended so that this script can be used as a cron job to update
- popularity information during low-usage periods. If neither --since or --interval are
- specified, incremental mode will default to processing the last twenty-four hours. </para>
- <para>--commit=N </para>
- <para>Commit the results to the database after every N records are processed. </para>
- <para>--test </para>
- <para>Only test the popularity population script. </para>
- <para><emphasis role="bold">WARNING</emphasis>
- </para>
- <para>If the time on your database server does not match the time on your Koha server
- you will need to take that into account, and probably use the --since argument instead
- of the --interval argument for incremental updating. </para>
- <para><emphasis role="bold">CREDITS</emphasis>
- </para>
- <para>This patch to Koha was sponsored by the Arcadia Public Library and the Arcadia
- Public Library Foundation in honor of Jackie Faust-Moreno, late director of the
- Arcadia Public Library. </para>
- <para><emphasis role="bold">AUTHOR</emphasis>
- </para>
- <para>Jared Camins-Esakov <jcamins AT cpbibliography DOT com></para>
- </section>
- </section>
- <section id="offlinecirccron">
- <title><link linkend="offlinecirccron">Generate Patron File for Offline Circulation</link></title>
- <para>Script path: misc/cronjobs/create_koc_db.pl</para>
- <para>Does: Generates the borrowers.db file for use with the <link linkend="windowsofflinecirc">Koha Offline Circulation</link> tool</para>
- <para>Frequency suggestion: weekly</para>
- </section>
- <section id="autorenewcron">
- <title><link linkend="autorenewcron">Automatic renewal</link></title>
- <para>Script path: misc/cronjobs/automatic_renewals.pl</para>
- <para>Does: Will automatically renew items if you're allowing automatic renewal with your
- <link linkend="circfinerules">circulation and fine rules</link>.</para>
- <para>Frequency suggestion: nightly</para>
- <section id="autorenewcronperl">
- <title><link linkend="autorenewcronperl">Perl Documentation</link></title>
- <para><emphasis role="bold">NAME</emphasis>
- </para>
- <para>automatic_renewals.pl - cron script to renew loans </para>
- <para><emphasis role="bold">SYNOPSIS</emphasis>
- </para>
- <para>./automatic_renewals.pl </para>
- <para>or, in crontab: 0 3 * * * automatic_renewals.pl </para>
- <para><emphasis role="bold">DESCRIPTION</emphasis>
- </para>
- <para>This script searches for issues scheduled for automatic renewal
- (issues.auto_renew). If there are still renews left (Renewals allowed) and the renewal
- isn't premature (No Renewal before) the issue is renewed. </para>
- <para><emphasis role="bold">OPTIONS</emphasis>
- </para>
- <para>No options.</para>
- </section>
- </section>
- </section>
- <section id="patroncrons">
- <title><link linkend="patroncrons">Patrons</link></title>
- <para/>
- <section id="deleteexpiredregistrationcron">
- <title><link linkend="deleteexpiredregistrationcron">Unverified Registrations</link></title>
- <para>Script path: misc/cronjobs/delete_expired_opac_registrations.pl</para>
- <para>Does: Deletes patron registrations that were submitted via the OPAC but not reviewed
- by the library within the number of days entered in the <link linkend="PatronSelfRegistrationExpireTemporaryAccountsDelay">PatronSelfRegistrationExpireTemporaryAccountsDelay</link> preference.</para>
- <para>Frequency suggestion: nightly</para>
- </section>
- <section id="deleteunverifiedcron">
- <title><link linkend="deleteunverifiedcron">Unconfirmed Registrations</link></title>
- <para>Script path: misc/cronjobs/delete_unverified_opac_registrations.pl </para>
- <para>Does: Deletes patron self registrations that were submitted via the OPAC but not
- confirmed via email within 24 hours. This is only necessary if you are requiring patrons
- to confirm their registrations via email with the <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link> preference.</para>
- <para>Frequency suggestion: hourly</para>
- </section>
- <section id="anonymizecron">
- <title><link linkend="anonymizecron">Anonymize Patron Data</link></title>
- <para>Script path: misc/cronjobs/batch_anonymise.pl</para>
- <para>Does: Used to anonymize patron data. This will remove borrowernumbers from
- circulation history so that the stats are kept, but the patron information is removed
- for privacy reasons.</para>
- </section>
- <section id="j2acron">
- <title><link linkend="j2acron">Update Child to Adult Patron Type</link></title>
- <para>Script path: misc/cronjobs/j2a.pl</para>
- <para>Does: Convert juvenile/child patrons from juvenile patron category and category code
- to corresponding adult patron category and category code when they reach the upper age
- limit defined in the Patron Categories. </para>
- <para>Frequency suggestion: nightly</para>
- <section id="j2aperldoc">
- <title><link linkend="j2aperldoc">Perl Documentation</link></title>
- <para><emphasis role="bold">NAME</emphasis>
- </para>
- <para>juv2adult.pl - convert juvenile/child patrons from juvenile patron category and
- category code to corresponding adult patron category and category code when they reach
- the upper age limit defined in the Patron Categories. </para>
- <para><emphasis role="bold">SYNOPSIS</emphasis>
- </para>
- <para>juv2adult.pl [ -b=<branchcode> -f=<categorycode> -t=<categorycode> ] </para>
- <para>Options: </para>
- <para>--help brief help message </para>
- <para>--man full documentation </para>
- <para>-v verbose mode </para>
- <para>-n take no action, display only </para>
- <para>-b <branchname> only deal with patrons from this library/branch </para>
- <para>-f <categorycode> change patron category from this category </para>
- <para>-t <categorycode> change patron category to this category </para>
- <para>=head1 OPTIONS </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 No Action. With this flag set, script will report changes but not actually
- execute them on the database. </para>
- <para>-b changes patrons for one specific branch. Use the value in the
- branches.branchcode table.</para>
- <para> -f *required* defines the juvenile category to update. Expects the code from
- categories.categorycode. </para>
- <para>-t *required* defines the category juvenile patrons will be converted to. Expects
- the code from categories.categorycode. </para>
- <para><emphasis role="bold">DESCRIPTION</emphasis>
- </para>
- <para>This script is designed to update patrons from juvenile to adult patron types,
- remove the guarantor, and update their category codes appropriately when they reach
- the upper age limit defined in the Patron Categories. </para>
- <para><emphasis role="bold">USAGE EXAMPLES</emphasis>
- </para>
- <para>"juv2adult.pl" - Suggests that you read this help. :) </para>
- <para>"juv2adult.pl" -b=<branchcode> -f=<categorycode> -t=<categorycode> -
- Processes a single branch, and updates the patron categories from fromcat to tocat. </para>
- <para>"juv2adult.pl" -f=<categorycode> -t=<categorycode> -v -n - Processes all
- branches, shows all messages, and reports the patrons who would be affected. Takes no
- action on the database.</para>
- </section>
- </section>
- </section>
-
- <section id="noticescron">
- <title><link linkend="noticescron">Notices</link></title>
-
- <para/>
-
- <section id="msgqueuecron">
- <title><link linkend="msgqueuecron">Message Queue</link></title>
-
- <para>Script path: misc/cronjobs/process_message_queue.pl</para>
-
- <para>Does: processes the message queue to send the check out, check in and hold filled
- emails and SMS message to users and sends outgoing emails to patrons. requires <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link> to be
- on</para>
-
- <para>Frequency suggestion: 1-4 hours<important>
- <para>Item due and Advanced due notices are controlled by the <link linkend="advnoticecron">advance_notices cron</link>.</para>
- </important></para>
- </section>
-
- <section id="advnoticecron">
- <title><link linkend="advnoticecron">Advanced Notice</link></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><link linkend="advnoticecronperl">Perl Documentation</link></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><link linkend="overduenoticecron">Overdue Notice</link></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><link linkend="overduenoticecronperl">Perl Documentation</link></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 processed 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><link linkend="printholdcron">Print Hold Notices</link></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 id="talkingtechcrons">
- <title><link linkend="talkingtechcrons">Talking Tech</link></title>
-
- <para>To learn more about setting up this third party product view
- the <link linkend="talkingtechappendix">Talking Tech
- Appendix</link>.</para>
-
- <section id="talkingtechsendcron">
- <title><link linkend="talkingtechsendcron">Sending Notices File</link></title>
-
- <para>Script path:
- misc/cronjobs/thirdparty/TalkingTech_itiva_outbound.pl</para>
-
- <para>Does: Script to generate Spec C outbound notifications file
- for Talking Tech i-tiva phone notification system.</para>
-
- <para>Required by: <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
-
- <para>Frequency suggestion: nightly</para>
-
- <section id="talkingsendcronperl">
- <title><link linkend="talkingsendcronperl">Perl Documentation</link></title>
-
- <para><emphasis role="bold">USAGE</emphasis></para>
-
- <para>TalkingTech_itiva_outbound.pl</para>
-
- <para>TalkingTech_itiva_outbound.pl --type=OVERDUE -w 0 -w 2 -w
- 6 --output=/tmp/talkingtech/outbound.csv</para>
-
- <para>TalkingTech_itiva_outbound.pl --type=RESERVE
- --type=PREOVERDUE --lang=FR</para>
-
- <para>Script to generate Spec C outbound notifications file for
- Talking Tech i-tiva phone notification system.</para>
-
- <para>--help -h</para>
-
- <para>Prints this help</para>
-
- <para>-v Provide verbose log information.</para>
-
- <para>--output -o</para>
-
- <para>Destination for outbound notifications file (CSV format).
- If no value is specified, output is dumped to screen.</para>
-
- <para>--lang</para>
-
- <para>Sets the language for all outbound messages. Currently
- supported values are EN, FR and ES. If no value is specified, EN
- will be used by default.</para>
-
- <para>--type</para>
-
- <para>REQUIRED. Sets which messaging types are to be used. Can
- be given multiple times, to specify multiple types in a single
- output file. Currently supported values are RESERVE, PREOVERDUE
- and OVERDUE. If no value is given, this script will not produce
- any outbound notifications.</para>
-
- <para>--waiting-hold-day -w</para>
-
- <para>OPTIONAL for --type=RESERVE. Sets the days after a hold
- has been set to waiting on which to call. Use switch as many
- times as desired. For example, passing "-w 0 -w 2 -w 6" will
- cause calls to be placed on the day the hold was set to waiting,
- 2 days after the waiting date, and 6 days after. See example
- above. If this switch is not used with --type=RESERVE, calls
- will be placed every day until the waiting reserve is picked up
- or canceled.</para>
-
- <para>--library-code --code -c</para>
-
- <para>OPTIONAL The code of the source library of the message.
- The library code is used to group notices together for
- consortium purposes and apply library specific settings, such as
- prompts, to those notices. This field can be blank if all
- messages are from a single library.</para>
- </section>
- </section>
-
- <section id="talkingtechreceivecron">
- <title><link linkend="talkingtechreceivecron">Receiving Notices File</link></title>
-
- <para>Script path:
- misc/cronjobs/thirdparty/TalkingTech_itiva_inbound.pl</para>
-
- <para>Does: Script to process received Results files for Talking
- Tech i-tiva phone notification system.</para>
-
- <para>Required by: <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
-
- <para>Frequency suggestion: nightly</para>
-
- <section id="talkingreceivecronperl">
- <title><link linkend="talkingreceivecronperl">Perl Documentation</link></title>
-
- <para><emphasis role="bold">USAGE</emphasis></para>
-
- <para>TalkingTech_itiva_inbound.pl</para>
-
- <para>TalkingTech_itiva_inbound.pl -v
- --input=/tmp/talkingtech/results.csv</para>
-
- <para>Script to process received Results files for Talking Tech
- i-tiva phone notification system.</para>
-
- <para>--help -h</para>
-
- <para>Prints this help</para>
-
- <para>-v Provide verbose log information.</para>
-
- <para>--input -i</para>
-
- <para>REQUIRED. Path to incoming results file.</para>
- </section>
- </section>
- </section>
- <section id="patronexpirycron">
- <title><link linkend="patronexpirycron">Notify Patrons of Expiration</link></title>
- <para>Script path: misc/cronjobs/membership_expiry.pl </para>
- <para>Does: Sends messages to warn patrons of their card expiration to the <link linkend="msgqueuecron">messaage queue</link> cron.</para>
- <para>Requires: <link linkend="MembershipExpiryDaysNotice">MembershipExpiryDaysNotice</link></para>
- <para>Frequency: nightly</para>
- </section>
- </section>
-
- <section id="proccartcron">
- <title><link linkend="proccartcron">In Processing/Book Cart</link></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><link linkend="proccartcronperl">Perl Documentation</link></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><link linkend="catalogcron">Catalog</link></title>
-
- <para/>
-
- <section id="checkurlcron">
- <title><link linkend="checkurlcron">Check URLs</link></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><link linkend="checkurlcronperl">Perl Documentation</link></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><link linkend="mergeauthcron">Update Authorities</link></title>
-
- <para>Script path: misc/migration_tools/merge_authority.pl</para>
-
- <para>Does: Updates biblio data with changes to authorities records<note>
- <para>The name of this script is misleading. This script does not merge authorities
- together it instead merges authority data with linked bib records. Edits to
- authority records will be applied to bibliographic records that use that authority
- when this script is run.</para>
- </note></para>
-
- <para>Required by: <link linkend="dontmerge">dontmerge</link> system
- preference</para>
-
- <para>Frequency suggestion: nightly</para>
- </section>
-
- <section id="serialscron">
- <title><link linkend="serialscron">Serials Update</link></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 id="autoitemupdatecron">
- <title><link linkend="autoitemupdatecron">Automatic item update</link></title>
- <para>Script path: misc/cronjobs/automatic_item_modification_by_age.pl</para>
- <para>Does: updates items based on the list of rules set forth in the <link linkend="autoitemagemod">Automatic item modifications by age</link> tool</para>
- <para>Required by: <link linkend="autoitemagemod">Automatic item modifications by
- age</link>
- </para>
- <para>Frequency suggestions: nightly</para>
- <section id="autoitemupdatecrondoc">
- <title><link linkend="autoitemupdatecrondoc">Perl Documentation</link></title>
- <para><emphasis role="bold">NAME</emphasis>
- </para>
- <para>automatic_item_modification_by_age.pl </para>
- <para><emphasis role="bold">SYNOPSIS</emphasis>
- </para>
- <para>./automatic_item_modification_by_age.pl -h </para>
- <para>Toggle recent acquisitions status. Use this script to delete "new" status for
- items. </para>
- <para><emphasis role="bold">OPTIONS</emphasis>
- </para>
- <para>-h|--help Prints this help message. </para>
- <para>-v|--verbose Set the verbose flag. </para>
- <para>-c|--confirm The script will modify the items. </para>
- <para><emphasis role="bold">AUTHOR</emphasis>
- </para>
- <para>Jonathan Druart <jonathan.druart@biblibre.com> </para>
- <para><emphasis role="bold">COPYRIGHT</emphasis>
- </para>
- <para>Copyright 2013 BibLibre </para>
- <para><emphasis role="bold">LICENSE</emphasis>
- </para>
- <para>This file is part of Koha. </para>
- <para>Koha is free software; you can redistribute it and/or modify it under the terms of
- the GNU General Public License as published by the Free Software Foundation; either
- version 3 of the License, or (at your option) any later version. </para>
- <para>Koha 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 GNU General Public License for more details. </para>
- <para>You should have received a copy of the GNU General Public License along with Koha;
- if not, see <http://www.gnu.org/licenses>.</para>
- </section>
- </section>
- </section>
-
- <section id="opaccrons">
- <title><link linkend="opaccrons">OPAC</link></title>
-
- <para/>
-
- <section id="customrssfeedcron">
- <title><link linkend="customrssfeedcron">RSS Feeds</link></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><link linkend="authbrowsercron">Authorities Browser</link></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<important>
- <para>This preference and cron job should only be used on French systems.</para>
- </important></para>
- </section>
-
- <section id="keywordclouds">
- <title><link linkend="keywordclouds">Subject/Author Clouds</link></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><link linkend="keywordcloudsperl">Perl Documentation</link></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><link linkend="systemcron">System Administration</link></title>
-
- <para/>
-
- <section id="cleandbcron">
- <title><link linkend="cleandbcron">Clean up Database</link></title>
-
- <para>Script path: misc/cronjobs/cleanup_database.pl</para>
-
- <para>Does: Truncates the sessions table, cleans out old zebraqueue entries, action logs
- and staged MARC files.</para>
- <section>
- <title>Perl Documentation</title>
- <para><emphasis role="bold">USAGE</emphasis></para>
- <para>kohaclone/misc/cronjobs/cleanup_database.pl [-h|--help] [--sessions] [--sessdays
- DAYS] [-v|--verbose] [--zebraqueue DAYS] [-m|--mail] [--merged] [--import DAYS]
- [--logs DAYS] [--searchhistory DAYS]</para>
- <para><emphasis role="bold">PARAMETERS</emphasis></para>
- <para>-h --help </para>
- <para>prints this help message, and exits, ignoring all other options</para>
- <para>--sessions </para>
- <para>purge the sessions table. If you use this while users are logged into Koha, they
- will have to reconnect.</para>
- <para>--sessdays DAYS </para>
- <para>purge only sessions older than DAYS days</para>
- <para>-v --verbose </para>
- <para>will cause the script to give you a bit more information about the run.</para>
- <para>--zebraqueue DAYS </para>
- <para>purge completed zebraqueue entries older than DAYS days. Defaults to 30 days if no
- days specified.</para>
- <para>-m --mail DAYS </para>
- <para>purge items from the mail queue that are older than DAYS days. Defaults to 30 days
- if no days specified.</para>
- <para>--merged </para>
- <para>purged completed entries from need_merge_authorities.</para>
- <para>--import DAYS </para>
- <para>purge records from import tables older than DAYS days. Defaults to 60 days if no
- days specified</para>
- <para>--z3950 </para>
- <para>purge records from import tables that are the result of Z39.50 searches</para>
- <para>--logs DAYS </para>
- <para>purge entries from action_logs older than DAYS days. Defaults to 180 days if no
- days specified</para>
- <para>--searchhistory DAYS </para>
- <para>purge entries from search_history older than DAYS days. Defaults to 30 days if no
- days specified</para>
- <para>--list-invites DAYS </para>
- <para>purge (unaccepted) list share invites older than DAYS days. Defaults to 14 days if
- no days specified.</para>
- <para>--restrictions DAYS</para>
- <para>purge patrons restrictions expired since more than DAYS days. Defaults to 30 days
- if no days specified. </para>
- </section>
- </section>
- <section id="usagecron">
- <title><link linkend="usagecron">Share Usage Stats</link></title>
- <para>Script path: misc/cronjobs/share_usage_with_koha_community.pl</para>
- <para>Does: If you're sharing information via the <link linkend="UsageStats">UsageStats</link> feature this will send your info to the <ulink url="http://hea.koha-community.org/">Hea website</ulink>.</para>
- <para>Frequency: monthly</para>
- <section id="usagecronperl">
- <title><link linkend="usagecronperl">Perl Documentation</link></title>
- <para><emphasis role="bold">NAME</emphasis>
- </para>
- <para>share_usage_with_koha_community.pl - Share your library's usage with the Koha
- community</para>
- <para><emphasis role="bold">SYNOPSIS</emphasis>
- </para>
- <para>share_usage_with_koha_community.pl [-h|--help] [-v|--verbose] </para>
- <para>If the <link linkend="UsageStats">UsageStats</link> system preference is set, you
- can launch this script to share your usage data anonymously with the Koha community. </para>
- <para>Collecting Koha usage statistics will help developers to know how Koha is used
- across the world. </para>
- <para>This script will send the usage data for the bibliographic and authority records,
- checkouts, holds, orders, and subscriptions. </para>
- <para>Only the total number is retrieved. In no case will private data be shared! </para>
- <para>In order to know which parts of Koha modules are used, this script will collect
- some system preference values. </para>
- <para>If you want to tell us who you are, you can fill the <link linkend="UsageStatsLibraryName">UsageStatsLibraryName</link> system preference with
- your library name, <link linkend="UsageStatsLibraryUrl">UsageStatsLibraryUrl</link>,
- <link linkend="UsageStatsLibraryType">UsageStatsLibraryType</link> and/or <link linkend="UsageStatsCountry">UsageStatsCountry</link>. </para>
- <para>All these data will be analyzed on the <ulink url="http://hea.koha-community.org">http://hea.koha-community.org</ulink> Koha community website. </para>
- <para>IMPORTANT : please do NOT run the cron on the 1st, but on another day. The idea is
- to avoid all Koha libraries sending their data at the same time ! So choose any day
- between 1 and 28 !</para>
- <para><emphasis role="bold">OPTIONS</emphasis>
- </para>
- <para>-h|--help </para>
- <para>Print a brief help message </para>
- <para>-v|--verbose </para>
- <para>Verbose mode. </para>
- <para>-f|--force </para>
- <para>Force the update.</para>
- <para><emphasis role="bold">AUTHOR</emphasis>
- </para>
- <para>Alex Arnaud <alex.arnaud@biblibre.com> </para>
- <para>Jonathan Druart <jonathan.druart@biblibre.com></para>
- <para><emphasis role="bold">COPYRIGHT</emphasis>
- </para>
- <para>Copyright 2014 BibLibre</para>
- <para><emphasis role="bold">LICENSE</emphasis>
- </para>
- <para>This file is part of Koha. </para>
- <para>Koha is free software; you can redistribute it and/or modify it under the terms of
- the GNU General Public License as published by the Free Software Foundation; either
- version 3 of the License, or (at your option) any later version. </para>
- <para>You should have received a copy of the GNU General Public License along with Koha;
- if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301 USA.</para>
- </section>
- </section>
- </section>
-
- <section id="acqcrons">
- <title><link linkend="acqcrons">Acquisitions</link></title>
-
- <section id="cleansuggcron">
- <title><link linkend="cleansuggcron">Clean up old suggestions</link></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 id="emailsuggestfund">
- <title><link linkend="emailsuggestfund">Email suggestions to process</link></title>
- <para>Script path: misc/cronjobs/notice_unprocessed_suggestions.pl</para>
- <para>Does: Generates a notice to the fund owner that there are suggestions in need of
- processing</para>
- <section id="emailsuggestfundperl">
- <title><link linkend="emailsuggestfundperl">Perl Documentation</link></title>
- <para><emphasis role="bold">NAME</emphasis>
- </para>
- <para>notice_unprocessed_suggestions.pl - Generate notification for unprocessed
- suggestions. </para>
- <para>The budget owner will be notified. </para>
- <para>The letter template 'TO_PROCESS' will be used. </para>
- <para><emphasis role="bold">SYNOPSIS</emphasis>
- </para>
- <para>notice_unprocessed_suggestions.pl [-h|--help] [-v|--verbose] [-c|--confirm]
- [--days=NUMBER_OF_DAYS] </para>
- <para><emphasis role="bold">OPTIONS</emphasis>
- </para>
- <para>-h|--help Print a brief help message </para>
- <para>-c|--confirm This flag must be provided in order for the script to actually
- generate notices. If it is not supplied, the script will only report on the patron it
- would have noticed. </para>
- <para>--days This parameter is mandatory. It must contain an integer representing the
- number of days elapsed since the last modification of suggestions to process. </para>
- <para>-v|--verbose Verbose mode.</para>
- </section>
- </section>
- <section id="edicron">
- <title><link linkend="edicron">EDI Message Processing</link></title>
- <para>Script path: misc/cronjobs/edi_cron.pl</para>
- <para>Does: Sends and received EDI messages</para>
- <para>Frequency: Every 15 minutes</para>
- </section>
- </section>
-
- <section id="deprecatedcrons">
- <title><link linkend="deprecatedcrons">Deprecated scripts</link></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>
- </section>
- </section>
- </chapter>
-
- <chapter id="webservices">
- <title>Web Services</title>
-
- <para/>
-
- <section id="OAI-PMHservice">
- <title><link linkend="OAI-PMHservice">OAI-PMH</link></title>
- <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. </para>
- <para>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>
- <para>Learn more about OAI-PMH at: <ulink url="http://www.openarchives.org/pmh/">http://www.openarchives.org/pmh/</ulink></para>
- <para>To enable OAI-PMH in Koha edit the <link linkend="OAI-PMH">OAI-PMH</link> preference.
- Once enabled you can visit http://YOURKOHACATALOG/cgi-bin/koha/oai.pl to see your
- file.</para>
-
- <section id="oaiconfsample">
- <title><link linkend="oaiconfsample">Sample OAI Conf File</link></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>
- <section id="Rest-services">
- <title><link linkend="Rest-services">REST services</link></title>
-
- <para>Koha can now be requested by REST http requests. BibLibre wrotes an external module to adds more possibilities than ILS-DI can provide.There is no authentication process, but authorized ips are listed in the config file. Services have been tested in 3.10, 3.12 and 3.14 koha versions. You can find more information about it into README file and opac/rest.pl documentation on http://git.biblibre.com. If you want to add features, send us a patch at dev_patches AT biblibre DOT com.</para>
- <para>Services provided in 1.4 version are:
- <programlisting>
- GET branches
- GET user/byid/:borrowernumber/holds
- GET user/:user_name/holds
- GET user/byid/:borrowernumber/issues
- GET user/:user_name/issues
- GET user/:user_name/issues_history
- GET user/byid/:borrowernumber/issues_history
- GET user/today
- GET user/all
- POST user
- PUT user/:user_name
- GET biblio/:biblionumber/items
- GET biblio/:biblionumber/holdable
- GET biblio/:biblionumber/items_holdable_status
- GET item/:itemnumber/holdable
- PUT auth/change_password
- GET /suggestions
- GET /suggestions/:suggestionid
- POST /suggestions
- PUT /suggestions/:suggestionid
- DELETE /suggestions/:suggestionid
- </programlisting>
- </para>
- </section>
- </chapter>
-
- <chapter id="sru">
- <title>Using the SRU server</title>
-
- <section id="usingsru">
- <sectioninfo>
- <authorgroup>
- <author>
- <firstname>Nicolas</firstname>
- <surname>Morin</surname>
- <affiliation>
- <orgname>BibLibre</orgname>
- </affiliation>
- </author>
-
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- <contrib>Edits where necessary.</contrib>
- </editor>
- </authorgroup>
-
- <pubdate>December 2009</pubdate>
- </sectioninfo>
- <title><link linkend="usingsru">Using the SRU server</link></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><link linkend="sru_explain">Explain</link></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><link linkend="sru_search">Search</link></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><link linkend="sru_search_more_details">More details about Search</link></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><link linkend="sru_retrieve">Retrieve</link></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="coverflow">
-
- <appendixinfo>
- <authorgroup>
- <author>
- <firstname>Kyle</firstname>
- <surname>Hall</surname>
- <affiliation>
- <orgname>ByWater Solutions</orgname>
- </affiliation>
- </author>
-
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- </editor>
- </authorgroup>
-
- <pubdate>2014</pubdate>
- </appendixinfo>
- <title>New titles slider for OPAC</title>
- <para>Often times libraries will want to add a flowing widget with new materials at the library
- to their main public catalog page. To do this you can use a widget from any number of
- services (usually for a cost) or you can <link linkend="pluginsystem">enable plugins</link> in
- Koha and use the <ulink url="http://git.bywatersolutions.com/koha-plugins.git/shortlog/refs/heads/cover_flow">Cover
- Flow plugin</ulink> which is based on the <ulink url="https://github.com/drien/jquery-flipster">Flipster</ulink>, a responsive jQuery
- coverflow plugin.</para>
- <para>Once the plugin is installed, the steps to get your coverflow to show up are as
- follows:</para>
- <para>First, you need to create one or more public reports for your coverflow widget or widgets
- to be based on. This is how the plugin knows what the content of your widget should contain.
- Each report needs only three columns; title, biblionumber, and isbn. It is important that you
- have a good and valid isbn, as that is the datum used to actually fetch the cover. In the
- iteration of the plugin, we are using Amazon cover images, but I believe in the end I will
- make the cover image fetcher configurable so we can use any data source for cover image
- fetching.</para>
- <para>Second, we need to configure the plugin. The plugin configuration is a single text area
- that uses YAML ( actually, it’s JSON, whcih is a subset of YAML ) to store the configuration
- options. In this example it looks like
- this:<programlisting>- id: 42
- selector: #coverflow
- options:
- style: coverflow</programlisting></para>
- <para>In this example, we are telling the plugin to use the report with id 42, and use it to
- create a coverflow widget to replace the HTML element with the id “coverflow”. The options
- list is passed directly to Flipster, so any options supported by Flipster can be set from the
- plugin configuration! In fact, in addition to the traditional coverflow, Flipster has a
- “carousel” mode which is a much more compact version of the coverflow. You can also configure
- which cover the widget will start on, among other options.</para>
- <para>At the time the plugins options are saved or updated, the plugin will then generate some
- minified JavaScript code that is automatically stored in the Koha system preference
- OPACUserJS. Here is an example of the
- output:<programlisting>/* JS for Koha CoverFlow Plugin
- This JS was added automatically by installing the CoverFlow plugin
- Please do not modify */$(document).ready(function(){$.getScript("/plugin/Koha/Plugin/Com/ByWaterSolutions/CoverFlow/jquery-flipster/src/js/jquery.flipster.min.js",function(data,textStatus,jqxhr){$("head").append("<link id='flipster-css' href='/plugin/Koha/Plugin/Com/ByWaterSolutions/CoverFlow/jquery-flipster/src/css/jquery.flipster.min.css' type='text/css' rel='stylesheet' />");$('#coverflow').load("/coverflow.pl?id=42",function(){var opt={'items':'.item','minfactor':15,'distribution':1.5,'scalethreshold':0,'staticbelowthreshold':false,'titleclass':'itemTitle','selectedclass':'selectedItem','scrollactive':true,'step':{'limit':4,'width':10,'scale':true}};$('#coverflow').flipster({style:'coverflow',});});});});
-/* End of JS for Koha CoverFlow Plugin */</programlisting></para>
- <para>Why do this? For speed! Rather than regenerating this code each and every time the page
- loads, we can generate it once, and use it over and over again.</para>
- <para>If you inspect the code closely, you’ll notice it references a script “coverflow.pl”. This
- is a script that is included with the coverflow plugin. Since we need to access this from the
- OPAC ( and we don’t want to set off any XSS attack alarms ), we need to modify the web server
- configuration for the public catalog and add the followup to
- it:<programlisting>ScriptAlias /coverflow.pl "/var/lib/koha/mykoha/plugins/Koha/Plugin/Com/ByWaterSolutions/CoverFlow/coverflow.pl"</programlisting></para>
- <para>This line gives us access to the coverflow.pl script from the OPAC. This script retrieves
- the report data and passes it back to the public catalog for creating the coverflow widget.
- Koha::Cache is supported in order to make the widget load as quickly as possible!</para>
- <para>The final step is to put your selector element somewhere in your public catalog. In this
- example, I put the following in the system preference
- OpacMainUserBlock:<programlisting><span id="coverflow">Loading...</span></programlisting></para>
- <para>Once that is in place, you need only refresh your OPAC page, and there you have it, your
- very own catalog coverflow widget! Not only do these coverflows look great on a computer
- screen, but they look great on mobile platforms as well, and are even touch responsive!<screenshot>
- <screeninfo>Coverflow Widget</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/appendix-coverflow/coverflow_2-300x170.gif"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </appendix>
-
- <appendix id="sysprefdefaults">
- <title>System Preference Defaults</title>
-
- <para/>
-
- <section id="isbddefaults">
- <title><link linkend="isbddefaults">ISBD Defaults</link></title>
-
- <para>Default values for the <link linkend="isbdpref">ISBD</link> preference.</para>
-
- <section id="isbddefault">
- <title><link linkend="isbddefault">MARC Default</link></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><link linkend="unimarcdefault">UNIMARC Default</link></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="opacisbddefaults">
- <title><link linkend="opacisbddefaults">OPACISBD Defaults</link></title>
- <para>Default values for the <link linkend="OPACISBD">OPACISBD</link> preference.</para>
- <section id="opacisbdmarcdefault">
- <title><link linkend="opacisbdmarcdefault">MARC</link></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 }| #255|, |{ 255a }{ 255b }{ 255c }{ 255d }{ 255e }{ 255f }{ 255g }|
- #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 }| #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 }|. #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 }| #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 }| #546|<br/><br/>|{\n5463
- }{\n546a }{ 546b }| </para>
- <para>#547|<br/><br/>|{\n547a }| #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 }| #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}|
- #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>
- </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><link linkend="epsonprinters">For Epson TM-T88III (3) & TM-T88IV (4) Printers</link></title>
-
- <para/>
-
- <section id="epsonprintdriver">
- <title><link linkend="epsonprintdriver">In the Print Driver</link></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><link linkend="epsonfirefox">In Firefox</link></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><link linkend="epson2">For Epson TM-T88II (2) Printers</link></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><link linkend="epson2firefox">In Firefox</link></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><link linkend="starprinter">For Star SP542 Printers</link></title>
-
- <section id="installstarprinter">
- <title><link linkend="installstarprinter">Installing the Printer</link></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 <emphasis role="bold">Firefox
- on Windows XP SP3</emphasis>. 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>
- <para><emphasis role="bold">Windows 7</emphasis> users should refer to this page: <ulink url="http://www.starmicronics.com/supports/win7.aspx">http://www.starmicronics.com/supports/win7.aspx</ulink>.
- </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><link linkend="firefoxreceipt">Configuring Firefox to Print to Receipt Printer</link></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="noticesappendix">
- <title>Notice & Slips Guides</title>
- <section id="noticesfieldguide">
- <sectioninfo>
- <authorgroup>
- <author>
- <firstname>Barton</firstname>
- <surname>Chittenden</surname>
- <affiliation>
- <orgname>ByWater Solutions</orgname>
- </affiliation>
- </author>
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- </editor>
- </authorgroup>
- <pubdate>2014</pubdate>
- </sectioninfo>
- <title><link linkend="noticesfieldguide">Field Guide for Notices & Slips</link></title>
- <para>This guide will break down the notices and slips information in 3 ways. First it will
- tell you what file generates the notice, then how you will present the item info in that
- notice and finally if the notice can be branch specific or not.</para>
- <para>
- <informaltable style="border-collapse:collapse;border:1px solid black;font-family:'Times New Roman';letter-spacing:normal;text-indent:0px;text-transform:none;word-spacing:0px">
- <thead>
- <tr>
- <th rowspan="1" colspan="1" align="left">Letter Code</th>
- <th rowspan="1" colspan="1" align="left">Used In</th>
- <th rowspan="1" colspan="1" align="left">Detail tag</th>
- <th rowspan="1" colspan="1" align="left">Can be branch specific</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td rowspan="1" colspan="1" align="left">DUE</td>
- <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
- <td rowspan="1" colspan="1" align="left"><<items.content>></td>
- <td rowspan="1" colspan="1" align="left">No</td>
- </tr>
- <tr>
- <td rowspan="1" colspan="1" align="left">DUEDGST</td>
- <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
- <td rowspan="1" colspan="1" align="left"><<items.content>></td>
- <td rowspan="1" colspan="1" align="left">No</td>
- </tr>
- <tr>
- <td rowspan="1" colspan="1" align="left">PREDUE</td>
- <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
- <td rowspan="1" colspan="1" align="left"><<items.content>></td>
- <td rowspan="1" colspan="1" align="left">No</td>
- </tr>
- <tr>
- <td rowspan="1" colspan="1" align="left">PREDUEDGST</td>
- <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
- <td rowspan="1" colspan="1" align="left"><<items.content>></td>
- <td rowspan="1" colspan="1" align="left">No</td>
- </tr>
- <tr>
- <td rowspan="1" colspan="1" align="left">ODUE*</td>
- <td rowspan="1" colspan="1" align="left">overdue_notices.pl</td>
- <td rowspan="1" colspan="1" align="left"><<items.content>> or <item>
- </item></td>
- <td rowspan="1" colspan="1" align="left">Yes</td>
- </tr>
- <tr>
- <td rowspan="1" colspan="1" align="left">CHECKOUT</td>
- <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
- <td rowspan="1" colspan="1" align="left">N/A</td>
- <td rowspan="1" colspan="1" align="left">Yes</td>
- </tr>
- <tr>
- <td rowspan="1" colspan="1" align="left">RENEWAL</td>
- <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
- <td rowspan="1" colspan="1" align="left">N/A</td>
- <td rowspan="1" colspan="1" align="left">Yes</td>
- </tr>
- <tr>
- <td rowspan="1" colspan="1" align="left">TRANSFERSLIP</td>
- <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
- <td rowspan="1" colspan="1" align="left">N/A</td>
- <td rowspan="1" colspan="1" align="left">Yes</td>
- </tr>
- <tr>
- <td rowspan="1" colspan="1" align="left">ISSUESLIP</td>
- <td rowspan="1" colspan="1" align="left">C4/Members.pm</td>
- <td rowspan="1" colspan="1" align="left">
- <para><checkedout> </checkedout> </para>
- <para> <overdue> </overdue> </para>
- <para> <news> </news> </para>
- </td>
- <td rowspan="1" colspan="1" align="left">Yes</td>
- </tr>
- <tr>
- <td rowspan="1" colspan="1" align="left">ISSUEQSLIP</td>
- <td rowspan="1" colspan="1" align="left">C4/Members.pm</td>
- <td rowspan="1" colspan="1" align="left"><checkedout> </checkedout></td>
- <td rowspan="1" colspan="1" align="left">Yes</td>
- </tr>
- <tr>
- <td rowspan="1" colspan="1" align="left">HOLDPLACED</td>
- <td rowspan="1" colspan="1" align="left">C4/Reserves.pm</td>
- <td rowspan="1" colspan="1" align="left">N/A</td>
- <td rowspan="1" colspan="1" align="left">Yes</td>
- </tr>
- <tr>
- <td rowspan="1" colspan="1" align="left">RESERVESLIP</td>
- <td rowspan="1" colspan="1" align="left">C4/Reserves.pm</td>
- <td rowspan="1" colspan="1" align="left">N/A</td>
- <td rowspan="1" colspan="1" align="left">Yes</td>
- </tr>
- <tr>
- <td rowspan="1" colspan="1" align="left">ASKED</td>
- <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
- <td rowspan="1" colspan="1" align="left">N/A</td>
- <td rowspan="1" colspan="1" align="left">Yes</td>
- </tr>
- <tr>
- <td rowspan="1" colspan="1" align="left">CHECKED</td>
- <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
- <td rowspan="1" colspan="1" align="left">N/A</td>
- <td rowspan="1" colspan="1" align="left">Yes</td>
- </tr>
- <tr>
- <td rowspan="1" colspan="1" align="left">ACCEPTED</td>
- <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
- <td rowspan="1" colspan="1" align="left">N/A</td>
- <td rowspan="1" colspan="1" align="left">Yes</td>
- </tr>
- <tr>
- <td rowspan="1" colspan="1" align="left">REJECTED</td>
- <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
- <td rowspan="1" colspan="1" align="left">N/A</td>
- <td rowspan="1" colspan="1" align="left">Yes</td>
- </tr>
- <tr>
- <td rowspan="1" colspan="1" align="left">OPAC_REG_VERIFY</td>
- <td rowspan="1" colspan="1" align="left">opac/opac-memberentry.pl</td>
- <td rowspan="1" colspan="1" align="left">N/A</td>
- <td rowspan="1" colspan="1" align="left">No</td>
- </tr>
- </tbody>
- </informaltable>
- </para>
- </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><link linkend="readersdigestsample">Reader's Digest (0034-0375)</link></title>
-
- <itemizedlist>
- <listitem>
- <para>Published 12 times a year (monthly)</para>
- </listitem>
-
- <listitem>
- <para>The Volume number changes every 6 months and 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><link linkend="peoplesample">People Weekly (1076-0091)</link></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><link linkend="hebrewserialsample">Et-Mol</link></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 indefinitely</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>
- <section id="backpackerserial">
- <title><link linkend="backpackerserial">Backpacker (0277-867X)</link></title>
- <para>Published 9 times a year irregularly. The issues continues while the volume and number
- rolls over every 9 issues. If you're holding Volume 41, Number 3, Issue 302 in your hand
- the prediction would look like this:</para>
- <screenshot>
- <screeninfo>Backpacker numbering pattern</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serialssamples/backpacker.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>And the received issues would number like this:</para>
- <para>v. 41, no. 3, iss. 302 </para>
- <para>v. 41, no. 4, iss. 303 </para>
- <para>v. 41, no. 5, iss. 304 </para>
- <para>v. 41, no. 6, iss. 305 </para>
- <para>v. 41, no. 7, iss. 306 </para>
- <para>v. 41, no. 8, iss. 307</para>
- <para>v. 41, no. 9, iss. 308 </para>
- <para>v. 42, no. 1, iss. 309 </para>
- <para>v. 42, no. 2, iss. 310 </para>
- <para>v. 42, no. 3, iss. 311 </para>
- <para>v. 42, no. 4, iss. 312</para>
- </section>
- <section id="keatsserial">
- <title><link linkend="keatsserial">Keats-Shelley Journal (0453-4387)</link></title>
- <para>This journal is published once per year in July. The numbering follows this pattern: <itemizedlist>
- <listitem>
- <para>Vol. 61 2013</para>
- </listitem>
- <listitem>
- <para>Vol. 62 2014</para>
- </listitem>
- <listitem>
- <para>Vol. 63 2015</para>
- </listitem>
- </itemizedlist> Setup should look like this (if you're starting in July 2014):</para>
- <screenshot>
- <screeninfo>Serial planning</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serialssamples/keatsplanning.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- <section id="cilserial">
- <title><link linkend="cilserial">Computers in Libraries (1041-7915)</link></title>
- <para>Computers in Libraries is published ten times per year (monthly with January/February
- and July/August combined issues).</para>
- <screenshot>
- <screeninfo>Subscription details</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serialssamples/cilirregular.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <screenshot>
- <screeninfo>Serial Planning</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serialssamples/cilpattern.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <screenshot>
- <screeninfo>Received details</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/serialssamples/cilreceived.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
- </appendix>
- <appendix id="samplelistemail">
- <title>Sample List & Cart Emails</title>
- <section id="examplelistemail">
- <title><link linkend="examplelistemail">Example Email from List</link></title>
- <para>Below is an example of an email from a list in
- Koha.<programlisting>Hi,
-
-Here is your list called If You Like Jodi Picoult, sent from our online catalog.
-
-Please note that the attached file is a MARC bibliographic records file
-which can be imported into a Personal Bibliographic Software like EndNote,
-Reference Manager or ProCite.
----------------------------------------------
-
-Home safe : a novel /
-
-by Berg, Elizabeth.
-
-Published by: Random House,, 260 p. ;, 25 cm.
-Copyright year: 2009
-LCCN: 2008049247
-In the online catalog:
- http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=12113
-Items :
- North Branch FIC (FIC Ber) TVSN500088894O
- Main Library FIC (FIC Boh) TVSN5000921548
- South Branch FIC (FIC Boh) TVSN500092156A
- West Branch FIC (FIC Boh) TVSN5000921559
-
----------------------------------------------
-
-Half a heart /
-
-by Brown, Rosellen.
-
-Published by: Farrar, Straus, and Giroux,, 402 p. ;, 24 cm.
-Copyright year: 2000
-LCCN: 00022926
-In the online catalog:
- http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=12501
-Items :
- East Branch (813/.54)
- South Branch FIC (FIC Bro) TVSN5000451333</programlisting></para>
- </section>
- <section id="examplecartemail">
- <title><link linkend="examplecartemail">Example Email from Cart</link></title>
- <para>Below is a sample of what an email from the Cart in Koha will look
- like:<programlisting>Hi,
-
- Joaquin D'Planque sent you a cart from our online catalog.
-
- Please note that the attached file is a MARC bibliographic records
- file which can be imported into personal bibliographic software like
- EndNote, Reference Manager or ProCite.
-
- ---------------------------------------------------------------------
-
-
- 1. Book /
- Author(s): Brookfield, Karen. ;
- Published by: Knopf : | Distributed by Random House, , 63 p. : ,
- 29 cm.
- Copyright year: 1993
- Notes : Includes index.
- LCCN: 93018833 /AC
-
- In online catalog:
- http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=31644
-
- Items:
-
- * East Branch (JNF 002 Bro) TVSN500017618A
-
- -----------------------------------------------------------------
-
- 2. The 1965 World book year book :
-
- Published by: Field Enterprises Educational Corp., , 628 p. : , 26
- cm.
- Copyright year: 1965
- Notes : Includes index. | Spine title: Year book, 1965. | Cover
- title: The World book year book, 1965.
- URL:
- http://www.archive.org/details/1965worldbookyea00chic%20%7C%20http://www.openlibrary.org/books/OL24199089M
-
- In online catalog:
- http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=88666
-
- -----------------------------------------------------------------</programlisting></para>
- </section>
- </appendix>
-
- <appendix id="kohacms">
- <title>Using Koha as a Content Management System (CMS)</title>
-
- <para/>
-
- <section id="kohacmssetup">
- <title><link linkend="kohacmssetup">Setup</link></title>
-
- <para>These are instructions for taking a default install of Koha 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 33 change this code: </para>
-
- <programlisting>template_name => "opac-main.tmpl",</programlisting>
- </listitem>
-
- <listitem>
- <para>To this code:</para>
-
- <programlisting>template_name => "pages.tmpl", </programlisting>
- </listitem>
-
- <listitem>
- <para>At approximately line 62 after this code: </para>
- <programlisting>$template->param(
- koha_news => $all_koha_news,
- koha_news_count => $koha_news_count,
- display_daily_quote => C4::Context->preference('QuoteOfTheDay'),
- daily_quote => $quote,
- );</programlisting>
- </listitem>
- <listitem>
- <para>Add these lines: </para>
- <programlisting> my $page = "page_" . $input->param('p'); # go for "p" value in URL and do the concatenation
- my $preference = C4::Context->preference($page); # Go for preference
- $template->{VARS}->{'page_test'} = $preference; # pass variable to template pages.tt</programlisting>
- </listitem>
-
- <listitem>
- <para>Note pages.pl file must have Webserver user execution permissions, you can use
- <ulink url="http://en.wikipedia.org/wiki/Chmod">chmod</ulink> command if you are
- actually logged in as such user:
- <programlisting> $chmod 755 pages.pl</programlisting></para>
- </listitem>
-
- <listitem>
- <para>In the browser go to Home > Administration > System Preferences > Local Use and add
- a New Preference called "page_test" </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>
- <para>To learn more visit the Koha wiki page on this topic: <ulink url="http://wiki.koha-community.org/wiki/Koha_as_a_CMS">http://wiki.koha-community.org/wiki/Koha_as_a_CMS</ulink></para>
- <section id="kohacmstmpl">
- <title><link linkend="kohacmstmpl">Editing the pages template</link></title>
- <para>The file to create / edit for the pages template will depend on your <link linkend="opacthemes">opacthemes</link> system preference setting </para>
- <section id="kohacmstmplboot">
- <title><link linkend="kohacmstmplboot">Editing 'bootstrap' theme template (current)</link></title>
- <itemizedlist>
- <listitem>
- <para>Copy /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/modules/opac-main.tt to /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/modules/pages.tt</para>
- </listitem>
- <listitem>
- <para>Edit /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/modules/pages.tt</para>
- </listitem>
- <listitem>
- <para>At approximately line 61, change this:
- <programlisting> [% IF ( OpacMainUserBlock ) %]<div id="opacmainuserblock">[% OpacMainUserBlock %]</div>[% END %]</programlisting></para>
- </listitem>
- <listitem>
- <para>To this:
- <programlisting> [% IF ( page_test ) %]<div id="opacmainuserblock">[% page_test %]</div>[% END %]</programlisting></para>
- </listitem>
- </itemizedlist>
- <para>Remark: You may wish to disable your News block of these CMS style pages e.g. when you do not want it displayed on the CMS style pages or where the News block is long enough that it actually makes the 'page_test' include scroll outside the default viewport dimensions. In that case, remove the following code from your pages.tt template.
- <programlisting>
- [% IF ( koha_news_count ) %]
- <div id="news">
- <table class="table table-bordered">
- [% FOREACH koha_new IN koha_news %]
- <thead><tr><th>[% koha_new.title %]</th></tr></thead>
- <tbody><tr><td><p>[% koha_new.new %]</p>
- <p class="newsfooter"><i>(published on [% koha_new.newdate %])</i></p></td></tr></tbody>
- [% END %]
- </table>
- </div>
- [% END %]
- </programlisting>
- </para>
- </section>
- </section>
- <section id="kohacmstrouble">
- <title><link linkend="kohacmstrouble">Troubleshooting</link></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><link linkend="kohacmsbonus">Bonus Points</link></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><link linkend="kohacmsusage">Usage</link></title>
-
- <para>After setting up Koha as a CMS you can create new pages following
- these instructions:</para>
-
- <section id="kohacmspages">
- <title><link linkend="kohacmspages">Adding Pages</link></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><link linkend="kohacmsview">Viewing your page</link></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><link linkend="kohacmsexpage">Example</link></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><link linkend="examplecms">Live Examples</link></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 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> and
- <ulink url="http://lists.katipo.co.nz/public/koha/2014-June/039701.html">http://lists.katipo.co.nz/public/koha/2014-June/039701.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="deletetables">
- <title><link linkend="deletetables">Delete sample data from Tables</link></title>
- <para>Use your preferred MySQL client to <ulink url="http://dev.mysql.com/doc/refman/5.5/en/delete.html">delete</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>
- <para>
- You may need to disable foreign key checks to delete data from same tables. For instructions follow this thread:
- <ulink url="https://lists.katipo.co.nz/pipermail/koha/2013-July/036853.html">https://lists.katipo.co.nz/pipermail/koha/2013-July/036853.html</ulink>.
- </para>
- </section>
-
- <section id="resetzebra">
- <title><link linkend="resetzebra">Reset the Zebra Index</link></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>
- <para>If you are running a package install then you'll want to run the following commands to
- reset the authorities and biblios Zebra indices
- instead:<programlisting>$ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-authorities-dom.cfg -g iso2709 -d authorities init
-$ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-biblios.cfg -g iso2709 -d biblios init </programlisting></para>
- <para>Replacing YOURLIBRARY with your Koha installation name.</para>
- </section>
- </appendix>
-
- <appendix id="importantlinks">
- <title>Important Links</title>
-
- <para/>
-
- <section id="koharelatedlinks">
- <title><link linkend="koharelatedlinks">Koha Related</link></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://schema.koha-community.org">http://schema.koha-community.org</ulink></para>
- </listitem>
- <listitem>
- <para>Koha Community Statistics - <ulink url="http://hea.koha-community.org">http://hea.koha-community.org</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://kylehall.info/index.php/projects/koha/">http://kylehall.info/index.php/projects/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>
- </itemizedlist>
- </section>
- <section id="circrelatedlinks">
- <title><link linkend="circrelatedlinks">Circulation Related</link></title>
- <itemizedlist>
- <listitem>
- <para>Koha Desktop Offline Circulation: <ulink url="https://github.com/bywatersolutions/koha-offline-circulation/releases">https://github.com/bywatersolutions/koha-offline-circulation/releases</ulink></para>
- </listitem>
- <listitem>
- <para>Koha Firefox Offline Circulation: <ulink url="https://addons.mozilla.org/en-US/firefox/addon/koct/">https://addons.mozilla.org/en-US/firefox/addon/koct/</ulink>
- </para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="catalogrelatedlinks">
- <title><link linkend="catalogrelatedlinks">Cataloging Related</link></title>
-
- <itemizedlist>
- <listitem>
- <para>Koha MARC Tutorials - <ulink url="http://www.pakban.net/brooke/">http://www.pakban.net/brooke/</ulink></para>
- </listitem>
-
- <listitem>
- <para>IRSpy Open Z39.50 Server Search - <ulink url="http://irspy.indexdata.com/">http://irspy.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>Open Koha Z39.50 Targets - <ulink url="http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources">http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources</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><link linkend="enhancedcontentlinks">Enhanced Content Related</link></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><link linkend="opaclinks">Design Related</link></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>HTML & CSS Library - <ulink url="http://wiki.koha-community.org/wiki/HTML_%26_CSS_Library">http://wiki.koha-community.org/wiki/HTML_%26_CSS_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><link linkend="reportlinks">Reports Related</link></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><link linkend="installlinks">Installation Guides</link></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><link linkend="misclinks">Misc</link></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> and <link linkend="DisplayIconsXSLT">DisplayIconsXSLT</link>
- preferences 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>Many libraries like to use MarcEdit for modifications or data cleanup. If you'd like to do
- this you will need to download it at: <ulink url="http://marcedit.reeset.net/">http://marcedit.reeset.net/</ulink><important>
- <para>Many of the actions described in this chapter can be done in Koha using <link linkend="marcmodtemplates">Marc Modification Templates</link>, but this section is here
- for those who are used to MarcEdit.</para>
- </important></para>
-
- <section id="marceditprefix">
- <title><link linkend="marceditprefix">Adding a prefix to call numbers</link></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>Edit 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>
- <authorgroup>
- <author>
- <firstname>Kanika</firstname>
- <surname>Goyal</surname>
- <affiliation>
- <orgname>Delhi Technological University</orgname>
- </affiliation>
- </author>
-
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- <contrib>Edits where necessary.</contrib>
- </editor>
- </authorgroup>
-
- <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><link linkend="marceditexcel">Importing Excel data into Koha</link></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><link linkend="convertexcel">Converting from Excel format into .mrk format</link></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://marcedit.reeset.net/">http://marcedit.reeset.net/</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><link linkend="convertmrk">Convert .mrk file to .mrc</link></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 with us (.mrc
- file).</para>
- </section>
-
- <section id="importmrc">
- <title><link linkend="importmrc">Import .mrc into Koha</link></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="talkingtechappendix">
- <title>Talking Tech</title>
-
- <para>Talking Tech I-tiva is a third party, proprietary, product that
- libraries can subscribe to. Learn more here: <ulink url="http://www.talkingtech.com/solutions/library">http://www.talkingtech.com/solutions/library</ulink>.</para>
-
- <section id="talkingtechinstall">
- <title><link linkend="talkingtechinstall">Installation and Setup Instructions</link></title>
-
- <para>Be sure you've run
- installer/data/mysql/atomicupdate/Bug-4246-Talking-Tech-itiva-phone-notifications.pl
- to install the required data pack (new syspref, notice placeholders and
- messaging transport preferences)</para>
-
- <para>To use, <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link>
- syspref must be turned on.</para>
-
- <para>If you wish to process PREOVERDUE or RESERVES messages, you'll
- need the <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
- system preference turned on, and patrons to have filled in a preference
- for receiving these notices by phone.</para>
-
- <para>For OVERDUE messages, overdue notice triggers must be configured
- under Koha -> Tools -> <link linkend="noticetriggers">Overdue
- Notice Triggers</link>. Either branch-specific triggers or the default
- level triggers may be used (script will select whichever is
- appropriate).</para>
- </section>
-
- <section id="talkingtechsend">
- <title><link linkend="talkingtechsend">Sending Notices File</link></title>
-
- <orderedlist>
- <listitem>
- <para>Add the <link linkend="talkingtechsendcron">TalkingTech_itiva_outbound.pl</link>
- script to your crontab</para>
- </listitem>
-
- <listitem>
- <para>Add an FTP/SFTP or other transport method to send the output
- file to the I-tiva server</para>
- </listitem>
-
- <listitem>
- <para>If you wish, archive the sent notices file in another
- directory after sending</para>
- </listitem>
- </orderedlist>
-
- <para>Run TalkingTech_itiva_outbound.pl --help for more
- information</para>
- </section>
-
- <section id="talkingtechreceive">
- <title><link linkend="talkingtechreceive">Receiving Results File</link></title>
-
- <orderedlist>
- <listitem>
- <para>Add an FTP/SFTP or other transport method to send the Results
- file to a known directory on your Koha server</para>
- </listitem>
-
- <listitem>
- <para>Add the <link linkend="talkingtechreceivecron">TalkingTech_itiva_inbound.pl</link>
- script to your crontab, aimed at that directory</para>
- </listitem>
-
- <listitem>
- <para>If you wish, archive the results file in another directory
- after processing</para>
- </listitem>
- </orderedlist>
-
- <para>Run TalkingTech_itiva_inbound.pl --help for more
- information</para>
- </section>
- </appendix>
- <appendix id="oclcappendix">
- <title>OCLC Connexion Gateway</title>
- <para>Koha can be set to work with the OCLC Connextion Gateway. This allows libraries to use
- OCLC Connexion as their cataloging tool and simply send those records to Koha with a single
- click. The following instructions will help you set up the OCLC Connexion Gateway, if you
- have a system administrator you will want to consult with them on this process.</para>
- <section id="oclckohasetup">
- <sectioninfo>
- <authorgroup>
- <author>
- <firstname>D. Ruth</firstname>
- <surname>Bavousett</surname>
- <affiliation>
- <orgname>ByWater Solutions</orgname>
- </affiliation>
- </author>
-
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- </editor>
- </authorgroup>
-
- <pubdate>2012</pubdate>
- </sectioninfo>
- <title><link linkend="oclckohasetup">Setting up OCLC service on Koha</link></title>
- <para>First, you'll need to create a file somewhere on your system with configuration
- information. You could put this anywhere that is visible to the account that will be
- running the service. </para>
- <para>The file contains 11 lines. The first 6 will be about your Koha
- system:<programlisting>host: The IP address of your Koha server
-port: The port you want to use for the Connexion service. This port must be different from your SIP port, or any other service
-koha: The full URL of your staff client
-log: The location (full file specification) of your log for the service
-user: The default Koha username to use for importing
-password: The password that goes with that username</programlisting></para>
- <para>The remaining lines describe how to do the staging:
- <programlisting>match: The name of the matching rule from your system to use
-overlay_action: "replace", "create_new", or "ignore"-- what to do if there is a match
-nomatch_action: "create_new" or "ignore"-- what to do if there is no match
-item_action: "always_add","add_only_for_matches","add_only_for_new", or "ignore" -- what to do with embedded 952 item data
-import_mode: "direct" or "stage"</programlisting></para>
- <para> A sample file would look like
- this:<programlisting>host: 1.2.3.4
-port: 8000
-log: /home/koha/koha-dev/var/log/connexion.log
-koha: http://kohastaff.myuniversity.edu
-user: koha_generic_staff
-password: password
-match: 001
-overlay_action: replace
-nomatch_action: create_new
-item_action: ignore
-import_mode: direct</programlisting></para>
- <para>When choosing an 'import_mode' if you use "direct" then the staged record will be
- immediately imported into Koha, and should be searchable after your indexes catch up. If
- you choose "stage", then the record will be placed in a staged batch for you to later go the
- <link linkend="managestaged">Manage Staged MARC Records</link> tool to finish the import. </para>
- <para>If you import multiple records, they'll be in the same batch, until that batch is
- imported, then a new batch will be created. </para>
- <para>In "direct" mode, each record will be in its' own batch. </para>
- <para>To start the service, run the script:
- <programlisting>/location/of/connexion/import/daemon/connexion_import_daemon.pl -d -c /location/of/config/file.cnf</programlisting></para>
- </section>
- <section id="oclcdesktopsetup">
- <sectioninfo>
- <authorgroup>
- <author>
- <firstname>D. Ruth</firstname>
- <surname>Bavousett</surname>
- <affiliation>
- <orgname>ByWater Solutions</orgname>
- </affiliation>
- </author>
-
- <author>
- <firstname>Heather</firstname>
- <surname>Hernandez</surname>
- <affiliation>
- <orgname>San Francisco Maritime National Historical Park</orgname>
- </affiliation>
- </author>
-
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- </editor>
- </authorgroup>
-
- <pubdate>2012/2014</pubdate>
- </sectioninfo>
- <title><link linkend="oclcdesktopsetup">Setting up your OCLC desktop client</link></title>
- <note>
- <para>Screenshots are OCLC Connexion Client v.2.50, Koha v.3.12</para>
- </note>
- <para>To set up the OCLC Connexion desktop client to connect to Koha, go to Tools > Options,
- then choose the Export tab. <screenshot>
- <screeninfo>Connexion Export Tab</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/appendix-oclc/oclcexporttab.png"/>
- </imageobject>
- </mediaobject>
- </screenshot><itemizedlist>
- <listitem>
- <para>Click the "Create..." button to set up a new destination, then choose "OCLC
- Gateway Export" and click OK.</para>
- <itemizedlist>
- <listitem>
- <para>Enter the following information:</para>
-
- <itemizedlist>
- <listitem>
- <para>"Host Name:" Your catalog’s appropriate IP address (from your <link linkend="oclckohasetup">config file above</link>) </para>
- </listitem>
- <listitem>
- <para>"Port:" Your catalog's appropriate port number (from your <link linkend="oclckohasetup">config file above</link>) </para>
- </listitem>
- <listitem>
- <para>"Login ID:" The cataloger's Koha login </para>
- </listitem>
- <listitem>
- <para>"Password:" The cataloger's Koha password </para>
- </listitem>
- <listitem>
- <para>"Notify Host Before Disconnect" = checked, </para>
- </listitem>
- <listitem>
- <para>"Timeout" = 100, "Retries" = 3, "Delay" = 0 (zero), </para>
- </listitem>
- <listitem>
- <para>"Send Local System Logon ID Password" = checked. </para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- <screenshot>
- <screeninfo>OCLC Gateway Export Settings</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/appendix-oclc/oclcgatewaysetup.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Select "OK" when finished, and you should see your new "Gateway Export" option
- listed (The catalog's IP address and port are blacked out in the following
- screenshot)</para>
- <para>
- <screenshot>
- <screeninfo>Gateway Export Added</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/appendix-oclc/oclcgatewayexport.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </para>
- </listitem>
- <listitem>
- <para>Click on "Record Characteristics" and make sure that the bibliographic records are
- using MARC21, UTF-8 Unicode, and click OK to save. </para>
- <para>
- <screenshot>
- <screeninfo>Record Characteristics</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/appendix-oclc/oclcrecordchar.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </para>
- </listitem>
- </itemizedlist></para>
- <para>You should be ready to go! To export a record from OCLC Connexion Client to Koha, just
- press F5 while the record is on-screen. The export dialog will pop up, and you'll see
- Connexion attempting to talk to Koha. You should get a message that the record was added or
- overlaid, including its biblio number, and a URL that you can copy into your web browser to
- jump straight to the record. </para>
- </section>
- <section id="oclcgateway">
- <sectioninfo>
- <authorgroup>
- <author>
- <firstname>Heather</firstname>
- <surname>Hernandez</surname>
- <affiliation>
- <orgname>San Francisco Maritime National Historical Park</orgname>
- </affiliation>
- </author>
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- </editor>
- </authorgroup>
- <pubdate>2014</pubdate>
- </sectioninfo>
- <title><link linkend="oclcgateway">Using the OCLC Connexion Gateway</link></title>
- <para>Records can be exported from Connexion either in a batch or one by one. </para>
- <section id="oclconeexport">
- <title><link linkend="oclconeexport">Exporting records one by one</link></title>
- <para>To export bibliographic records one by one, be sure your "Batch" options are correct:
- from the "Tools" menu, select "Options", and select the "Batch" tab. In the "Perform local
- actions in batch" area, "Bibliographic Record Export" should be unchecked<screenshot>
- <screeninfo>Connexion batch options</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/appendix-oclc/oclcoptions.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>When ready to export, from the "Action" menu, select "Export" or use the F5 key. You
- will see a screen similar to the following if the import is successful and if the record
- is new to the Catalog; you may copy & paste the resulting URL into your Koha catalog
- to see the new record.<screenshot>
- <screeninfo>Connexion Export</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/appendix-oclc/oclcstatus.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>If the record was overlaid, you will see a message to that effect in the "OCLC Gateway
- Export Status" window<screenshot>
- <screeninfo>Overlay confirmation</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/appendix-oclc/oclcoverlay.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- </section>
- <section id="oclcbatchexport">
- <title><link linkend="oclcbatchexport">Exporting records in a batch</link></title>
- <para>To export bibliographic records in a batch, be sure your "Batch" options are correct:
- from the "Tools" menu, select "Options", and select the "Batch" tab. In the "Perform local
- actions in batch" area, "Bibliographic Record Export" should be checked<screenshot>
- <screeninfo>OCLC Batch Export Options</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/appendix-oclc/oclcexportbatch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>When a record is ready to export, from the "Action" menu, select "Export" or use the
- F5 key, and it’s export status will be "ready." </para>
- <para>When ready to export the batch, from the "Batch" menu, select "Process batch" and
- check the appropriate "Path" and "Export" boxes<screenshot>
- <screeninfo>Batch import process</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/appendix-oclc/oclcprocessbatch.png"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>The export will begin, and the bib records will be exported & imported into Koha
- one by one; you will see "OCLC Gateway Export Status" windows, as above, showing you the
- results of each export. That window will stay there until you select "Close," and then the
- next record’s export/import will begin. The process will continue until all records in the
- batch are completed. Then you may or may not see the Connexion Client export report
- (depending on your Client options for that). </para>
- </section>
- <section id="oclcitems">
- <title><link linkend="oclcitems">Items in OCLC</link></title>
- <para>If you'd like to create your item records in OCLC you can do so by addding a 952 for
- each item to the bib record you're cataloging. The <link linkend="itemcatguide">Item/Holdings Cataloging Guide</link> will break down what subfields you can use in the
- 952, but at the minimum you want to have subfield 2, a, b, and y on your items.</para>
- <example>
- <title>Item record example</title>
- <para>952 \\$2CLASSIFICATION$aHOMEBRANCHCODE$bHOLDINGBRANCHCODE$yITEMTYPECODE</para>
- </example>
- <para>
- <itemizedlist>
- <listitem>
- <para>The subfield 2 holds the classification code. This can be ddc for Dewey or lcc
- for Library of Congress or z for Custom. Other classification sources can be found
- in the <link linkend="classificationsources">Classification Sources</link> area in
- administration</para>
- </listitem>
- <listitem>
- <para>Subfield a is your home library and needs to be the code for your home library,
- not the library name. You can find these codes in the <link linkend="libsgroups">Libraries & Groups</link> administration area.</para>
- </listitem>
- <listitem>
- <para>Subfield b is your holding library and needs to be the code for your holding
- library, not the library name. You can find these codes in the <link linkend="libsgroups">Libraries & Groups</link> administration area.</para>
- </listitem>
- <listitem>
- <para>Subfield y is your item type code. It needs to be the code, not the item type
- name. You can find these codes in the <link linkend="itemtypeadmin">Item
- Types</link> administration area.</para>
- </listitem>
- </itemizedlist>
- </para>
- <example>
- <title>Item record example</title>
- <para>952 \\$2ddc$aMAIN$bMAIN$yBOOK</para>
- </example>
- <para>In addition to these required fields you can enter any other subfield you'd like. Most
- libraries will enter a call number in subfield o and a barcode in subfield p as well.
- Review the <link linkend="itemcatguide">Item/Holdings Cataloging Guide</link> for a full
- list of subfields and values.</para>
- </section>
- </section>
- </appendix>
-
- <appendix id="faqs">
- <title>FAQs</title>
-
- <para/>
-
- <section id="displayfaq">
- <title><link linkend="displayfaq">Display</link></title>
-
- <para/>
-
- <section id="customicons">
- <title><link linkend="customicons">Custom Item Type/Authorized Value Icons</link></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>
- <note>
- <para>Remember to put the icons in both places (on the OPAC and
- the intranet).</para>
- </note>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="customkohaimages">
- <title><link linkend="customkohaimages">Customizing Koha Images</link></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><link linkend="opacdisplayfaq">OPAC Display Fields</link></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><link linkend="displaysubtitle">Subtitle Display on Bib Records</link></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="opacbarcodesfaq">
- <title><link linkend="opacbarcodesfaq">Show patrons the barcodes of items they have checked
- out</link></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><link linkend="circfaq">Circulation/Notices</link></title>
-
- <para/>
-
- <section id="dropboxfaq">
- <title><link linkend="dropboxfaq">Book drop Date</link></title>
-
- <para><emphasis role="bold">Question</emphasis>: How is the book drop date is determined? Is
- it the last open date for the checkout branch? Is it today's date minus one? Can the book
- drop 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 book drop date.
- You will only have one book drop 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 book drop mode is to modify the calendar.</para>
- </section>
- <section id="holdsreportsfaq">
- <title><link linkend="holdsreportsfaq">Holds to Pull and Holds Queue</link></title>
- <para><emphasis role="bold">Question</emphasis>: What is the difference between the <link linkend="holdsqueue">Holds Queue</link> and <link linkend="holdspull">Holds to
- Pull</link>?</para>
- <para><emphasis role="bold">Answer</emphasis>: The holds to pull report gives a simple list
- of what holds need to be filled with available items. It should only be used in Koha
- installations where there is only one library. </para>
- <para>The holds queue tries to do the same thing, but in a 'smarter' way. This allows it to
- split up the list by library, consult the <link linkend="transportcostmatrix">transport
- cost matrix</link> and refresh regularly to provide different pull lists to each
- library.</para>
- </section>
-
- <section id="dupoverduefaq">
- <title><link linkend="dupoverduefaq">Duplicate Overdue Notices</link></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><link linkend="printoverduefaq">Printing Overdue Notices</link></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 usage 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><link linkend="renewfaq">Unable to Renew Items</link></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 or renewing items, since there was no baseline number
- of holds or renewals to utilize.</para>
- </section>
-
- <section id="holdsfaq">
- <title><link linkend="holdsfaq">Unable to Place Holds</link></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><link linkend="keyboardshort">Keyboard Shortcuts</link></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><note>
- <para>Mac users use the OPTION button in place of ALT</para>
- </note></para>
- </section>
-
- <section id="smsnoticefaq">
- <title><link linkend="smsnoticefaq">SMS Notices/Messages</link></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>
- <para><emphasis role="bold">Question</emphasis>: What about in India?</para>
-
- <para><emphasis role="bold">Answer</emphasis>: India does not yet have too many options
- here. This is partly due to the Telecom regulatory authority's (TRAI) stipulations about
- transactional SMSes and limits on the number of SMSes that may be sent / received per
- users per day. India specific drivers include: <itemizedlist>
- <listitem>
- <para>Unicel Technologies Pvt Ltd (<ulink url="http://unicel.in">unicel.in</ulink>)</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
-
- <section id="catfaq">
- <title><link linkend="catfaq">Cataloging</link></title>
-
- <para/>
-
- <section id="authorityfaq">
- <title><link linkend="authorityfaq">Authority Fields</link></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 "Don't allow". When it is set to "Don't allow" these fields will be locked and require
- you to search for an existing authority record to populate the field with. To allow typing
- in these authority fields set <link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> to 'Allow'.<note>
- <para>Fields affected by this preference will show a lock symbol in them</para>
- </note></para>
-
- <screenshot>
- <screeninfo>Fields affected by this preference show a lock in the field</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/cataloging/lockedauthority.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
-
- <section id="kohamarcfaq">
- <title><link linkend="kohamarcfaq">Koha to MARC Mapping</link></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><link linkend="itemsperbibfaq">Number of Items Per Bib Record</link></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><link linkend="analyticsfaq">Analytics</link></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><link linkend="acqfaq">Acquisitions</link></title>
-
- <para/>
-
- <section id="planningcatfaq">
- <title><link linkend="planningcatfaq">Planning Categories</link></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><link linkend="serialsfaq">Serials</link></title>
-
- <para/>
-
- <section id="advancedpatternfaq">
- <title><link linkend="advancedpatternfaq">Advanced Patterns</link></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><link linkend="reportsfaq">Reports</link></title>
-
- <para/>
-
- <section id="accounttypefaq">
- <title><link linkend="accounttypefaq">Define Codes Stored in DB</link></title>
-
- <para/>
-
- <section id="finescodefaq">
- <title><link linkend="finescodefaq">Fines Table</link></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 = Account 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>LR = Lost item returned/refunded</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><link linkend="statscodefaq">Statistics Table</link></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>The XXX 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><link linkend="rescodefaq">Reserves Table</link></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 chosen 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><link linkend="reportdicfaq">Reports Dictionary Table</link></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 = Acquisitions</para>
- </listitem>
-
- <listitem>
- <para>5 = Accounts</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="msgtablefaq">
- <title><link linkend="msgtablefaq">Messages Table</link></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><link linkend="serialtablefaq">Serial Table</link></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>
- <listitem>
- <para>7 = Claimed </para>
- </listitem>
- <listitem>
- <para>8 = Stopped</para>
- </listitem>
- <listitem>
- <para>41 = Missing (not received) </para>
- </listitem>
- <listitem>
- <para>42 = Missing (sold out) </para>
- </listitem>
- <listitem>
- <para>43 = Missing (damaged) </para>
- </listitem>
- <listitem>
- <para>44 = Missing (lost)</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="borrowerprivacyvalues">
- <title><link linkend="borrowerprivacyvalues">Borrowers Table</link></title>
- <para><emphasis role="bold">Question</emphasis>: What are the possible codes for the
- privacy field in the borrowers table?</para>
- <para><emphasis role="bold">Answer</emphasis>:<itemizedlist>
- <listitem>
- <para>0 = Forever</para>
- </listitem>
- <listitem>
- <para>1 = Default</para>
- </listitem>
- <listitem>
- <para>2 = Never</para>
- </listitem>
- </itemizedlist></para>
- </section>
- <section id="messpreffaq">
- <title><link linkend="messpreffaq">Messaging Preferences</link></title>
- <para><emphasis role="bold">Question</emphasis>: What are the possible codes in the
- message_attribute_id field in the borrower_message_preferences table?</para>
- <para><emphasis role="bold">Answer</emphasis>:<itemizedlist>
- <listitem>
- <para>2 = advanced notice </para>
- </listitem>
- <listitem>
- <para>6 = item checkout </para>
- </listitem>
- <listitem>
- <para>4 = hold filled </para>
- </listitem>
- <listitem>
- <para>1 = item due </para>
- </listitem>
- <listitem>
- <para>5 = item check in</para>
- </listitem>
- </itemizedlist></para>
- </section>
- </section>
-
- <section id="runtimefaq">
- <title><link linkend="runtimefaq">Runtime Parameters</link></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 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 or
- biblio_framework, 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>
- <listitem>
- <para>SELECT title , author FROM biblio WHERE frameworkcode=<<Enter the
- frameworkcode|biblio_framework>> </para>
- </listitem>
- </itemizedlist>
-
- <note>
- <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>
- </note>
-
- <note>
- <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>
- </note>
-
- <para><important>
- <para>In addition to using any authorized value code to generate a dropdown, you can use
- the following values as well: Framework codes (biblio_framework), 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><link linkend="reportlimitfaq">Results Limited</link></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><link linkend="searchfaq">Searching</link></title>
-
- <para/>
-
- <section id="advancedsearchfaq">
- <title><link linkend="advancedsearchfaq">Advanced Search</link></title>
-
- <para/>
-
- <section id="scanindexfaq">
- <title><link linkend="scanindexfaq">Scan Indexes</link></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><link linkend="searchstartswith">Searching for Terms that Start With a Character</link></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><link linkend="wildcardsearchfaq">Wildcard Searching</link></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 id="titlesearchingfaq">
- <title><link linkend="titlesearchingfaq">Title Searching</link></title>
- <para><emphasis role="bold">Question</emphasis>: Why does my Zebra title search for 'Help'
- not turn up 'The help' in the first pages of results?</para>
- <para><emphasis role="bold">Answer</emphasis>: When doing a title search, you actually want
- to search for the title (i.e., 'the help' rather than just 'help'), and it will bubble
- right up to the top. If you're just searching for 'help' then the relevance ranking is
- going to affect the results you see. </para>
- <para>When it comes to relevance in Zebra, here's what's happening. First, the search is
- done. If you search for the title "help", then any title that has "help" in it comes back.
- Then from those records, separately, it does relevance on the *whole* record. The more
- your word appears, the more relevant, and some MARC tags are worth more points than
- others. So a self-help book with 505 notes where "help" appears a *lot* will be at the
- top, regardless of keyword or title.</para>
- <para>But when you add a *second word*, that helps it figure things out, as it's weighing
- the relevance of both words and the phrase. Because of the way relevance works, if you
- search "the help", then "the help" or "the help I need" are more relevant than "the way to
- help", because they appear together in order. Likewise, "help the girl" would be lower
- relevance, because it's out of order, and "help for the homeless" would be lower still, as
- they're out of order, and apart.</para>
- <para>The moral of the story is that single word searches, particularly on common words,
- will always struggle a bit; it can't evaluate relevance well, because you've not given it
- enough input.</para>
- </section>
- </section>
-
- <section id="enhancedcontentfaq">
- <title><link linkend="enhancedcontentfaq">Enhanced Content</link></title>
-
- <para/>
-
- <section id="frbrfaq">
- <title><link linkend="frbrfaq">FRBRizing Content</link></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><link linkend="amzfaq">Amazon</link></title>
-
- <para/>
-
- <section id="amazonfaq">
- <title><link linkend="amazonfaq">All Amazon Content</link></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><link linkend="systemfaq">System Administration</link></title>
-
- <para/>
-
- <section id="zebracronfaq">
- <title><link linkend="zebracronfaq">Errors in Zebra Cron</link></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><link linkend="publicztarget">Making Z39.50 Target Public</link></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><link linkend="authvalfaq">Shelving Location Authorized Values</link></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><link linkend="whyauthvals">Why do I need Authorized Values?</link></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>
-
- <note>
- <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>
- </note>
- </section>
-
- <section id="sessionstblfaq">
- <title><link linkend="sessionstblfaq">How do I clean up the sessions table?</link></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><link linkend="hardwarefaq">Hardware</link></title>
-
- <para/>
-
- <section id="barcodefaq">
- <title><link linkend="barcodefaq">Barcode Scanners</link></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><link linkend="printersfaq">Printers</link></title>
-
- <para/>
-
- <section id="kohaprinters">
- <title><link linkend="kohaprinters">Printers used by Koha libraries</link></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><link linkend="braillefaq">Braille Support</link></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><link linkend="hardwaresupport">Additional Support</link></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>
- <authorgroup>
- <author>
- <firstname>Cab</firstname>
- <surname>Vinton</surname>
- <affiliation>
- <orgname>Sanbornton Public Library</orgname>
- </affiliation>
- </author>
- <editor>
- <firstname>Nicole C.</firstname>
- <surname>Engard</surname>
- </editor>
- </authorgroup>
-
- <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><link linkend="amzlookup">Amazon lookup script for Koha libraries</link></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><link linkend="extendkeywordclouds">Keyword Clouds</link></title>
-
- <para>In addition to the traditional tag cloud available 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>
-
- <section id="newtitlesoption">
- <title><link linkend="newtitlesoption">Newest Titles Pulldown</link></title>
-
- <para>Often we want to add a way for our patrons to do searches for the
- newest items. In this example I'll show you how to create a pull down
- menu of the newest items by item type. These tips will work (with a
- couple changes) for collection codes or shelving locations as
- well.</para>
-
- <para>First, it's important to note that every link in Koha is a
- permanent link. This means if I do a search for everything of a specific
- item type sorted by the acquisitions date and bookmark that URL,
- whenever I click it I'll see the newest items of that type on the first
- few pages of the results.</para>
-
- <para>I took this knowledge and wrote a form takes this functionality in
- to consideration. It basically just does a search of your Koha catalog
- for a specific item type and sorts the results by acquisitions
- date.</para>
-
- <para>The first thing I did was write a MySQL statement to generate a
- list of item types for me - why copy and paste when you can use the
- power of MySQL?</para>
-
- <para><programlisting>select concat('<option value=\"mc-itype:', itemtype, '\">',description,'</option>') from itemtypes</programlisting></para>
-
- <para>The above looks at the itemtypes table and slaps the necessary
- HTML around each item type for me. I then exported that to CSV and
- opened it in my text editor and added the other parts of the
- form.</para>
-
- <para><programlisting><p><strong>New Items</strong></p>
-<p><form name="searchform" method="get" action="/cgi-bin/koha/opac-search.pl">
-<input name="idx" value="kw" type="hidden">
-<input name="sort_by" value="acqdate_dsc" type="hidden">
-<input name="do" value="OK" type="hidden">
-<select name="limit" onchange="this.form.submit()">
-<option>-- Please choose --</option>
-<option value="mc-itype:BOOK">Book</option>
-<option value="mc-itype:BOOKCD">Book on CD</option>
-<option value="mc-itype:DVD">DVD</option>
-<option value="mc-itype:LRG_PRINT">Large print book</option>
-<option value="mc-itype:MAGAZINE">Magazine</option>
-<option value="mc-itype:NEWSPAPER">Newspaper</option>
-<option value="mc-itype:VIDEO">Videocassette</option>
-</select>
-</form>
-</p></programlisting></para>
-
- <para>Now, what does all of that mean? The important bits are
- these:</para>
-
- <para>First the starting of the form.</para>
-
- <para><programlisting><p><form name="searchform" method="get" action="/cgi-bin/koha/opac-search.pl"></programlisting></para>
-
- <para>This tells the browser to take any value selected and put it at
- the end of this http://YOURSITE/cgi-bin/koha/opac-search.pl. If you want
- to embed this form on your library website (and not on your OPAC) you
- can put the full OPAC URL in there.</para>
-
- <para>Next, there is a hidden value that is telling the search to sort
- by acquisitions date descending (newest items at the top):</para>
-
- <para><programlisting><input name="sort_by" value="acqdate_dsc" type="hidden"></programlisting></para>
-
- <para>And finally you have an option for each item type you want people
- to search.<programlisting><option value="mc-itype:BOOK">Book</option></programlisting></para>
-
- <para>These options each include the string "mc-itype:" which tells Koha
- to do an item type search.</para>
-
- <para>Once you have all of that in place you can copy and paste the form
- to somewhere on your OPAC. The <ulink url="http://catalog.farmingtonlibraries.org">Farmington Public Libraries
- OPAC</ulink> has a few examples of this on the left.</para>
- </section>
-
- <section id="colorsearch">
- <title><link linkend="colorsearch">Cataloging and Searching by Color</link></title>
-
- <para>One of the icon sets installed in Koha includes a series of
- colors. This set can be used to catalog and search by color if you'd
- like. This guide will walk you use changing collection code to color in
- Koha so that you can do this.</para>
-
- <para>The following SQL could be used to add these colors to the CCODE
- authorized value category in a batch. If you wanted to use these colors
- for another authorized value you'd have to edit this to use that
- category:</para>
-
- <programlisting> insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','000000','Black','','colors/000000.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','66cc66','Bright Green','','colors/66cc66.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','99cc33','Olive','','colors/99cc33.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','3333cc','Dark Blue','','colors/3333cc.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','006600' ,'Dark Green','','colors/006600.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','6600cc','Plum','','colors/6600cc.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','6666cc','Purple','','colors/6666cc.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','9999cc','Light Purple','','colors/9999cc.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','660000' ,'Burgundy','','colors/660000.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','663333' ,'Brown','','colors/663333.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','990000' ,'Red','','colors/990000.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','996633' ,'Tan','','colors/996633.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','999999' ,'Gray','','colors/999999.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','cc66cc','Pink','','colors/cc66cc.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','cc99cc','Bubble Gum','','colors/cc99cc.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','cc3333' ,'Orange','','colors/cc3333.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','cc6666' ,'Peach','','colors/cc6666.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','cc9999' ,'Rose','','colors/cc9999.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','cccc00' ,'Gold','','colors/cccc00.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','ffff33' ,'Yellow','','colors/ffff33.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','ffffcc','Cream','','colors/ffffcc.png');
- insert into authorised_values (category, authorised_value, lib,
- lib_opac, imageurl) values ('CCODE','ffffff','White','','colors/ffffff.png');</programlisting>
-
- <para>If you would like to choose the colors manually you can do that
- via the <link linkend="authorizedvalues">Authorized Values</link>
- administration area.</para>
-
- <screenshot>
- <screeninfo>Colors for CCODE</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/appendix-extending/colorccode.png"/>
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>Next you'll want to <link linkend="marcbibframeworks">update the
- frameworks</link> so that the 952$8 (if you're using collection code)
- label to says Color.</para>
-
- <para>Once you have that in place you can start to catalog items by
- color.</para>
-
- <para>Finally you'll want to add the following JQuery to your
- preferences so that it will relabel 'Collection' to 'Color'</para>
-
- <para><link linkend="intranetuserjs">IntranetUserJS</link></para>
-
- <programlisting>$(document).ready(function(){
- $("#advsearch-tab-ccode a:contains('Collection')").text("Color");
- $("#holdings th:contains('Collection')").text("Color");
- });</programlisting>
-
- <para><link linkend="opacuserjs">OPACUserJS</link></para>
-
- <programlisting>$(document).ready(function(){
- $("#advsearch-tab-ccode a:contains('Collection')").text("Color");
- $('#item_ccode').text("Color");
- });</programlisting>
-
- <para/>
- </section>
- </appendix>
-
- <appendix id="siteintegration">
- <title>Koha and Your Website</title>
-
- <para>This appendix will include tips for integrating Koha in to your
- library website.</para>
-
- <section id="embedsearch">
- <title><link linkend="embedsearch">Koha search on your site</link></title>
-
- <para>Often you'll want to add a Koha search box to your library
- website. To do so, just copy and paste the following code in to your
- library website and update the YOURCATALOG bit with your catalog's URL
- and you're set to go.</para>
-
- <para><programlisting>
-<form name="searchform" method="get" action="http://YOURCATLOG/cgi-bin/koha/opac-search.pl" id="searchform">
-<input id="transl1" name="q" type="text"><p>
-<select name="idx" id="masthead_search">
-<option value="kw">Keyword</option>
-<option value="ti">Title</option>
-<option value="au">Author</option>
-<option value="su">Subject</option>
-<option value="nb">ISBN</option>
-<option value="se">Series</option>
-<option value="callnum">Call Number</option>
-</select>
-<input value="Search" id="searchsubmit" type="submit">
-</p></form>
- </programlisting></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>
projects / kohadocs.git / commitdiff