en/manual.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- This document is maintained with oXygen. -->
   3 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
   4 <book>
   5   <bookinfo id="manual">
   6     <title>Koha 3.20 Manual (en)</title>
   7
   8     <author id="manualauthor">
   9       <firstname>Nicole C.</firstname>
  10
  11       <surname>Engard</surname>
  12
  13       <affiliation>
  14         <orgname>ByWater Solutions/BibLibre</orgname>
  15       </affiliation>
  16     </author>
  17
  18     <copyright id="manualcopy">
  19       <year>2015</year>
  20       <holder>Nicole C. Engard/ByWater Solutions/BibLibre</holder>
  21     </copyright>
  22
  23     <legalnotice id="manuallegal">
  24       <para>This manual is licensed under the <ulink url="http://www.gnu.org/licenses/gpl.html">GNU General Public License,
  25       version 3</ulink> or later</para>
  26
  27       <para>Learn more about this license in the <link linkend="gpl">GPL3
  28       Appendix</link></para>
  29     </legalnotice>
  30
  31     <pubdate id="manualpubdate">Published: 2015</pubdate>
  32   </bookinfo>
  33   <chapter id="introchapter">
  34     <title>Introduction</title>
  35     <section>
  36       <title id="introbasics">Koha Basics</title>
  37       <para>Koha is the first free and open source software library automation package (ILS).
  38         Development is sponsored by libraries of varying types and sizes, volunteers, and support
  39         companies from around the world.</para>
  40       <para>Learn more about Koha by visiting the official Koha website: <ulink
  41           url="http://koha-community.org">http://koha-community.org</ulink></para>
  42     </section>
  43     <section id="introrecommend">
  44       <title>Koha Recommendations</title>
  45       <para>Full system recommendations can be found on the official Koha wiki along with the
  46         developer documentation: <ulink url="http://wiki.koha-community.org">
  47           http://wiki.koha-community.org</ulink></para>
  48       <para>When working in the Koha staff client it is strongly recommended that you use the
  49         Firefox browser.  Koha's staff client is not supported in Internet Explorer and has not yet
  50         been fully optimized for Google Chrome.</para>
  51     </section>
  52     <section id="usingmanual">
  53       <title>Using this Manual</title>
  54       <para>This manual is always changing and suggestions for edits can be sent to the
  55         Documentation Manager via the <ulink
  56           url="https://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-docs">DOCS mailing
  57           list</ulink>.  The manual is organized by Koha module. At the start of most sections (and
  58         throughout) you will find 'Get there' tips. These lines tell you how to get to the section
  59         in Koha.  </para>
  60       <para>For example: <emphasis>Get there:</emphasis> More &gt; Administration &gt; Global System
  61         Preferences</para>
  62       <para>
  63         <screenshot>
  64           <screeninfo>Get there: More > Administration > Global System Preferences</screeninfo>
  65           <mediaobject>
  66             <imageobject>
  67               <imagedata fileref="images/intro/getthere.png"/>
  68             </imageobject>
  69           </mediaobject>
  70         </screenshot>
  71       </para>
  72       <para>The instruction tells you where to find the necessary menu option at the top of the Koha
  73         staff client.</para>
  74       <para>Links will be found throughout the manual to other sections in the manual and images
  75         will depict what should be seen on the screen.  </para>
  76       <para>The manual can be searched using the custom Google search on the <ulink
  77           url="http://koha-community.org/documentation/">Koha Documentation</ulink> page.</para>
  78     </section>
  79     <section id="contributing">
  80       <title>Contributing to the Manual</title>
  81       <para>This manual is an ever-changing document and edits to the manual are welcome at any
  82         time.  </para>
  83       <para>The <ulink url="http://manual.koha-community.org/">Koha Manual</ulink> is managed by the
  84         Documentation Manager, but that doesn't mean we can't all participate in making the best
  85         manual possible. </para>
  86       <para>The manual is stored in git at: <ulink
  87           url="http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary"
  88           >http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary</ulink></para>
  89       <para>To edit the manual we recommend <ulink url="http://www.oxygenxml.com">oXygen</ulink> or
  90         other XML/DocBook editor. We ask that every chapter and section have an ID tag associated
  91         with it to enable permanent linking and searching. </para>
  92       <para>Patches to the manual should be emailed to the <ulink
  93           url="https://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-docs">DOCS mailing
  94           list</ulink> and will be reviewed by the Documentation Manager before inclusion. </para>
  95     </section>
  96   </chapter>
  97
  98   <chapter id="administration">
  99     <title>Administration</title>
 100
 101     <section id="globalsysprefs">
 102       <title>Global System Preferences</title>
 103
 104       <para>Global system preferences control the way your Koha system works
 105       in general. Set these preferences before anything else in Koha.</para>
 106
 107       <itemizedlist>
 108         <listitem>
 109           <para><emphasis>Get there:</emphasis> More &gt; Administration &gt; Global System
 110             Preferences</para>
 111         </listitem>
 112       </itemizedlist>
 113
 114       <screenshot>
 115         <screeninfo>Global System Preferences Link and Search</screeninfo>
 116
 117         <mediaobject>
 118           <imageobject>
 119             <imagedata fileref="images/admin/globalprefs/prefsearch.png"/>
 120           </imageobject>
 121         </mediaobject>
 122       </screenshot>
 123
 124       <para>System preferences can be searched (using any part of the
 125       preference name or description) using the search box on the
 126       'Administration' page or the search box at the top of each system
 127       preferences page.</para>
 128
 129       <screenshot>
 130         <screeninfo>Preferences search at the top of System Preference
 131         page</screeninfo>
 132
 133         <mediaobject>
 134           <imageobject>
 135             <imagedata fileref="images/admin/globalprefs/prefsearch1.png"/>
 136           </imageobject>
 137         </mediaobject>
 138       </screenshot>
 139
 140       <para>When editing preferences a '(modified)' tag will appear next to
 141       items you change until you click the 'Save All' button:</para>
 142
 143       <screenshot>
 144         <screeninfo>After editing TagsModeration the '(modified)' label
 145         appears</screeninfo>
 146
 147         <mediaobject>
 148           <imageobject>
 149             <imagedata fileref="images/admin/globalprefs/saveallprefs.png"/>
 150           </imageobject>
 151         </mediaobject>
 152       </screenshot>
 153
 154       <para>After saving your preferences you'll get a confirmation message
 155       telling you what preferences were saved:</para>
 156
 157       <screenshot>
 158         <screeninfo>Preference save confirmation message</screeninfo>
 159
 160         <mediaobject>
 161           <imageobject>
 162             <imagedata fileref="images/admin/globalprefs/saveconfirmation.png"/>
 163           </imageobject>
 164         </mediaobject>
 165       </screenshot>
 166
 167       <para>Each section of preferences can be sorted alphabetically by
 168       clicking the small down arrow to the right of the word 'Preference' in
 169       the header column</para>
 170
 171       <screenshot>
 172         <screeninfo>Sort option at the top right of each section of
 173         preferences</screeninfo>
 174
 175         <mediaobject>
 176           <imageobject>
 177             <imagedata fileref="images/admin/globalprefs/sortprefs.png"/>
 178           </imageobject>
 179         </mediaobject>
 180       </screenshot>
 181
 182       <para>If the preference refers to monetary values (like <link linkend="maxoutstanding"
 183           >maxoutstanding</link>) the currency displayed will be the default you set in your <link
 184           linkend="currexchangeadmin">Currency and Exchange Rate</link> administration area. In the
 185         examples to follow they will all read USD for U.S. Dollars.<important>
 186           <para>For libraries systems with unique URLs for each site the system preference can be
 187             overridden by editing your koha-http.conf file this has to be done by a system
 188             administrator or someone with access to your system files.  For example if all libraries
 189             but one want to have search terms highlighted in results you set the
 190             OpacHighlightedWords preference to 'Highlight' then edit the koha-http.conf for the
 191             library that wants this turned off by adding 'SetEnv
 192             OVERRIDE_SYSPREF_OpacHighlightedWords "0"'. After restarting the web server that one
 193             library will no longer see highlighted terms.  Consult with your system administrator
 194             for more information.</para>
 195         </important></para>
 196
 197       <section id="acqprefs">
 198         <title>Acquisitions</title>
 199
 200         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
 201         Global System Preferences &gt; Acquisitions</para>
 202
 203         <section id="acqprefspolicy">
 204           <title>Policy</title>
 205
 206           <section id="AcqCreateItem">
 207             <title>AcqCreateItem</title>
 208
 209             <para>Default: placing an order</para>
 210
 211             <para>Asks: Create an item when ___.</para>
 212
 213             <para>Values:</para>
 214
 215             <itemizedlist>
 216               <listitem>
 217                 <para>cataloging a record</para>
 218               </listitem>
 219
 220               <listitem>
 221                 <para>placing an order</para>
 222               </listitem>
 223
 224               <listitem>
 225                 <para>receiving an order</para>
 226               </listitem>
 227             </itemizedlist>
 228
 229             <para>Description:</para>
 230
 231             <itemizedlist>
 232               <listitem>
 233                 <para>This preference lets you decide when you'd like to
 234                 create an item record in Koha. If you choose to add an item
 235                 record when 'placing an order' then you will enter item
 236                 information in as you place records in your basket. If you
 237                 choose to add the item when 'receiving an order' you will be
 238                 asked for item record information when you're receiving orders
 239                 in acquisitions. If you choose to add the item when
 240                 'cataloging a record' then item records will not be created in
 241                 acquisitions at all, you will need to go to the cataloging
 242                 module to add the items.</para>
 243               </listitem>
 244             </itemizedlist>
 245           </section>
 246           <section id="AcqEnableFiles">
 247             <title>AcqEnableFiles</title>
 248             <para>Default: Don't</para>
 249             <para>Asks: ___  enable the ability to upload and attach arbitrary files to invoices. </para>
 250             <para>Values:<itemizedlist>
 251                 <listitem>
 252                   <para>Do</para>
 253                 </listitem>
 254                 <listitem>
 255                   <para>Don't</para>
 256                 </listitem>
 257               </itemizedlist></para>
 258             <para>Description:<itemizedlist>
 259                 <listitem>
 260                   <para>This preference controls whether or not you allow the uploading of invoice
 261                     files via the acquisitions module.</para>
 262                 </listitem>
 263               </itemizedlist></para>
 264           </section>
 265           <section id="AcqItemSetSubfieldsWhenReceiptIsCancelled">
 266             <title>AcqItemSetSubfieldsWhenReceiptIsCancelled</title>
 267             <para>Asks: Upon cancelling a receipt, update the item's subfields if they were created
 268               when placing an order (e.g. o=5|a="bar foo""). ___</para>
 269             <para>Description:<itemizedlist>
 270                 <listitem>
 271                   <para>This preference is used in conjunction with the <link
 272                       linkend="AcqItemSetSubfieldsWhenReceived"
 273                       >AcqItemSetSubfieldsWhenReceived</link> preference. If you have the system set
 274                     to enter default values when you receive you will want to have those values
 275                     revert back if reeipt is cancelled. This preference allows you to do
 276                     that.</para>
 277                 </listitem>
 278               </itemizedlist></para>
 279           </section>
 280           <section id="AcqItemSetSubfieldsWhenReceived">
 281             <title>AcqItemSetSubfieldsWhenReceived</title>
 282             <para>Asks: Upon receiving items, update their subfields if they were created when
 283               placing an order (e.g. o=5|a="foo bar"). ___</para>
 284             <para>Description:<itemizedlist>
 285                 <listitem>
 286                   <para>This preference allows you to set default values for items that you receive
 287                     via acquisitions. Enter the data as subfield=value and split your values with a
 288                     bar ( | ). For example you can remove the Ordered status on the item
 289                     automatically when you receive it just by entering 7=0 in this preference. That
 290                     will set the Not for Loan status (subfield 7) to 0 which is available.</para>
 291                 </listitem>
 292               </itemizedlist></para>
 293           </section>
 294
 295           <section id="AcqViewBaskets">
 296             <title>AcqViewBaskets</title>
 297
 298             <para>Default: created by staff member</para>
 299
 300             <para>Asks: Show baskets ___</para>
 301
 302             <para>Values:</para>
 303
 304             <itemizedlist>
 305               <listitem>
 306                 <para>created by staff member</para>
 307               </listitem>
 308
 309               <listitem>
 310                 <para>from staff member's branch</para>
 311               </listitem>
 312
 313               <listitem>
 314                 <para>in system, regardless of owner</para>
 315               </listitem>
 316             </itemizedlist>
 317
 318             <para>Description:</para>
 319
 320             <itemizedlist>
 321               <listitem>
 322                 <para>When in acquisitions this preference allows you to
 323                 control whose baskets you can see when looking at a vendor.
 324                 The default value of 'created by staff member' makes it so
 325                 that you only see the baskets you created. Choosing to see
 326                 baskets 'from staff member's branch' will show you the baskets
 327                 created by anyone at the branch you're logged in at. Finally,
 328                 you can choose to set this preference to show you all baskets
 329                 regardless of who created it ('in system, regardless of
 330                 owner). Regardless of which value you choose for this
 331                 preference, superlibrarians can see all baskets created in the
 332                 system.</para>
 333               </listitem>
 334             </itemizedlist>
 335           </section>
 336           <section id="AcqWarnOnDuplicateInvoice">
 337             <title>AcqWarnOnDuplicateInvoice</title>
 338             <para>Default: Do not warn</para>
 339             <para>Asks: ___ when the librarian tries to create an invoice with a duplicate
 340               number.</para>
 341             <para>Values: <itemizedlist>
 342                 <listitem>
 343                   <para>Do not warn</para>
 344                 </listitem>
 345                 <listitem>
 346                   <para>Warn</para>
 347                 </listitem>
 348               </itemizedlist></para>
 349           </section>
 350
 351           <section id="BasketConfirmations">
 352             <title>BasketConfirmations</title>
 353
 354             <para>Default: always ask for confirmation</para>
 355
 356             <para>Asks: When closing or reopening a basket, ___.</para>
 357
 358             <para>Values:</para>
 359
 360             <itemizedlist>
 361               <listitem>
 362                 <para>always ask for confirmation</para>
 363               </listitem>
 364
 365               <listitem>
 366                 <para>do not ask for confirmation</para>
 367               </listitem>
 368             </itemizedlist>
 369
 370             <para>Descriptions:</para>
 371
 372             <itemizedlist>
 373               <listitem>
 374                 <para>This preference adds the option to skip confirmations on
 375                 closing and reopening a basket. If you skip the confirmation,
 376                 you do not create a new basket group.</para>
 377               </listitem>
 378             </itemizedlist>
 379           </section>
 380
 381           <section id="CurrencyFormat">
 382             <title>CurrencyFormat</title>
 383
 384             <para>Default: 360,000.00 (US)</para>
 385
 386             <para>Asks: Display currencies using the following format
 387             ___</para>
 388
 389             <para>Values:</para>
 390
 391             <itemizedlist>
 392               <listitem>
 393                 <para>360,000.00 (US)</para>
 394               </listitem>
 395
 396               <listitem>
 397                 <para>360 000,00 (FR)</para>
 398               </listitem>
 399             </itemizedlist>
 400           </section>
 401
 402           <section id="gist">
 403             <title>gist</title>
 404
 405             <para>Default: 0</para>
 406
 407             <para>Asks: The default tax rate is ___</para>
 408
 409             <para>Description:</para>
 410
 411             <itemizedlist>
 412               <listitem>
 413                 <para>This preference will allow the library to define a
 414                 default Goods and Services Tax rate. The default of value of 0
 415                 will disable this preference.</para>
 416               </listitem>
 417             </itemizedlist>
 418
 419             <para><note>
 420                 <para>Enter this value as a number (.06) versus a percent
 421                 (6%).</para>
 422               </note></para>
 423           </section>
 424           <section id="MarcFieldsToOrder">
 425             <title>MarcFieldsToOrder</title>
 426             <para>Asks: Set the mapping values for a new order line created from a MARC record in a
 427               staged file. </para>
 428             <para>Description:<itemizedlist>
 429                 <listitem>
 430                   <para>This preference includes MARC fields to check for order information to use
 431                     when <link linkend="orderfromstagedfile">ordering from a staged file</link> in
 432                     acquisitions. You can use the following fields: price, quantity, budget_code,
 433                     discount, sort1, sort2.</para>
 434                   <para>For
 435                     example:<programlisting>price: 947$a|947$c
 436 quantity: 969$h
 437 budget_code: 922$a</programlisting></para>
 438                 </listitem>
 439               </itemizedlist></para>
 440           </section>
 441
 442           <section id="UniqueItemFields">
 443             <title>UniqueItemFields</title>
 444
 445             <para>Default: barcode</para>
 446
 447             <para>Asks:___ (space-separated list of fields that should be
 448             unique for items, must be valid SQL fields of <ulink url="http://schema.koha-community.org/tables/items.html">items</ulink>
 449             table)</para>
 450
 451             <para>Description:</para>
 452
 453             <itemizedlist>
 454               <listitem>
 455                 <para>If this preference is left blank when adding items in
 456                 acquisitions there will be no check for uniqueness. This means
 457                 that a duplicate barcode can be created in acquisitions which
 458                 will cause errors later when checking items in and out.</para>
 459               </listitem>
 460             </itemizedlist>
 461           </section>
 462         </section>
 463
 464         <section id="acqprefsprinting">
 465           <title>Printing</title>
 466
 467           <section id="OrderPdfFormat">
 468             <title>OrderPdfFormat</title>
 469
 470             <para>Default: pdfformat::layout2pages</para>
 471
 472             <para>Asks: Use ___ when printing basket groups.</para>
 473           </section>
 474         </section>
 475       </section>
 476
 477       <section id="adminprefs">
 478         <title>Administration</title>
 479
 480         <para>These preferences are general settings for your system.</para>
 481
 482         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
 483         Global System Preferences &gt; Administration</para>
 484
 485         <section id="casauthentication">
 486           <title>CAS Authentication</title>
 487
 488           <para>The Central Authentication Service (CAS) is a single sign-on
 489           protocol for the web. If you don't know what this is, leave these
 490           preferences set to their defaults.</para>
 491
 492           <section id="AllowPKIAuth">
 493             <title>AllowPKIAuth</title>
 494
 495             <para>Default: no</para>
 496
 497             <para>Asks: Use ___ field for SSL client certificate
 498             authentication</para>
 499
 500             <para>Values:</para>
 501
 502             <itemizedlist>
 503               <listitem>
 504                 <para>no</para>
 505               </listitem>
 506
 507               <listitem>
 508                 <para>the common name</para>
 509               </listitem>
 510
 511               <listitem>
 512                 <para>the email address</para>
 513               </listitem>
 514             </itemizedlist>
 515           </section>
 516
 517           <section id="casAuthentication">
 518             <title>casAuthentication</title>
 519
 520             <para>Default: Don't use</para>
 521
 522             <para>Asks: ___ CAS for login authentication.</para>
 523           </section>
 524
 525           <section id="casLogout">
 526             <title>casLogout</title>
 527
 528             <para>Default: Don't logout</para>
 529
 530             <para>Asks: ___ of CAS when logging out of Koha.</para>
 531           </section>
 532
 533           <section id="casServerUrl">
 534             <title>casServerUrl</title>
 535
 536             <para>Asks: The CAS Authentication Server can be found at
 537             ___</para>
 538           </section>
 539         </section>
 540
 541         <section id="adminprefsinterface">
 542           <title>Interface options</title>
 543
 544           <para>These preference are related to your Koha interface</para>
 545
 546           <section id="DebugLevel">
 547             <title>DebugLevel</title>
 548
 549             <para>Default: lots of</para>
 550
 551             <para>Asks: Show ___ debugging information in the browser when an
 552             internal error occurs.</para>
 553
 554             <para>Values:</para>
 555
 556             <itemizedlist>
 557               <listitem>
 558                 <para>lots of - will show as much information as
 559                 possible</para>
 560               </listitem>
 561
 562               <listitem>
 563                 <para>no - will only show basic error messages</para>
 564               </listitem>
 565
 566               <listitem>
 567                 <para>some - will show only some of the information
 568                 available</para>
 569               </listitem>
 570             </itemizedlist>
 571
 572             <para>Description:</para>
 573
 574             <itemizedlist>
 575               <listitem>
 576                 <para>This preference determines how much information will be
 577                 sent to the user's screen when the system encounters an error.
 578                 The most detail will be sent when the value level is set at 2,
 579                 some detail will be sent when the value is set at 1, and only
 580                 a basic error message will display when the value is set at 0.
 581                 This setting is especially important when a system is new and
 582                 the administration is interested in working out the bugs
 583                 (errors or problems) quickly. Having detailed error messages
 584                 makes quick fixes more likely in problem areas.</para>
 585               </listitem>
 586             </itemizedlist>
 587           </section>
 588
 589           <section id="delimiter">
 590             <title>delimiter</title>
 591
 592             <para>Default: semicolons</para>
 593
 594             <para>Asks: Separate columns in an exported report file with ___
 595             by default.</para>
 596
 597             <para>Values:</para>
 598
 599             <itemizedlist>
 600               <listitem>
 601                 <para>#'s</para>
 602               </listitem>
 603
 604               <listitem>
 605                 <para>backslashes</para>
 606               </listitem>
 607
 608               <listitem>
 609                 <para>commas</para>
 610               </listitem>
 611
 612               <listitem>
 613                 <para>semicolons</para>
 614               </listitem>
 615
 616               <listitem>
 617                 <para>slashes</para>
 618               </listitem>
 619
 620               <listitem>
 621                 <para>tabs</para>
 622               </listitem>
 623             </itemizedlist>
 624
 625             <para>Description:</para>
 626
 627             <itemizedlist>
 628               <listitem>
 629                 <para>This preference determines how reports exported from
 630                 Koha will separate data. In many cases you will be able to
 631                 change this option when exporting if you'd like.</para>
 632               </listitem>
 633             </itemizedlist>
 634           </section>
 635
 636           <section id="KohaAdminEmailAddress">
 637             <title>KohaAdminEmailAddress</title>
 638
 639             <para>This is the default 'From' address for emails unless there
 640             is one for the particular branch, and is referred to when an
 641             internal error occurs.</para>
 642
 643             <para>Asks: Use ___ as the email address for the administrator of
 644             Koha.</para>
 645
 646             <para>Description:</para>
 647
 648             <itemizedlist>
 649               <listitem>
 650                 <para>This preference allows one email address to be used in
 651                 warning messages set to the OPAC. If no email address is set
 652                 for the branch this address will receive messages from patrons
 653                 regarding modification requests, purchase suggestions, and
 654                 questions or information regarding overdue notices. It is
 655                 recommended that a email address that can be accessed by
 656                 multiple staff members be used for this purpose so that if one
 657                 librarian is out the others can address these requests. This
 658                 email address can be changed when needed.</para>
 659               </listitem>
 660             </itemizedlist>
 661           </section>
 662
 663           <section id="noItemTypeImages">
 664             <title>noItemTypeImages</title>
 665
 666             <para>Default: Show</para>
 667
 668             <para>Asks: ___ itemtype icons in the catalog.</para>
 669
 670             <para>Values:</para>
 671
 672             <itemizedlist>
 673               <listitem>
 674                 <para>Shows</para>
 675               </listitem>
 676
 677               <listitem>
 678                 <para>Don't show</para>
 679               </listitem>
 680             </itemizedlist>
 681
 682             <para>Description:</para>
 683
 684             <itemizedlist>
 685               <listitem>
 686                 <para>This preference allows the system administrator to
 687                 determine if users will be able to set and see an <link linkend="itemtypeadmin">item type icon</link> the catalog on
 688                 both the OPAC and the Staff Client. The images will display in
 689                 both the OPAC and the Staff Client/Intranet. If images of item
 690                 types are disabled, text labels for item types will still
 691                 appear in the OPAC and Staff Client.</para>
 692               </listitem>
 693             </itemizedlist>
 694           </section>
 695           <section id="ReplytoDefault">
 696             <title>ReplytoDefault</title>
 697             <para>Asks: Use ___ as the email address that will be set as the replyto in emails </para>
 698             <para>Description:<itemizedlist>
 699                 <listitem>
 700                   <para>By default replies to notice emails will go to the <link
 701                       linkend="libsgroups">library email address</link>, if you would like to
 702                     specify a default email address for all replies to notices you can do that
 703                     here.</para>
 704                 </listitem>
 705               </itemizedlist></para>
 706           </section>
 707           <section id="ReturnpathDefault">
 708             <title>ReturnpathDefault</title>
 709             <para>Asks: Use ___ as the email address set as the return path, if you leave this empty
 710               the KohaAdminEmailAddress will be used. </para>
 711             <para>Description:<itemizedlist>
 712                 <listitem>
 713                   <para>The return path is the email address that bounces will be delivered to. By
 714                     default bounced notices will go to the <link linkend="libsgroups">library email
 715                       address</link>, if you would like to specify a default email address for
 716                     bounces to go to then fill in this preference.</para>
 717                 </listitem>
 718               </itemizedlist></para>
 719           </section>
 720
 721           <section id="virtualshelves">
 722             <title>virtualshelves</title>
 723
 724             <para>Default: Allow</para>
 725
 726             <para>Asks: ___ staff and patrons to create and view saved lists
 727             of books.</para>
 728
 729             <para>Values:</para>
 730
 731             <itemizedlist>
 732               <listitem>
 733                 <para>Allow</para>
 734               </listitem>
 735
 736               <listitem>
 737                 <para>Don't Allow</para>
 738               </listitem>
 739             </itemizedlist>
 740
 741             <para>Description:</para>
 742
 743             <itemizedlist>
 744               <listitem>
 745                 <para>This preference controls whether the lists functionality
 746                 will be available in the staff client and OPAC. If this is set
 747                 to "Don't allow" then no one will be able to save items to
 748                 public or private lists.</para>
 749               </listitem>
 750             </itemizedlist>
 751           </section>
 752         </section>
 753
 754         <section id="adminprefslogin">
 755           <title>Login options</title>
 756
 757           <para>These preferences are related to logging into your Koha
 758           system</para>
 759
 760           <section id="AutoLocation">
 761             <title>AutoLocation</title>
 762
 763             <para>Default: Don't require</para>
 764
 765             <para>Asks: ___ staff to log in from a computer in the IP address
 766             range specified by their library (if any).</para>
 767
 768             <itemizedlist>
 769               <listitem>
 770                 <para>Set IP address range in the library administration
 771                 area</para>
 772
 773                 <itemizedlist>
 774                   <listitem>
 775                     <para><emphasis>Get there:</emphasis> More &gt;
 776                     Administration &gt; Basic Parameters &gt; <link linkend="libsgroups">Libraries &amp; Groups</link></para>
 777                   </listitem>
 778                 </itemizedlist>
 779               </listitem>
 780             </itemizedlist>
 781
 782             <para>Values:</para>
 783
 784             <itemizedlist>
 785               <listitem>
 786                 <para>Don't require</para>
 787               </listitem>
 788
 789               <listitem>
 790                 <para>Require</para>
 791               </listitem>
 792             </itemizedlist>
 793
 794             <para>Description:</para>
 795
 796             <itemizedlist>
 797               <listitem>
 798                 <para>This preference protects the system by blocking
 799                 unauthorized users from accessing the staff client program and
 800                 settings. Authorized and unauthorized users are determined by
 801                 their computer's IP addresses. When the preference is set to
 802                 'Require', IP authorization is in effect and unauthorized IP
 803                 addresses will be blocked. This means that staff cannot work
 804                 from home unless their IP address has been authorized. When
 805                 set to 'Don't require', anyone with a staff client login will
 806                 have access no matter which IP address they are using.</para>
 807               </listitem>
 808             </itemizedlist>
 809           </section>
 810
 811           <section id="IndependentBranches">
 812             <title>IndependentBranches</title>
 813             <para>Default: Don't prevent</para>
 814             <para>Asks: ___ staff (but not superlibrarians) from modifying objects (holds, items,
 815               patrons, etc.) belonging to other libraries.</para>
 816             <para>Values:</para>
 817             <itemizedlist>
 818               <listitem>
 819                 <para>Don't prevent</para>
 820               </listitem>
 821               <listitem>
 822                 <para>Prevent</para>
 823               </listitem>
 824             </itemizedlist>
 825             <para>Description:</para>
 826             <itemizedlist>
 827               <listitem>
 828                 <para>This preference should only be used by library systems which are sharing a
 829                   single Koha installation among multiple branches but are considered independent
 830                   organizations, meaning they do not share material or patrons with other branches
 831                   and do not plan to change that in the future. If set to 'Prevent' it increases the
 832                   security between library branches by: prohibiting staff users from logging into
 833                   another branch from within the staff client, filtering out patrons from patron
 834                   searches who are not a part of the login branch conducting the search, limiting
 835                   the location choices to the login branch when adding or modifying an item record,
 836                   preventing users from other branch locations from placing holds or checking out
 837                   materials from library branches other than their own, and preventing staff from
 838                   editing item records which belong to other library branches. All of these security
 839                   safeguards can be overridden only by the superlibrarian, the highest level of
 840                   privileges.</para>
 841               </listitem>
 842             </itemizedlist>
 843             <important>
 844               <para>It is important that this value be set before going live and that it NOT be
 845                 changed</para>
 846             </important>
 847           </section>
 848           <section id="SessionRestrictionByIP">
 849             <title>SessionRestrictionByIP</title>
 850             <para>Default: Enable</para>
 851             <para>Asks: ___ check for change in remote IP address for session security. Disable only
 852               when remote IP address changes frequently. </para>
 853             <para>Values:<itemizedlist>
 854                 <listitem>
 855                   <para>Disable</para>
 856                 </listitem>
 857                 <listitem>
 858                   <para>Enable</para>
 859                 </listitem>
 860               </itemizedlist></para>
 861             <para>Description:<itemizedlist>
 862                 <listitem>
 863                   <para>When this preference is set to 'Enable' Koha will log you out of the staff
 864                     client if your IP address changes as a security measure.  For some systems the
 865                     IP address changes frequently so you'll want to set this preference to 'Disable'
 866                     to prevent Koha from logging you out of the staff client every time that
 867                     happens.</para>
 868                 </listitem>
 869               </itemizedlist></para>
 870             <important>
 871               <para>This is meant to help those whose IP address changes several times during the
 872                 day, setting this preference to 'Disable' is not recommended otherwise because it is
 873                 removing important security features from your staff client.</para>
 874             </important>
 875           </section>
 876
 877           <section id="SessionStorage">
 878             <title>SessionStorage</title>
 879
 880             <para>Default: in the MySQL database</para>
 881
 882             <para>Asks: Store login session information ___</para>
 883
 884             <para>Values:</para>
 885
 886             <itemizedlist>
 887               <listitem>
 888                 <para>as temporary files</para>
 889               </listitem>
 890
 891               <listitem>
 892                 <para>in the MySQL database</para>
 893               </listitem>
 894
 895               <listitem>
 896                 <para>in the PostgreSQL database</para>
 897
 898                 <itemizedlist>
 899                   <listitem>
 900                     <important>
 901                       <para>PostgreSQL is not yet supported</para>
 902                     </important>
 903                   </listitem>
 904                 </itemizedlist>
 905               </listitem>
 906             </itemizedlist>
 907
 908             <para>Description:</para>
 909
 910             <itemizedlist>
 911               <listitem>
 912                 <para>This preference allows administrators to choose what
 913                 format session data is stored in during web sessions.</para>
 914               </listitem>
 915             </itemizedlist>
 916           </section>
 917
 918           <section id="timeout">
 919             <title>timeout</title>
 920
 921             <para>Default: 12000000</para>
 922
 923             <para>Asks: Automatically log out users after ___ seconds of inactivity.</para>
 924
 925             <para>Description:</para>
 926
 927             <itemizedlist>
 928               <listitem>
 929                 <para>This preference sets the length of time the Staff Client
 930                 or OPAC accounts can be left inactive before re-logging in is
 931                 necessary. The value of this preference is in seconds. At this
 932                 time, the amount of time before a session times out must be
 933                 the same for both the Staff Client and the OPAC.</para>
 934               </listitem>
 935             </itemizedlist>
 936           </section>
 937         </section>
 938         <section id="mozillapersona">
 939           <title>Mozilla Persona</title>
 940           <section id="persona">
 941             <title>Persona</title>
 942             <para>Default: Don't allow</para>
 943             <para>Asks: ___  Mozilla persona for login.</para>
 944             <para>Values:</para>
 945             <itemizedlist>
 946                 <listitem>
 947                   <para>Allow</para>
 948                   <screenshot>
 949                       <screeninfo>Persona login on OPAC</screeninfo>
 950                       <mediaobject>
 951                         <imageobject>
 952                           <imagedata fileref="images/admin/globalprefs/persona.png"/>
 953                         </imageobject>
 954                       </mediaobject>
 955                     </screenshot>
 956                 </listitem>
 957                 <listitem>
 958                   <para>Don't allow</para>
 959                 </listitem>
 960               </itemizedlist>
 961             <para>Description:<itemizedlist>
 962                 <listitem>
 963                   <para>Mozilla Persona is an OpenID-like service that lets you log in to multiple
 964                     websites with your Mozilla credentials.  If you allow Persona log in for Koha
 965                     then your patrons can log in to the OPAC using their Mozilla Persona.  Learn
 966                     more about Persona on the <ulink url="http://www.mozilla.org/en-US/persona/">official Mozilla site</ulink>.<important>
 967                       <para>For Persona log in to work you will need you <link linkend="OPACBaseURL">OPACBaseURL</link> preference to be set correctly.</para>
 968                     </important></para>
 969                 </listitem>
 970               </itemizedlist></para>
 971           </section>
 972         </section>
 973         <section id="heaprefs">
 974           <title>Share anonymous usage statistics</title>
 975           <para>As an open source project Koha is used all over the world. These preference will
 976             help us keep more accurate statistics on where Koha is being used. If you choose to
 977             share your information, it will be published on the <ulink
 978               url="http://hea.koha-community.org">Hea Koha community website</ulink>. You will need
 979             to enable the <link linkend="usagecron">matching cron job</link> to send this
 980             information at regular intervals to the community.</para>
 981           <section id="UsageStats">
 982             <title>UsageStats</title>
 983             <para>Default: Don't share</para>
 984             <para>Asks: ___  anonymous Koha usage data with the Koha community.</para>
 985             <para>Values:<itemizedlist>
 986                 <listitem>
 987                   <para>Don't share</para>
 988                 </listitem>
 989                 <listitem>
 990                   <para>Share</para>
 991                 </listitem>
 992               </itemizedlist></para>
 993             <para>Description:<itemizedlist>
 994                 <listitem>
 995                   <para>This data is stored to help track usage of Koha around the world. If you
 996                     choose to share your information, it will be published on the <ulink
 997                       url="http://hea.koha-community.org">Hea Koha community website</ulink>. This
 998                     information is sent using the <link linkend="usagecron">Usage Sharing Cron
 999                       Job</link>.</para>
1000                 </listitem>
1001               </itemizedlist></para>
1002           </section>
1003           <section id="UsageStatsCountry">
1004             <title>UsageStatsCountry</title>
1005             <para>Asks: The country where your library is located: ___</para>
1006             <para>Description:<itemizedlist>
1007                 <listitem>
1008                   <para>This data is stored to help track usage of Koha around the world. If you
1009                     choose to share your information, it will be published on the <ulink
1010                       url="http://hea.koha-community.org">Hea Koha community website</ulink>. This
1011                     information is sent using the <link linkend="usagecron">Usage Sharing Cron
1012                       Job</link>.</para>
1013                 </listitem>
1014               </itemizedlist></para>
1015             <important>
1016               <para>This preference depends on the <link linkend="UsageStats">UsageStats</link>
1017                 preference. Set that to 'Share' to share your information.</para>
1018             </important>
1019           </section>
1020           <section id="UsageStatsLibraryName">
1021             <title>UsageStatsLibraryName</title>
1022             <para>Asks: The library name ___ will be shown on the <ulink
1023                 url="http://hea.koha-community.org">Hea Koha community website</ulink>.</para>
1024             <para>Description:<itemizedlist>
1025                 <listitem>
1026                   <para>This data is stored to help track usage of Koha around the world. If you
1027                     choose to share your information, it will be published on the <ulink
1028                       url="http://hea.koha-community.org">Hea Koha community website</ulink>. This
1029                     information is sent using the <link linkend="usagecron">Usage Sharing Cron
1030                       Job</link>.</para>
1031                 </listitem>
1032               </itemizedlist></para>
1033             <important>
1034               <para>This preference depends on the <link linkend="UsageStats">UsageStats</link>
1035                 preference. Set that to 'Share' to share your information. If this field is empty
1036                 data will be sent anonymously if you choose 'Share' for the <link
1037                   linkend="UsageStats">UsageStats</link> preference. </para>
1038             </important>
1039           </section>
1040           <section id="UsageStatsLibraryType">
1041             <title>UsageStatsLibraryType</title>
1042             <para>Default: public</para>
1043             <para>Asks: The library type ___ will be shown on the <ulink
1044                 url="http://hea.koha-community.org">Hea Koha community website</ulink>.</para>
1045             <para>Values:<itemizedlist>
1046                 <listitem>
1047                   <para>academic </para>
1048                 </listitem>
1049                 <listitem>
1050                   <para>corporate </para>
1051                 </listitem>
1052                 <listitem>
1053                   <para>government </para>
1054                 </listitem>
1055                 <listitem>
1056                   <para>private </para>
1057                 </listitem>
1058                 <listitem>
1059                   <para>public </para>
1060                 </listitem>
1061                 <listitem>
1062                   <para>religious organization </para>
1063                 </listitem>
1064                 <listitem>
1065                   <para>research </para>
1066                 </listitem>
1067                 <listitem>
1068                   <para>school </para>
1069                 </listitem>
1070                 <listitem>
1071                   <para>society or association </para>
1072                 </listitem>
1073                 <listitem>
1074                   <para>subscription</para>
1075                 </listitem>
1076               </itemizedlist></para>
1077             <para>Description:<itemizedlist>
1078                 <listitem>
1079                   <para>This data is stored to help track usage of Koha around the world. If you
1080                     choose to share your information, it will be published on the <ulink
1081                       url="http://hea.koha-community.org">Hea Koha community website</ulink>. This
1082                     information is sent using the <link linkend="usagecron">Usage Sharing Cron
1083                       Job</link>.</para>
1084                 </listitem>
1085               </itemizedlist></para>
1086             <important>
1087               <para>This preference depends on the <link linkend="UsageStats">UsageStats</link>
1088                 preference. Set that to 'Share' to share your information. </para>
1089             </important>
1090           </section>
1091           <section id="UsageStatsLibraryUrl">
1092             <title>UsageStatsLibraryUrl</title>
1093             <para>Asks: The library URL ___ will be shown on the <ulink
1094                 url="http://hea.koha-community.org">Hea Koha community website</ulink>.</para>
1095             <para>Description:<itemizedlist>
1096                 <listitem>
1097                   <para>This data is stored to help track usage of Koha around the world. If you
1098                     choose to share your information, it will be published on the <ulink
1099                       url="http://hea.koha-community.org">Hea Koha community website</ulink>. This
1100                     information is sent using the <link linkend="usagecron">Usage Sharing Cron
1101                       Job</link>.</para>
1102                 </listitem>
1103               </itemizedlist></para>
1104             <important>
1105               <para>This preference depends on the <link linkend="UsageStats">UsageStats</link>
1106                 preference. Set that to 'Share' to share your information. </para>
1107             </important>
1108           </section>
1109         </section>
1110       </section>
1111
1112       <section id="authprefs">
1113         <title>Authorities</title>
1114
1115         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
1116         Global System Preferences &gt; Authorities</para>
1117
1118         <section id="generalauthorities">
1119           <title>General</title>
1120
1121           <section id="AuthDisplayHierarchy">
1122             <title>AuthDisplayHierarchy</title>
1123
1124             <para>Default: Don't display</para>
1125
1126             <para>Asks: ___ broader term/narrower term hierarchies when
1127             viewing authorities.</para>
1128
1129             <para>Values:</para>
1130
1131             <itemizedlist>
1132               <listitem>
1133                 <para>Display</para>
1134
1135                 <screenshot>
1136                   <screeninfo>AuthDisplayHierarchy</screeninfo>
1137
1138                   <mediaobject>
1139                     <imageobject>
1140                       <imagedata fileref="images/admin/globalprefs/AuthDisplayHierarchy.png"/>
1141                     </imageobject>
1142                   </mediaobject>
1143                 </screenshot>
1144               </listitem>
1145
1146               <listitem>
1147                 <para>Don't display</para>
1148               </listitem>
1149             </itemizedlist>
1150
1151             <para>Description:</para>
1152
1153             <itemizedlist>
1154               <listitem>
1155                 <para>If your authority records includes 5xx fields with
1156                 linked references to broader and/or narrower see also
1157                 references this preference will turn on a display of those
1158                 authorities at the top of the record.</para>
1159               </listitem>
1160             </itemizedlist>
1161           </section>
1162
1163           <section id="AutoCreateAuthorities">
1164             <title>AutoCreateAuthorities</title>
1165
1166             <para>Default: do not generate</para>
1167
1168             <para>Asks: When editing records, ___ authority records that are
1169             missing.</para>
1170
1171             <para>Values:</para>
1172
1173             <itemizedlist>
1174               <listitem>
1175                 <para>do not generate</para>
1176               </listitem>
1177
1178               <listitem>
1179                 <para>generate</para>
1180               </listitem>
1181             </itemizedlist>
1182
1183             <important>
1184               <para><link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
1185               must be set to "allow" for this to have any effect</para>
1186             </important>
1187
1188             <para>Description:</para>
1189
1190             <itemizedlist>
1191               <listitem>
1192                 <para>When this and <link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
1193                 are both turned on, automatically create authority records for
1194                 headings that don't have any authority link when cataloging.
1195                 When BiblioAddsAuthorities is on and AutoCreateAuthorities is
1196                 turned off, do not automatically generate authority records,
1197                 but allow the user to enter headings that don't match an
1198                 existing authority. When BiblioAddsAuthorities is off, this
1199                 has no effect.</para>
1200               </listitem>
1201             </itemizedlist>
1202           </section>
1203
1204           <section id="BiblioAddsAuthorities">
1205             <title>BiblioAddsAuthorities</title>
1206
1207             <para>Default: allow</para>
1208
1209             <para>Asks: When editing records, ___ them to automatically create
1210             new authority records if needed, rather than having to reference
1211             existing authorities.</para>
1212
1213             <para>Values:</para>
1214
1215             <itemizedlist>
1216               <listitem>
1217                 <para>allow</para>
1218
1219                 <itemizedlist>
1220                   <listitem>
1221                     <para>This setting allows you to type values in the fields
1222                     controlled by authorities and then adds a new authority if
1223                     one does not exist</para>
1224                   </listitem>
1225                 </itemizedlist>
1226               </listitem>
1227
1228               <listitem>
1229                 <para>don't allow</para>
1230
1231                 <itemizedlist>
1232                   <listitem>
1233                     <para>This setting will lock the authority controlled
1234                     fields, forcing you to search for an authority versus
1235                     allowing you to type the information in yourself.</para>
1236                   </listitem>
1237                 </itemizedlist>
1238               </listitem>
1239             </itemizedlist>
1240           </section>
1241
1242           <section id="dontmerge">
1243             <title>dontmerge</title>
1244
1245             <para>Default: Don't</para>
1246
1247             <para>Asks: ___ automatically update attached biblios when
1248             changing an authority record.</para>
1249
1250             <para>Values:</para>
1251
1252             <itemizedlist>
1253               <listitem>
1254                 <para>Do</para>
1255               </listitem>
1256
1257               <listitem>
1258                 <para>Don't</para>
1259               </listitem>
1260             </itemizedlist>
1261
1262             <para>Description:</para>
1263
1264             <itemizedlist>
1265               <listitem>
1266                 <para>This preference tells Koha how to handle changes to your Authority records. If
1267                   you edit an authority record and this preference is set to 'Do' Koha will
1268                   immediately update all of the bib records linked to the authority with the new
1269                   authority record's data. If this is set to "Don't" then Koha won't edit bib
1270                   records when changes are made to authorities, rather, this is done later by the
1271                     <link linkend="mergeauthcron">merge_authority.pl cronjob</link>.</para>
1272               </listitem>
1273             </itemizedlist>
1274
1275             <important>
1276               <para>If this is set to "Don't automatically update" you will need to ask your
1277                 administrator to enable the <link linkend="mergeauthcron">merge_authority.pl
1278                   cronjob</link>.</para>
1279             </important>
1280           </section>
1281
1282           <section id="MARCAuthorityControlField008">
1283             <title>MARCAuthorityControlField008</title>
1284
1285             <para>Default: || aca||aabn | a|a d</para>
1286
1287             <para>Asks: Use the following text for the contents of MARC21 authority control field
1288               008 position 06-39 (fixed length data elements).</para>
1289
1290             <para><important>
1291                 <para>Do not include the date (position 00-05) in this
1292                 preference, Koha will calculate automatically and put that in
1293                 before the values in this preference.</para>
1294               </important>Description:</para>
1295
1296             <itemizedlist>
1297               <listitem>
1298                 <para>This preference controls the default value in the 008
1299                 field on Authority records. It does not effect bibliographic
1300                 records.</para>
1301               </listitem>
1302             </itemizedlist>
1303           </section>
1304           <section id="UNIMARCAuthorityField100">
1305             <title>UNIMARCAuthorityField100</title>
1306             <para>Default: afrey50      ba0</para>
1307             <para>Asks: Use the following text for the contents of UNIMARC authority field 100
1308               position (fixed length data elements). <important>
1309                 <para>Do not include the date (position 00-07) in this preference, Koha will
1310                   calculate automatically and put that in before the values in this
1311                   preference.</para>
1312               </important></para>
1313             <para>Description:<itemizedlist>
1314                 <listitem>
1315                   <para>This preference controls the default value in the 100 field on Authority
1316                     records cataloged in UNIMARC. It does not effect bibliographic records.</para>
1317                 </listitem>
1318               </itemizedlist></para>
1319           </section>
1320
1321           <section id="UseAuthoritiesForTracings">
1322             <title>UseAuthoritiesForTracings</title>
1323
1324             <para>Default: Don't use</para>
1325
1326             <para>Asks: ___ authority record numbers instead of text strings
1327             for searches from subject tracings.</para>
1328
1329             <para>Values:</para>
1330
1331             <itemizedlist>
1332               <listitem>
1333                 <para>Don't use</para>
1334
1335                 <itemizedlist>
1336                   <listitem>
1337                     <para>Search links look for subject/author keywords
1338                     (example: opac-search.pl?q=su:Business%20networks)</para>
1339                   </listitem>
1340                 </itemizedlist>
1341               </listitem>
1342
1343               <listitem>
1344                 <para>Use</para>
1345
1346                 <itemizedlist>
1347                   <listitem>
1348                     <para>Search links look for an authority record (example:
1349                     opac-search.pl?q=an:354)</para>
1350                   </listitem>
1351                 </itemizedlist>
1352               </listitem>
1353             </itemizedlist>
1354
1355             <para>Description:</para>
1356
1357             <itemizedlist>
1358               <listitem>
1359                 <para>For libraries that have authority files, they may want
1360                 to make it so that when a link to an authorized subject or
1361                 author is clicked on the OPAC or staff client it takes the
1362                 searcher only to a list of results with that authority record.
1363                 Most libraries do not have complete authority files and so
1364                 setting this preference to 'Don't use' will allow searchers to
1365                 click on links to authors and subject headings and perform a
1366                 keyword search against those fields, finding all possible
1367                 relevant results instead.</para>
1368               </listitem>
1369             </itemizedlist>
1370           </section>
1371         </section>
1372
1373         <section id="linkerauthorities">
1374           <title>Linker</title>
1375
1376           <para>These preferences will control how Koha links bibliographic records to authority
1377             records. All bibliographic records added to Koha after these preferences are set will
1378             link automatically to authority records, for records added before these preferences are
1379             set there is a script (misc/link_bibs_to_authorities.pl) that your system administrator
1380             can run to link records together.</para>
1381
1382           <section id="CatalogModuleRelink">
1383             <title>CatalogModuleRelink</title>
1384
1385             <para>Default: Do not</para>
1386
1387             <para>Asks: ___ automatically relink headings that have previously
1388             been linked when saving records in the cataloging module.</para>
1389
1390             <para>Values:</para>
1391
1392             <itemizedlist>
1393               <listitem>
1394                 <para>Do</para>
1395               </listitem>
1396
1397               <listitem>
1398                 <para>Do not</para>
1399               </listitem>
1400             </itemizedlist>
1401
1402             <para>Description:</para>
1403
1404             <itemizedlist>
1405               <listitem>
1406                 <para>Longtime users of Koha don't expect the authority and
1407                 bib records to link consistently. This preference makes it
1408                 possible to disable authority relinking in the cataloging
1409                 module only (i.e. relinking is still possible if
1410                 link_bibs_to_authorities.pl is run). Note that though the
1411                 default behavior matches the previous behavior of Koha
1412                 (retaining links to outdated authority records), it does not
1413                 match the intended behavior (updating biblio/authority link
1414                 after bibliographic record is edited). Libraries that want the
1415                 intended behavior of authority control rather than the way
1416                 Koha used to handle linking should set CatalogModuleRelink to
1417                 'Do'. Once setting this to 'Do' the following preferences can
1418                 also be set.</para>
1419               </listitem>
1420             </itemizedlist>
1421           </section>
1422
1423           <section id="LinkerKeepStale">
1424             <title>LinkerKeepStale</title>
1425
1426             <para>Default: Do not</para>
1427
1428             <para>Asks: ___ keep existing links to authority records for
1429             headings where the linker is unable to find a match.</para>
1430
1431             <para>Values:</para>
1432
1433             <itemizedlist>
1434               <listitem>
1435                 <para>Do</para>
1436               </listitem>
1437
1438               <listitem>
1439                 <para>Do not</para>
1440               </listitem>
1441             </itemizedlist>
1442
1443             <para>Description:</para>
1444
1445             <itemizedlist>
1446               <listitem>
1447                 <para>When set to 'Do', the linker will never remove a link to
1448                 an authority record, though, depending on the value of <link linkend="LinkerRelink">LinkerRelink</link>, it may change the
1449                 link.</para>
1450               </listitem>
1451             </itemizedlist>
1452           </section>
1453
1454           <section id="LinkerModule">
1455             <title>LinkerModule</title>
1456
1457             <para>Default: Default</para>
1458
1459             <para>Asks: Use the ___ linker module for matching headings to
1460             authority records.</para>
1461
1462             <para>Values:</para>
1463
1464             <itemizedlist>
1465               <listitem>
1466                 <para>Default</para>
1467
1468                 <itemizedlist>
1469                   <listitem>
1470                     <para>Retains Koha's previous behavior of only creating
1471                     links when there is an exact match to one and only one
1472                     authority record; if the <link linkend="LinkerOptions">LinkerOptions</link> preference is
1473                     set to 'broader_headings', it will try to link headings to
1474                     authority records for broader headings by removing
1475                     subfields from the end of the heading</para>
1476                   </listitem>
1477                 </itemizedlist>
1478               </listitem>
1479
1480               <listitem>
1481                 <para>First match</para>
1482
1483                 <itemizedlist>
1484                   <listitem>
1485                     <para>Creates a link to the first authority record that
1486                     matches a given heading, even if there is more than one
1487                     authority record that matches</para>
1488                   </listitem>
1489                 </itemizedlist>
1490               </listitem>
1491
1492               <listitem>
1493                 <para>Last match</para>
1494
1495                 <itemizedlist>
1496                   <listitem>
1497                     <para>Creates a link to the last authority record that
1498                     matches a given heading, even if there is more than one
1499                     record that matches</para>
1500                   </listitem>
1501                 </itemizedlist>
1502               </listitem>
1503             </itemizedlist>
1504
1505             <para>Description:</para>
1506
1507             <itemizedlist>
1508               <listitem>
1509                 <para>This preference tells Koha which match to use when
1510                 searching for authority matches when saving a record.</para>
1511               </listitem>
1512             </itemizedlist>
1513           </section>
1514
1515           <section id="LinkerOptions">
1516             <title>LinkerOptions</title>
1517
1518             <para>Asks: Set the following options for the authority linker
1519             ___<important>
1520                 <para>This feature is experimental and shouldn't be used in a
1521                 production environment until further expanded upon.</para>
1522               </important></para>
1523
1524             <para>Description:</para>
1525
1526             <itemizedlist>
1527               <listitem>
1528                 <para>This is a pipe separated (|) list of options. At the
1529                 moment, the only option available is "broader_headings." With
1530                 this option set to "broader_headings", the linker will try to
1531                 match the following heading as follows:<programlisting>=600 10$aCamins-Esakov, Jared$xCoin collections$vCatalogs$vEarly works to 1800.</programlisting></para>
1532
1533                 <para>First: Camins-Esakov, Jared--Coin
1534                 collections--Catalogs--Early works to 1800</para>
1535
1536                 <para>Next: Camins-Esakov, Jared--Coin
1537                 collections--Catalogs</para>
1538
1539                 <para>Next: Camins-Esakov, Jared--Coin collections</para>
1540
1541                 <para>Next: Camins-Esakov, Jared (matches! if a previous
1542                 attempt had matched, it would not have tried this)</para>
1543               </listitem>
1544             </itemizedlist>
1545           </section>
1546
1547           <section id="LinkerRelink">
1548             <title>LinkerRelink</title>
1549
1550             <para>Default: Do</para>
1551
1552             <para>Asks: ___ relink headings that have previously been linked
1553             to authority records.</para>
1554
1555             <para>Values:</para>
1556
1557             <itemizedlist>
1558               <listitem>
1559                 <para>Do</para>
1560               </listitem>
1561
1562               <listitem>
1563                 <para>Do not</para>
1564               </listitem>
1565             </itemizedlist>
1566
1567             <para>Description:</para>
1568
1569             <itemizedlist>
1570               <listitem>
1571                 <para>When set to 'Do', the linker will confirm the links for
1572                 headings that have previously been linked to an authority
1573                 record when it runs, correcting any incorrect links it may
1574                 find. When set to 'Do not', any heading with an existing link
1575                 will be ignored, even if the existing link is invalid or
1576                 incorrect.</para>
1577               </listitem>
1578             </itemizedlist>
1579           </section>
1580         </section>
1581       </section>
1582
1583       <section id="catprefs">
1584         <title>Cataloging</title>
1585
1586         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
1587         Global System Preferences &gt; Cataloging</para>
1588
1589         <section id="catdisplayprefs">
1590           <title>Display</title>
1591
1592           <para/>
1593           <section id="AcquisitionDetails">
1594             <title>AcquisitionDetails</title>
1595             <para>Default: Display</para>
1596             <para>Asks: ___ acquisition details on the biblio detail page. </para>
1597             <para>Values:<itemizedlist>
1598                 <listitem>
1599                   <para>Display</para>
1600                 </listitem>
1601                 <listitem>
1602                   <para>Don't display</para>
1603                 </listitem>
1604               </itemizedlist></para>
1605             <para>Description:<itemizedlist>
1606                 <listitem>
1607                   <para>This preference controls whether a tab will show on the detail page in the
1608                     staff client that includes detailed acquisitions information for the title. This
1609                     tab will include links to order information stored in the acquisitions module.<screenshot>
1610                       <screeninfo>AcquisitionDetails</screeninfo>
1611                       <mediaobject>
1612                         <imageobject>
1613                           <imagedata fileref="images/admin/globalprefs/AcquisitionDetails.png"/>
1614                         </imageobject>
1615                       </mediaobject>
1616                     </screenshot></para>
1617                 </listitem>
1618               </itemizedlist></para>
1619           </section>
1620
1621           <section id="authoritysep">
1622             <title>AuthoritySeparator</title>
1623
1624             <para>Default: --</para>
1625
1626             <para>Asks: Separate multiple displayed authors, series or
1627             subjects with ___.</para>
1628           </section>
1629
1630           <section id="hide_marc">
1631             <title>hide_marc</title>
1632
1633             <para>Default: Display</para>
1634
1635             <para>Asks: ___ MARC tag numbers, subfield codes and indicators in
1636             MARC views.</para>
1637
1638             <para>Values:</para>
1639
1640             <itemizedlist>
1641               <listitem>
1642                 <para>Display -- shows the tag numbers on the cataloging
1643                 interface</para>
1644
1645                 <screenshot>
1646                   <screeninfo>MARC editor with tags showing</screeninfo>
1647
1648                   <mediaobject>
1649                     <imageobject>
1650                       <imagedata fileref="images/admin/globalprefs/hide_marc-display.png"/>
1651                     </imageobject>
1652                   </mediaobject>
1653                 </screenshot>
1654               </listitem>
1655
1656               <listitem>
1657                 <para>Don't display -- shows just descriptive text when
1658                 cataloging</para>
1659
1660                 <screenshot>
1661                   <screeninfo>MARC editor without tags showing</screeninfo>
1662
1663                   <mediaobject>
1664                     <imageobject>
1665                       <imagedata fileref="images/admin/globalprefs/hide_marc-dont.png"/>
1666                     </imageobject>
1667                   </mediaobject>
1668                 </screenshot>
1669               </listitem>
1670             </itemizedlist>
1671           </section>
1672
1673           <section id="IntranetBiblioDefaultView">
1674             <title>IntranetBiblioDefaultView</title>
1675
1676             <para>Default: ISBD form</para>
1677
1678             <para>Asks: By default, display biblio records in ___</para>
1679
1680             <para>Values:</para>
1681
1682             <itemizedlist>
1683               <listitem>
1684                 <para>ISBD form -- displays records in the staff client in the
1685                 old card catalog format</para>
1686
1687                 <itemizedlist>
1688                   <listitem>
1689                     <para>See <link linkend="isbdpref">ISBD</link> preference
1690                     for more information</para>
1691                   </listitem>
1692                 </itemizedlist>
1693               </listitem>
1694
1695               <listitem>
1696                 <para>Labelled MARC form -- displays records in the staff
1697                 client in MARC with text labels to explain the different
1698                 fields</para>
1699               </listitem>
1700
1701               <listitem>
1702                 <para>MARC form -- displays records in the staff client in
1703                 MARC</para>
1704               </listitem>
1705
1706               <listitem>
1707                 <para>normal form -- visual display in the staff client (for
1708                 the average person)</para>
1709               </listitem>
1710             </itemizedlist>
1711
1712             <para>Description:</para>
1713
1714             <itemizedlist>
1715               <listitem>
1716                 <para>This setting determines the bibliographic record display
1717                 when searching the catalog on the staff client. This setting
1718                 does not affect the display in the OPAC which is changed using
1719                 the <link linkend="BiblioDefaultView">BiblioDefaultView</link>
1720                 preference under the OPAC preference tab. This setting changes
1721                 the look of the record when first displayed. The MARC and ISBD
1722                 views can still be seen by clicking in the sidebar.</para>
1723               </listitem>
1724             </itemizedlist>
1725           </section>
1726
1727           <section id="isbdpref">
1728             <title>ISBD</title>
1729
1730             <para>Default: <link linkend="isbddefault">MARC21 Default
1731             Appendix</link> or <link linkend="unimarcdefault">UNIMARC Default
1732             Appendix</link></para>
1733
1734             <para>Asks: Use the following as the ISBD template:</para>
1735
1736             <para>Description:</para>
1737
1738             <itemizedlist>
1739               <listitem>
1740                 <para>This determines how the ISBD information will display.
1741                 Elements in the list can be reordered to produce a different
1742                 ISBD view. ISBD, the International Standard Bibliographic
1743                 Description, was first introduced by IFLA (International
1744                 Federation of Library Associations) in 1969 in order to
1745                 provide guidelines for descriptive cataloging. The purpose of
1746                 ISBD is to aid the international exchange of bibliographic
1747                 records for a variety of materials.</para>
1748               </listitem>
1749             </itemizedlist>
1750           </section>
1751
1752           <section id="LabelMARCView">
1753             <title>LabelMARCView</title>
1754
1755             <para>Default: Don't</para>
1756
1757             <para>Asks: ___ collapse repeated tags of the same type into one
1758             tag entry.</para>
1759
1760             <para>Values:</para>
1761
1762             <itemizedlist>
1763               <listitem>
1764                 <para>Do -- will combine all identical tag numbers under one
1765                 heading in the MARC view in the OPAC and Staff Client</para>
1766
1767                 <screenshot>
1768                   <screeninfo>MARC View in the Staff Client with LabelMARCView
1769                   set to Do</screeninfo>
1770
1771                   <mediaobject>
1772                     <imageobject>
1773                       <imagedata fileref="images/admin/globalprefs/LabelMARCView-do.png"/>
1774                     </imageobject>
1775                   </mediaobject>
1776                 </screenshot>
1777               </listitem>
1778
1779               <listitem>
1780                 <para>Don't -- will list all of the tags individually in the
1781                 MARC view in the OPAC and Staff Client</para>
1782
1783                 <screenshot>
1784                   <screeninfo>MARC View in the Staff Client with LabelMARCView
1785                   set to Don't</screeninfo>
1786
1787                   <mediaobject>
1788                     <imageobject>
1789                       <imagedata fileref="images/admin/globalprefs/LabelMARCView-dont.png"/>
1790                     </imageobject>
1791                   </mediaobject>
1792                 </screenshot>
1793               </listitem>
1794             </itemizedlist>
1795           </section>
1796           <section id="NotesBlacklist">
1797             <title>NotesBlacklist</title>
1798             <para>Asks: Don't show these ___ note fields in title notes separator (OPAC record
1799               details) and in the description separator (Staff client record details). </para>
1800             <para>Description:<itemizedlist>
1801                 <listitem>
1802                   <para>This preference lets you define which of your note fields are hidden from
1803                     the title notes (OPAC) and descriptions (Staff) tabs.  Enter the values as a
1804                     comma separated list. For example to hide the local note and the bibliography
1805                     note in MARC21 enter 504, 590.</para>
1806                 </listitem>
1807               </itemizedlist></para>
1808           </section>
1809
1810           <section id="OpacSuppression">
1811             <title>OpacSuppression, OpacSuppressionByIPRange, OpacSuppressionRedirect, and
1812               OpacSuppressionMessage</title>
1813             <para>OpacSuppression Default: Don't hide</para>
1814
1815             <para>Asks:  ___ items marked as suppressed from OPAC search results. Note that you must
1816               have the Suppress index set up in Zebra and at least one suppressed item, or your
1817               searches will be broken. Restrict the suppression to IP adresses outside of the IP
1818               range ___ (Leave blank if not used. Define a range like 192.168..) Redirect the opac
1819               detail page for suppressed records to ___ Display the following message on the
1820               redirect page for suppressed biblios ___.</para>
1821
1822             <para>OpacSuppression Values:</para>
1823
1824             <itemizedlist>
1825               <listitem>
1826                 <para>Don't hide</para>
1827
1828                 <itemizedlist>
1829                   <listitem>
1830                     <para>Will show records in OPAC search results if they are marked
1831                       suppressed</para>
1832                   </listitem>
1833                 </itemizedlist>
1834               </listitem>
1835
1836               <listitem>
1837                 <para>Hide</para>
1838
1839                 <itemizedlist>
1840                   <listitem>
1841                     <para>Will not show records in OPAC search results if they're marked as
1842                       suppressed</para>
1843                   </listitem>
1844                 </itemizedlist>
1845               </listitem>
1846             </itemizedlist>
1847             <para>OpacSuppressionRedirect Values:<itemizedlist>
1848                 <listitem>
1849                   <para>an explanatory page ('This record is blocked').</para>
1850                 </listitem>
1851                 <listitem>
1852                   <para>the 404 error page ('Not found').</para>
1853                 </listitem>
1854               </itemizedlist></para>
1855
1856             <para>Description:</para>
1857
1858             <itemizedlist>
1859               <listitem>
1860                 <para>These preferences control hiding of bibliographic records from display in the
1861                   OPAC. Each bibliogrphic record you want to hide from the OPAC simply needs to have
1862                   the value "1" in the field mapped with Suppress index (942$n field in MARC21, no
1863                   official field in UNIMARC). The indexer then hides it from display in OPAC but
1864                   will still display it in the Staff Client. If you want to further control
1865                   suppression you can set an IP address range to still show suppressed items to.
1866                   Define a range like 192.168.. If you don't want to limit suppression in this way,
1867                   leave the IP field blank. You can also decide what the patrons will see in the
1868                   OPAC when a title is suppressed by setting the OpacSuppressionRedirect and
1869                   OpacSuppressionMessage preferences.  You can either show the patron a 404 page if
1870                   they try to see a suppressed record or you can create a custom page by entering
1871                   the HTML in the OpacSuppressionMessage part of this preference.</para>
1872                 <para>
1873                   <note>
1874                     <para>An <link linkend="authorizedvalues">authorized value</link> for the MARC21
1875                       942$n field (or the equivalent UNIMARC field) should be set to eliminate
1876                       errors. One example would be to create an authorized value titled SUPPRESS
1877                       with a value of 0 for don't suppress and 1 for suppress.</para>
1878                   </note>
1879                 </para>
1880               </listitem>
1881             </itemizedlist>
1882
1883             <important>
1884               <para>If this preference is set to 'hide' and you have the 942n
1885               field set to 1, it will hide the entire bib record - not just an
1886               individual item.</para>
1887             </important>
1888
1889             <important>
1890               <para>You must have the Suppress index set up in Zebra and at least one record with
1891                 the value "1" in the field mapped with this index, or your searches will be
1892                 completely broken in OPAC (you won't get any results at all).</para>
1893             </important>
1894           </section>
1895           <section id="SeparateHoldings">
1896             <title>SeparateHoldings &amp; SeparateHoldingsBranch </title>
1897             <para>SeparateHoldings default: Don't separate</para>
1898             <para>SeparateHoldingsBranch default: home library </para>
1899             <para>Asks:  ___ items display into two tabs, where the first tab contains items whose
1900               ___ is the logged in user's library. The second tab will contain all other items. </para>
1901             <para>SeparateHoldings values:<itemizedlist>
1902                 <listitem>
1903                   <para>Don't separate</para>
1904                 </listitem>
1905                 <listitem>
1906                   <para>Separate</para>
1907                 </listitem>
1908               </itemizedlist></para>
1909             <para>SeparateHoldingsBranch values:<itemizedlist>
1910                 <listitem>
1911                   <para>holding library</para>
1912                 </listitem>
1913                 <listitem>
1914                   <para>home library</para>
1915                 </listitem>
1916               </itemizedlist></para>
1917             <para>Description:</para>
1918             <itemizedlist>
1919                 <listitem>
1920                   <para>This preference lets you decide if you would like to have the holding
1921                     information on the bibliographic detail page in the staff client split in to
1922                     multiple tabs.  The default is to show all holdings on one tab.</para>
1923                   <screenshot>
1924                       <screeninfo>Separate holdings tabs</screeninfo>
1925                       <mediaobject>
1926                         <imageobject>
1927                           <imagedata fileref="images/admin/globalprefs/SeparateHoldings.png"/>
1928                         </imageobject>
1929                       </mediaobject>
1930                     </screenshot>
1931                 </listitem>
1932               </itemizedlist>
1933           </section>
1934
1935           <section id="URLLinkText">
1936             <title>URLLinkText</title>
1937
1938             <para>Default: Online Resource</para>
1939
1940             <para>Asks: Show ___ as the text of links embedded in MARC
1941             records.</para>
1942
1943             <para>Description:</para>
1944
1945             <itemizedlist>
1946               <listitem>
1947                 <para>If the 856 field does not have a subfield 3 or y
1948                 defined, the OPAC will say 'Click here to access online.' If
1949                 you would like the field to say something else enter that in
1950                 this field.</para>
1951               </listitem>
1952             </itemizedlist>
1953           </section>
1954
1955           <section id="UseControlNumber">
1956             <title>UseControlNumber</title>
1957
1958             <para>Default: Don't use</para>
1959
1960             <para>Asks: ___ record control number ($w subfields) and control
1961             number (001) for linking of bibliographic records.</para>
1962
1963             <para>Values:</para>
1964
1965             <itemizedlist>
1966               <listitem>
1967                 <para>Don't use</para>
1968
1969                 <itemizedlist>
1970                   <listitem>
1971                     <para>When clicking on links to titles that appear next to
1972                     'Continues' and 'Continued by' in the detail display Koha
1973                     will perform a title search</para>
1974                   </listitem>
1975                 </itemizedlist>
1976               </listitem>
1977
1978               <listitem>
1979                 <para>Use</para>
1980
1981                 <itemizedlist>
1982                   <listitem>
1983                     <para>When clicking on links to titles that appear next to
1984                     'Continues' and 'Continued by' in the detail display Koha
1985                     will perform a control number (MARC field 001)
1986                     search</para>
1987                   </listitem>
1988                 </itemizedlist>
1989               </listitem>
1990             </itemizedlist>
1991
1992             <important>
1993               <para>Unless you are going in and manually changing 773$w to
1994               match your rigorously-defined bibliographic relationships, you
1995               should set this preference to "Don't use" and instead set <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> to
1996               "Display"</para>
1997             </important>
1998
1999             <para>Description:</para>
2000
2001             <itemizedlist>
2002               <listitem>
2003                 <para>If you have a serial called "Journal of Interesting
2004                 Things" which has a separate record from when it was called
2005                 "Transactions of the Interesting Stuff Society," you could add
2006                 linking fields to indicate the relationship between the two
2007                 records. UseControlNumber allows you to use your local
2008                 accession numbers for those links. In MARC21, the relevant
2009                 sections of the two records might look like
2010                 this:<programlisting>    =001    12345
2011     =110  2_$aInteresting Stuff Society.
2012     =245  10$aTransactions of the Interesting Stuff Society.
2013     =785  00$aInteresting Stuff Society$tJournal of Interesting Things.$w12346
2014
2015     =001    12346
2016     =110  2_$aInteresting Stuff Society.
2017     =245  10$aJournal of Interesting Things.
2018     =780  00$aInteresting Stuff Society$tTransactions of the Interesting Stuff Society.$w12345</programlisting></para>
2019
2020                 <para>With UseControlNumber set to 'Use', the 78x links will
2021                 use the Control Numbers is subfield $w, instead of doing a
2022                 title search on "Journal of Interesting Things" and
2023                 "Transactions of the Interesting Stuff Society"
2024                 respectively.</para>
2025               </listitem>
2026             </itemizedlist>
2027           </section>
2028         </section>
2029         <section id="catimportprefs">
2030           <title>Importing</title>
2031           <section id="AggressiveMatchOnISBN">
2032             <title>AggressiveMatchOnISBN</title>
2033             <para>Default: don't</para>
2034             <para>Asks: When matching on ISBN with the record import tool, ___ attempt to match
2035               aggressively by trying all variations of the ISBNs in the imported record as a phrase
2036               in the ISBN fields of already cataloged records. </para>
2037             <para>Values:<itemizedlist>
2038                 <listitem>
2039                   <para>do</para>
2040                 </listitem>
2041                 <listitem>
2042                   <para>don't</para>
2043                 </listitem>
2044               </itemizedlist>Description:<itemizedlist>
2045                 <listitem>
2046                   <para>This preference allows you to choose to alter the ISBN matching rule used
2047                     when staging records for import to be more aggressive. This means that all text
2048                     will be stripped from the ISBN field so that a pure number match is possible. If
2049                     this preference is set to "Don't" then Koha will find a match only if the ISBN
2050                     fields are identical.</para>
2051                 </listitem>
2052               </itemizedlist><important>
2053                 <para>Note that this preference has no effect if <link linkend="UseQueryParser"
2054                     >UseQueryParser</link> is on. </para>
2055               </important></para>
2056           </section>
2057         </section>
2058
2059         <section id="catinterfaceprefs">
2060           <title>Interface</title>
2061
2062           <para/>
2063
2064           <section id="advancedMARCeditor">
2065             <title>advancedMARCeditor</title>
2066
2067             <para>Default: Don't display</para>
2068
2069             <para>Asks: ___ descriptions of fields and subfields in the MARC
2070             editor.</para>
2071
2072             <para>Description:</para>
2073
2074             <itemizedlist>
2075               <listitem>
2076                 <para>This preference determines whether or not MARC field
2077                 names will be present when editing or creating MARC
2078                 records.</para>
2079               </listitem>
2080             </itemizedlist>
2081
2082             <para>Values:</para>
2083
2084             <itemizedlist>
2085               <listitem>
2086                 <para>Display</para>
2087
2088                 <screenshot>
2089                   <screeninfo>MARC editor with text labels</screeninfo>
2090
2091                   <mediaobject>
2092                     <imageobject>
2093                       <imagedata fileref="images/admin/globalprefs/advancedMARCeditor-display.png"/>
2094                     </imageobject>
2095                   </mediaobject>
2096                 </screenshot>
2097               </listitem>
2098
2099               <listitem>
2100                 <para>Don't display</para>
2101
2102                 <screenshot>
2103                   <screeninfo>MARC editor without text labels</screeninfo>
2104
2105                   <mediaobject>
2106                     <imageobject>
2107                       <imagedata fileref="images/admin/globalprefs/advancedMARCeditor-dontdisplay.png"/>
2108                     </imageobject>
2109                   </mediaobject>
2110                 </screenshot>
2111               </listitem>
2112             </itemizedlist>
2113           </section>
2114
2115           <section id="DefaultClassificationSource">
2116             <title>DefaultClassificationSource</title>
2117
2118             <para>Default: Dewey Decimal System</para>
2119
2120             <para>Asks: Use ___ as the default classification source.</para>
2121
2122             <para>Values:</para>
2123
2124             <itemizedlist>
2125               <listitem>
2126                 <para>ANSCR (Sound Recordings)</para>
2127               </listitem>
2128
2129               <listitem>
2130                 <para>Dewey Decimal Classification</para>
2131               </listitem>
2132
2133               <listitem>
2134                 <para>Library of Congress Classification</para>
2135               </listitem>
2136
2137               <listitem>
2138                 <para>Other/Generic Classification Scheme</para>
2139               </listitem>
2140
2141               <listitem>
2142                 <para>SuDoc Classification (U.S. GPO)</para>
2143               </listitem>
2144
2145               <listitem>
2146                 <para>Universal Decimal Classification</para>
2147               </listitem>
2148             </itemizedlist>
2149           </section>
2150
2151           <section id="EasyAnalyticalRecords">
2152             <sectioninfo>
2153               <authorgroup>
2154                 <author>
2155                   <firstname>Linda</firstname>
2156                   <surname>Culberson</surname>
2157                   <affiliation>
2158                     <orgname>Ms. Dept. of Archives and History</orgname>
2159                   </affiliation>
2160                 </author>
2161
2162                 <editor>
2163                   <firstname>Nicole C.</firstname>
2164                   <surname>Engard</surname>
2165                   <contrib>Fixed typos, changed content
2166                     where necessary and added new screenshots.</contrib>
2167                 </editor>
2168               </authorgroup>
2169
2170               <pubdate>October 2011</pubdate>
2171             </sectioninfo>
2172
2173             <title>EasyAnalyticalRecords</title>
2174             <para>Default: Don't Display</para>
2175
2176             <para>Asks: ___ easy ways to create analytical record
2177             relationships</para>
2178
2179             <para>Values:</para>
2180
2181             <itemizedlist>
2182               <listitem>
2183                 <para>Display</para>
2184               </listitem>
2185
2186               <listitem>
2187                 <para>Don't Display</para>
2188               </listitem>
2189             </itemizedlist>
2190
2191             <important>
2192               <para>If you decide to use this feature you'll want to make sure
2193               that your <link linkend="UseControlNumber">UseControlNumber</link> preference is
2194               set to "Don't use" or else the "Show analytics" links in the
2195               staff client and the OPAC will be broken.</para>
2196             </important>
2197
2198             <para>Description:</para>
2199
2200             <itemizedlist>
2201               <listitem>
2202                 <para>An analytic entry in a catalog is one that describes a
2203                 part of a larger work that is also described in the catalog.
2204                 In bibliographic cataloging, analytic entries may be made for
2205                 chapters in books or special issues of articles in
2206                 periodicals. In archival cataloging, analytic entries may be
2207                 made for series or items within a collection. This feature in
2208                 Koha allows for an easy way of linking analytic entries to the
2209                 host records, and this system preference adds several new menu
2210                 options to the staff cataloging detail pages to allow that to
2211                 happen.</para>
2212               </listitem>
2213             </itemizedlist>
2214           </section>
2215         </section>
2216
2217         <section id="catrecordprefs">
2218           <title>Record Structure</title>
2219
2220           <para/>
2221
2222           <section id="AlternateHoldingsField">
2223             <title>AlternateHoldingsField &amp;
2224             AlternateHoldingsSeparator</title>
2225
2226             <para>Asks: Display MARC subfield ___ as holdings information for
2227             records that do not have items, with the subfields separated by
2228             ___.</para>
2229
2230             <para>Description:</para>
2231
2232             <itemizedlist>
2233               <listitem>
2234                 <para>Sometimes libraries migrate to Koha with their holding
2235                 info in the 852 field (OCLC holdings information field) and
2236                 choose not to transfer that information into the 952 (Koha
2237                 holdings information field) because they don't plan on
2238                 circulating those items. For those libraries or other
2239                 libraries that have data in the 852 fields of their records
2240                 that they want to display, these preferences let you choose to
2241                 display holdings info from a field other than the 952 field.
2242                 The AlternateHoldingsField preference can contain multiple
2243                 subfields to look in; for instance 852abhi would look in 852
2244                 subfields a, b, h, and i.</para>
2245               </listitem>
2246
2247               <listitem>
2248                 <para>With AlternateHoldingsField set to 852abhi and
2249                 AlternateHoldingsSeparator set to a space the holdings would
2250                 look like the following:</para>
2251
2252                 <screenshot>
2253                   <screeninfo>Alternate Holdings Display</screeninfo>
2254
2255                   <mediaobject>
2256                     <imageobject>
2257                       <imagedata fileref="images/admin/globalprefs/AlternateHoldingsField.png"/>
2258                     </imageobject>
2259                   </mediaobject>
2260                 </screenshot>
2261               </listitem>
2262             </itemizedlist>
2263           </section>
2264
2265           <section id="autoBarcode">
2266             <title>autoBarcode</title>
2267
2268             <para>Default: generated in the form
2269             &lt;branchcode&gt;yymm0001</para>
2270
2271             <para>Asks: Barcodes are ___</para>
2272
2273             <para>Values:</para>
2274
2275             <itemizedlist>
2276               <listitem>
2277                 <para>generated in the form &lt;branchcode&gt;yymm0001</para>
2278               </listitem>
2279
2280               <listitem>
2281                 <para>generated in the form &lt;year&gt;-0001, &lt;year&gt;-0002</para>
2282               </listitem>
2283
2284               <listitem>
2285                 <para>generated in the form 1, 2, 3</para>
2286               </listitem>
2287
2288               <listitem>
2289                 <para>incremental EAN-13 barcodes</para>
2290               </listitem>
2291
2292               <listitem>
2293                 <para>not generated automatically</para>
2294               </listitem>
2295             </itemizedlist>
2296
2297             <para>Description:</para>
2298
2299             <itemizedlist>
2300               <listitem>
2301                 <para>This setting is for libraries wishing to generate
2302                 barcodes from within Koha (as opposed to scanning in
2303                 pre-printed barcodes or manually assigning them). The default
2304                 behavior makes it so that when you click in the barcode field
2305                 (952$p in MARC21) it will populate with the automatic barcode
2306                 you have chosen. If you would rather it only enter an
2307                 automatic barcode when you click on the plugin (the ... to the
2308                 right of the field) you can change the plugin used for that
2309                 field in the framework. Set the plugin for 952$p (if using
2310                 MARC21 or equivalent field mapped to items.barcode in your
2311                 local MARC format) for your frameworks to barcode_manual.pl
2312                 instead of barcode.pl. Learn more about editing frameworks
2313                 under the <link linkend="marcbibframeworks">MARC Bibliographic
2314                 Frameworks</link> section of this manual.</para>
2315               </listitem>
2316             </itemizedlist>
2317           </section>
2318
2319           <section id="DefaultLanguageField008">
2320             <title>DefaultLanguageField008</title>
2321             <para>Default: Empty defaults to eng</para>
2322
2323             <para>Asks: Fill in the default language for field 008 Range 35-37 of MARC21 records
2324               ___.</para>
2325
2326             <para>Description:</para>
2327
2328             <itemizedlist>
2329               <listitem>
2330                 <para>This preference will allow you to set the language for your MARC21 008 field
2331                   by default. If this is left empty it will default to English (eng). See the <ulink
2332                     url="http://www.loc.gov/marc/languages/language_code.html">MARC Code List for
2333                     Languages</ulink> for additional values for this preference.</para>
2334               </listitem>
2335             </itemizedlist>
2336             <note>
2337               <para>This preference won't have any effect if your records are in UNIMARC.</para>
2338             </note>
2339           </section>
2340
2341           <section id="item-level_itypes">
2342             <title>item-level_itypes</title>
2343
2344             <para>Default: specific item</para>
2345
2346             <para>Asks: Use the item type of the ___ as the authoritative item
2347             type (for determining circulation and fines rules, etc).</para>
2348
2349             <para>Values:</para>
2350
2351             <itemizedlist>
2352               <listitem>
2353                 <para>biblio record</para>
2354               </listitem>
2355
2356               <listitem>
2357                 <para>specific item</para>
2358               </listitem>
2359             </itemizedlist>
2360
2361             <para>Description:</para>
2362
2363             <itemizedlist>
2364               <listitem>
2365                 <para>This preference determines whether the item type Koha
2366                 uses for issuing rules will be an attribute of the
2367                 bibliographic record or the item record. Most libraries refer
2368                 to the item record for item types. It also determines if the
2369                 item type icon appears on the OPAC search results. If you have
2370                 the preference set to 'biblio record' then Koha displays the
2371                 item type icon on the search results to the left of the result
2372                 info.</para>
2373
2374                 <screenshot>
2375                   <screeninfo>Item Type Icons to the Left of Result
2376                   Information</screeninfo>
2377
2378                   <mediaobject>
2379                     <imageobject>
2380                       <imagedata fileref="images/admin/globalprefs/item-level_itypes.png"/>
2381                     </imageobject>
2382                   </mediaobject>
2383                 </screenshot>
2384               </listitem>
2385             </itemizedlist>
2386           </section>
2387
2388           <section id="itemcallnumber">
2389             <title>itemcallnumber</title>
2390
2391             <para>Default: 082ab</para>
2392
2393             <para>Asks: Map the MARC subfield to an item's callnumber.</para>
2394
2395             <note>
2396               <para>This can contain multiple subfields to look in; for
2397               instance 082ab would look in 082 subfields a and b.</para>
2398             </note>
2399
2400             <para>Description:</para>
2401
2402             <itemizedlist>
2403               <listitem>
2404                 <para>This setting determines which MARC field will be used to determine the call
2405                   number that will be entered into item records automatically (952$o). The value is
2406                   set by providing the MARC field code (050, 082, 090, 852 are all common in MARC21)
2407                   and the subfield codes without the delimiters ($a, $b would be ab).</para>
2408               </listitem>
2409             </itemizedlist>
2410
2411             <para>Examples:</para>
2412
2413             <itemizedlist>
2414               <listitem>
2415                 <para>Dewey: 082ab or 092ab; LOC: 050ab or 090ab; from the
2416                 item record: 852hi</para>
2417               </listitem>
2418             </itemizedlist>
2419           </section>
2420
2421           <section id="marcflavour">
2422             <title>marcflavour</title>
2423
2424             <para>Default: MARC21</para>
2425
2426             <para>Asks: Interpret and store MARC records in the ___
2427             format.</para>
2428
2429             <para>Values:</para>
2430
2431             <itemizedlist>
2432               <listitem>
2433                 <para>MARC21<itemizedlist>
2434                     <listitem>
2435                       <para>The standard style for the US, Canada, Australia, New Zealand, United
2436                         Kingdom, Germany and other countries</para>
2437                     </listitem>
2438                   </itemizedlist></para>
2439               </listitem>
2440
2441               <listitem>
2442                 <para>UNIMARC<itemizedlist>
2443                     <listitem>
2444                       <para>The standard style used in France, Italy, Portugal, Russia, and other
2445                         countries</para>
2446                     </listitem>
2447                   </itemizedlist></para>
2448               </listitem>
2449               <listitem>
2450                 <para>NORMARC<itemizedlist>
2451                     <listitem>
2452                       <para>The standard style for Norway</para>
2453                     </listitem>
2454                   </itemizedlist></para>
2455               </listitem>
2456             </itemizedlist>
2457             <para>Description:</para>
2458             <itemizedlist>
2459               <listitem>
2460                 <para>This preference defines global MARC style (MARC21, UNIMARC or NORMARC) used
2461                   for encoding.</para>
2462               </listitem>
2463             </itemizedlist>
2464             <important>
2465               <para>Changing the value of this preference will not convert your records from one
2466                 MARC style to an other.</para>
2467             </important>
2468           </section>
2469
2470           <section id="MARCOrgCode">
2471             <title>MARCOrgCode</title>
2472
2473             <para>Default: OSt</para>
2474
2475             <para>Asks: Fill in the MARC organization code ___ by default in new MARC21 records
2476               (leave blank to disable). </para>
2477
2478             <para>Description:</para>
2479
2480             <itemizedlist>
2481               <listitem>
2482                 <para>The MARC Organization Code is used to identify libraries
2483                 with holdings of titles and more.</para>
2484               </listitem>
2485             </itemizedlist>
2486
2487             <para>Learn more and find your library's MARC21 code on the <ulink
2488                 url="http://www.loc.gov/marc/organizations/orgshome.html">MARC Code list for
2489                 Organizations</ulink> or in Canada on the <ulink
2490                 url="http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1">Canadian
2491                 Symbols Directory</ulink>.<note>
2492                 <para>This preference won't have any effect if your records are in UNIMARC.</para>
2493               </note></para>
2494           </section>
2495
2496           <section id="NewItemsDefaultLocation">
2497             <title>NewItemsDefaultLocation</title>
2498
2499             <para>Asks: When items are created, give them the temporary
2500             location of ___ (should be a location code, or blank to
2501             disable).</para>
2502           </section>
2503           <section id="PrefillItem">
2504             <title>PrefillItem</title>
2505             <para>Default: the new item is not prefilled with last created item values.</para>
2506             <para>Asks: When a new item is added ___</para>
2507             <para>Values:<itemizedlist>
2508                 <listitem>
2509                   <para>the new item is not prefilled with last created item values.</para>
2510                 </listitem>
2511                 <listitem>
2512                   <para>the new item is prefilled with last created item values.</para>
2513                 </listitem>
2514               </itemizedlist></para>
2515             <para>Description:<itemizedlist>
2516                 <listitem>
2517                   <para>This preference controls the behavior used when adding new items.  Using the
2518                     options here you can choose to have your next new item prefill with the values
2519                     used in the last item was added to save time typing values or to have the item
2520                     form appear completely blank. Using <link linkend="SubfieldsToUseWhenPrefill">SubfieldsToUseWhenPrefill</link> you can control specifically which fields
2521                     are prefilled.</para>
2522                 </listitem>
2523               </itemizedlist></para>
2524           </section>
2525           <section id="SubfieldsToAllowForRestrictedBatchmod">
2526             <title>SubfieldsToAllowForRestrictedBatchmod</title>
2527             <para>Asks: Define a list of subfields for which editing is authorized when <link
2528                 linkend="items_batchmod_restricted">items_batchmod_restricted</link> permission is
2529               enabled, separated by spaces. ___</para>
2530             <para>Examples:<itemizedlist>
2531                 <listitem>
2532                   <para>UNIMARC: "995$f 995$h 995$j" </para>
2533                 </listitem>
2534                 <listitem>
2535                   <para>MARC21: "952$a 952$b 952$c" </para>
2536                 </listitem>
2537               </itemizedlist></para>
2538             <para>Description:<itemizedlist>
2539                 <listitem>
2540                   <para>This preference lets you define what fields can be edited via the <link
2541                       linkend="batchmodifyitems">batch item modification tool</link> if the
2542                     items_batchmod_restricted permission is enabled.</para>
2543                   <para>
2544                     <note>
2545                       <para>The FA framework is excluded from the permission. If the pref is empty,
2546                         no fields are restricted. </para>
2547                     </note>
2548                   </para>
2549                 </listitem>
2550               </itemizedlist></para>
2551           </section>
2552           <section id="SubfieldsToAllowForRestrictedEditing">
2553             <title>SubfieldsToAllowForRestrictedEditing</title>
2554             <para>Asks: Define a list of subfields for which editing is authorized when
2555               edit_items_restricted permission is enabled, separated by spaces. ___</para>
2556             <para>Examples:<itemizedlist>
2557                 <listitem>
2558                   <para>UNIMARC: "995$f 995$h 995$j"</para>
2559                 </listitem>
2560                 <listitem>
2561                   <para>MARC21: "952$a 952$b 952$c"</para>
2562                 </listitem>
2563               </itemizedlist></para>
2564             <para>Description:<itemizedlist>
2565                 <listitem>
2566                   <para>This preference lets you define what fields can be edited via cataloging if
2567                     the <link linkend="edit_items_restricted">edit_items_restricted</link>
2568                     permission is enabled<note>
2569                       <para>The FA framework is excluded from the permission. If the pref is empty,
2570                         no fields are restricted. </para>
2571                     </note></para>
2572                 </listitem>
2573               </itemizedlist></para>
2574           </section>
2575           <section id="SubfieldsToUseWhenPrefill">
2576             <title>SubfieldsToUseWhenPrefill</title>
2577             <para>Asks: Define a list of subfields to use when prefilling items ___<important>
2578                 <para>Separate values with a space.</para>
2579               </important></para>
2580             <para>Description:<itemizedlist>
2581                 <listitem>
2582                   <para>When the <link linkend="PrefillItem">PrefillItem</link> preference is set to
2583                     prefill item values with those from the last added item, this preference can
2584                     control which fields are prefilled (and which are not). Enter a space separated
2585                     list of fields that you would like to prefill when adding a new item.</para>
2586                 </listitem>
2587               </itemizedlist></para>
2588           </section>
2589
2590           <section id="z3950NormalizeAuthor">
2591             <title>z3950NormalizeAuthor &amp; z3950AuthorAuthFields</title>
2592
2593             <para>Defaults: Don't copy &amp; 701,702,700</para>
2594
2595             <para>Asks: ___ authors from the UNIMARC ___ tags (separated by
2596             commas) to the correct author tags when importing a record using
2597             Z39.50.</para>
2598
2599             <para>Description for z3950NormalizeAuthor:</para>
2600
2601             <itemizedlist>
2602               <listitem>
2603                 <para>This preference allows for 'Personal Name Authorities'
2604                 to replace authors as the bibliographic authority. This
2605                 preference should only be considered by libraries using
2606                 UNIMARC.</para>
2607               </listitem>
2608             </itemizedlist>
2609
2610             <para>Values for z3950NormalizeAuthor:</para>
2611
2612             <itemizedlist>
2613               <listitem>
2614                 <para>Copy</para>
2615               </listitem>
2616
2617               <listitem>
2618                 <para>Don't copy</para>
2619               </listitem>
2620             </itemizedlist>
2621
2622             <para>Description for z3950AuthorAuthFields:</para>
2623
2624             <itemizedlist>
2625               <listitem>
2626                 <para>This preference defines which MARC fields will be used
2627                 for 'Personal Name Authorities' to replace authors as the
2628                 bibliographic authorities. This preference only applies to
2629                 those using UNIMARC encoding. The MARC fields selected here
2630                 will only be used if 'z3950NormalizeAuthor' is set to "Copy".
2631                 The default field are 700, 701, and 702.</para>
2632               </listitem>
2633             </itemizedlist>
2634           </section>
2635         </section>
2636
2637         <section id="catspineprefs">
2638           <title>Spine Labels</title>
2639
2640           <para/>
2641
2642           <section id="SpineLabelAutoPrint">
2643             <title>SpineLabelAutoPrint</title>
2644
2645             <para>Default: don't</para>
2646
2647             <para>Asks: When using the quick spine label printer, ___
2648             automatically pop up a print dialog.</para>
2649
2650             <para>Values:</para>
2651
2652             <itemizedlist>
2653               <listitem>
2654                 <para>do</para>
2655               </listitem>
2656
2657               <listitem>
2658                 <para>don't</para>
2659               </listitem>
2660             </itemizedlist>
2661           </section>
2662
2663           <section id="SpineLabelFormat">
2664             <title>SpineLabelFormat</title>
2665
2666             <para>Default: &lt;itemcallnumber&gt;&lt;copynumber&gt;</para>
2667
2668             <para>Asks: Include the following fields on a quick-printed spine
2669             label: (Enter in columns from the biblio, biblioitems or items
2670             tables, surrounded by &lt; and &gt;.)</para>
2671           </section>
2672
2673           <section id="SpineLabelShowPrintOnBibDetails">
2674             <title>SpineLabelShowPrintOnBibDetails</title>
2675
2676             <para>Default: Don't display</para>
2677
2678             <para>Asks: ___ buttons on the bib details page to print item
2679             spine labels.</para>
2680
2681             <para>Values:</para>
2682
2683             <itemizedlist>
2684               <listitem>
2685                 <para>Display</para>
2686
2687                 <screenshot>
2688                   <screeninfo>'Print Label' link appears on bibliographic
2689                   record in the staff client</screeninfo>
2690
2691                   <mediaobject>
2692                     <imageobject>
2693                       <imagedata fileref="images/admin/globalprefs/SpineLabelShowPrintOnBibDetails.png"/>
2694                     </imageobject>
2695                   </mediaobject>
2696                 </screenshot>
2697               </listitem>
2698
2699               <listitem>
2700                 <para>Don't display</para>
2701               </listitem>
2702             </itemizedlist>
2703           </section>
2704         </section>
2705       </section>
2706
2707       <section id="circprefs">
2708         <title>Circulation</title>
2709
2710         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
2711         Global System Preferences &gt; Circulation</para>
2712         <section id="checkinpolicyprefs">
2713           <title>Checkin Policy</title>
2714           <para/>
2715           <section id="AllowMultipleIssuesOnABiblio">
2716             <title>AllowMultipleIssuesOnABiblio</title>
2717             <para>Default: Allow</para>
2718             <para>Asks: ___  patrons to check out multiple items from the same record. </para>
2719             <para>Values:<itemizedlist>
2720                 <listitem>
2721                   <para>Allow</para>
2722                 </listitem>
2723                 <listitem>
2724                   <para>Don't allow</para>
2725                 </listitem>
2726               </itemizedlist></para>
2727             <para>Description:<itemizedlist>
2728                 <listitem>
2729                   <para>If this preference is set to 'Allow' then patrons will be able to check out
2730                     multiple copies of the same title at the same time. If it's set to "Don't allow"
2731                     then patrons will only be allowed to check out one item attached to a record at
2732                     a time. Regardless of the option chosen in this preference records with
2733                     subscriptions attached will allow multiple check outs.<important>
2734                       <para>This will only effect records without a subscription attached.</para>
2735                     </important></para>
2736                 </listitem>
2737               </itemizedlist></para>
2738           </section>
2739           <section id="BlockReturnOfWithdrawnItems">
2740             <title>BlockReturnOfWithdrawnItems</title>
2741             <para>Default: Block</para>
2742             <para>Asks: ___ returning of items that have been withdrawn. </para>
2743             <para>Values:<itemizedlist>
2744                 <listitem>
2745                   <para>Block</para>
2746                 </listitem>
2747                 <listitem>
2748                   <para>Don't block</para>
2749                 </listitem>
2750               </itemizedlist>Description:<itemizedlist>
2751                 <listitem>
2752                   <para>This preference controls whether and item with a withdrawn status (952$0 in
2753                     MARC21) can be checked in or not.</para>
2754                 </listitem>
2755               </itemizedlist></para>
2756           </section>
2757           <section id="CalculateFinesOnReturn">
2758             <title>CalculateFinesOnReturn</title>
2759             <para>Default: Do</para>
2760             <para>Asks: ___ calculate and update overdue charges when an item is returned.</para>
2761             <para>Values:<itemizedlist>
2762                 <listitem>
2763                   <para>Do</para>
2764                 </listitem>
2765                 <listitem>
2766                   <para>Don't</para>
2767                 </listitem>
2768               </itemizedlist></para>
2769             <para>Description:<itemizedlist>
2770                 <listitem>
2771                   <para>If this preference is set to "Do" and the <link linkend="finescronjob">fines
2772                       cron job</link> is off then Koha will calculate fines only when items are
2773                     returned. If you have the fines cron job on and this preference set to "Do" then
2774                     this preference will calculate fines based on the cron (usually run nightly) and
2775                     then again when you check the item in.  This option is best for those who are
2776                     doing hourly loans.  If this preference is set to "Don't" then fines will only
2777                     be accrued if the fines cron job is running.</para>
2778                 </listitem>
2779               </itemizedlist></para>
2780             <para>
2781               <important>
2782                 <para>If you are doing hourly loans then you should have this set to 'Do'.</para>
2783               </important>
2784             </para>
2785           </section>
2786           <section id="RentalFeesCheckoutConfirmation">
2787             <title>RentalFeesCheckoutConfirmation</title>
2788             <para>Default: do not ask</para>
2789             <para>Asks: When checking out an item with rental fees, ___ for confirmation.</para>
2790             <para>Values:<itemizedlist>
2791                 <listitem>
2792                   <para>ask<screenshot>
2793                       <screeninfo>RentalFeesCheckoutConfirmation</screeninfo>
2794                       <mediaobject>
2795                         <imageobject>
2796                           <imagedata
2797                             fileref="images/admin/globalprefs/RentalFeesCheckoutConfirmation.png"/>
2798                         </imageobject>
2799                       </mediaobject>
2800                     </screenshot></para>
2801                 </listitem>
2802                 <listitem>
2803                   <para>do not ask</para>
2804                 </listitem>
2805               </itemizedlist></para>
2806             <para>Description:<itemizedlist>
2807                 <listitem>
2808                   <para>If you are charging rental fees for items this preference will make it so
2809                     that you can show (or not show) a confirmation before checking out an item that
2810                     will incur a rental charge.</para>
2811                 </listitem>
2812               </itemizedlist></para>
2813           </section>
2814           <section id="UpdateNotForLoanStatusOnCheckin">
2815             <title>UpdateNotForLoanStatusOnCheckin</title>
2816             <para>Asks: This is a list of value pairs. When an item is checked in, if the not for
2817               loan value on the left matches the items not for loan value it will be updated to the
2818               right-hand value. E.g. '-1: 0' will cause an item that was set to 'Ordered' to now be
2819               available for loan. Each pair of values should be on a separate line. </para>
2820           </section>
2821         </section>
2822
2823         <section id="circcheckoutpolicy">
2824           <title>Checkout Policy</title>
2825
2826           <para/>
2827
2828           <section id="AgeRestrictionMarker">
2829             <title>AgeRestrictionMarker</title>
2830
2831             <para>Asks: Restrict patrons with the following target audience
2832             values from checking out inappropriate materials: ___</para>
2833
2834             <para>Description:</para>
2835
2836             <itemizedlist>
2837               <listitem>
2838                 <para>This preference defines certain keywords that will
2839                 trigger Koha to restrict checkout based on age. These
2840                 restrictions can be overridden by the <link linkend="AgeRestrictionOverride">AgeRestrictionOverride</link>
2841                 preference. Enter in this field a series of keywords separated
2842                 by bar (|) with no spaces. For example PG|R|E|EC|Age| will
2843                 look for PG followed by an age number, R folllowed by an age
2844                 number, Age followed by an age number, and so on. These values
2845                 can appear in any MARC field, but Library of Congress
2846                 recommends the 521$a (Target Audience Note). Whatever field
2847                 you decide to use you must map the word agerestriction in the
2848                 biblioitems table to that field in the <link linkend="kohamarcmapping">Koha to MARC Mapping</link>. When
2849                 cataloging you can enter values like PG 13 or E 10 in the
2850                 521$a and Koha will then notify circulation librarians that
2851                 the material may not be recommended for the patron based on
2852                 their age.<important>
2853                     <para>You must map the word agerestriction in the biblioitems table to the MARC
2854                       field where this information will appear via the <link linkend="kohamarcmapping">Koha to MARC Mapping</link> administration
2855                       area.</para>
2856                   </important></para>
2857               </listitem>
2858             </itemizedlist>
2859           </section>
2860
2861           <section id="AgeRestrictionOverride">
2862             <title>AgeRestrictionOverride</title>
2863
2864             <para>Default: Don't allow</para>
2865
2866             <para>Asks: ___ staff to check out an item with age
2867             restriction.</para>
2868
2869             <para>Values:</para>
2870
2871             <itemizedlist>
2872               <listitem>
2873                 <para>Allow</para>
2874
2875                 <screenshot>
2876                   <screeninfo>Allow age restriction override</screeninfo>
2877
2878                   <mediaobject>
2879                     <imageobject>
2880                       <imagedata fileref="images/admin/globalprefs/AgeRestrictionOverride.png"/>
2881                     </imageobject>
2882                   </mediaobject>
2883                 </screenshot>
2884               </listitem>
2885
2886               <listitem>
2887                 <para>Don't allow</para>
2888
2889                 <screenshot>
2890                   <screeninfo>Don't allow age restriction
2891                   override</screeninfo>
2892
2893                   <mediaobject>
2894                     <imageobject>
2895                       <imagedata fileref="images/admin/globalprefs/AgeRestrictionMarker.png"/>
2896                     </imageobject>
2897                   </mediaobject>
2898                 </screenshot>
2899               </listitem>
2900             </itemizedlist>
2901
2902             <para>Description:</para>
2903
2904             <itemizedlist>
2905               <listitem>
2906                 <para>When the <link linkend="AgeRestrictionMarker">AgeRestrictionMarker</link>
2907                 preference is set, Koha will try to warn circulation
2908                 librarians before checking out an item that might have an age
2909                 restriction listed in the MARC record. This preference asks if
2910                 you would like the staff to be able to still check out these
2911                 items to patrons under the age limit.</para>
2912               </listitem>
2913             </itemizedlist>
2914           </section>
2915
2916           <section id="AllFinesNeedOverride">
2917             <title>AllFinesNeedOverride</title>
2918
2919             <para>Default: Require</para>
2920
2921             <para>Asks: ___ staff to manually override all fines, even fines
2922             less than <link linkend="noissuescharge">noissuescharge</link>.</para>
2923
2924             <para>Values:</para>
2925
2926             <itemizedlist>
2927               <listitem>
2928                 <para>Don't require</para>
2929               </listitem>
2930
2931               <listitem>
2932                 <para>Require</para>
2933               </listitem>
2934             </itemizedlist>
2935
2936             <para>Description:</para>
2937
2938             <itemizedlist>
2939               <listitem>
2940                 <para>This preference let's you decide if you want to always
2941                 be warned that the patron has fines when checking out. If you
2942                 have it set to 'Require' then no matter how much money the
2943                 patron owes a message will pop up warning you that the patron
2944                 owes money.</para>
2945               </listitem>
2946             </itemizedlist>
2947           </section>
2948
2949           <section id="AllowFineOverride">
2950             <title>AllowFineOverride</title>
2951
2952             <para>Default: Don't allow</para>
2953
2954             <para>Asks: ___ staff to manually override and check out items to
2955             patrons who have more than <link linkend="noissuescharge">noissuescharge</link> in fines.</para>
2956
2957             <para>Values:</para>
2958
2959             <itemizedlist>
2960               <listitem>
2961                 <para>Allow</para>
2962               </listitem>
2963
2964               <listitem>
2965                 <para>Don't allow</para>
2966               </listitem>
2967             </itemizedlist>
2968
2969             <para>Description:</para>
2970
2971             <itemizedlist>
2972               <listitem>
2973                 <para>This preference lets you decide if you staff can check
2974                 out to patrons who owe more money than you usually let them
2975                 carry on their account. If set to 'Allow' staff will be warned
2976                 that the patrons owes money, but it won't stop the staff from
2977                 checking out to the patron.</para>
2978               </listitem>
2979             </itemizedlist>
2980           </section>
2981
2982           <section id="AllowItemsOnHoldCheckout">
2983             <title>AllowItemsOnHoldCheckout</title>
2984
2985             <para>Default: Don't allow</para>
2986
2987             <para>Asks: ___ checkouts of items reserved to someone else. If
2988             allowed do not generate RESERVE_WAITING and RESERVED warning. This
2989             allows self checkouts for those items.</para>
2990
2991             <para>Values:</para>
2992
2993             <itemizedlist>
2994               <listitem>
2995                 <para>Allow</para>
2996               </listitem>
2997
2998               <listitem>
2999                 <para>Don't allow</para>
3000               </listitem>
3001             </itemizedlist>
3002
3003             <important>
3004               <para>This system preference relates only to SIP based self
3005               checkout, not Koha's web based self checkout.</para>
3006             </important>
3007
3008             <para>Description:</para>
3009
3010             <itemizedlist>
3011               <listitem>
3012                 <para>When this preference is set to 'Allow' patrons will be
3013                 able to use your external self check machine to check out a
3014                 book to themselves even if it's on hold for someone else. If
3015                 you would like Koha to prevent people from checking out books
3016                 that are on hold for someone else set this preference to
3017                 "Don't allow."</para>
3018               </listitem>
3019             </itemizedlist>
3020           </section>
3021
3022           <section id="AllowNotForLoanOverride">
3023             <title>AllowNotForLoanOverride</title>
3024
3025             <para>Default: Allow</para>
3026
3027             <para>Asks: ___ staff to override and check out items that are
3028             marked as not for loan.</para>
3029
3030             <para>Values:</para>
3031
3032             <itemizedlist>
3033               <listitem>
3034                 <para>Allow</para>
3035               </listitem>
3036
3037               <listitem>
3038                 <para>Don't allow</para>
3039               </listitem>
3040             </itemizedlist>
3041
3042             <para>Description:</para>
3043
3044             <itemizedlist>
3045               <listitem>
3046                 <para>This parameter is a binary setting which controls the
3047                 ability of staff (patrons will always be prevented from
3048                 checking these items out) to check out items that are marked
3049                 as "not for loan". Setting it to "Allow" would allow such
3050                 items to be checked out, setting it to "Don't allow" would
3051                 prevent this. This setting determines whether items meant to
3052                 stay in the library, such as reference materials, and other
3053                 library resources can be checked out by patrons.</para>
3054               </listitem>
3055             </itemizedlist>
3056           </section>
3057
3058           <section id="AllowRenewalLimitOverride">
3059             <title>AllowRenewalLimitOverride</title>
3060
3061             <para>Default: Allow</para>
3062
3063             <para>Asks: ___ staff to manually override the renewal limit and
3064             renew a checkout when it would go over the renewal limit.</para>
3065
3066             <para>Values:</para>
3067
3068             <itemizedlist>
3069               <listitem>
3070                 <para>Allow</para>
3071               </listitem>
3072
3073               <listitem>
3074                 <para>Don't allow</para>
3075               </listitem>
3076             </itemizedlist>
3077
3078             <para>Description:</para>
3079
3080             <itemizedlist>
3081               <listitem>
3082                 <para>This preference is a binary setting which controls the
3083                 ability of staff to override the limits placed on the number
3084                 of times an item can be renewed. Setting it to "Allow" would
3085                 allow such limits to be overridden, setting it to "Don't
3086                 allow" would prevent this. This is a preference in which if it
3087                 is set to "allow" it would allow the library staff to use
3088                 their judgment for overriding the renew limit for special
3089                 cases, setting it to "Don't allow" prevents an opportunity for
3090                 abuse by the library staff.</para>
3091               </listitem>
3092             </itemizedlist>
3093           </section>
3094
3095           <section id="AllowReturnToBranch">
3096             <title>AllowReturnToBranch</title>
3097
3098             <para>Default: to any library</para>
3099
3100             <para>Asks: Allow materials to be returned to ___</para>
3101
3102             <para>Values:</para>
3103
3104             <itemizedlist>
3105               <listitem>
3106                 <para>either the library the item is from or the library it
3107                 was checked out from.</para>
3108               </listitem>
3109
3110               <listitem>
3111                 <para>only the library the item is from.</para>
3112               </listitem>
3113
3114               <listitem>
3115                 <para>only the library the item was checked out from.</para>
3116               </listitem>
3117
3118               <listitem>
3119                 <para>to any library.</para>
3120               </listitem>
3121             </itemizedlist>
3122
3123             <para>Description:</para>
3124
3125             <itemizedlist>
3126               <listitem>
3127                 <para>This preference lets the library system decide how they
3128                 will accept returns. Some systems allow for items to be
3129                 returned to any library in the system (the default value of
3130                 this preference) others want to limit item returns to only
3131                 specific branches. This preference will allow you to limit
3132                 item returns (checkins) to the branch(es) set in the
3133                 value.</para>
3134               </listitem>
3135             </itemizedlist>
3136           </section>
3137           <section id="AllowTooManyOverride">
3138             <title>AllowTooManyOverride</title>
3139             <para>Default: Allow</para>
3140             <para>Asks: ___  staff to override and check out items when the patron has reached the
3141               maximum number of allowed checkouts.</para>
3142             <para>Values:</para>
3143             <itemizedlist>
3144                 <listitem>
3145                   <para>Allow</para>
3146                   <screenshot>
3147                       <screeninfo>Allow too many checkouts override</screeninfo>
3148                       <mediaobject>
3149                         <imageobject>
3150                           <imagedata fileref="images/admin/globalprefs/AllowTooManyOverride-yes.png"
3151                           />
3152                         </imageobject>
3153                       </mediaobject>
3154                     </screenshot>
3155                 </listitem>
3156                 <listitem>
3157                   <para>Don't allow</para>
3158                   <screenshot>
3159                     <screeninfo>Don't allow too many checkouts override</screeninfo>
3160                     <mediaobject>
3161                       <imageobject>
3162                         <imagedata fileref="images/admin/globalprefs/AllowTooManyOverride-no.png"/>
3163                       </imageobject>
3164                     </mediaobject>
3165                   </screenshot>
3166                 </listitem>
3167               </itemizedlist>
3168             <para>Description:<itemizedlist>
3169                 <listitem>
3170                   <para>If this preference is set to "Allow" then staff all will be presented with
3171                     an option to checkout more items to a patron than are normally allowed in the
3172                       <link linkend="circfinerules">Circulation and Fine Rules</link>.  If this
3173                     preference is set to "Don't allow" then no staff member will be able to check
3174                     out more than the circulation limit.</para>
3175                 </listitem>
3176               </itemizedlist></para>
3177           </section>
3178
3179           <section id="AutomaticItemReturn">
3180             <title>AutomaticItemReturn</title>
3181
3182             <para>Default: Do</para>
3183
3184             <para>Asks: ___ automatically transfer items to their home branch
3185             when they are returned.</para>
3186
3187             <para>Values:</para>
3188
3189             <itemizedlist>
3190               <listitem>
3191                 <para>Do</para>
3192               </listitem>
3193
3194               <listitem>
3195                 <para>Don't</para>
3196               </listitem>
3197             </itemizedlist>
3198
3199             <para>Description:</para>
3200
3201             <itemizedlist>
3202               <listitem>
3203                 <para>This preference is a binary setting which determines
3204                 whether an item is returned to its home branch automatically
3205                 or not. If set to "Don't", the staff member checking an item
3206                 in at a location other than the item's home branch will be
3207                 asked whether the item will remain at the non-home branch (in
3208                 which case the new location will be marked as a holding
3209                 location) or returned. Setting it to "Do" will ensure that
3210                 items checked in at a branch other than their home branch will
3211                 be sent to that home branch.</para>
3212               </listitem>
3213             </itemizedlist>
3214           </section>
3215           <section id="AutoRemoveOverduesRestrictions">
3216             <title>AutoRemoveOverduesRestrictions</title>
3217             <para>Default: Do not</para>
3218             <para>Asks: ___ allow OVERDUES restrictions triggered by sent notices to be cleared
3219               automatically when all overdue items are returned by a patron. </para>
3220             <para>Values:<itemizedlist>
3221                 <listitem>
3222                   <para>Do</para>
3223                 </listitem>
3224                 <listitem>
3225                   <para>Do not</para>
3226                 </listitem>
3227               </itemizedlist></para>
3228             <para>Description:<itemizedlist>
3229                 <listitem>
3230                   <para>Using the <link linkend="noticetriggers">Overdue Notice/Status
3231                       Triggers</link> you can restrict patrons after they receive an overdue notice.
3232                     This preference lets you define whether Koha will automatically remove that
3233                     restriction once the overdue items in question are returned or not.</para>
3234                 </listitem>
3235               </itemizedlist></para>
3236           </section>
3237
3238           <section id="CircControl">
3239             <title>CircControl</title>
3240
3241             <para>Default: the library the item is from</para>
3242
3243             <para>Asks: Use the checkout and fines rules of ___</para>
3244
3245             <para>Values:</para>
3246
3247             <itemizedlist>
3248               <listitem>
3249                 <para>the library the item is from</para>
3250
3251                 <itemizedlist>
3252                   <listitem>
3253                     <para>The <link linkend="circfinerules">circulation and fines policies</link>
3254                       will be determined by the item's library where <link
3255                         linkend="HomeOrHoldingBranch">HomeOrHoldingBranch</link> chooses if item's
3256                       home library is used or holding library is used.</para>
3257                   </listitem>
3258                 </itemizedlist>
3259               </listitem>
3260
3261               <listitem>
3262                 <para>the library the patron is from</para>
3263
3264                 <itemizedlist>
3265                   <listitem>
3266                     <para>The <link linkend="circfinerules">circulation and fines policies</link>
3267                       will be determined the patron's home library</para>
3268                   </listitem>
3269                 </itemizedlist>
3270               </listitem>
3271
3272               <listitem>
3273                 <para>the library you are logged in at</para>
3274
3275                 <itemizedlist>
3276                   <listitem>
3277                     <para>The <link linkend="circfinerules">circulation and fines policies</link>
3278                       will be determined by the library that checked the item out to the
3279                       patron</para>
3280                   </listitem>
3281                 </itemizedlist>
3282               </listitem>
3283             </itemizedlist>
3284           </section>
3285           <section id="DefaultLongOverdueChargeValue">
3286             <title>DefaultLongOverdueChargeValue</title>
3287             <para>Asks: Charge a lost item to the borrower's account when the LOST value of the item
3288               changes to ___</para>
3289             <para>Description: <itemizedlist>
3290                 <listitem>
3291                   <para>Leave this field empty if you don't want to charge the user for lost items.
3292                     If you want the user to be charged enter the <link linkend="lost">LOST
3293                       authorized value</link> you are using in the <link
3294                       linkend="DefaultLongOverdueLostValue">DefaultLongOverdueLostValue</link>
3295                     preference. This preference is used when the <link linkend="longoverduecron"
3296                       >longoverdue cron job</link> is called without the --charge parameter.</para>
3297                 </listitem>
3298               </itemizedlist></para>
3299           </section>
3300           <section id="DefaultLongOverdueLostValue">
3301             <title>DefaultLongOverdueLostValue &amp; DefaultLongOverdueDays </title>
3302             <para>Asks: By default, set the LOST value of an item to ___ when the item has been
3303               overdue for more than ___ days. </para>
3304             <para>Description:<itemizedlist>
3305                 <listitem>
3306                   <para>These preferences are used when the <link linkend="longoverduecron"
3307                       >longoverdue cron job</link> is called without the --lost parameter. It allows
3308                     users to set the values of the <link linkend="longoverduecron">longoverdue
3309                       cron</link> without having to edit the crontab.  Setting the values to 1 and
3310                     30 for example will mark the item with the <link linkend="lost">LOST authorized
3311                       value</link> of 1 after the item is 30 days overdue. </para>
3312                 </listitem>
3313               </itemizedlist></para>
3314           </section>
3315           <section id="HoldsInNoissuesCharge">
3316             <title>HoldsInNoissuesCharge</title>
3317             <para>Default: Don't include</para>
3318             <para>Asks: ___ hold charges when summing up charges for noissuescharge.</para>
3319             <para>Values:<itemizedlist>
3320                 <listitem>
3321                   <para>Don't include</para>
3322                 </listitem>
3323                 <listitem>
3324                   <para>Include</para>
3325                 </listitem>
3326               </itemizedlist></para>
3327           </section>
3328
3329           <section id="HomeOrHoldingBranch">
3330             <title>HomeOrHoldingBranch</title>
3331
3332             <para>Default: the library the item was checked out from</para>
3333
3334             <para>Asks: Use the checkout and fines rules of ___</para>
3335
3336             <para>Values:</para>
3337
3338             <itemizedlist>
3339               <listitem>
3340                 <para>the library the item is from<itemizedlist>
3341                     <listitem>
3342                       <para>This is equivalent to 'home library'</para>
3343                     </listitem>
3344                   </itemizedlist></para>
3345               </listitem>
3346
3347               <listitem>
3348                 <para>the library the item was checked out from<itemizedlist>
3349                     <listitem>
3350                       <para>This is equivalent to 'holding library'</para>
3351                     </listitem>
3352                   </itemizedlist></para>
3353               </listitem>
3354             </itemizedlist>
3355             <para>Description:</para>
3356             <itemizedlist>
3357               <listitem>
3358                 <para>This preference does several things.  <itemizedlist>
3359                     <listitem>
3360                       <para>If <link linkend="CircControl">CircControl</link> is set to 'the library
3361                         the item is from' then the <link linkend="circfinerules">circulation and
3362                           fines policies</link> will be determined by the item's library where
3363                         HomeOrHoldingBranch chooses if item's home library is used or holding
3364                         library is used.</para>
3365                     </listitem>
3366                     <listitem>
3367                       <para>If <link linkend="IndependentBranches">IndependentBranches</link> is set
3368                         to 'Prevent' then the value of this preference is used in figuring out if
3369                         the item can be checked out.  If the item's home library does not match the
3370                         logged in library, the item cannot be checked out unless you are a <link
3371                           linkend="patronpermsdefined">superlibrarian</link>.</para>
3372                     </listitem>
3373                   </itemizedlist></para>
3374               </listitem>
3375             </itemizedlist>
3376             <important>
3377               <para>It is not recommend that this setting be changed after initial setup of Koha
3378                 because it will change the behavior of items already checked out.</para>
3379             </important>
3380           </section>
3381           <section id="HomeOrHoldingBranchReturn">
3382             <title>HomeOrHoldingBranchReturn</title>
3383             <para>Default: the library the item is from</para>
3384             <para>Asks: On checkin route the returned item to ___</para>
3385             <para>Values:<itemizedlist>
3386                 <listitem>
3387                   <para>the library the item is from</para>
3388                 </listitem>
3389                 <listitem>
3390                   <para>the library item was checked out from</para>
3391                 </listitem>
3392               </itemizedlist></para>
3393             <para>Description:<itemizedlist>
3394                 <listitem>
3395                   <para>This preference will control where Koha prompts you to return the checked in
3396                     item to.  The value in this preference is overridden by any values you have
3397                     related to item returns and floating collections in the <link linkend="circfinerules">Circulation and Fine Rules</link>.</para>
3398                 </listitem>
3399               </itemizedlist></para>
3400           </section>
3401
3402           <section id="InProcessingToShelvingCart">
3403             <title>InProcessingToShelvingCart</title>
3404
3405             <para>Default: Don't move</para>
3406
3407             <para>Asks: ___ items that have the location PROC to the location
3408             CART when they are checked in.</para>
3409
3410             <para>Values:</para>
3411
3412             <itemizedlist>
3413               <listitem>
3414                 <para>Don't move</para>
3415               </listitem>
3416
3417               <listitem>
3418                 <para>Move</para>
3419               </listitem>
3420             </itemizedlist>
3421             <para>Description:<itemizedlist>
3422                 <listitem>
3423                   <para>This preference is used to managed automatically changing item locations
3424                     from processing (PROC) to the book cart (CART). A <link linkend="proccartcron"
3425                       >cron job</link> needs to be set to run at specified intervals to age items
3426                     from CART to the permanent shelving location. (For example, an hourly cron entry
3427                     of cart_to_shelf.pl --hours 3 where --hours is the amount of time an item should
3428                     spend on the cart before aging to its permanent location.)</para>
3429
3430                     <itemizedlist>
3431                       <listitem>
3432                         <note>
3433                           <para>If the <link linkend="ReturnToShelvingCart"
3434                               >ReturnToShelvingCart</link> system preference is turned on, any newly
3435                             checked-in item is also automatically put into the shelving cart, to be
3436                             covered by the same script run.</para>
3437                         </note>
3438                       </listitem>
3439                       <listitem>
3440                         <important>
3441                           <para>Checkins with confirmed holds will not go into the shelving cart. If
3442                             items on the shelving cart are checked out, the cart location will be
3443                             cleared.</para>
3444                         </important>
3445                       </listitem>
3446                     </itemizedlist>
3447
3448                 </listitem>
3449               </itemizedlist></para>
3450           </section>
3451
3452           <section id="IssuingInProcess">
3453             <title>IssuingInProcess</title>
3454
3455             <para>Default: Don't prevent</para>
3456
3457             <para>Asks: ___ patrons from checking out an item whose rental
3458             charge would take them over the limit.</para>
3459
3460             <para>Values:</para>
3461
3462             <itemizedlist>
3463               <listitem>
3464                 <para>Don't prevent</para>
3465               </listitem>
3466
3467               <listitem>
3468                 <para>Prevent</para>
3469               </listitem>
3470             </itemizedlist>
3471
3472             <para>Description:</para>
3473
3474             <itemizedlist>
3475               <listitem>
3476                 <para>This preference determines if a patron can check items
3477                 out if there is an overdue fine on the account and any of the
3478                 materials the patron wishes to check out will potentially tip
3479                 the account balance over the maximum fines policy the library
3480                 has in place.</para>
3481               </listitem>
3482             </itemizedlist>
3483
3484             <para>Example: Your library has a $5 limit set for 'fines' (ie,
3485             after incurring $5 in fines, a patron can no longer check out
3486             items). A patron comes to the desk with 5 items to check out (4
3487             books and a video) The patron has $4 in charges already on their
3488             account. One of the videos has a rental charge of $1, therefore
3489             making the total fines on the patron's account suddenly $5 (the
3490             limit).</para>
3491           </section>
3492
3493           <section id="IssueLostItem">
3494             <title>IssueLostItem</title>
3495
3496             <para>Default: display a message</para>
3497
3498             <para>Asks: When issuing an item that has been marked as lost,
3499             ___.</para>
3500
3501             <para>Values:</para>
3502
3503             <itemizedlist>
3504               <listitem>
3505                 <para>display a message</para>
3506
3507                 <screenshot>
3508                   <screeninfo>Lost message when checking out</screeninfo>
3509
3510                   <mediaobject>
3511                     <imageobject>
3512                       <imagedata fileref="images/admin/globalprefs/IssueLostItem-msg.png"/>
3513                     </imageobject>
3514                   </mediaobject>
3515                 </screenshot>
3516               </listitem>
3517
3518               <listitem>
3519                 <para>do nothing</para>
3520
3521                 <itemizedlist>
3522                   <listitem>
3523                     <para>This option will just check the item out without
3524                     notifying you that the item was marked lost.</para>
3525                   </listitem>
3526                 </itemizedlist>
3527               </listitem>
3528
3529               <listitem>
3530                 <para>require confirmation</para>
3531
3532                 <screenshot>
3533                   <screeninfo>Confirm checkout of lost item</screeninfo>
3534
3535                   <mediaobject>
3536                     <imageobject>
3537                       <imagedata fileref="images/admin/globalprefs/IssueLostItem-confirm.png"/>
3538                     </imageobject>
3539                   </mediaobject>
3540                 </screenshot>
3541               </listitem>
3542             </itemizedlist>
3543
3544             <para>Description:</para>
3545
3546             <itemizedlist>
3547               <listitem>
3548                 <para>This preference lets you define how library staff are
3549                 notified that an item with a lost status is being checked out.
3550                 This will help staff mark items as 'available' if you choose
3551                 to 'display a message' or 'require confirmation.' If you
3552                 choose to 'do nothing,' there will be no notification that the
3553                 item being checked out is marked as 'lost.'</para>
3554               </listitem>
3555             </itemizedlist>
3556           </section>
3557           <section id="ManInvInNoissuesCharge">
3558             <title>ManInvInNoissuesCharge</title>
3559             <para>Default: Include</para>
3560             <para>Asks: ___  MANUAL_INV charges when summing up charges for noissuescharge. </para>
3561             <para>Values:<itemizedlist>
3562                 <listitem>
3563                   <para>Don't include</para>
3564                 </listitem>
3565                 <listitem>
3566                   <para>Include</para>
3567                 </listitem>
3568               </itemizedlist></para>
3569             <para>Description:<itemizedlist>
3570                 <listitem>
3571                   <para>This preference lets you decide if charges entered as manual invoices are
3572                     included when calculating the <link linkend="noissuescharge">noissuescharge</link>. If this is set to include then Koha will include all
3573                     manual invoices when deciding if the patron owes too much money to check
3574                     anything else out of the library.  If it's set to Don't include then Koha will
3575                     ignore all manual invoice charges when figuring out if the patron owes too much
3576                     money to checkout additional materials.</para>
3577                 </listitem>
3578               </itemizedlist></para>
3579           </section>
3580
3581           <section id="maxoutstanding">
3582             <title>maxoutstanding</title>
3583
3584             <para>Default: 5</para>
3585
3586             <para>Asks: Prevent patrons from making holds on the OPAC if they
3587             owe more than ___ USD in fines.</para>
3588           </section>
3589
3590           <section id="noissuescharge">
3591             <title>noissuescharge</title>
3592
3593             <para>Default: 5</para>
3594
3595             <para>Asks: Prevent patrons from checking out books if they have
3596             more than ___ USD in fines.</para>
3597
3598             <para>Description:</para>
3599
3600             <itemizedlist>
3601               <listitem>
3602                 <para>This preference is the maximum amount of money owed to the library before the
3603                   user is banned from borrowing more items. Using the <link linkend="ManInvInNoissuesCharge">ManInvInNoissuesCharge</link> and <link linkend="RentalsInNoissuesCharge">RentalsInNoissuesCharge</link> preferences you
3604                   can control which types of charges are considered in this total. This also
3605                   coincides with <link linkend="maxoutstanding">maxoutstanding</link> that limits
3606                   patrons from placing holds when the maximum amount is owed to the library.</para>
3607               </listitem>
3608             </itemizedlist>
3609           </section>
3610           <section id="OnSiteCheckouts">
3611             <title>OnSiteCheckouts</title>
3612             <para>Default: Disable</para>
3613             <para>Asks: ___ the on-site checkouts feature.</para>
3614             <para>Values:<itemizedlist>
3615                 <listitem>
3616                   <para>Disable</para>
3617                 </listitem>
3618                 <listitem>
3619                   <para>Enable<screenshot>
3620                       <screeninfo>OnSiteCheckouts</screeninfo>
3621                       <mediaobject>
3622                         <imageobject>
3623                           <imagedata fileref="images/admin/globalprefs/OnSiteCheckouts.png"/>
3624                         </imageobject>
3625                       </mediaobject>
3626                     </screenshot></para>
3627                 </listitem>
3628               </itemizedlist></para>
3629             <para>Description:<itemizedlist>
3630                 <listitem>
3631                   <para>This preference lets you check out items that are 'not for loan' to patrons.
3632                     A checkbox is added to the checkout screen when this preference is set to
3633                     'Enable' labeled 'On-site checkout'. This allows you to track who's using items
3634                     that are normally not for loan or are in a closed stack setting.</para>
3635                 </listitem>
3636               </itemizedlist></para>
3637           </section>
3638           <section id="OnSiteCheckoutsForce">
3639             <title>OnSiteCheckoutsForce</title>
3640             <para>Default: Disable</para>
3641             <para>Asks: ___ the on-site for all cases (Even if a user is debarred, etc.).</para>
3642             <para>Values:<itemizedlist>
3643                 <listitem>
3644                   <para>Disable</para>
3645                 </listitem>
3646                 <listitem>
3647                   <para>Enable</para>
3648                   <screenshot>
3649                     <screeninfo>Force checkouts on restricted patrons</screeninfo>
3650                     <mediaobject>
3651                       <imageobject>
3652                         <imagedata fileref="images/admin/globalprefs/OnSiteCheckoutsForce.png"/>
3653                       </imageobject>
3654                     </mediaobject>
3655                   </screenshot>
3656                 </listitem>
3657
3658               </itemizedlist></para>
3659             <para>Description:<itemizedlist>
3660                 <listitem>
3661                   <para>This preference lets the staff override any restrictions a patron might have
3662                     and check out items for use within the library.  The <link
3663                       linkend="OnSiteCheckouts">OnSiteCheckouts</link> preference must first be set
3664                     to 'Enable' for this preference to be considered.</para>
3665                 </listitem>
3666               </itemizedlist></para>
3667           </section>
3668
3669           <section id="OverduesBlockCirc">
3670             <title>OverduesBlockCirc</title>
3671
3672             <para>Default: Ask for confirmation</para>
3673
3674             <para>Asks: ___ when checking out to a borrower that has overdues
3675             outstanding</para>
3676
3677             <para>Values:</para>
3678
3679             <itemizedlist>
3680               <listitem>
3681                 <para>Ask for confirmation</para>
3682
3683                 <itemizedlist>
3684                   <listitem>
3685                     <para>Will not let you check an item out to patrons with
3686                     overdues until a librarian confirms that it is okay</para>
3687                   </listitem>
3688                 </itemizedlist>
3689               </listitem>
3690
3691               <listitem>
3692                 <para>Block</para>
3693
3694                 <itemizedlist>
3695                   <listitem>
3696                     <para>Block all patrons with overdue items from being able
3697                     to check out</para>
3698                   </listitem>
3699                 </itemizedlist>
3700               </listitem>
3701
3702               <listitem>
3703                 <para>Don't block</para>
3704
3705                 <itemizedlist>
3706                   <listitem>
3707                     <para>Allow all patrons with overdue items to continue to
3708                     check out</para>
3709                   </listitem>
3710                 </itemizedlist>
3711               </listitem>
3712             </itemizedlist>
3713           </section>
3714
3715           <section id="OverdueNoticeBcc">
3716             <title>OverdueNoticeBcc</title>
3717
3718             <para>Asks: Send all notices as a BCC to this email address
3719             ___</para>
3720
3721             <para>This preference makes it so that a librarian can get a copy of every notice sent
3722               out to patrons.<note>
3723                 <para>If you'd like more than one person to receive the blind copy you can simply
3724                   enter in multiple email addresses separated by commas.</para>
3725               </note><note>
3726                 <para>The name of this preference is misleading, it does not only send overdues, but
3727                   all notices to the BCC address.</para>
3728               </note></para>
3729           </section>
3730           <section id="OverdueNoticeCalendar">
3731             <title>OverdueNoticeCalendar</title>
3732             <para>Default: Ignore calendar</para>
3733             <para>Asks: ___  when working out the period for overdue notices</para>
3734             <para>Values:<itemizedlist>
3735                 <listitem>
3736                   <para>Ignore calendar<itemizedlist>
3737                       <listitem>
3738                         <para>Notices do not take holidays into account, so they will be sent even
3739                           if holidays have meant the item is not actually overdue yet</para>
3740                       </listitem>
3741                     </itemizedlist></para>
3742                 </listitem>
3743                 <listitem>
3744                   <para>Use calendar<itemizedlist>
3745                       <listitem>
3746                         <para>Notices take holidays into account, so they will not be sent if
3747                           holidays mean the item is not actually overdue yet</para>
3748                       </listitem>
3749                     </itemizedlist></para>
3750                 </listitem>
3751               </itemizedlist></para>
3752           </section>
3753
3754           <section id="PrintNoticesMaxLines">
3755             <title>PrintNoticesMaxLines</title>
3756
3757             <para>Asks: Include up to ___ item lines in a printed overdue
3758             notice.</para>
3759
3760             <note>
3761               <para>If the number of items is greater than this number, the
3762               notice will end with a warning asking the borrower to check
3763               their online account for a full list of overdue items.</para>
3764             </note>
3765
3766             <note>
3767               <para>Set to 0 to include all overdue items in the notice, no
3768               matter how many there are.</para>
3769             </note>
3770
3771             <important>
3772               <para>This preference only refers to the print notices, not
3773               those sent via email.</para>
3774             </important>
3775           </section>
3776
3777           <section id="RenewalPeriodBase">
3778             <title>RenewalPeriodBase</title>
3779
3780             <para>Default: the old due date of the checkout</para>
3781
3782             <para>Asks: When renewing checkouts, base the new due date on
3783             ___</para>
3784
3785             <para>Values:</para>
3786
3787             <itemizedlist>
3788               <listitem>
3789                 <para>the old due date of the checkout</para>
3790               </listitem>
3791
3792               <listitem>
3793                 <para>the current date</para>
3794               </listitem>
3795             </itemizedlist>
3796           </section>
3797           <section id="RenewalSendNotice">
3798             <title>RenewalSendNotice</title>
3799             <para> Default: Don't send </para>
3800             <para>Asks: ____ a renewal notice according to patron checkout alert preferences. </para>
3801             <para>Values: <itemizedlist>
3802                 <listitem>
3803                   <para>Don't send</para>
3804                 </listitem>
3805                 <listitem>
3806                   <para>Send</para>
3807                 </listitem>
3808               </itemizedlist></para>
3809             <para>Description:<itemizedlist>
3810                 <listitem>
3811                   <para>If a patron has chosen to receive a check out notice in their messaging
3812                     preferences and this preference is set to 'Send' then those patrons will also
3813                     receive a notice when they renew materials. You will want to set up a <link
3814                       linkend="addnotices">new notice</link> with the code of RENEWAL (if you don't
3815                     already have it) with custom text for renewing items.<important>
3816                       <para>This preference requires that you have <link
3817                           linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
3818                         set to 'Allow'</para>
3819                     </important></para>
3820                 </listitem>
3821               </itemizedlist></para>
3822           </section>
3823           <section id="RentalsInNoissuesCharge">
3824             <title>RentalsInNoissuesCharge</title>
3825             <para>Default: Include</para>
3826             <para>Asks: ___  rental charges when summing up charges for noissuescharge. </para>
3827             <para>Values:<itemizedlist>
3828                 <listitem>
3829                   <para>Don't include</para>
3830                 </listitem>
3831                 <listitem>
3832                   <para>Include</para>
3833                 </listitem>
3834               </itemizedlist></para>
3835             <para>Description:<itemizedlist>
3836                 <listitem>
3837                   <para>This preference lets you decide if rental charges are included when
3838                     calculating the <link linkend="noissuescharge">noissuescharge</link>. If this is
3839                     set to include then Koha will include all rental charges when deciding if the
3840                     patron owes too much money to check anything else out of the library.  If it's
3841                     set to Don't include then Koha will ignore all rental charges when figuring out
3842                     if the patron owes too much money to checkout additional materials.</para>
3843                 </listitem>
3844               </itemizedlist></para>
3845           </section>
3846
3847           <section id="ReturnBeforeExpiry">
3848             <title>ReturnBeforeExpiry</title>
3849
3850             <para>Default: Don't require</para>
3851
3852             <para>Asks: ___ patrons to return books before their accounts
3853             expire (by restricting due dates to before the patron's expiration
3854             date).</para>
3855
3856             <para>Values:</para>
3857
3858             <itemizedlist>
3859               <listitem>
3860                 <para>Don't require</para>
3861               </listitem>
3862
3863               <listitem>
3864                 <para>Require</para>
3865               </listitem>
3866             </itemizedlist>
3867
3868             <para>Description:</para>
3869
3870             <itemizedlist>
3871               <listitem>
3872                 <para>This is preference may prevent a patron from having
3873                 items checked out after their library card has expired. If
3874                 this is set to "Require", then a due date of any checked out
3875                 item can not be set for a date which falls after the patron's
3876                 card expiration. If the setting is left "Don't require" then
3877                 item check out dates may exceed the expiration date for the
3878                 patron's library card.</para>
3879               </listitem>
3880             </itemizedlist>
3881           </section>
3882
3883           <section id="ReturnToShelvingCart">
3884             <title>ReturnToShelvingCart</title>
3885
3886             <para>Default: Don't move</para>
3887
3888             <para>Asks: ___ all items to the location CART when they are
3889             checked in.</para>
3890
3891             <para>Values:</para>
3892
3893             <itemizedlist>
3894               <listitem>
3895                 <para>Don't move</para>
3896               </listitem>
3897
3898               <listitem>
3899                 <para>Move</para>
3900               </listitem>
3901             </itemizedlist>
3902           </section>
3903           <section id="StaffSearchResultsDisplayBranch">
3904             <title>StaffSearchResultsDisplayBranch</title>
3905             <para>Default: the library the item is held by</para>
3906             <para>Asks: For search results in the staff client, display the branch of ___</para>
3907             <para>Values:<itemizedlist>
3908                 <listitem>
3909                   <para>the library the item is from</para>
3910                 </listitem>
3911                 <listitem>
3912                   <para>the library the items is held by</para>
3913                 </listitem>
3914               </itemizedlist></para>
3915           </section>
3916
3917           <section id="TransfersMaxDaysWarning">
3918             <title>TransfersMaxDaysWarning</title>
3919
3920             <para>Default: 3</para>
3921
3922             <para>Asks: Show a warning on the "Transfers to Receive" screen if
3923             the transfer has not been received ___ days after it is
3924             sent.</para>
3925
3926             <para>Description:</para>
3927
3928             <itemizedlist>
3929               <listitem>
3930                 <para>The TransferMaxDaysWarning preference is set at a
3931                 default number of days. This preference allows for a warning
3932                 to appear after a set amount of time if an item being
3933                 transferred between library branches has not been received.
3934                 The warning will appear in the <link linkend="transferstoreceive">Transfers to Receive</link>
3935                 report.</para>
3936               </listitem>
3937             </itemizedlist>
3938           </section>
3939
3940           <section id="UseBranchTransferLimits">
3941             <title>UseBranchTransferLimits &amp;
3942             BranchTransferLimitsType</title>
3943
3944             <para>Defaults: Don't enforce &amp; collection code</para>
3945
3946             <para>Asks: ___ branch transfer limits based on ___</para>
3947
3948             <para>UseBranchTransferLimits Values:</para>
3949
3950             <itemizedlist>
3951               <listitem>
3952                 <para>Don't enforce</para>
3953               </listitem>
3954
3955               <listitem>
3956                 <para>Enforce</para>
3957               </listitem>
3958             </itemizedlist>
3959
3960             <para>BranchTransferLimitsType Values:</para>
3961
3962             <itemizedlist>
3963               <listitem>
3964                 <para>collection code</para>
3965               </listitem>
3966
3967               <listitem>
3968                 <para>item type</para>
3969               </listitem>
3970             </itemizedlist>
3971
3972             <para>BranchTransferLimitsType Description:</para>
3973
3974             <itemizedlist>
3975               <listitem>
3976                 <para>This parameter is a binary setting which determines
3977                 whether items are transferred according to item type or
3978                 collection code. This value determines how the library manager
3979                 is able to restrict what items can be transferred between the
3980                 branches.</para>
3981               </listitem>
3982             </itemizedlist>
3983           </section>
3984
3985           <section id="useDaysMode">
3986             <title>useDaysMode</title>
3987
3988             <para>Default: Don't include</para>
3989
3990             <para>Asks: Calculate the due date using ___.</para>
3991
3992             <para>Values:</para>
3993
3994             <itemizedlist>
3995               <listitem>
3996                 <para>circulation rules only.</para>
3997               </listitem>
3998
3999               <listitem>
4000                 <para>the calendar to push the due date to the next open
4001                 day.</para>
4002               </listitem>
4003
4004               <listitem>
4005                 <para>the calendar to skip all days the library is
4006                 closed.</para>
4007               </listitem>
4008             </itemizedlist>
4009
4010             <para>Description:</para>
4011
4012             <itemizedlist>
4013               <listitem>
4014                 <para>This preference controls how scheduled library closures
4015                 affect the due date of a material. The 'the calendar to skip
4016                 all days the library is closed' setting allows for a scheduled
4017                 closure not to count as a day in the loan period, the
4018                 'circulation rules only' setting would not consider the
4019                 scheduled closure at all, and 'the calendar to push the due
4020                 date to the next open day' would only effect the due date if
4021                 the day the item is due would fall specifically on the day of
4022                 closure.</para>
4023               </listitem>
4024             </itemizedlist>
4025
4026             <para>Example:</para>
4027
4028             <itemizedlist>
4029               <listitem>
4030                 <para>The library has put December 24th and 25th in as
4031                 closures on the calendar. A book checked out by a patron has a
4032                 due date of December 25th according to the circulation and
4033                 fine rules. If this preference is set to 'circulation rules
4034                 only' then the item will remain due on the 25th. If the
4035                 preference is set to 'the calendar to push the due date to the
4036                 next open day' then the due date will be December 26th. If the
4037                 preference is set to 'the calendar to skip all days the
4038                 library is closed' then the due date will be pushed to the
4039                 27th of December to accommodate for the two closed
4040                 days.</para>
4041               </listitem>
4042             </itemizedlist>
4043
4044             <para>The calendar is defined on a branch by branch basis. To
4045             learn more about the calendar, check out the '<link linkend="calholidays">Calendar &amp; Holidays</link>' section of
4046             this manual.</para>
4047           </section>
4048           <section id="UseTransportCostMatrix">
4049             <title>UseTransportCostMatrix</title>
4050             <para>Default: Don't use</para>
4051             <para>Asks: ___  Transport Cost Matrix for calculating optimal holds filling between
4052               branches.</para>
4053             <para>Values:<itemizedlist>
4054                 <listitem>
4055                   <para>Don't use</para>
4056                 </listitem>
4057                 <listitem>
4058                   <para>Use</para>
4059                 </listitem>
4060               </itemizedlist></para>
4061             <para>Description:<itemizedlist>
4062                 <listitem>
4063                   <para>If the system is configured to use the <link linkend="transportcostmatrix">Transport cost matrix</link> for filling holds, then when attempting to fill
4064                     a hold, the system will search for the lowest cost branch, and attempt to fill
4065                     the hold with an item from that branch first. Branches of equal cost will be
4066                     selected from randomly. The branch or branches of the next highest cost shall be
4067                     selected from only if all the branches in the previous group are unable to fill
4068                     the hold.</para>
4069                   <para>The system will use the item's current holding branch when determining
4070                     whether the item can fulfill a hold using the Transport Cost Matrix. </para>
4071                 </listitem>
4072               </itemizedlist></para>
4073           </section>
4074         </section>
4075         <section id="coursereserveprefs">
4076           <title>Course Reserves</title>
4077           <section id="UseCourseReserves">
4078             <title>UseCourseReserves</title>
4079             <para>Default: Don't use</para>
4080             <para>Asks: ___ course reserves</para>
4081             <para>Values:</para>
4082             <itemizedlist>
4083               <listitem>
4084                 <para>Don't use</para>
4085               </listitem>
4086               <listitem>
4087                 <para>Use</para>
4088               </listitem>
4089             </itemizedlist>
4090             <para>Description:<itemizedlist>
4091                 <listitem>
4092                   <para>The <link linkend="coursereserves">Course Reserves</link> module in Koha
4093                     allows you to temporarily move items to 'reserve' and assign different
4094                     circulation rules to these items while they are being used for a specific
4095                     course.</para>
4096                 </listitem>
4097               </itemizedlist></para>
4098           </section>
4099         </section>
4100
4101         <section id="circfinespolicy">
4102           <title>Fines Policy</title>
4103
4104           <para/>
4105
4106           <section id="finesCalendar">
4107             <title>finesCalendar</title>
4108
4109             <para>Default: not including the days the library is closed</para>
4110
4111             <para>Asks: Calculate fines based on days overdue ___</para>
4112
4113             <para>Values:</para>
4114
4115             <itemizedlist>
4116               <listitem>
4117                 <para>directly</para>
4118               </listitem>
4119
4120               <listitem>
4121                 <para>not including the days the library is closed</para>
4122               </listitem>
4123             </itemizedlist>
4124
4125             <para>Description:</para>
4126
4127             <itemizedlist>
4128               <listitem>
4129                 <para>This preference will determine whether or not fines will
4130                 be accrued during instances when the library is closed.
4131                 Examples include holidays, library in-service days, etc.
4132                 Choosing "not including the days the library is closed"
4133                 setting will enable Koha to access its <link linkend="calholidays">Calendar</link> module and be
4134                 considerate of dates when the library is closed. To make use
4135                 of this setting the administrator must first access Koha's
4136                 calendar and mark certain days as "holidays" ahead of
4137                 time.</para>
4138               </listitem>
4139             </itemizedlist>
4140
4141             <para>The calendar is defined on a branch by branch basis. To
4142             learn more about the calendar, check out the '<link linkend="calholidays">Calendar &amp; Holidays</link>' section of
4143             this manual.</para>
4144           </section>
4145           <section id="FinesIncludeGracePeriod">
4146             <title>FinesIncludeGracePeriod</title>
4147             <para>Default: Include</para>
4148             <para>Asks: ___  the grace period when calculating the fine for an overdue item.</para>
4149             <para>Values:<itemizedlist>
4150                 <listitem>
4151                   <para>Don't include</para>
4152                 </listitem>
4153                 <listitem>
4154                   <para>Include</para>
4155                 </listitem>
4156               </itemizedlist></para>
4157             <para>Description:<itemizedlist>
4158                 <listitem>
4159                   <para>This preference lets you control how Koha calculates fines when there is a
4160                     grace period. If you choose to include the grace period when calculating fines
4161                     then Koha will charge for the days in the grace period should the item be
4162                     overdue more than those days. If you choose not to include the grace period then
4163                     Koha will only charge for the days overdue after the grace period.</para>
4164                 </listitem>
4165               </itemizedlist></para>
4166           </section>
4167
4168           <section id="finesMode">
4169             <title>finesMode</title>
4170
4171             <para>Default: Calculate (but only for mailing to the
4172             admin)</para>
4173
4174             <para>Asks: ___ fines</para>
4175
4176             <para>Values:</para>
4177
4178             <itemizedlist>
4179               <listitem>
4180                 <para>Calculate (but only for mailing to the admin)</para>
4181               </listitem>
4182
4183               <listitem>
4184                 <para>Calculate and charge</para>
4185               </listitem>
4186
4187               <listitem>
4188                 <para>Don't calculate</para>
4189               </listitem>
4190             </itemizedlist>
4191
4192             <important>
4193               <para>Requires that you have the fines cron job running
4194               (misc/cronjobs/fines.pl)</para>
4195             </important>
4196           </section>
4197           <section id="RefundLostItemFeeOnReturn">
4198             <title>RefundLostItemFeeOnReturn</title>
4199             <para>Default: Refund</para>
4200             <para>Asks: ___  lost item fees charged to a borrower when the lost item is
4201               returned.</para>
4202             <para>Values:<itemizedlist>
4203                 <listitem>
4204                   <para>Don't refund</para>
4205                 </listitem>
4206                 <listitem>
4207                   <para>Refund</para>
4208                 </listitem>
4209               </itemizedlist></para>
4210             <para>Description:<itemizedlist>
4211                 <listitem>
4212                   <para>When an item is marked lost in Koha the system charges the patron the
4213                     replacement fee for the item.  This preference lets you control how Koha handles
4214                     returns of these items.  By default when an item that was previously marked lost
4215                     is checked in Koha refunds the patron the replacement fee. Change this
4216                     preference to "Don't refund" if you would like Koha to not refund the
4217                     replacement fee.</para>
4218                 </listitem>
4219               </itemizedlist></para>
4220           </section>
4221           <section id="WhenLostChargeReplacementFee">
4222             <title>WhenLostChargeReplacementFee</title>
4223             <para>Default: Charge</para>
4224             <para>Asks: ___  the replacement price when a patron loses an item. </para>
4225             <para>Values:<itemizedlist>
4226                 <listitem>
4227                   <para>Charge</para>
4228                 </listitem>
4229                 <listitem>
4230                   <para>Don't charge</para>
4231                 </listitem>
4232               </itemizedlist></para>
4233             <para>Description:<itemizedlist>
4234                 <listitem>
4235                   <para>This preference lets you tell Koha what to do with an item is marked lost.
4236                     If you want Koha can 'Charge' the patron the replacement fee listed on the item
4237                     they lost or it can do nothing in reference to the patron and just mark the item
4238                     lost in the catalog.</para>
4239                 </listitem>
4240               </itemizedlist></para>
4241           </section>
4242           <section id="WhenLostForgiveFine">
4243             <title>WhenLostForgiveFine</title>
4244             <para>Default: Don't forgive</para>
4245             <para>Asks: ___  the fines on an item when it is lost.</para>
4246             <para>Values:<itemizedlist>
4247                 <listitem>
4248                   <para>Don't forgive</para>
4249                 </listitem>
4250                 <listitem>
4251                   <para>Forgive</para>
4252                 </listitem>
4253               </itemizedlist></para>
4254             <para>Description:<itemizedlist>
4255                 <listitem>
4256                   <para>This preference allows the library to decide if fines are charged in
4257                     addition to the replacement fee when an item is marked as lost.  If this
4258                     preference is set to 'Forgive' then the patron won't be charged fines in
4259                     addition to the replacement fee.</para>
4260                 </listitem>
4261               </itemizedlist></para>
4262           </section>
4263         </section>
4264
4265         <section id="circholdspolicy">
4266           <title>Holds Policy</title>
4267
4268           <para/>
4269
4270           <section id="AllowHoldDateInFuture">
4271             <title>AllowHoldDateInFuture</title>
4272
4273             <para>Default: Allow</para>
4274
4275             <para>Asks: ___ hold requests to be placed that do not enter the
4276             waiting list until a certain future date.</para>
4277
4278             <para>Values:</para>
4279
4280             <itemizedlist>
4281               <listitem>
4282                 <para>Allow</para>
4283               </listitem>
4284
4285               <listitem>
4286                 <para>Don't allow</para>
4287               </listitem>
4288             </itemizedlist>
4289           </section>
4290
4291           <section id="AllowHoldsOnDamagedItems">
4292             <title>AllowHoldsOnDamagedItems</title>
4293
4294             <para>Default: Allow</para>
4295
4296             <para>Asks: ___ hold requests to be placed on damaged
4297             items.</para>
4298
4299             <para>Values:</para>
4300
4301             <itemizedlist>
4302               <listitem>
4303                 <para>Allow</para>
4304               </listitem>
4305
4306               <listitem>
4307                 <para>Don't allow</para>
4308               </listitem>
4309             </itemizedlist>
4310
4311             <para>Description:</para>
4312
4313             <itemizedlist>
4314               <listitem>
4315                 <para>This parameter is a binary setting which controls
4316                 whether or not hold requests can be placed on items that are
4317                 marked as "damaged" (items are marked as damaged by editing
4318                 subfield 4 on the item record). Setting this value to "Don't
4319                 allow" will prevent anyone from placing a hold on such items,
4320                 setting it to "Allow" will allow it. This preference is
4321                 important because it determines whether or not a patron can
4322                 place a request for an item that might be in the process of
4323                 being repaired or not in good condition. The library may wish
4324                 to set this to "Don't allow" if they were concerned about
4325                 their patrons not receiving the item in a timely manner or at
4326                 all (if it is determined that the item is beyond repair).
4327                 Setting it to "Allow" would allow a patron to place a hold on
4328                 an item and therefore receive it as soon as it becomes
4329                 available.</para>
4330               </listitem>
4331             </itemizedlist>
4332           </section>
4333           <section id="AllowHoldsOnPatronsPossessions">
4334             <title>AllowHoldsOnPatronsPossessions</title>
4335             <para>Default: Allow </para>
4336             <para>Asks: ____ a patron to place a hold on a record where the patron already has one
4337               or more items attached to that record checked out. </para>
4338             <para>Values:<itemizedlist>
4339                 <listitem>
4340                   <para>Allow</para>
4341                 </listitem>
4342                 <listitem>
4343                   <para>Don't allow</para>
4344                 </listitem>
4345               </itemizedlist></para>
4346             <para>Description:<itemizedlist>
4347                 <listitem>
4348                   <para>By setting to "Don't allow," you can prevent patrons from placing holds on
4349                     items they already have out, thus preventing them from blocking anyone else from
4350                     getting an item. </para>
4351                 </listitem>
4352               </itemizedlist></para>
4353           </section>
4354
4355           <section id="AllowHoldPolicyOverride">
4356             <title>AllowHoldPolicyOverride</title>
4357
4358             <para>Default: Allow</para>
4359
4360             <para>Asks: ___ staff to override hold policies when placing
4361             holds.</para>
4362
4363             <para>Values:</para>
4364
4365             <itemizedlist>
4366               <listitem>
4367                 <para>Allow</para>
4368               </listitem>
4369
4370               <listitem>
4371                 <para>Don't allow</para>
4372               </listitem>
4373             </itemizedlist>
4374
4375             <para>Description:</para>
4376
4377             <itemizedlist>
4378               <listitem>
4379                 <para>This preference is a binary setting which controls
4380                 whether or not the library staff can override the circulation
4381                 and fines rules as they pertain to the placement of holds.
4382                 Setting this value to "Don't allow" will prevent anyone from
4383                 overriding, setting it to "Allow" will allow it. This setting
4384                 is important because it determines how strict the libraries
4385                 rules for placing holds are. If this is set to "Allow",
4386                 exceptions can be made for patrons who are otherwise normally
4387                 in good standing with the library, but there is opportunity
4388                 for the staff to abuse this function. If it is set to "Don't
4389                 allow", no abuse of the system is possible, but it makes the
4390                 system entirely inflexible in respect to holds.</para>
4391               </listitem>
4392             </itemizedlist>
4393           </section>
4394           <section id="AllowRenewalIfOtherItemsAvailable">
4395             <title>AllowRenewalIfOtherItemsAvailable</title>
4396             <para>Default: Don't allow</para>
4397             <para>Asks: ___  a patron to renew an item with unfilled holds if other available items
4398               can fill that hold.</para>
4399             <para>Values:<itemizedlist>
4400                 <listitem>
4401                   <para>Allow</para>
4402                 </listitem>
4403                 <listitem>
4404                   <para>Don't allow</para>
4405                 </listitem>
4406               </itemizedlist></para>
4407           </section>
4408
4409           <section id="AutoResumeSuspendedHolds">
4410             <title>AutoResumeSuspendedHolds</title>
4411
4412             <para>Default: Allow</para>
4413
4414             <para>Asks: ___ suspended holds to be automatically resumed by a
4415             set date.</para>
4416
4417             <para>Values:</para>
4418
4419             <itemizedlist>
4420               <listitem>
4421                 <para>Allow</para>
4422               </listitem>
4423
4424               <listitem>
4425                 <para>Don't allow</para>
4426               </listitem>
4427             </itemizedlist>
4428
4429             <para>Description:</para>
4430
4431             <itemizedlist>
4432               <listitem>
4433                 <para>If this preference is set to 'Allow' then all suspended holds will be able to
4434                   have a date at after which they automatically become unsuspended. If you have this
4435                   preference set to 'Allow' you will also need the <link linkend="unsuspendholdcron">Unsuspend Holds</link> cron job running.</para>
4436               </listitem>
4437             </itemizedlist>
4438             <important>
4439               <para>The holds will become unsuspended the date after that entered by the
4440                 patron.</para>
4441             </important>
4442           </section>
4443
4444           <section id="canreservefromotherbranches">
4445             <title>canreservefromotherbranches</title>
4446
4447             <para>Default: Allow</para>
4448
4449             <para>Asks: ___ a user from one library to place a hold on an item
4450             from another library</para>
4451
4452             <para>Description:</para>
4453
4454             <itemizedlist>
4455               <listitem>
4456                 <para>This preference is a binary setting which determines
4457                 whether patrons can place holds on items from other branches.
4458                 If the preference is set to "Allow" patrons can place such
4459                 holds, if it is set to "Don't allow" they cannot. This is an
4460                 important setting because it determines if users can use Koha
4461                 to request items from another branch. If the library is
4462                 sharing an installation of Koha with other independent
4463                 libraries which do not wish to allow interlibrary borrowing it
4464                 is recommended that this parameter be set to "Don't
4465                 allow".</para>
4466               </listitem>
4467             </itemizedlist>
4468
4469             <para>Values:</para>
4470
4471             <itemizedlist>
4472               <listitem>
4473                 <para>Allow</para>
4474               </listitem>
4475
4476               <listitem>
4477                 <para>Don't allow (with <link linkend="IndependentBranches">independent
4478                     branches</link>)</para>
4479               </listitem>
4480             </itemizedlist>
4481           </section>
4482           <section id="ConfirmFutureHolds">
4483             <title>ConfirmFutureHolds</title>
4484             <para>Default: 0</para>
4485             <para>Asks: Confirm future hold requests (starting no later than ___ days from now) at
4486               checkin time.  </para>
4487             <para>Description:<itemizedlist>
4488                 <listitem>
4489                   <para>When confirming a hold at checkin time, the number of days in this
4490                     preference is taken into account when deciding which holds to show alerts for.
4491                     This preference does not interfere with renewing, checking out or transferring a
4492                     book.</para>
4493                 </listitem>
4494               </itemizedlist></para>
4495             <note>
4496               <para>This number of days will be used too in calculating the default end date for the
4497                 Holds to pull-report. But it does not interfere with issuing, renewing or
4498                 transferring books.</para>
4499             </note>
4500             <important>
4501               <para>This preference is only looked at if you're allowing hold dates in the future
4502                 with <link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link> or <link
4503                   linkend="OPACAllowHoldDateInFuture">OPACAllowHoldDateInFuture</link></para>
4504             </important>
4505           </section>
4506           <section id="decreaseLoanHighHolds">
4507             <title>decreaseLoanHighHolds, decreaseLoanHighHoldsDuration and
4508               decreaseLoanHighHoldsValue</title>
4509             <para>Asks: ___ the reduction of loan period to ___ days for items with more than ___
4510               holds. </para>
4511             <para>decreaseLoanHighHolds default: Don't enable</para>
4512             <para>decreaseLoanHighHolds values:<itemizedlist>
4513                 <para>Don't enable</para>
4514                 <listitem>
4515                   <para>Enable</para>
4516                 </listitem>
4517               </itemizedlist>Description:<itemizedlist>
4518                 <listitem>
4519                   <para>These preferences let you change the loan length for items that have many
4520                     holds on them.  This will not effect items that are already checked out, but
4521                     items that are checked out after the decreaseLoanHighHoldsValue is met will only
4522                     be checked out for the number of days entered in the
4523                     decreaseLoanHighHoldsDuration preference.</para>
4524                   <screenshot>
4525                     <screeninfo>Warning on checkout</screeninfo>
4526                     <mediaobject>
4527                       <imageobject>
4528                         <imagedata fileref="images/admin/globalprefs/decreaseLoanHighHoldsDuration.png"/>
4529                       </imageobject>
4530                     </mediaobject>
4531                   </screenshot>
4532                 </listitem>
4533               </itemizedlist></para>
4534           </section>
4535
4536           <section id="DisplayMultiPlaceHold">
4537             <title>DisplayMultiPlaceHold</title>
4538
4539             <para>Default: Don't enable</para>
4540
4541             <para>Asks: ___ the ability to place holds on multiple biblio from
4542             the search results</para>
4543
4544             <para>Values:</para>
4545
4546             <itemizedlist>
4547               <listitem>
4548                 <para>Don't enable</para>
4549               </listitem>
4550
4551               <listitem>
4552                 <para>Enable</para>
4553               </listitem>
4554             </itemizedlist>
4555           </section>
4556
4557           <section id="emailLibrarianWhenHoldIsPlaced">
4558             <title>emailLibrarianWhenHoldIsPlaced</title>
4559
4560             <para>Default: Don't enable</para>
4561
4562             <para>Asks: ___ sending an email to the Koha administrator email
4563             address whenever a hold request is placed.</para>
4564
4565             <para>Values:</para>
4566
4567             <itemizedlist>
4568               <listitem>
4569                 <para>Don't enable</para>
4570               </listitem>
4571
4572               <listitem>
4573                 <para>Enable</para>
4574               </listitem>
4575             </itemizedlist>
4576
4577             <para>Description:</para>
4578
4579             <itemizedlist>
4580               <listitem>
4581                 <para>This preference enables Koha to email the library staff
4582                 whenever a patron requests an item to be held. While this
4583                 function will immediately alert the librarian to the patron's
4584                 need, it is extremely impractical in most library settings. In
4585                 most libraries the hold lists are monitored and maintained
4586                 from a separate interface. That said, many libraries that
4587                 allow on shelf holds prefer to have this preference turned on
4588                 so that they are alerted to pull an item from the
4589                 shelf.</para>
4590               </listitem>
4591             </itemizedlist>
4592
4593             <important>
4594               <para>In order for this email to send you must have a <link linkend="notices"
4595                   >notice</link> template with the code of HOLDPLACED</para>
4596             </important>
4597
4598             <important>
4599               <para>This notice will only be sent if the <link linkend="msgqueuecron">process_message_queue.pl cronjob</link>
4600               being run periodically to send the messages.</para>
4601             </important>
4602           </section>
4603
4604           <section id="ExpireReservesMaxPickUpDelay">
4605             <title>ExpireReservesMaxPickUpDelay</title>
4606
4607             <para>Default: Don't allow</para>
4608
4609             <para>Asks: ___ holds to expire automatically if they have not
4610             been picked by within the time period specified in <link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link></para>
4611
4612             <para>Values:</para>
4613
4614             <itemizedlist>
4615               <listitem>
4616                 <para>Allow</para>
4617               </listitem>
4618
4619               <listitem>
4620                 <para>Don't allow</para>
4621               </listitem>
4622             </itemizedlist>
4623
4624             <para>Description:</para>
4625
4626             <itemizedlist>
4627               <listitem>
4628                 <para>If set to 'allow' this will cancel holds that have been
4629                 waiting for longer than the number of days specified in the
4630                 <link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
4631                 system preference. Holds will only be cancelled if the <link linkend="expiredholdscron">Expire Holds cron job</link> is
4632                 runnning.</para>
4633               </listitem>
4634             </itemizedlist>
4635           </section>
4636
4637           <section id="ExpireReservesMaxPickUpDelayCharge">
4638             <title>ExpireReservesMaxPickUpDelayCharge</title>
4639
4640             <para>Default: 0</para>
4641
4642             <para>Asks: If using <link linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>,
4643             charge a borrower who allows his or her waiting hold to expire a
4644             fee of ___ USD</para>
4645
4646             <para>Description:</para>
4647
4648             <itemizedlist>
4649               <listitem>
4650                 <para>If you are expiring holds that have been waiting too
4651                 long you can use this preference to charge the patron for not
4652                 picking up their hold. If you don't charge patrons for items
4653                 that aren't picked up you can leave this set to the default
4654                 which is 0. Holds will only be cancelled and charged if the
4655                 <link linkend="expiredholdscron">Expire Holds cron job</link>
4656                 is running.</para>
4657               </listitem>
4658             </itemizedlist>
4659           </section>
4660           <section id="ExpireReservesOnHolidays">
4661             <title>ExpireReservesOnHolidays</title>
4662             <para>Default: Allow</para>
4663             <para>Asks: ___  expired holds to be cancelled on days the library is closed.</para>
4664             <para>Values:<itemizedlist>
4665                 <listitem>
4666                   <para>Allow</para>
4667                 </listitem>
4668                 <listitem>
4669                   <para>Don't allow</para>
4670                 </listitem>
4671               </itemizedlist></para>
4672           </section>
4673           <section label="" id="LocalHoldsPriority">
4674             <title>LocalHoldsPriority, LocalHoldsPriorityPatronControl,
4675               LocalHoldsPriorityItemControl</title>
4676             <para>Asks: ___ priority for filling holds to patrons whose ___ matches the item's
4677               ___</para>
4678             <para>LocalHoldsPriority Values:<itemizedlist>
4679                 <listitem>
4680                   <para>Don't give</para>
4681                 </listitem>
4682                 <listitem>
4683                   <para>Give</para>
4684                 </listitem>
4685               </itemizedlist></para>
4686             <para>LocalHoldsPriorityPatronControl Values:<itemizedlist>
4687                 <listitem>
4688                   <para>home library</para>
4689                 </listitem>
4690                 <listitem>
4691                   <para>pickup library</para>
4692                 </listitem>
4693               </itemizedlist></para>
4694             <para>LocalHoldsPriorityItemControl Values:<itemizedlist>
4695                 <listitem>
4696                   <para>holding library</para>
4697                 </listitem>
4698                 <listitem>
4699                   <para>home library</para>
4700                 </listitem>
4701               </itemizedlist></para>
4702             <para>Description:<itemizedlist>
4703                 <listitem>
4704                   <para>This feature will allow libraries to specify that, when an item is returned,
4705                     a local hold may be given priority for fulfillment even though it is of lower
4706                     priority in the list of unfilled holds. </para>
4707                 </listitem>
4708               </itemizedlist></para>
4709           </section>
4710
4711           <section id="maxreserves">
4712             <title>maxreserves</title>
4713
4714             <para>Default: 50</para>
4715
4716             <para>Asks: Patrons can only have ___ holds at once.</para>
4717           </section>
4718
4719           <section id="OPACAllowHoldDateInFuture">
4720             <title>OPACAllowHoldDateInFuture</title>
4721
4722             <para>Default: Allow</para>
4723
4724             <para>Asks: ___ patrons to place holds that don't enter the
4725             waiting list until a certain future date.</para>
4726
4727             <para>Values:</para>
4728
4729             <itemizedlist>
4730               <listitem>
4731                 <para>Allow</para>
4732
4733                 <itemizedlist>
4734                   <listitem>
4735                     <para><link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
4736                     must also be enabled for this to work</para>
4737                   </listitem>
4738                 </itemizedlist>
4739               </listitem>
4740
4741               <listitem>
4742                 <para>Don't allow</para>
4743               </listitem>
4744             </itemizedlist>
4745           </section>
4746
4747           <section id="OPACAllowUserToChooseBranch">
4748             <title>OPACAllowUserToChooseBranch</title>
4749
4750             <para>Default: Allow</para>
4751
4752             <para>Asks: ___ a user to choose the branch to pick up a hold
4753             from.</para>
4754
4755             <para>Values:</para>
4756
4757             <itemizedlist>
4758               <listitem>
4759                 <para>Allow</para>
4760               </listitem>
4761
4762               <listitem>
4763                 <para>Don't allow</para>
4764               </listitem>
4765             </itemizedlist>
4766
4767             <para>Description:</para>
4768
4769             <itemizedlist>
4770               <listitem>
4771                 <para>Changing this preference will not prevent staff from
4772                 being able to transfer titles from one branch to another to
4773                 fill a hold, it will only prevent patrons from saying they
4774                 plan on picking a book up at a branch other than their home
4775                 branch.</para>
4776               </listitem>
4777             </itemizedlist>
4778           </section>
4779
4780           <section id="ReservesControlBranch">
4781             <title>ReservesControlBranch</title>
4782
4783             <para>Default: item's home library</para>
4784
4785             <para>Asks: Check the ___ to see if the patron can place a hold on
4786             the item.</para>
4787
4788             <para>Values:</para>
4789
4790             <itemizedlist>
4791               <listitem>
4792                 <para>item's home library.</para>
4793               </listitem>
4794
4795               <listitem>
4796                 <para>patron's home library.</para>
4797               </listitem>
4798             </itemizedlist>
4799           </section>
4800
4801           <section id="ReservesMaxPickUpDelay">
4802             <title>ReservesMaxPickUpDelay</title>
4803
4804             <para>Default: 7</para>
4805
4806             <para>Asks: Mark a hold as problematic if it has been waiting for
4807             more than ___ days.</para>
4808
4809             <para>Description:</para>
4810
4811             <itemizedlist>
4812               <listitem>
4813                 <para>This preference (based on calendar days, not the <link linkend="calholidays">Koha holiday calendar</link>) puts an
4814                 expiration date on an item a patron has on hold. After this
4815                 expiration date the staff will have the option to release the
4816                 unclaimed hold which then may be returned to the library shelf
4817                 or issued to the next patron on the item's hold list. Items
4818                 that are 'expired' by this preference are moved to the 'Holds
4819                 Over' tab on the '<link linkend="holdspickup">Holds Awaiting
4820                 Pickup</link>' report.</para>
4821               </listitem>
4822             </itemizedlist>
4823           </section>
4824
4825           <section id="ReservesNeedReturns">
4826             <title>ReservesNeedReturns</title>
4827
4828             <para>Default: Don't automatically</para>
4829
4830             <para>Asks: ___ mark holds as found and waiting when a hold is
4831             placed specifically on them and they are already checked
4832             in.</para>
4833
4834             <para>Values:</para>
4835
4836             <itemizedlist>
4837               <listitem>
4838                 <para>Automatically</para>
4839               </listitem>
4840
4841               <listitem>
4842                 <para>Don't automatically</para>
4843               </listitem>
4844             </itemizedlist>
4845
4846             <para>Description:</para>
4847
4848             <itemizedlist>
4849               <listitem>
4850                 <para>This preference refers to 'item specific' holds where
4851                 the item is currently on the library shelf. This preference
4852                 allows a library to decide whether an 'item specific' hold is
4853                 marked as "Waiting" at the time the hold is placed or if the
4854                 item will be marked as "Waiting" after the item is checked in.
4855                 This preference will tell the patron that their item is
4856                 'Waiting' for them at their library and ready for check
4857                 out.</para>
4858               </listitem>
4859             </itemizedlist>
4860           </section>
4861
4862           <section id="holdqueueweight">
4863             <title>StaticHoldsQueueWeight &amp;
4864             RandomizeHoldsQueueWeight</title>
4865
4866             <para>StaticHoldsQueueWeight Default: 0</para>
4867
4868             <para>RandomizeHoldsQueueWeight Default: in that order</para>
4869
4870             <para>Asks: Satisfy holds from the libraries ___ (as branchcodes,
4871             separated by commas; if empty, uses all libraries) ___</para>
4872
4873             <para>RandomizeHoldsQueueWeight Values:</para>
4874
4875             <itemizedlist>
4876               <listitem>
4877                 <para>in random order</para>
4878
4879                 <itemizedlist>
4880                   <listitem>
4881                     <para>If StaticHoldsQueueWeight is left at the default
4882                     Koha will randomize all libraries, otherwise it will
4883                     randomize the libraries listed.</para>
4884                   </listitem>
4885                 </itemizedlist>
4886               </listitem>
4887
4888               <listitem>
4889                 <para>in that order</para>
4890
4891                 <itemizedlist>
4892                   <listitem>
4893                     <para>If StaticHoldsQueueWeight is left at the default
4894                     then this will use all of your branches in alphabetical
4895                     order, otherwise it will use the branches in the order
4896                     that you entered them in the StaticHoldsQueueWeight
4897                     preference.</para>
4898                   </listitem>
4899                 </itemizedlist>
4900               </listitem>
4901             </itemizedlist>
4902
4903             <para>Descriptions:</para>
4904
4905             <itemizedlist>
4906               <listitem>
4907                 <para>These preferences control how the <link linkend="holdsqueue">Holds Queue report</link> is generated
4908                 using <link linkend="buildholdscron">a cron job</link>.</para>
4909
4910                 <para>If you do not want all of your libraries to participate
4911                 in the on-shelf holds fulfillment process, you should list the
4912                 the libraries that *do* participate in the process here by
4913                 inputting all the participating library's branchcodes,
4914                 separated by commas ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
4915
4916                 <para>By default, the holds queue will be generated such that
4917                 the system will first attempt to hold fulfillment using items
4918                 already at the pickup library if possible. If there are no
4919                 items available at the pickup library to fill a hold,
4920                 build_holds_queue.pl will then use the list of libraries
4921                 defined in StaticHoldsQueueWeight. If
4922                 RandomizeHoldsQueueWeight is disabled ( which it is by default
4923                 ), the script will assign fulfillment requests in the order
4924                 the branches are placed in the StaticHoldsQueueWeight system
4925                 preference.</para>
4926
4927                 <para>For example, if your system has three libraries, of
4928                 varying sizes ( small, medium and large ) and you want the
4929                 burden of holds fulfillment to be on larger libraries before
4930                 smaller libraries, you would want StaticHoldsQueueWeight to
4931                 look something like "LRG,MED,SML".</para>
4932
4933                 <para>If you want the burden of holds fulfillment to be spread
4934                 out equally throughout your library system, simply enable
4935                 RandomizeHoldsQueueWeight. When this system preference is
4936                 enabled, the order in which libraries will be requested to
4937                 fulfill an on-shelf hold will be randomized each time the list
4938                 is regenerated.</para>
4939
4940                 <para>Leaving StaticHoldsQueueWeight empty is contraindicated
4941                 at this time. Doing so will cause the build_holds_queue script
4942                 to ignore RandomizeHoldsQueueWeight, causing the script to
4943                 request hold fulfillment not randomly, but by alphabetical
4944                 order.</para>
4945               </listitem>
4946             </itemizedlist>
4947             <important>
4948               <para>The <link linkend="transportcostmatrix">Transport Cost Matrix</link> takes
4949                 precedence in controlling where holds are filled from, if the matrix is not used
4950                 then Koha checks the StaticHoldsQueueWeight.  To use the Transport Cost Matrix
4951                 simply set your <link linkend="UseTransportCostMatrix">UseTransportCostMatrix</link>
4952                 preference to 'Use'</para>
4953             </important>
4954           </section>
4955
4956           <section id="SuspendHoldsIntranet">
4957             <title>SuspendHoldsIntranet</title>
4958
4959             <para>Default: Allow</para>
4960
4961             <para>Asks: ___ holds to be suspended from the intranet.</para>
4962
4963             <para>Values:</para>
4964
4965             <itemizedlist>
4966               <listitem>
4967                 <para>Allow</para>
4968               </listitem>
4969
4970               <listitem>
4971                 <para>Don't allow</para>
4972               </listitem>
4973             </itemizedlist>
4974
4975             <para>Description:</para>
4976
4977             <itemizedlist>
4978               <listitem>
4979                 <para>The holds suspension feature can be turned on and off in
4980                 the staff client by altering this system preference. If this
4981                 is set to 'allow' you will want to set the <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
4982                 system preference.</para>
4983               </listitem>
4984             </itemizedlist>
4985           </section>
4986
4987           <section id="SuspendHoldsOpac">
4988             <title>SuspendHoldsOpac</title>
4989
4990             <para>Default: Allow</para>
4991
4992             <para>Asks: ___ holds to be suspended from the OPAC.</para>
4993
4994             <para>Values:</para>
4995
4996             <itemizedlist>
4997               <listitem>
4998                 <para>Allow</para>
4999               </listitem>
5000
5001               <listitem>
5002                 <para>Don't allow</para>
5003               </listitem>
5004             </itemizedlist>
5005
5006             <para>Description:</para>
5007
5008             <itemizedlist>
5009               <listitem>
5010                 <para>The holds suspension feature can be turned on and off in
5011                 the OPAC by altering this system preference. If this is set to
5012                 'allow' you will want to set the <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
5013                 system preference.</para>
5014               </listitem>
5015             </itemizedlist>
5016           </section>
5017           <section id="TransferWhenCancelAllWaitingHolds">
5018             <title>TransferWhenCancelAllWaitingHolds</title>
5019             <para>Default: Don't transfer</para>
5020             <para>Asks: ___  items when cancelling all waiting holds. </para>
5021             <para>Values:<itemizedlist>
5022                 <listitem>
5023                   <para>Don't transfer</para>
5024                 </listitem>
5025                 <listitem>
5026                   <para>Transfer</para>
5027                 </listitem>
5028               </itemizedlist></para>
5029             <para>Description:<itemizedlist>
5030                 <listitem>
5031                   <para>When TransferWhenCancelAllWaitingHolds is set to "Don't transfer", no branch
5032                     transfer records are created. Koha will not allow the holds to be transferred,
5033                     because that would orphan the items at the library where the holds were awaiting
5034                     pickup, without any further instruction to staff as to what items are at the
5035                     library or where they need to go. When that system preference set to "Transfer",
5036                     branch transfers are created, so the holds may be cancelled.</para>
5037                 </listitem>
5038               </itemizedlist></para>
5039           </section>
5040         </section>
5041
5042         <section id="circinterfaceprefs">
5043           <title>Interface</title>
5044
5045           <para/>
5046
5047           <section id="AllowAllMessageDeletion">
5048             <title>AllowAllMessageDeletion</title>
5049
5050             <para>Default: Don't allow</para>
5051
5052             <para>Asks: ___ staff to delete messages added from other
5053             libraries.</para>
5054
5055             <para>Values:</para>
5056
5057             <itemizedlist>
5058               <listitem>
5059                 <para>Allow</para>
5060               </listitem>
5061
5062               <listitem>
5063                 <para>Don't allow</para>
5064               </listitem>
5065             </itemizedlist>
5066           </section>
5067           <section id="AllowOfflineCirculation">
5068             <title>AllowOfflineCirculation</title>
5069             <para>Default: Do not enable</para>
5070             <para>Asks: ___  offline circulation on regular circulation computers. </para>
5071             <para>Values:<itemizedlist>
5072                 <listitem>
5073                   <para>Do not enable</para>
5074                 </listitem>
5075                 <listitem>
5076                   <para>Enable</para>
5077                 </listitem>
5078               </itemizedlist></para>
5079             <para>Description:<itemizedlist>
5080                 <listitem>
5081                   <para>Setting this preference to 'Enable' allows you to use the Koha interface for
5082                       <link linkend="offlinecirc">offline circulation</link>. This system preference
5083                     does not affect the <link linkend="firefoxofflinecirc">Firefox plugin</link> or
5084                     the <link linkend="windowsofflinecirc">desktop application</link>, any of these
5085                     three options can be used for offline circulation without effecting the
5086                     other.</para>
5087                 </listitem>
5088               </itemizedlist></para>
5089           </section>
5090
5091           <section id="CircAutocompl">
5092             <title>CircAutocompl</title>
5093
5094             <para>Default: Try</para>
5095
5096             <para>Asks: ___ to automatically fill in the member when entering
5097             a patron search on the circulation screen.</para>
5098
5099             <para>Description:</para>
5100
5101             <itemizedlist>
5102               <listitem>
5103                 <para>This preference is a binary setting which determines
5104                 whether auto-completion of fields is enabled or disabled for
5105                 the circulation input field. Setting it to "Try" would enable
5106                 a staff member to begin typing a name or other value into the
5107                 field and have a menu pop up with suggestions for completing
5108                 it. Setting it to "Don't try" would disable this feature. This
5109                 preference can make staff members' jobs easier or it could
5110                 potentially slow down the page loading process.</para>
5111               </listitem>
5112             </itemizedlist>
5113
5114             <para>Values:</para>
5115
5116             <itemizedlist>
5117               <listitem>
5118                 <para>Don't try</para>
5119               </listitem>
5120
5121               <listitem>
5122                 <para>Try</para>
5123
5124                 <screenshot>
5125                   <screeninfo>When CircAutocompl is turned on search results
5126                   will appear below the search box</screeninfo>
5127
5128                   <mediaobject>
5129                     <imageobject>
5130                       <imagedata fileref="images/admin/globalprefs/CircAutocompl.png"/>
5131                     </imageobject>
5132                   </mediaobject>
5133                 </screenshot>
5134               </listitem>
5135             </itemizedlist>
5136           </section>
5137
5138           <section id="CircAutoPrintQuickSlip">
5139             <title>CircAutoPrintQuickSlip</title>
5140
5141             <para>Default: open a print quick slip window</para>
5142
5143             <para>Asks: When an empty barcode field is submitted in
5144             circulation ___</para>
5145
5146             <para>Values:</para>
5147
5148             <itemizedlist>
5149               <listitem>
5150                 <para>clear the screen</para>
5151               </listitem>
5152
5153               <listitem>
5154                 <para>open a print quick slip window</para>
5155               </listitem>
5156               <listitem>
5157                 <para>open a print slip window</para>
5158               </listitem>
5159             </itemizedlist>
5160
5161             <para>Description:</para>
5162
5163             <itemizedlist>
5164               <listitem>
5165                 <para>If this preference is set to open a quick slip (<link
5166                     linkend="existingnotices">ISSUEQSLIP</link>) or open a slip (<link
5167                     linkend="existingnotices">ISSUESLIP</link>) for printing it will eliminate the
5168                   need for the librarian to click the print button to generate a checkout receipt
5169                   for the patron they're checking out to. If the preference is set to clear the
5170                   screen then "checking out" an empty barcode will clear the screen of the patron
5171                   you were last working with.</para>
5172               </listitem>
5173             </itemizedlist>
5174           </section>
5175
5176           <section id="FilterBeforeOverdueReport">
5177             <title>FilterBeforeOverdueReport</title>
5178
5179             <para>Default: Don't require</para>
5180
5181             <para>Asks: ___ staff to choose which checkouts to show before
5182             running the overdues report.</para>
5183
5184             <para>Description:</para>
5185
5186             <itemizedlist>
5187               <listitem>
5188                 <para>Koha's overdue report shows you all of the overdue items
5189                 in your library system. If you have a large library system
5190                 you'll want to set this preference to 'Require' to force those
5191                 running the report to first limit the data generated to a
5192                 branch, date range, patron category or other such filter.
5193                 Requiring that the report be filtered before it's run prevents
5194                 your staff from running a system heavy report and slowing down
5195                 other operations in the system.</para>
5196
5197                 <screenshot>
5198                   <screeninfo>Overdue Report Filters</screeninfo>
5199
5200                   <mediaobject>
5201                     <imageobject>
5202                       <imagedata fileref="images/admin/globalprefs/FilterBeforeOverdueReport.png"/>
5203                     </imageobject>
5204                   </mediaobject>
5205                 </screenshot>
5206               </listitem>
5207             </itemizedlist>
5208
5209             <para>Values:</para>
5210
5211             <itemizedlist>
5212               <listitem>
5213                 <para>Don't require</para>
5214               </listitem>
5215
5216               <listitem>
5217                 <para>Require</para>
5218               </listitem>
5219             </itemizedlist>
5220           </section>
5221
5222           <section id="FineNotifyAtCheckin">
5223             <title>FineNotifyAtCheckin</title>
5224
5225             <para>Default: Don't notify</para>
5226
5227             <para>Asks: ___ librarians of overdue fines on the items they are
5228             checking in.</para>
5229
5230             <para>Values:</para>
5231
5232             <itemizedlist>
5233               <listitem>
5234                 <para>Don't notify</para>
5235               </listitem>
5236
5237               <listitem>
5238                 <para>Notify</para>
5239               </listitem>
5240             </itemizedlist>
5241
5242             <para>Description:</para>
5243
5244             <itemizedlist>
5245               <listitem>
5246                 <para>With this preference set to 'Notify' all books that have
5247                 overdue fines owed on them will pop up a warning when checking
5248                 them in. This warning will need to acknowledged before you can
5249                 continue checking items in. With this preference set to 'Don't
5250                 notify,' you will still see fines owed on the patron record,
5251                 you just won't have an additional notification at check
5252                 in.</para>
5253
5254                 <screenshot>
5255                   <screeninfo>Fine notification at checkin</screeninfo>
5256
5257                   <mediaobject>
5258                     <imageobject>
5259                       <imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
5260                     </imageobject>
5261                   </mediaobject>
5262                 </screenshot>
5263               </listitem>
5264             </itemizedlist>
5265           </section>
5266
5267           <section id="DisplayClearScreenButton">
5268             <title>DisplayClearScreenButton</title>
5269
5270             <para>Default: Show</para>
5271
5272             <para>Asks: ___ a button to clear the current patron from the
5273             screen on the circulation screen.</para>
5274
5275             <para>Values:</para>
5276
5277             <itemizedlist>
5278               <listitem>
5279                 <para>Don't show</para>
5280
5281                 <screenshot>
5282                   <screeninfo>No X in the top right</screeninfo>
5283
5284                   <mediaobject>
5285                     <imageobject>
5286                       <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButtonOff.png"/>
5287                     </imageobject>
5288                   </mediaobject>
5289                 </screenshot>
5290               </listitem>
5291
5292               <listitem>
5293                 <para>Show</para>
5294
5295                 <screenshot>
5296                   <screeninfo>X in the top right will clear the
5297                   screen</screeninfo>
5298
5299                   <mediaobject>
5300                     <imageobject>
5301                       <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
5302                     </imageobject>
5303                   </mediaobject>
5304                 </screenshot>
5305               </listitem>
5306             </itemizedlist>
5307           </section>
5308           <section id="ExportRemoveFields">
5309             <title>ExportRemoveFields</title>
5310             <para>Asks: The following fields should be excluded from the patron checkout history CSV
5311               or iso2709 export ___ </para>
5312             <para>Description:<itemizedlist>
5313                 <listitem>
5314                   <para>This space separated list of fields (e.g. 100a 245b) will automatically be
5315                     excluded when exporting the patron's current checkout history.</para>
5316                   <screenshot>
5317                     <screeninfo>ExportRemoveFields</screeninfo>
5318                     <mediaobject>
5319                       <imageobject>
5320                         <imagedata fileref="images/admin/globalprefs/ExportRemoveFields.png"/>
5321                       </imageobject>
5322                     </mediaobject>
5323                   </screenshot>
5324                 </listitem>
5325               </itemizedlist></para>
5326           </section>
5327           <section id="ExportWithCsvProfile">
5328             <title>ExportWithCsvProfile</title>
5329             <para>Asks: Use the ___ CSV profile when exporting patron checkout history</para>
5330             <para>Description:<itemizedlist>
5331                 <listitem>
5332                   <para>Use this preference to define which <link linkend="csvprofiles">CSV
5333                       profile</link> should be used when exporting patron's current checkout data.
5334                     Enter the CSV Profile name as the value for this preference. If this preference
5335                     is left blank you will not be able to export the patron's current checkout
5336                     summary.</para>
5337                   <screenshot>
5338                     <screeninfo>ExportWithCsvProfile</screeninfo>
5339                     <mediaobject>
5340                       <imageobject>
5341                         <imagedata fileref="images/admin/globalprefs/ExportWithCsvProfile.png"/>
5342                       </imageobject>
5343                     </mediaobject>
5344                   </screenshot>
5345                 </listitem>
5346               </itemizedlist></para>
5347           </section>
5348           <section id="HoldsToPullStartDate">
5349             <title>HoldsToPullStartDate</title>
5350             <para>Default: 2</para>
5351             <para>Asks: Set the default start date for the Holds to pull list to ___ day(s) ago. </para>
5352             <para>Description:<itemizedlist>
5353                 <listitem>
5354                   <para>The <link linkend="holdspull">Holds to Pull</link> report in circulation
5355                     defaults to filtering holds placed 2 days ago. This preference allows you to set
5356                     this default filter to any number of days.</para>
5357                 </listitem>
5358               </itemizedlist></para>
5359           </section>
5360           <section id="itemBarcodeFallbackSearch">
5361             <title>itemBarcodeFallbackSearch</title>
5362             <para>Default: Don't enable</para>
5363             <para>Asks: ___  the automatic use of a keyword catalog search if the phrase entered as
5364               a barcode on the checkout page does not turn up any results during an item barcode
5365               search. </para>
5366             <para>Values:</para>
5367             <itemizedlist>
5368                 <listitem>
5369                   <para>Don't enable</para>
5370                 </listitem>
5371                 <listitem>
5372                   <para>Enable</para>
5373                   <screenshot>
5374                       <screeninfo>Checkout by keyword</screeninfo>
5375                       <mediaobject>
5376                         <imageobject>
5377                           <imagedata
5378                             fileref="images/admin/globalprefs/itemBarcodeFallbackSearch.png"/>
5379                         </imageobject>
5380                       </mediaobject>
5381                     </screenshot>
5382                 </listitem>
5383               </itemizedlist>
5384             <para>Description:<itemizedlist>
5385                 <listitem>
5386                   <para>Sometimes libraries want to checkout using something other than the barcode.
5387                     Enabling this preference will do a keyword search of Koha to find the item
5388                     you're trying to check out. You can use the call number, barcode, part of the
5389                     title or anything you'd enter in the keyword search when this preference is
5390                     enabled and Koha will ask you which item you're trying to check out.</para>
5391                 </listitem>
5392               </itemizedlist></para>
5393             <important>
5394               <para>While you're not searching by barcode a barcode is required on every title you
5395                 check out. Only titles with barcodes will appear in the search results.</para>
5396             </important>
5397           </section>
5398
5399           <section id="itemBarcodeInputFilter">
5400             <title>itemBarcodeInputFilter</title>
5401
5402             <para>Default: Don't filter</para>
5403
5404             <para>Asks: ___ scanned item barcodes.</para>
5405
5406             <para>Values:</para>
5407
5408             <itemizedlist>
5409               <listitem>
5410                 <para>Convert from CueCat format</para>
5411               </listitem>
5412
5413               <listitem>
5414                 <para>Convert from Libsuite8 form</para>
5415               </listitem>
5416
5417               <listitem>
5418                 <para>Don't filter</para>
5419               </listitem>
5420
5421               <listitem>
5422                 <para>EAN-13 or zero-padded UPC-A from</para>
5423               </listitem>
5424
5425               <listitem>
5426                 <para>Remove spaces from</para>
5427               </listitem>
5428
5429               <listitem>
5430                 <para>Remove the first number from T-prefix style</para>
5431
5432                 <itemizedlist>
5433                   <listitem>
5434                     <para>This format is common among those libraries
5435                     migrating from Follett systems</para>
5436                   </listitem>
5437                 </itemizedlist>
5438               </listitem>
5439             </itemizedlist>
5440           </section>
5441
5442           <section id="NoticeCSS">
5443             <title>NoticeCSS</title>
5444
5445             <para>Asks: Include the stylesheet at ___ on Notices.<important>
5446                 <para>This should be a complete URL, starting with
5447                 http://</para>
5448               </important></para>
5449
5450             <para>Description:</para>
5451
5452             <itemizedlist>
5453               <listitem>
5454                 <para>If you would like to style your notices with a
5455                 consistent set of fonts and colors you can use this preference
5456                 to point Koha to a stylesheet specifically for your
5457                 notices.</para>
5458               </listitem>
5459             </itemizedlist>
5460           </section>
5461
5462           <section id="numReturnedItemsToShow">
5463             <title>numReturnedItemsToShow</title>
5464
5465             <para>Default: 20</para>
5466
5467             <para>Asks : Show the ___ last returned items on the checkin
5468             screen.</para>
5469           </section>
5470
5471           <section id="previousIssuesDefaultSortOrder">
5472             <title>previousIssuesDefaultSortOrder</title>
5473
5474             <para>Default: earliest to latest</para>
5475
5476             <para>Asks: Sort previous checkouts on the circulation page from
5477             ___ due date.</para>
5478
5479             <para>Values:</para>
5480
5481             <itemizedlist>
5482               <listitem>
5483                 <para>earliest to latest</para>
5484               </listitem>
5485
5486               <listitem>
5487                 <para>latest to earliest</para>
5488               </listitem>
5489             </itemizedlist>
5490           </section>
5491
5492           <section id="RecordLocalUseOnReturn">
5493             <title>RecordLocalUseOnReturn</title>
5494
5495             <para>Default: Don't record</para>
5496
5497             <para>Asks: ___ local use when an unissued item is checked
5498             in.</para>
5499
5500             <para>Values:</para>
5501
5502             <itemizedlist>
5503               <listitem>
5504                 <para>Don't record</para>
5505               </listitem>
5506
5507               <listitem>
5508                 <para>Record</para>
5509               </listitem>
5510             </itemizedlist>
5511
5512             <para>Description:</para>
5513
5514             <itemizedlist>
5515               <listitem>
5516                 <para>When this preference is set to "Don't record" you can
5517                 record local use of items by checking items out to the
5518                 statistical patron. With this preference set to "Record" you
5519                 can record local use by checking out to the statistical patron
5520                 and/or by checking in a book that is not currently checked
5521                 out.</para>
5522               </listitem>
5523             </itemizedlist>
5524           </section>
5525
5526           <section id="soundon">
5527             <title>soundon</title>
5528
5529             <para>Default: Don't enable</para>
5530
5531             <para>Asks: ___ circulation sounds during checkin and checkout in
5532             the staff interface.</para>
5533
5534             <para>Values:</para>
5535
5536             <itemizedlist>
5537               <listitem>
5538                 <para>Don't enable</para>
5539               </listitem>
5540
5541               <listitem>
5542                 <para>Enable</para>
5543               </listitem>
5544             </itemizedlist>
5545
5546             <para><important>
5547                 <para>This feature is not supported by all browsers. Requires
5548                 an HTML5 compliant browser.</para>
5549               </important></para>
5550           </section>
5551
5552           <section id="SpecifyDueDate">
5553             <title>SpecifyDueDate</title>
5554
5555             <para>Default: Allow</para>
5556
5557             <para>Asks: ___ staff to specify a due date for a checkout.</para>
5558
5559             <para>Due dates are calculated using your circulation and fines
5560             rules, but staff can override that if you allow them to specify a
5561             due date at checkout.</para>
5562
5563             <para>Description:</para>
5564
5565             <itemizedlist>
5566               <listitem>
5567                 <para>This preference allows for circulation staff to change a
5568                 due date from the automatic due date to another calendar date.
5569                 This option would be used for circumstances in which the due
5570                 date may need to be decreased or extended in a specific
5571                 circumstance. The "Allow" setting would allow for this option
5572                 to be utilized by staff, the "Don't allow" setting would bar
5573                 staff from changing the due date on materials.</para>
5574               </listitem>
5575             </itemizedlist>
5576
5577             <para>Values:</para>
5578
5579             <itemizedlist>
5580               <listitem>
5581                 <para>Allow</para>
5582
5583                 <screenshot>
5584                   <screeninfo>Specify Due Date Box Shows</screeninfo>
5585
5586                   <mediaobject>
5587                     <imageobject>
5588                       <imagedata fileref="images/admin/globalprefs/SpecifyDueDate.png"/>
5589                     </imageobject>
5590                   </mediaobject>
5591                 </screenshot>
5592               </listitem>
5593
5594               <listitem>
5595                 <para>Don't allow</para>
5596
5597                 <screenshot>
5598                   <screeninfo>Specify Due Date Box Doesn't Show</screeninfo>
5599
5600                   <mediaobject>
5601                     <imageobject>
5602                       <imagedata fileref="images/admin/globalprefs/SpecifyDueDate-no.png"/>
5603                     </imageobject>
5604                   </mediaobject>
5605                 </screenshot>
5606               </listitem>
5607             </itemizedlist>
5608           </section>
5609           <section id="SpecifyReturnDate">
5610             <title>SpecifyReturnDate</title>
5611             <para>Default: Don't allow</para>
5612             <para>Asks: ___  staff to specify a return date for a check in.</para>
5613             <para>Values:<itemizedlist>
5614                 <listitem>
5615                   <para>Allow<screenshot>
5616                       <screeninfo>Allow return date edits</screeninfo>
5617                       <mediaobject>
5618                         <imageobject>
5619                           <imagedata fileref="images/admin/globalprefs/SpecifyReturnDate.png"/>
5620                         </imageobject>
5621                       </mediaobject>
5622                     </screenshot></para>
5623                 </listitem>
5624                 <listitem>
5625                   <para>Don't allow<screenshot>
5626                       <screeninfo>Don't allow return date edits</screeninfo>
5627                       <mediaobject>
5628                         <imageobject>
5629                           <imagedata fileref="images/admin/globalprefs/SpecifyReturnDate-no.png"/>
5630                         </imageobject>
5631                       </mediaobject>
5632                     </screenshot></para>
5633                 </listitem>
5634               </itemizedlist></para>
5635             <para>Description:<itemizedlist>
5636                 <listitem>
5637                   <para>This preference lets you decide if staff can specify an arbitrary return
5638                     date when checking in items.</para>
5639                 </listitem>
5640               </itemizedlist></para>
5641           </section>
5642
5643           <section id="todaysIssuesDefaultSortOrder">
5644             <title>todaysIssuesDefaultSortOrder</title>
5645
5646             <para>Default: latest to earliest</para>
5647
5648             <para>Asks: Sort today's checkouts on the circulation page from
5649             ___ due date.</para>
5650
5651             <para>Values:</para>
5652
5653             <itemizedlist>
5654               <listitem>
5655                 <para>earliest to latest</para>
5656               </listitem>
5657
5658               <listitem>
5659                 <para>latest to earliest</para>
5660               </listitem>
5661             </itemizedlist>
5662           </section>
5663
5664           <section id="UpdateTotalIssuesOnCirc">
5665             <title>UpdateTotalIssuesOnCirc</title>
5666
5667             <para>Default: Do not</para>
5668
5669             <para>Asks: ___ update a bibliographic record's total issues count
5670             whenever an item is issued</para>
5671
5672             <para>Values:</para>
5673
5674             <itemizedlist>
5675               <listitem>
5676                 <para>Do<important>
5677                     <para>This increases server load significantly; if
5678                     performance is a concern, use the <link linkend="updateissuescron">cron job</link> to update the
5679                     total issues count instead.</para>
5680                   </important></para>
5681               </listitem>
5682
5683               <listitem>
5684                 <para>Do not</para>
5685               </listitem>
5686             </itemizedlist>
5687
5688             <para>Description:</para>
5689
5690             <itemizedlist>
5691               <listitem>
5692                 <para>Koha can track the number of times and item is checked
5693                 out and store that on the item record in the database. This
5694                 information is not stored by default. Setting this preference
5695                 to 'Do' will tell Koha to track that info everytime the item
5696                 is checked out in real time. Otherwise you could use the <link linkend="updateissuescron">cron job</link> to have Koha update
5697                 that field nightly.</para>
5698               </listitem>
5699             </itemizedlist>
5700           </section>
5701
5702           <section id="WaitingNotifyAtCheckin">
5703             <title>WaitingNotifyAtCheckin</title>
5704
5705             <para>Default: Don't notify</para>
5706
5707             <para>Asks: ___ librarians of waiting holds for the patron whose
5708             items they are checking in.</para>
5709
5710             <para>Values:</para>
5711
5712             <itemizedlist>
5713               <listitem>
5714                 <para>Don't notify</para>
5715               </listitem>
5716
5717               <listitem>
5718                 <para>Notify</para>
5719
5720                 <screenshot>
5721                   <screeninfo>Notification that a hold is waiting</screeninfo>
5722
5723                   <mediaobject>
5724                     <imageobject>
5725                       <imagedata fileref="images/admin/globalprefs/WaitingNotifyAtCheckin.png"/>
5726                     </imageobject>
5727                   </mediaobject>
5728                 </screenshot>
5729               </listitem>
5730             </itemizedlist>
5731
5732             <para>Description:</para>
5733
5734             <itemizedlist>
5735               <listitem>
5736                 <para>When checking in books you can choose whether or not to
5737                 have a notice pop up if the patron who returned the book has a
5738                 hold waiting for pick up. If you choose 'Notify' for
5739                 WaitingNotifyAtCheckin then every time a hold is found for the
5740                 patron who had the book out last a message will appear on your
5741                 check in screen.</para>
5742               </listitem>
5743             </itemizedlist>
5744           </section>
5745         </section>
5746
5747         <section id="circscoprefs">
5748           <title>Self Checkout</title>
5749
5750           <para/>
5751
5752           <section id="AllowSelfCheckReturns">
5753             <title>AllowSelfCheckReturns</title>
5754
5755             <para>Default: Don't allow</para>
5756
5757             <para>Asks: ___ patrons to return items through web-based self
5758             checkout system.</para>
5759
5760             <para>Values:</para>
5761
5762             <itemizedlist>
5763               <listitem>
5764                 <para>Allow</para>
5765               </listitem>
5766
5767               <listitem>
5768                 <para>Don't allow</para>
5769               </listitem>
5770             </itemizedlist>
5771
5772             <para>Description:</para>
5773
5774             <itemizedlist>
5775               <listitem>
5776                 <para>This preference is used to determine if you want patrons
5777                 to be allowed to return items through your self check
5778                 machines. By default Koha's self check interface is simply for
5779                 checking items out.</para>
5780               </listitem>
5781             </itemizedlist>
5782           </section>
5783
5784           <section id="AutoSelfCheckAllowed">
5785             <title>AutoSelfCheckAllowed, AutoSelfCheckID &amp;
5786             AutoSelfCheckPass</title>
5787
5788             <important>
5789               <para>Most libraries will want to leave this set to 'Don't
5790               allow.' This preference turns off the requirement to log into
5791               the self checkout machine with a staff username and password by
5792               storing the username and password for automatic login.</para>
5793             </important>
5794
5795             <para>AutoSelfCheckAllowed Default: Don't allow</para>
5796
5797             <para>Asks: ___ the web-based self checkout system to
5798             automatically login with this staff login ___ and this password
5799             ___ .</para>
5800
5801             <para>AutoSelfCheckAllowed Values:</para>
5802
5803             <itemizedlist>
5804               <listitem>
5805                 <para>Allow</para>
5806               </listitem>
5807
5808               <listitem>
5809                 <para>Don't allow</para>
5810               </listitem>
5811             </itemizedlist>
5812
5813             <para>AutoSelfCheckID Value:<itemizedlist>
5814                 <listitem>
5815                   <para>The username of a staff patron with 'circulate' <link linkend="patronpermissions">permissions</link>.</para>
5816                 </listitem>
5817               </itemizedlist></para>
5818
5819             <para>AutoSelfCheckPass Value:<itemizedlist>
5820                 <listitem>
5821                   <para>The password of a staff patron with 'circulate' <link linkend="patronpermissions">permissions</link>.</para>
5822                 </listitem>
5823               </itemizedlist></para>
5824           </section>
5825           <section id="SCOUserCSS">
5826             <title>SCOUserCSS</title>
5827             <para>Asks: Include the following CSS on all pages in the web-based self checkout</para>
5828             <para>Description:<itemizedlist>
5829                 <listitem>
5830                   <para>The CSS entered in this preference will be used on all of your Koha self
5831                     checkout screens.</para>
5832                 </listitem>
5833               </itemizedlist></para>
5834           </section>
5835           <section id="SCOUserJS">
5836             <title>SCOUserJS</title>
5837             <para>Asks: Include the following JavaScript on all pages in the web-based self
5838               checkout</para>
5839             <para>Description:<itemizedlist>
5840                 <listitem>
5841                   <para>The JavaScript entered in this preference will effect all of your Koha self
5842                     checkout screens.</para>
5843                 </listitem>
5844               </itemizedlist></para>
5845           </section>
5846
5847           <section id="SelfCheckHelpMessage">
5848             <title>SelfCheckHelpMessage</title>
5849
5850             <para>Asks: Include the following HTML in the Help page of the
5851             web-based self checkout system</para>
5852
5853             <para>Description:</para>
5854
5855             <itemizedlist>
5856               <listitem>
5857                 <para>Clicking the 'Help' link in the top right of the self
5858                 checkout interface opens up a three step process for using the
5859                 self check interface. Adding HTML to this system preference
5860                 will print that additional help text above what's already
5861                 included.</para>
5862               </listitem>
5863             </itemizedlist>
5864           </section>
5865
5866           <section id="SelfCheckoutByLogin">
5867             <title>SelfCheckoutByLogin</title>
5868
5869             <para>Default: Barcode</para>
5870
5871             <para>Asks: Have patrons login into the web-based self checkout
5872             system with their ___</para>
5873
5874             <para>Values:</para>
5875
5876             <itemizedlist>
5877               <listitem>
5878                 <para>Barcode</para>
5879
5880                 <screenshot>
5881                   <screeninfo>Self Checkout Patron Card Number</screeninfo>
5882
5883                   <mediaobject>
5884                     <imageobject>
5885                       <imagedata fileref="images/circ/selfcheckout.png"/>
5886                     </imageobject>
5887                   </mediaobject>
5888                 </screenshot>
5889               </listitem>
5890
5891               <listitem>
5892                 <para>Username and password</para>
5893
5894                 <screenshot>
5895                   <screeninfo>Shelf checkout by login</screeninfo>
5896
5897                   <mediaobject>
5898                     <imageobject>
5899                       <imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
5900                     </imageobject>
5901                   </mediaobject>
5902                 </screenshot>
5903               </listitem>
5904             </itemizedlist>
5905
5906             <para>Description:</para>
5907
5908             <itemizedlist>
5909               <listitem>
5910                 <para>This preference lets you decide how your patrons will
5911                 log in to the self checkout machine. Barcode is the patron's
5912                 card number and their username and password is set using the
5913                 opac/staff username and password fields on the patron
5914                 record.</para>
5915               </listitem>
5916             </itemizedlist>
5917           </section>
5918           <section id="SelfCheckReceiptPrompt">
5919             <title>SelfCheckReceiptPrompt</title>
5920             <para>Default: Show</para>
5921             <para>Asks: ___  the print receipt popup dialog when self checkout is finished.</para>
5922             <para>Values:<itemizedlist>
5923                 <listitem>
5924                   <para>Don't show</para>
5925                 </listitem>
5926                 <listitem>
5927                   <para>Show</para>
5928                 </listitem>
5929               </itemizedlist></para>
5930             <para>Description:<itemizedlist>
5931                 <listitem>
5932                   <para>This preference controls whether a prompt shows up on the web based self
5933                     check out when the patron clicks the 'Finish' button.</para>
5934                 </listitem>
5935               </itemizedlist></para>
5936           </section>
5937
5938           <section id="SelfCheckTimeout">
5939             <title>SelfCheckTimeout</title>
5940
5941             <para>Default: 120</para>
5942
5943             <para>Asks: Time out the current patron's web-based self checkout
5944             system login after ___ seconds.</para>
5945
5946             <para>Description:</para>
5947
5948             <itemizedlist>
5949               <listitem>
5950                 <para>After the machine is idle for the time entered in this
5951                 preference the self check out system will log out the current
5952                 patron and return to the starting screen.</para>
5953               </listitem>
5954             </itemizedlist>
5955           </section>
5956
5957           <section id="ShowPatronImageInWebBasedSelfCheck">
5958             <title>ShowPatronImageInWebBasedSelfCheck</title>
5959
5960             <para>Default: Don't show</para>
5961
5962             <para>Asks: ___ the patron's picture (if one has been added) when
5963             they use the web-based self checkout.</para>
5964
5965             <para>Values:</para>
5966
5967             <itemizedlist>
5968               <listitem>
5969                 <para>Don't show</para>
5970               </listitem>
5971
5972               <listitem>
5973                 <para>Show</para>
5974               </listitem>
5975             </itemizedlist>
5976           </section>
5977
5978           <section id="WebBasedSelfCheck">
5979             <title>WebBasedSelfCheck</title>
5980
5981             <para>Default: Don't enable</para>
5982
5983             <para>Asks: ___ the web-based self checkout system.</para>
5984
5985             <para>Values:</para>
5986
5987             <itemizedlist>
5988               <listitem>
5989                 <para>Don't enable</para>
5990               </listitem>
5991
5992               <listitem>
5993                 <para>Enable</para>
5994               </listitem>
5995             </itemizedlist>
5996
5997             <para>Enabling this preference will allow access to the <link linkend="selfcheckout">self checkout</link> module in Koha.</para>
5998           </section>
5999         </section>
6000       </section>
6001
6002
6003
6004       <section id="enhancedcontent">
6005         <title>Enhanced Content</title>
6006
6007         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
6008         Global System Preferences &gt; Enhanced Content</para>
6009
6010         <important>
6011           <para>Always read the terms of service associated with external data
6012           sources to be sure that you are using the products within the
6013           allowed limits.</para>
6014         </important>
6015
6016         <note>
6017           <para>You cannot have more than one service for cover images
6018           (including local cover images) set up. If you set up more than one
6019           you will get multiple cover images. Instead choose only one source
6020           for cover images.</para>
6021         </note>
6022
6023         <section id="frbrenhancedprefs">
6024           <title>All</title>
6025
6026           <para/>
6027
6028           <section id="FRBRizeEditions">
6029             <title>FRBRizeEditions</title>
6030
6031             <para>Default: Don't show</para>
6032
6033             <para>Asks: ___ other editions of an item on the staff
6034             client</para>
6035
6036             <para>Values:</para>
6037
6038             <itemizedlist>
6039               <listitem>
6040                 <para>Don't show</para>
6041               </listitem>
6042
6043               <listitem>
6044                 <para>Show</para>
6045
6046                 <screenshot>
6047                   <screeninfo>Editions tab in staff client</screeninfo>
6048
6049                   <mediaobject>
6050                     <imageobject>
6051                       <imagedata fileref="images/admin/globalprefs/editionstab.png"/>
6052                     </imageobject>
6053                   </mediaobject>
6054                 </screenshot>
6055               </listitem>
6056             </itemizedlist>
6057
6058             <para>Description:</para>
6059
6060             <itemizedlist>
6061               <listitem>
6062                 <para>Using the rules set forth in the Functional Requirements for Bibliographic
6063                   records, this option, when enabled, pulls all editions of the same title available
6064                   in your collection regardless of material type. Items will appear under an
6065                   'Editions' tab on the detail page for the title in question.. According to
6066                     <emphasis>Libraries Unlimited's Online Dictionary for Library and Information
6067                     Science</emphasis> (<ulink url="http://lu.com/odlis/">http://lu.com/odlis/</ulink>), FRBRizing the catalog involves collating MARC
6068                   records of similar materials. FRBRization brings together entities (sets of Works,
6069                   Expressions, or Manifestations), rather than just sets of Items. It can aid
6070                   patrons in selecting related items, expressions, and manifestations that will
6071                   serve their needs. When it is set to "Show", the OPAC will query one or more ISBN
6072                   web services for associated ISBNs and display an Editions tab on the details
6073                   pages. Once this preference is enabled, the library must select one of the ISBN
6074                   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
6075                   to have the Editions tab appear on the OPAC.</para>
6076               </listitem>
6077             </itemizedlist>
6078
6079             <important>
6080               <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>
6081             </important>
6082           </section>
6083
6084           <section id="OPACFRBRizeEditions">
6085             <title>OPACFRBRizeEditions</title>
6086
6087             <para>Default: Don't show</para>
6088
6089             <para>Asks: ___ other editions of an item on the OPAC.</para>
6090
6091             <para>Description:</para>
6092
6093             <itemizedlist>
6094               <listitem>
6095                 <para>Using the rules set forth in the Functional Requirements for Bibliographic
6096                   records, this option, when enabled, pulls all editions of the same title available
6097                   in your collection regardless of material type. Items will appear under an
6098                   'Editions' tab on the detail page for the title in question.. According to
6099                     <emphasis>Libraries Unlimited's Online Dictionary for Library and Information
6100                     Science</emphasis> (<ulink url="http://lu.com/odlis/">http://lu.com/odlis/</ulink>), FRBRizing the catalog involves collating MARC
6101                   records of similar materials. FRBRization brings together entities (sets of Works,
6102                   Expressions, or Manifestations), rather than just sets of Items. It can aid
6103                   patrons in selecting related items, expressions, and manifestations that will
6104                   serve their needs. When it is set to "Show", the OPAC will query one or more ISBN
6105                   web services for associated ISBNs and display an Editions tab on the details
6106                   pages. Once this preference is enabled, the library must select one of the ISBN
6107                   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
6108                   have the Editions tab appear on the Staff Client.</para>
6109               </listitem>
6110             </itemizedlist>
6111
6112             <para>Values:</para>
6113
6114             <itemizedlist>
6115               <listitem>
6116                 <para>Don't show</para>
6117               </listitem>
6118
6119               <listitem>
6120                 <para>Show</para>
6121
6122                 <screenshot>
6123                   <screeninfo>Editions tab in the OPAC</screeninfo>
6124
6125                   <mediaobject>
6126                     <imageobject>
6127                       <imagedata fileref="images/admin/globalprefs/editions.png"/>
6128                     </imageobject>
6129                   </mediaobject>
6130                 </screenshot>
6131               </listitem>
6132             </itemizedlist>
6133
6134             <para>This preference pulls all editions of the same title
6135             available in your collection regardless of material type. Items
6136             will appear under an 'Editions' tab on the detail page for the
6137             title in question.</para>
6138
6139             <important>
6140               <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>
6141             </important>
6142           </section>
6143         </section>
6144
6145         <section id="amazonprefs">
6146           <title>Amazon</title>
6147
6148           <para/>
6149
6150           <section id="AmazonAssocTag">
6151             <title>AmazonAssocTag</title>
6152
6153             <para>Asks: Put the associate tag ___ on links to Amazon.</para>
6154
6155             <note>
6156               <para>This can net your library referral fees if a patron
6157               decides to buy an item after clicking through to Amazon from
6158               your site.</para>
6159             </note>
6160
6161             <para>Description:</para>
6162
6163             <itemizedlist>
6164               <listitem>
6165                 <para>An Amazon Associates Tag allows a library to earn a
6166                 percentage of all purchases made on Amazon when a patron
6167                 accesses Amazon's site via links on the library's website.
6168                 More information about the Amazon Associates program is
6169                 available at Amazon's Affiliate Program's website, <ulink url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</ulink>.
6170                 Before a tag can be obtained, however, the library must first
6171                 apply for an Amazon Web Services (AWS) account. Applications
6172                 are free of charge and can be made at <ulink url="http://aws.amazon.com">http://aws.amazon.com</ulink>.
6173                 Once an AWS account has been established, the library can then
6174                 obtain the Amazon Associates Tag.</para>
6175               </listitem>
6176             </itemizedlist>
6177
6178             <para>Sign up at: <ulink url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</ulink></para>
6179           </section>
6180
6181           <section id="AmazonCoverImages">
6182             <title>AmazonCoverImages</title>
6183
6184             <para>Default: Don't show</para>
6185
6186             <para>Asks: ___ cover images from Amazon on search results and
6187             item detail pages on the staff interface.</para>
6188
6189             <para>Values:</para>
6190
6191             <itemizedlist>
6192               <listitem>
6193                 <para>Don't show</para>
6194               </listitem>
6195
6196               <listitem>
6197                 <para>Show</para>
6198               </listitem>
6199             </itemizedlist>
6200
6201             <para>Description:</para>
6202
6203             <itemizedlist>
6204               <listitem>
6205                 <para>This preference makes it possible to either allow or
6206                 prevent Amazon cover images from being displayed in the Staff
6207                 Client. Cover images are retrieved by Amazon, which pulls the
6208                 content based on the first ISBN number in the item's MARC
6209                 record. Amazon offers this service free of charge. If the
6210                 value for this preference is set to "Show", the cover images
6211                 will appear in the Staff Client, and if it is set to "Don't
6212                 show", the images will not appear. Finally, if you're using
6213                 Amazon cover images, all other cover image services must be
6214                 disabled. If they are not disabled, they will prevent
6215                 AmazonCoverImages from functioning properly.</para>
6216               </listitem>
6217             </itemizedlist>
6218           </section>
6219
6220           <section id="AmazonLocale">
6221             <title>AmazonLocale</title>
6222
6223             <para>Default: American</para>
6224
6225             <para>Asks: Use Amazon data from its ___ website.</para>
6226
6227             <para>Value:</para>
6228
6229             <itemizedlist>
6230               <listitem>
6231                 <para>American</para>
6232               </listitem>
6233
6234               <listitem>
6235                 <para>British</para>
6236               </listitem>
6237
6238               <listitem>
6239                 <para>Canadian</para>
6240               </listitem>
6241
6242               <listitem>
6243                 <para>French</para>
6244               </listitem>
6245
6246               <listitem>
6247                 <para>German</para>
6248               </listitem>
6249
6250               <listitem>
6251                 <para>Japanese</para>
6252               </listitem>
6253             </itemizedlist>
6254           </section>
6255
6256           <section id="OPACAmazonCoverImages">
6257             <title>OPACAmazonCoverImages</title>
6258
6259             <para>Default: Don't show</para>
6260
6261             <para>Asks: ___ cover images from Amazon on search results and
6262             item detail pages on the OPAC.</para>
6263
6264             <para>Values:</para>
6265
6266             <itemizedlist>
6267               <listitem>
6268                 <para>Don't show</para>
6269               </listitem>
6270
6271               <listitem>
6272                 <para>Show</para>
6273               </listitem>
6274             </itemizedlist>
6275
6276             <para>Description:</para>
6277
6278             <itemizedlist>
6279               <listitem>
6280                 <para>This preference makes it possible to either allow or
6281                 prevent Amazon cover images from being displayed in the OPAC.
6282                 Cover images are retrieved by Amazon, which pulls the content
6283                 based on the first ISBN number in the item's MARC record.
6284                 Amazon offers this service free of charge. If the value for
6285                 this preference is set to "Show", the cover images will appear
6286                 in the OPAC, and if it is set to "Don't show", the images will
6287                 not appear. Finally, if you're using Amazon cover images, all
6288                 other cover image services must be disabled. If they are not
6289                 disabled, they will prevent AmazonCoverImages from functioning
6290                 properly.</para>
6291               </listitem>
6292             </itemizedlist>
6293           </section>
6294         </section>
6295
6296         <section id="Babelthequeprefs">
6297           <title>Babelthèque</title>
6298
6299           <para/>
6300
6301           <section id="Babeltheque">
6302             <title>Babeltheque</title>
6303
6304             <para>Default: Don't</para>
6305
6306             <para>Asks: ___ include information (such as reviews and
6307             citations) from Babelthèque in item detail pages on the
6308             OPAC.</para>
6309
6310             <para>Description:</para>
6311
6312             <itemizedlist>
6313               <listitem>
6314                 <para>This preference makes it possible to display a
6315                 Babeltheque tab in the OPAC, allowing patrons to access tags,
6316                 reviews, and additional title information provided by
6317                 Babeltheque. The information which Babeltheque supplies is
6318                 drawn from the French language-based <ulink url="http://www.babelio.com/">Babelio.com</ulink>, a French
6319                 service similar to LibraryThing for Libraries. More
6320                 information about Babeltheque is available through its
6321                 website, <ulink url="http://www.babeltheque.com/">http://www.babeltheque.com</ulink>.
6322                 Libraries that wish to allow access to this information must
6323                 first register for the service at <ulink url="http://www.babeltheque.com">http://www.babeltheque.com</ulink>.
6324                 Please note that this information is only provided in
6325                 French.</para>
6326               </listitem>
6327             </itemizedlist>
6328
6329             <para>Values:</para>
6330
6331             <itemizedlist>
6332               <listitem>
6333                 <para>Do</para>
6334
6335                 <screenshot>
6336                   <screeninfo>Data from Babelthèque on the bib
6337                   record</screeninfo>
6338
6339                   <mediaobject>
6340                     <imageobject>
6341                       <imagedata fileref="images/admin/globalprefs/Babeltheque.png"/>
6342                     </imageobject>
6343                   </mediaobject>
6344                 </screenshot>
6345               </listitem>
6346
6347               <listitem>
6348                 <para>Don't</para>
6349               </listitem>
6350             </itemizedlist>
6351           </section>
6352
6353           <section id="Babeltheque_url_js">
6354             <title>Babeltheque_url_js</title>
6355
6356             <para>Asks: ___ Defined the url for the Babeltheque javascript
6357             file (eg. http://www.babeltheque.com/bw_XX.js)</para>
6358           </section>
6359
6360           <section id="Babeltheque_url_update">
6361             <title>Babeltheque_url_update</title>
6362
6363             <para>Asks: ___ Defined the url for the Babeltheque update
6364             periodically (eq.
6365             http://www.babeltheque.com/.../file.csv.bz2).</para>
6366           </section>
6367         </section>
6368
6369         <section id="btcontentprefs">
6370           <title>Baker &amp; Taylor</title>
6371
6372           <important>
6373             <para>This is a pay service, you must contact Baker &amp; Taylor
6374             to subscribe to this service before setting these options.</para>
6375           </important>
6376
6377           <section id="BakerTaylorEnabled">
6378             <title>BakerTaylorEnabled</title>
6379
6380             <para>Default: Don't add</para>
6381
6382             <para>Asks: ___ Baker and Taylor links and cover images to the
6383             OPAC and staff client. This requires that you have entered in a
6384             username and password (which can be seen in image links).</para>
6385
6386             <para>Values:</para>
6387
6388             <itemizedlist>
6389               <listitem>
6390                 <para>Add</para>
6391               </listitem>
6392
6393               <listitem>
6394                 <para>Don't add</para>
6395               </listitem>
6396             </itemizedlist>
6397
6398             <para>Description:</para>
6399
6400             <itemizedlist>
6401               <listitem>
6402                 <para>This preference makes it possible to display Baker &amp;
6403                 Taylor content (book reviews, descriptions, cover images,
6404                 etc.) in both the Staff Client and the OPAC. Libraries that
6405                 wish to display Baker &amp; Taylor content must first register
6406                 and pay for this service with Baker &amp; Taylor (<ulink url="http://www.btol.com">http://www.btol.com</ulink>). If
6407                 Baker &amp; Taylor content is enabled be sure to turn off
6408                 other cover and review services to prevent
6409                 interference.</para>
6410               </listitem>
6411             </itemizedlist>
6412
6413             <important>
6414               <para>To use this you will need to also set the <link linkend="btuserpass">BakerTaylorUsername &amp;
6415               BakerTaylorPassword</link> system preferences</para>
6416             </important>
6417           </section>
6418
6419           <section id="BakerTaylorBookstoreURL">
6420             <title>BakerTaylorBookstoreURL</title>
6421
6422             <para>Asks: Baker and Taylor "My Library Bookstore" links should
6423             be accessed at https:// ___ isbn</para>
6424
6425             <para>Description:</para>
6426
6427             <itemizedlist>
6428               <listitem>
6429                 <para>Some libraries generate additional funding for the
6430                 library by selling books and other materials that are
6431                 purchased from or have been previously leased from Baker &amp;
6432                 Taylor. These materials can be accessed via a link on the
6433                 library's website. This service is often referred to as "My
6434                 Library Bookstore." In order to participate in this program,
6435                 the library must first register and pay for the service with
6436                 Baker &amp; Taylor. Additional information about this and
6437                 other services provided by Baker &amp; Taylor is available at
6438                 the Baker &amp; Taylor website, <ulink url="http://www.btol.com">http://www.btol.com</ulink>. The
6439                 BakerTaylorBookstoreURL preference establishes the URL in
6440                 order to link to the library's Baker &amp; Taylor-backed
6441                 online bookstore, if such a bookstore has been established.
6442                 The default for this field is left blank; if no value is
6443                 entered, the links to My Library Bookstore will remain
6444                 inactive. If enabling this preference, enter the library's
6445                 Hostname and Parent Number in the appropriate location within
6446                 the URL. The "key" value (key=) should be appended to the URL,
6447                 and https:// should be prepended.</para>
6448               </listitem>
6449             </itemizedlist>
6450
6451             <para>This should be filled in with something like
6452             koha.mylibrarybookstore.com/MLB/actions/searchHandler.do?nextPage=bookDetails&amp;parentNum=10923&amp;key=</para>
6453
6454             <note>
6455               <para>Leave it blank to disable these links.</para>
6456             </note>
6457
6458             <important>
6459               <para>Be sure to get this information from Baker &amp; Taylor
6460               when subscribing.</para>
6461             </important>
6462           </section>
6463
6464           <section id="btuserpass">
6465             <title>BakerTaylorUsername &amp; BakerTaylorPassword</title>
6466
6467             <para>Asks: Access Baker and Taylor using username ___ and
6468             password ___</para>
6469
6470             <para>Descriptions:</para>
6471
6472             <itemizedlist>
6473               <listitem>
6474                 <para>This setting in only applicable if the library has a
6475                 paid subscription to the external Content Café service from
6476                 Baker &amp; Taylor. Use the box provided to enter in the
6477                 library's Content Café username and password. Also, ensure
6478                 that the <link linkend="BakerTaylorBookstoreURL">BakerTaylorBookstoreURL</link>
6479                 and <link linkend="BakerTaylorEnabled">BakerTaylorEnabled</link>
6480                 settings are properly set. The Content Café service is a feed
6481                 of enhanced content such as cover art, professional reviews,
6482                 and summaries that is displayed along with Staff Client/OPAC
6483                 search results. For more information on this service please
6484                 see the Baker &amp; Taylor website: <ulink url="http://www.btol.com">http://www.btol.com</ulink></para>
6485               </listitem>
6486             </itemizedlist>
6487
6488             <important>
6489               <para>Be sure to get this information from Baker &amp; Taylor
6490               when subscribing.</para>
6491             </important>
6492           </section>
6493         </section>
6494         <section id="coceimages">
6495           <title>Coce Cover images cache</title>
6496           <para>Coce is a remote image URL cache. With this option, cover images are not fetched
6497             directly from Amazon, Google, and so on. Their URLs are requested via a web service to
6498             Coce which manages a cache of URLs. </para>
6499           <section id="Coce">
6500             <title>Coce</title>
6501             <para>Default: Don't enable</para>
6502             <para>Asks: ___  a Coce image cache service.</para>
6503             <para>Values:<itemizedlist>
6504                 <listitem>
6505                   <para>Don't enable</para>
6506                 </listitem>
6507                 <listitem>
6508                   <para>Enable</para>
6509                 </listitem>
6510               </itemizedlist></para>
6511             <para>Description: <itemizedlist>
6512                 <listitem>
6513                   <para>Coce has many benefits when it comes to choosing and displaying cover images
6514                     in Koha:<itemizedlist>
6515                       <listitem>
6516                         <para>If a book cover is not available from a provider, but is available
6517                           from another one, Koha will be able to display a book cover, which isn't
6518                           the case now </para>
6519                       </listitem>
6520                       <listitem>
6521                         <para>Since URLs are cached, it isn't necessary for each book cover to
6522                           request, again and again, the provider, and several of them if necessary.
6523                         </para>
6524                       </listitem>
6525                       <listitem>
6526                         <para>Amazon book covers are retrieved with Amazon Product Advertising API,
6527                           which means that more covers are retrieved (ISBN13).</para>
6528                       </listitem>
6529                     </itemizedlist><important>
6530                       <para>Coce does not come bundled with Koha. Your Koha install with not already
6531                         have a Coce server set up. Before enabling this functionality you will want
6532                         to be sure to have a Coce server set up.  Instructions on installing and
6533                         setting up Coce can be found on the official github page at <ulink
6534                           url="https://github.com/fredericd/coce"
6535                           >https://github.com/fredericd/coce</ulink>.</para>
6536                     </important></para>
6537                 </listitem>
6538               </itemizedlist></para>
6539           </section>
6540           <section id="CoceHost">
6541             <title>CoceHost</title>
6542             <para>Asks: Coce server URL ___</para>
6543             <para>Description:<itemizedlist>
6544                 <listitem>
6545                   <para>This will be the full URL (starting with http://) to your Coce server.
6546                   </para>
6547                 </listitem>
6548               </itemizedlist></para>
6549           </section>
6550           <section id="CoceProviders">
6551             <title>CoceProviders</title>
6552             <para>Asks: Use the following providers to fetch the covers ___</para>
6553             <para>Values:<itemizedlist>
6554                 <listitem>
6555                   <para>[Select all]</para>
6556                 </listitem>
6557                 <listitem>
6558                   <para>Amazon Web Services</para>
6559                 </listitem>
6560                 <listitem>
6561                   <para>Google Books</para>
6562                 </listitem>
6563                 <listitem>
6564                   <para>Open Library</para>
6565                 </listitem>
6566               </itemizedlist></para>
6567             <para>Description:<itemizedlist>
6568                 <listitem>
6569                   <para>The providers chosen here will be used to gather cover images for display in
6570                     your Koha catalog.</para>
6571                 </listitem>
6572               </itemizedlist></para>
6573           </section>
6574         </section>
6575
6576         <section id="googleprefs">
6577           <title>Google</title>
6578
6579           <para/>
6580
6581           <section id="GoogleJackets">
6582             <title>GoogleJackets</title>
6583
6584             <para>Default: Don't add</para>
6585
6586             <para>Asks: ___ cover images from Google Books to search results
6587             and item detail pages on the OPAC.</para>
6588
6589             <para>Values:</para>
6590
6591             <itemizedlist>
6592               <listitem>
6593                 <para>Add</para>
6594               </listitem>
6595
6596               <listitem>
6597                 <para>Don't add</para>
6598               </listitem>
6599             </itemizedlist>
6600
6601             <para>Description:</para>
6602
6603             <itemizedlist>
6604               <listitem>
6605                 <para>This setting controls the display of applicable cover
6606                 art from the free Google Books database, via the Google Books
6607                 API. Please note that to use this feature, all other cover
6608                 services should be turned off.</para>
6609               </listitem>
6610             </itemizedlist>
6611           </section>
6612         </section>
6613         <section id="html5">
6614           <title>HTML5 Media</title>
6615           <section id="HTML5MediaEnabled">
6616             <title>HTML5MediaEnabled</title>
6617             <para>Default: not at all</para>
6618             <para>Asks: Show a tab with a HTML5 media player for files catalogued in field 856
6619               ___</para>
6620             <para>Values:<itemizedlist>
6621                 <listitem>
6622                   <para>in OPAC and staff client</para>
6623                 </listitem>
6624                 <listitem>
6625                   <para>in the OPAC</para>
6626                   <screenshot>
6627                     <screeninfo>HTML5 Media in the OPAC</screeninfo>
6628                     <mediaobject>
6629                       <imageobject>
6630                         <imagedata fileref="images/admin/globalprefs/HTML5MediaEnabled-opac.png"/>
6631                       </imageobject>
6632                     </mediaobject>
6633                   </screenshot>
6634                 </listitem>
6635                 <listitem>
6636                   <para>in the staff client</para>
6637                   <screenshot>
6638                       <screeninfo>HTML5 Media in the staff client</screeninfo>
6639                       <mediaobject>
6640                         <imageobject>
6641                           <imagedata fileref="images/admin/globalprefs/HTML5MediaEnabled-staff.png"/>
6642                         </imageobject>
6643                       </mediaobject>
6644                     </screenshot>
6645                 </listitem>
6646                 <listitem>
6647                   <para>not at all</para>
6648                 </listitem>
6649               </itemizedlist></para>
6650             <para>Description:<itemizedlist>
6651                 <listitem>
6652                   <para>If you have media elements in the 856 of your MARC record this preference
6653                     can run/show those media files in a separate tab using HTML5.</para>
6654                 </listitem>
6655               </itemizedlist></para>
6656           </section>
6657           <section id="HTML5MediaExtensions">
6658             <title>HTML5MediaExtensions</title>
6659             <para>Default: webm|ogg|ogv|oga|vtt</para>
6660             <para>Asks: Media file extensions ___</para>
6661             <para>Description:<itemizedlist>
6662                 <listitem>
6663                   <para>Enter in file extensions separated with bar (|)</para>
6664                 </listitem>
6665               </itemizedlist></para>
6666           </section>
6667         </section>
6668         <section id="IDreamLibraries">
6669           <title>IDreamLibraries</title>
6670           <para><ulink url="http://idreambooks.com/">IDreamBooks.com</ulink> aggregates book reviews
6671             by critics to help you discover the very best of what's coming out each week.  These
6672             preferences let you integrated content from <ulink url="http://IDreamBooks.com">IDreamBooks.com</ulink> in to your Koha OPAC.  <note>
6673               <para>This is a new website and has limited content, so you may only see these
6674                 features on new popular titles until the database grows some more.</para>
6675             </note></para>
6676           <section id="IDreamBooksReadometer">
6677             <title>IDreamBooksReadometer</title>
6678             <para>Default: Don't add</para>
6679             <para>Asks: ___ a "Readometer" that summarizes the reviews gathered by IDreamBooks.com
6680               to the OPAC details page. </para>
6681             <para>Values:<itemizedlist>
6682                 <listitem>
6683                   <para>Add</para>
6684                   <screenshot>
6685                       <screeninfo>Readometer on the details page</screeninfo>
6686                       <mediaobject>
6687                         <imageobject>
6688                           <imagedata fileref="images/admin/globalprefs/IDreamBooksReadometer.png"/>
6689                         </imageobject>
6690                       </mediaobject>
6691                     </screenshot>
6692                 </listitem>
6693                 <listitem>
6694                   <para>Don't add</para>
6695                 </listitem>
6696               </itemizedlist></para>
6697           </section>
6698           <section id="IDreamBooksResults">
6699             <title>IDreamBooksResults</title>
6700             <para>Default: Don't add</para>
6701             <para>Asks: ___ the rating from IDreamBooks.com to OPAC search results. </para>
6702             <para>Values:<itemizedlist>
6703                 <listitem>
6704                   <para>Add</para>
6705                   <screenshot>
6706                       <screeninfo>iDreamBooks rating on search results</screeninfo>
6707                       <mediaobject>
6708                         <imageobject>
6709                           <imagedata fileref="images/admin/globalprefs/IDreamBooksResults.png"/>
6710                         </imageobject>
6711                       </mediaobject>
6712                     </screenshot>
6713                 </listitem>
6714                 <listitem>
6715                   <para>Don't add</para>
6716                 </listitem>
6717               </itemizedlist></para>
6718           </section>
6719           <section id="IDreamBooksReviews">
6720             <title>IDreamBooksReviews</title>
6721             <para>Default: Don't add</para>
6722             <para>Asks: ___ a tab on the OPAC details with book reviews from critics aggregated by
6723               IDreamBooks.com. </para>
6724             <para>Values:<itemizedlist>
6725                 <listitem>
6726                   <para>Add</para>
6727                     <screenshot>
6728                       <screeninfo>Reviews tab on the detail page</screeninfo>
6729                       <mediaobject>
6730                         <imageobject>
6731                           <imagedata fileref="images/admin/globalprefs/IDreamBooksReviews.png"/>
6732                         </imageobject>
6733                       </mediaobject>
6734                     </screenshot>
6735                 </listitem>
6736                 <listitem>
6737                   <para>Don't add</para>
6738                 </listitem>
6739               </itemizedlist></para>
6740           </section>
6741         </section>
6742
6743         <section id="librarythingprefs">
6744           <title>LibraryThing</title>
6745
6746           <para>LibraryThing for Libraries is a pay service. You must first
6747           contact LibraryThing directly for pricing and subscription
6748           information. Learn more at <ulink url="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</ulink>.
6749           Also, for further configuration instructions please see the
6750           LibraryThing Wiki: <ulink url="http://www.librarything.com/wiki/index.php/Koha">http://www.librarything.com/wiki/index.php/Koha</ulink></para>
6751
6752           <section id="LibraryThingForLibrariesEnabled">
6753             <title>LibraryThingForLibrariesEnabled</title>
6754
6755             <para>Default: Don't show</para>
6756
6757             <para>Asks: ___ reviews, similar items, and tags from Library
6758             Thing for Libraries on item detail pages on the OPAC.</para>
6759
6760             <para>Values:</para>
6761
6762             <itemizedlist>
6763               <listitem>
6764                 <para>Don't show</para>
6765               </listitem>
6766
6767               <listitem>
6768                 <para>Show</para>
6769               </listitem>
6770             </itemizedlist>
6771
6772             <para>Description:</para>
6773
6774             <itemizedlist>
6775               <listitem>
6776                 <para>This setting is only applicable if the library has a
6777                 paid subscription to the external LibraryThing for Libraries
6778                 service. This service can provide patrons with the display of
6779                 expanded information on catalog items such as book
6780                 recommendations. It also can offer advanced features like
6781                 tagged browsing, patron written reviews, and a virtual library
6782                 display accessed from the details tab.</para>
6783               </listitem>
6784             </itemizedlist>
6785
6786             <important>
6787               <para>If this is set to 'show' you will need to enter a value in
6788               the '<link linkend="LibraryThingForLibrariesID">LibraryThingForLibrariesID</link>'
6789               system preference.</para>
6790             </important>
6791           </section>
6792
6793           <section id="LibraryThingForLibrariesID">
6794             <title>LibraryThingForLibrariesID</title>
6795
6796             <para>Asks: Access Library Thing for Libraries using the customer
6797             ID ___</para>
6798
6799             <para>Description:</para>
6800
6801             <itemizedlist>
6802               <listitem>
6803                 <para>This setting is only applicable if the library has a
6804                 paid subscription to the external LibraryThing for Libraries
6805                 service. Use the box provided to enter in the library's
6806                 LibraryThing for Libraries ID as provided to the library by
6807                 LibraryThing. The ID number is a series of numbers in the form
6808                 ###-#########, and can be found on the library's account page
6809                 at LibraryThing for Libraries. This service can provide
6810                 patrons with the display of expanded information on catalog
6811                 items such as book recommendations and cover art. It also can
6812                 offer advanced features like tagged browsing, patron written
6813                 reviews, and a virtual library display accessed from the
6814                 details tab.</para>
6815               </listitem>
6816             </itemizedlist>
6817           </section>
6818
6819           <section id="LibraryThingForLibrariesTabbedView">
6820             <title>LibraryThingForLibrariesTabbedView</title>
6821
6822             <para>Default: in line with bibliographic information</para>
6823
6824             <para>Asks: Show Library Thing for Libraries content ___</para>
6825
6826             <para>Values:</para>
6827
6828             <itemizedlist>
6829               <listitem>
6830                 <para>in line with bibliographic information</para>
6831               </listitem>
6832
6833               <listitem>
6834                 <para>in tabs</para>
6835               </listitem>
6836             </itemizedlist>
6837
6838             <para>Description:</para>
6839
6840             <itemizedlist>
6841               <listitem>
6842                 <para>This setting is only applicable if the library has a
6843                 paid subscription to the external LibraryThing for Libraries
6844                 service. This service can provide patrons with the display of
6845                 expanded information on catalog items such as book
6846                 recommendations and cover art. It also can offer advanced
6847                 features like tagged browsing, patron written reviews, and a
6848                 virtual library display accessed from the details tab.</para>
6849               </listitem>
6850             </itemizedlist>
6851           </section>
6852           <section id="ThingISBN">
6853             <title>ThingISBN</title>
6854             <para>Default: Don't use</para>
6855             <para>Asks: ___ the ThingISBN service to show other editions of a title</para>
6856             <para>Values:</para>
6857             <itemizedlist>
6858               <listitem>
6859                 <para>Don't use</para>
6860               </listitem>
6861               <listitem>
6862                 <para>Use</para>
6863               </listitem>
6864             </itemizedlist>
6865             <para>Description:</para>
6866             <itemizedlist>
6867               <listitem>
6868                 <para>Set to 'Use' to display an "Editions" tab on the item's detail page. Editions
6869                   are listed, complete with cover art (if you have one of the cover services
6870                   enabled) and bibliographic information. The feed comes from LibraryThing's
6871                   ThingISBN web service. This is a free service to non-commercial sites with fewer
6872                   than 1,000 requests per day.</para>
6873               </listitem>
6874             </itemizedlist>
6875             <important>
6876               <para>Requires <link linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
6877                   linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to 'show'</para>
6878             </important>
6879             <important>
6880               <para>This is separate from Library Thing for Libraries and does not have a cost
6881                 associated with it.</para>
6882             </important>
6883           </section>
6884         </section>
6885
6886         <section id="localimages">
6887           <title>Local Cover Images</title>
6888
6889           <para/>
6890
6891           <section id="AllowMultipleCovers">
6892             <title>AllowMultipleCovers</title>
6893
6894             <para>Default: Don't allow</para>
6895
6896             <para>Asks: ___ multiple images to be attached to each
6897             bibliographic record.</para>
6898
6899             <para>Values:</para>
6900
6901             <itemizedlist>
6902               <listitem>
6903                 <para>Allow</para>
6904               </listitem>
6905
6906               <listitem>
6907                 <para>Don't allow</para>
6908               </listitem>
6909             </itemizedlist>
6910
6911             <para>Description:</para>
6912
6913             <itemizedlist>
6914               <listitem>
6915                 <para>If this preference is set to 'Allow' then you can upload
6916                 multiple images that will appear in the images tab on the bib
6917                 record in the OPAC and the staff client. This preference
6918                 requires that either one or both <link linkend="LocalCoverImages">LocalCoverImages</link> and <link linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> are
6919                 set to 'Display.'</para>
6920
6921                 <screenshot>
6922                   <screeninfo>Multiple cover images</screeninfo>
6923
6924                   <mediaobject>
6925                     <imageobject>
6926                       <imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
6927                     </imageobject>
6928                   </mediaobject>
6929                 </screenshot>
6930               </listitem>
6931             </itemizedlist>
6932           </section>
6933
6934           <section id="LocalCoverImages">
6935             <title>LocalCoverImages</title>
6936
6937             <para>Default: Don't display</para>
6938
6939             <para>Asks: ___ local cover images on intranet search and details
6940             pages.</para>
6941
6942             <para>Values:</para>
6943
6944             <itemizedlist>
6945               <listitem>
6946                 <para>Display</para>
6947               </listitem>
6948
6949               <listitem>
6950                 <para>Don't display</para>
6951               </listitem>
6952             </itemizedlist>
6953
6954             <para>Description:</para>
6955
6956             <itemizedlist>
6957               <listitem>
6958                 <para>Setting this preference to 'Display' allows you to
6959                 upload your own cover images to bib records and display them
6960                 on the detail page in the staff client. At this time the cover
6961                 will only show under the 'Images' tab on the holdings table on
6962                 the detail display, not next to the title at the top left or
6963                 on the search results.</para>
6964               </listitem>
6965             </itemizedlist>
6966           </section>
6967
6968           <section id="OPACLocalCoverImages">
6969             <title>OPACLocalCoverImages</title>
6970
6971             <para>Default: Don't display</para>
6972
6973             <para>Asks: ___ local cover images on OPAC search and details
6974             pages.</para>
6975
6976             <para>Values:</para>
6977
6978             <itemizedlist>
6979               <listitem>
6980                 <para>Display</para>
6981               </listitem>
6982
6983               <listitem>
6984                 <para>Don't display</para>
6985               </listitem>
6986             </itemizedlist>
6987
6988             <para>Description:</para>
6989
6990             <itemizedlist>
6991               <listitem>
6992                 <para>Setting this preference to 'Display' allows you to
6993                 upload your own cover images to bib records and display them
6994                 on the detail page and search results in the OPAC.</para>
6995               </listitem>
6996             </itemizedlist>
6997           </section>
6998         </section>
6999
7000         <section id="novelistselect">
7001           <title>Novelist Select</title>
7002
7003           <para>Novelist Select is not a free service. Contact your Ebsco
7004           representitive to get your log in information to embed this content
7005           in the OPAC.<important>
7006               <para>Novelist Select does not include cover images for the search results and
7007                 bibliographic detail pages. You can choose any other cover image service for this
7008                 content or you can contract with Ebsco to get access to the <link linkend="btcontentprefs">Baker &amp; Taylor Content Cafe</link> for an added
7009                 fee.</para>
7010             </important></para>
7011
7012           <section id="NovelistSelectEnabled">
7013             <title>NovelistSelectEnabled</title>
7014
7015             <para>Default: Don't add</para>
7016
7017             <para>Asks: ___ Novelist Select content to the OPAC.</para>
7018
7019             <para>Values:</para>
7020
7021             <itemizedlist>
7022               <listitem>
7023                 <para>Add</para>
7024               </listitem>
7025
7026               <listitem>
7027                 <para>Don't add</para>
7028               </listitem>
7029             </itemizedlist>
7030
7031             <para><important>
7032                 <para>Enabling this requires that you have entered in a user
7033                 profile and password in the <link linkend="NovelistSelectProfile">NovelistSelectProfile &amp;
7034                 NovelistSelectPassword</link> preferences</para>
7035               </important>Description:</para>
7036
7037             <itemizedlist>
7038               <listitem>
7039                 <para>Novelist Select from Ebsco is a subscription service
7040                 that can provide additional content in the OPAC.</para>
7041               </listitem>
7042             </itemizedlist>
7043           </section>
7044
7045           <section id="NovelistSelectProfile">
7046             <title>NovelistSelectProfile &amp; NovelistSelectPassword</title>
7047
7048             <para>Asks: Access Novelist Select using user profile ___ and
7049             password ___.</para>
7050
7051             <important>
7052               <para>This information will be visible if someone views the
7053               source code on your OPAC.</para>
7054             </important>
7055
7056             <para>Description:</para>
7057
7058             <itemizedlist>
7059               <listitem>
7060                 <para>Novelist Select from Ebsco is a subscription service
7061                 that can provide additional content in the OPAC.</para>
7062               </listitem>
7063             </itemizedlist>
7064           </section>
7065
7066           <section id="NovelistSelectView">
7067             <title>NovelistSelectView</title>
7068
7069             <para>Default: in an OPAC tab</para>
7070
7071             <para>Asks: Display Novelist Select content ___</para>
7072
7073             <para>Description:</para>
7074
7075             <itemizedlist>
7076               <listitem>
7077                 <para>Novelist Select provides a lot of content, for that
7078                 reason you have four choices of where to display this content.
7079                 The default view is in a tab in the holdings table.</para>
7080
7081                 <screenshot>
7082                   <screeninfo>Novelist Select in a tab</screeninfo>
7083
7084                   <mediaobject>
7085                     <imageobject>
7086                       <imagedata fileref="images/admin/globalprefs/novelisttab.png"/>
7087                     </imageobject>
7088                   </mediaobject>
7089                 </screenshot>
7090
7091                 <para>The content is the same if you choose to show it above
7092                 the holdings table or below it. If shown in the right column
7093                 of the page it's the same content, but displays a bit
7094                 differently since space is limited.</para>
7095
7096                 <screenshot>
7097                   <screeninfo>Novelist Select on the side</screeninfo>
7098
7099                   <mediaobject>
7100                     <imageobject>
7101                       <imagedata fileref="images/admin/globalprefs/novelistside.png"/>
7102                     </imageobject>
7103                   </mediaobject>
7104                 </screenshot>
7105               </listitem>
7106             </itemizedlist>
7107
7108             <para>Values:</para>
7109
7110             <itemizedlist>
7111               <listitem>
7112                 <para>above the holdings table</para>
7113               </listitem>
7114
7115               <listitem>
7116                 <para>below the holdings table</para>
7117               </listitem>
7118
7119               <listitem>
7120                 <para>in an OPAC tab</para>
7121               </listitem>
7122
7123               <listitem>
7124                 <para>under the Save Record dropdown on the right</para>
7125               </listitem>
7126             </itemizedlist>
7127           </section>
7128         </section>
7129
7130         <section id="oclcprefs">
7131           <title>OCLC</title>
7132
7133           <para/>
7134
7135           <section id="XISBN">
7136             <title>XISBN</title>
7137
7138             <para>Default: Don't use</para>
7139
7140             <para>Asks: ___ the OCLC xISBN service to show other editions of a
7141             title</para>
7142
7143             <para>Description:</para>
7144
7145             <itemizedlist>
7146               <listitem>
7147                 <para>Set to 'Use' to display an "Editions" tab on the item's
7148                 detail page. Editions are listed, complete with cover art and
7149                 bibliographic information. The feed comes from OCLC's xISBN
7150                 web service. The feed limit for non-commercial sites is 1000
7151                 requests per day.</para>
7152               </listitem>
7153             </itemizedlist>
7154
7155             <para>Values:</para>
7156
7157             <itemizedlist>
7158               <listitem>
7159                 <para>Don't use</para>
7160               </listitem>
7161
7162               <listitem>
7163                 <para>Use</para>
7164               </listitem>
7165             </itemizedlist>
7166
7167             <important>
7168               <para>Requires <link linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
7169               'show'</para>
7170             </important>
7171           </section>
7172
7173           <section id="OCLCAffiliateID">
7174             <title>OCLCAffiliateID</title>
7175
7176             <para>Asks: Use the OCLC affiliate ID ___ to access the xISBN
7177             service.</para>
7178
7179             <para>Description:</para>
7180
7181             <itemizedlist>
7182               <listitem>
7183                 <para>This setting is only applicable if the library has an
7184                 OCLC Affiliate ID. This allows WorldCat searching in the OPAC
7185                 via the XISBN programming interface. Simply enter the
7186                 library's OCLC Affiliate ID in the box provided. Please note
7187                 that using this data is only necessary if <link linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> and
7188                 <link linkend="XISBN">XISBN</link> settings are enabled. For
7189                 more information on this service please visit the OCLC
7190                 website: <ulink url="http://www.worldcat.org/affiliate/default.jsp">http://www.worldcat.org/affiliate/default.jsp</ulink>.</para>
7191               </listitem>
7192             </itemizedlist>
7193
7194             <important>
7195               <para>Unless you have signed up for an ID with OCLC, you are
7196               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>
7197             </important>
7198           </section>
7199
7200           <section id="XISBNDailyLimit">
7201             <title>XISBNDailyLimit</title>
7202
7203             <para>Default: 999</para>
7204
7205             <para>Asks: Only use the xISBN service ___ times a day.</para>
7206
7207             <important>
7208               <para>Unless you have signed up for an ID with OCLC, you are
7209               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>
7210             </important>
7211           </section>
7212         </section>
7213
7214         <section id="OpenLibraryPrefs">
7215           <title>Open Library</title>
7216
7217           <section id="OpenLibraryCovers">
7218             <title>OpenLibraryCovers</title>
7219
7220             <para>Default: Don't add</para>
7221
7222             <para>Asks: ___ cover images from Open Library to search results
7223             and item detail pages on the OPAC.</para>
7224
7225             <para>Values:</para>
7226
7227             <itemizedlist>
7228               <listitem>
7229                 <para>Add</para>
7230               </listitem>
7231
7232               <listitem>
7233                 <para>Don't add</para>
7234               </listitem>
7235             </itemizedlist>
7236
7237             <para>Description:</para>
7238
7239             <itemizedlist>
7240               <listitem>
7241                 <para>This setting controls the display of applicable cover
7242                 art from the free Open Library database, via the Open Library
7243                 API. Please note that to use this feature, all other cover
7244                 services should be turned off.</para>
7245               </listitem>
7246             </itemizedlist>
7247           </section>
7248         </section>
7249         <section id="overdriveprefs">
7250           <title>Overdrive</title>
7251           <para>OverDrive is an pay service. You must first contact OverDrive directly for pricing
7252             and subscription information. Enabling this service will integrate Overdrive results in
7253             to your OPAC searches. You will have to apply for these 3 pieces of information through
7254             an application as an API developer. Overdrive API applications are evaluated once a week
7255             so you may not be able to use this feature immediately after signing up. To learn more
7256             please contact your OverDrive representative.</para>
7257           <screenshot>
7258               <screeninfo>Overdrive results</screeninfo>
7259               <mediaobject>
7260                 <imageobject>
7261                   <imagedata fileref="images/admin/globalprefs/Overdrive.png"/>
7262                 </imageobject>
7263               </mediaobject>
7264             </screenshot>
7265           <section id="OverDriveClientKey">
7266             <title>OverDriveClientKey and OverDriveClientSecret</title>
7267             <para>Asks: Include OverDrive availability information with the client key __ and client
7268               secret ___</para>
7269             <para>Description:<itemizedlist>
7270                 <listitem>
7271                   <para>OverDrive customers can get this information by visiting the <ulink
7272                       url="https://developer.overdrive.com/docs/getting-started">OverDrive Developer
7273                       Portal</ulink> and following the instructions found there to apply as an API
7274                     developer. Once this data and the <link linkend="OverDriveLibraryID"
7275                       >OverDriveLibraryID</link> are populated you will see OverDrive results on
7276                     your OPAC searches.</para>
7277                 </listitem>
7278               </itemizedlist></para>
7279           </section>
7280           <section id="OverDriveLibraryID">
7281             <title>OverDriveLibraryID</title>
7282             <para>Asks: Show items from the OverDrive catalog of library # ___</para>
7283             <para>Description:<itemizedlist>
7284                 <listitem>
7285                   <para>OverDrive customers can get this information by visiting the <ulink
7286                       url="https://developer.overdrive.com/docs/getting-started">OverDrive Developer
7287                       Portal</ulink> and following the instructions found there to apply as an API
7288                     developer. Once this data and the <link linkend="OverDriveClientKey"
7289                       >OverDriveClientKey and OverDriveClientSecret</link> are populated you will
7290                     see OverDrive results on your OPAC searches.</para>
7291                 </listitem>
7292               </itemizedlist></para>
7293           </section>
7294         </section>
7295         <section id="pluginprefs">
7296           <title>Plugins</title>
7297           <section id="UseKohaPlugins">
7298             <title>UseKohaPlugins</title>
7299             <para>Default: Don't enable</para>
7300             <para>Asks: ___  the ability to use Koha Plugins.</para>
7301             <para>Values:<itemizedlist>
7302                 <listitem>
7303                   <para>Don't enable</para>
7304                 </listitem>
7305                 <listitem>
7306                   <para>Enable</para>
7307                 </listitem>
7308               </itemizedlist></para>
7309             <note>
7310               <para>The plugin system must also be enabled in the Koha configuration file to be
7311                 fully enabled. Learn more in the <link linkend="pluginsystem">Plugins
7312                 chapter</link>.</para>
7313             </note>
7314           </section>
7315         </section>
7316
7317         <section id="Syndeticsprefs">
7318           <title>Syndetics</title>
7319
7320           <para>Syndetics is a pay service. You must first contact Syndetics
7321           directly for pricing and subscription information.</para>
7322
7323           <section id="SyndeticsEnabled">
7324             <title>SyndeticsEnabled</title>
7325
7326             <para>Default: Don't use</para>
7327
7328             <para>Asks: ___ content from Syndetics.</para>
7329
7330             <para>Values:</para>
7331
7332             <itemizedlist>
7333               <listitem>
7334                 <para>Don't use</para>
7335               </listitem>
7336
7337               <listitem>
7338                 <para>Use</para>
7339               </listitem>
7340             </itemizedlist>
7341
7342             <para>Description:</para>
7343
7344             <itemizedlist>
7345               <listitem>
7346                 <para>When this option is enabled any of the Syndetics options
7347                 can be used.</para>
7348               </listitem>
7349             </itemizedlist>
7350
7351             <important>
7352               <para>Requires that you enter your <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> before
7353               this content will appear.</para>
7354             </important>
7355           </section>
7356
7357           <section id="SyndeticsClientCode">
7358             <title>SyndeticsClientCode</title>
7359
7360             <para>Asks: Use the client code ___ to access Syndetics.</para>
7361
7362             <para>Description:</para>
7363
7364             <itemizedlist>
7365               <listitem>
7366                 <para>Once the library signs up for Syndetics' services,
7367                 Syndetics will provide the library with an access code. (Visit
7368                 the Syndetics homepage at <ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>
7369                 for more information.) This is the code that must be entered
7370                 to access Syndetics' subscription services. Syndetics is a
7371                 paid subscription service. This value must be entered before
7372                 <link linkend="SyndeticsEditions">SyndeticsEditions</link> can
7373                 be enabled. If the code is lost, corrupted, or forgotten, a
7374                 new one can be obtained from <ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>.</para>
7375               </listitem>
7376             </itemizedlist>
7377
7378             <important>
7379               <para>You will need to get your client code directly from
7380               Syndetics.</para>
7381             </important>
7382           </section>
7383
7384           <section id="SyndeticsCoverImages">
7385             <title>SyndeticsCoverImages &amp; SyndeticsCoverImageSize</title>
7386
7387             <para>SyndeticsCoverImages Default: Don't show</para>
7388
7389             <para>SyndeticsCoverImageSize Default: medium</para>
7390
7391             <para>Asks: ___ cover images from Syndetics on search results and
7392             item detail pages on the OPAC in a ___ size.</para>
7393
7394             <para>Descriptions:</para>
7395
7396             <itemizedlist>
7397               <listitem>
7398                 <para>When enabled, SyndeticsCoverImages, allows libraries to
7399                 display Syndetics' collection of full-color cover images for
7400                 books, videos, DVDs and CDs on their OPAC. For each book or
7401                 item that comes up during a user search, the cover image for
7402                 that title will be displayed. Since these cover images come in
7403                 three sizes, the optimum size must be selected using the
7404                 SyndeticsCoverImageSize preference after SyndeticsCoverImages
7405                 are enabled. Syndetics cover images come in two sizes:
7406                 mid-size (187 x 187 pixels), and large (400 x 400 pixels).
7407                 Syndetics is a paid subscription service. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
7408                 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
7409                 be activated before this service can be used. Other cover
7410                 image preferences should also be disabled to avoid
7411                 interference.</para>
7412               </listitem>
7413             </itemizedlist>
7414
7415             <para>SyndeticsCoverImages Values:</para>
7416
7417             <itemizedlist>
7418               <listitem>
7419                 <para>Don't show</para>
7420               </listitem>
7421
7422               <listitem>
7423                 <para>Show</para>
7424               </listitem>
7425             </itemizedlist>
7426
7427             <para>SyndeticsCoverImageSize Values:</para>
7428
7429             <itemizedlist>
7430               <listitem>
7431                 <para>medium</para>
7432               </listitem>
7433
7434               <listitem>
7435                 <para>large</para>
7436               </listitem>
7437             </itemizedlist>
7438           </section>
7439
7440           <section id="SyndeticsAuthorNotes">
7441             <title>SyndeticsAuthorNotes</title>
7442
7443             <para>Default: Don't show</para>
7444
7445             <para>Asks: ___ notes about the author of a title from Syndetics
7446             on item detail pages on the OPAC.</para>
7447
7448             <para>Values:</para>
7449
7450             <itemizedlist>
7451               <listitem>
7452                 <para>Don't show</para>
7453               </listitem>
7454
7455               <listitem>
7456                 <para>Show</para>
7457               </listitem>
7458             </itemizedlist>
7459
7460             <para>Description:</para>
7461
7462             <itemizedlist>
7463               <listitem>
7464                 <para>When this option is set to "Show", Syndetics provides
7465                 notes and short author biographies for more that 300,000
7466                 authors, in both fiction and nonfiction. With this option
7467                 enabled the library can display Syndetics Author Notes on the
7468                 OPAC. According to the Syndetics Solutions website (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>),
7469                 Author Notes include lists of contributors for many
7470                 multi-author texts and compilations. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
7471                 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
7472                 be activated before this service can be used.</para>
7473               </listitem>
7474             </itemizedlist>
7475           </section>
7476
7477           <section id="SyndeticsAwards">
7478             <title>SyndeticsAwards</title>
7479
7480             <para>Default: Don't show</para>
7481
7482             <para>Asks: ___ information from Syndetics about the awards a
7483             title has won on item detail pages on the OPAC.</para>
7484
7485             <para>Values:</para>
7486
7487             <itemizedlist>
7488               <listitem>
7489                 <para>Don't show</para>
7490               </listitem>
7491
7492               <listitem>
7493                 <para>Show</para>
7494               </listitem>
7495             </itemizedlist>
7496
7497             <para>Description:</para>
7498
7499             <itemizedlist>
7500               <listitem>
7501                 <para>When this option is set to "Show", Syndetics provides
7502                 its clients with a list of awards that any title has won. With
7503                 this service enabled the library can display those awards for
7504                 each book on its website. For each book or item that comes up
7505                 during a user search, the list of awards for that title will
7506                 be displayed. When a user clicks on a given award, information
7507                 about that award is presented along with a list of the other
7508                 titles that have won that award. If the user clicks on any
7509                 title in the list, they will see holdings information about
7510                 that title in their region. This option is a paid subscription
7511                 service. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
7512                 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
7513                 be activated before this service can be used.</para>
7514               </listitem>
7515             </itemizedlist>
7516           </section>
7517
7518           <section id="SyndeticsEditions">
7519             <title>SyndeticsEditions</title>
7520
7521             <para>Default: Don't show</para>
7522
7523             <para>Asks: ___ information about other editions of a title from
7524             Syndetics on item detail pages on the OPAC</para>
7525
7526             <para>Description:</para>
7527
7528             <itemizedlist>
7529               <listitem>
7530                 <para>When enabled this option shows information on other
7531                 editions of a title from Syndetics on the item detail pages of
7532                 the OPAC. Syndetics is a paid subscription service. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
7533                 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
7534                 be activated before this service can be used.</para>
7535               </listitem>
7536             </itemizedlist>
7537
7538             <para>Values:</para>
7539
7540             <itemizedlist>
7541               <listitem>
7542                 <para>Don't show</para>
7543               </listitem>
7544
7545               <listitem>
7546                 <para>Show</para>
7547               </listitem>
7548             </itemizedlist>
7549
7550             <important>
7551               <para>Requires <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
7552               'show'</para>
7553             </important>
7554           </section>
7555
7556           <section id="SyndeticsExcerpt">
7557             <title>SyndeticsExcerpt</title>
7558
7559             <para>Default: Don't show</para>
7560
7561             <para>Asks: ___ excerpts from of a title from Syndetics on item
7562             detail pages on the OPAC.</para>
7563
7564             <para>Values:</para>
7565
7566             <itemizedlist>
7567               <listitem>
7568                 <para>Don't show</para>
7569               </listitem>
7570
7571               <listitem>
7572                 <para>Show</para>
7573               </listitem>
7574             </itemizedlist>
7575
7576             <para>Description:</para>
7577
7578             <itemizedlist>
7579               <listitem>
7580                 <para>This preference allows Syndetics to display excerpts
7581                 given to them from selected publishers. The excerpts are
7582                 available from prominently reviewed new titles, both fiction
7583                 and non-fiction. The excerpts include poems, essays, recipes,
7584                 forwards and prefaces. Automatic links provided by the ISBNs
7585                 within local MARC records are required to integrate Syndetics
7586                 secured, high-speed Internet servers to the library OPACs. For
7587                 more information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7588               </listitem>
7589             </itemizedlist>
7590           </section>
7591
7592           <section id="SyndeticsReviews">
7593             <title>SyndeticsReviews</title>
7594
7595             <para>Default: Don't show</para>
7596
7597             <para>Asks: ___ reviews of a title from Syndetics on item detail
7598             pages on the OPAC.</para>
7599
7600             <para>Values:</para>
7601
7602             <itemizedlist>
7603               <listitem>
7604                 <para>Don't show</para>
7605               </listitem>
7606
7607               <listitem>
7608                 <para>Show</para>
7609               </listitem>
7610             </itemizedlist>
7611
7612             <para>Description:</para>
7613
7614             <itemizedlist>
7615               <listitem>
7616                 <para>Syndetics Reviews is an accumulation of book reviews
7617                 available from a variety of journals and serials. The reviews
7618                 page displays colored images of reviewed books dust jackets,
7619                 partnered with the names of the journal or serial providing
7620                 the review. Clicking on an icon opens a window revealing the
7621                 book title, author's name, book cover icon and the critic's
7622                 opinion of the book. Automatic links provided by the ISBNs
7623                 within local MARC records are required to integrate Syndetics
7624                 secured, high-speed Internet servers to the library OPACs. For
7625                 more information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7626               </listitem>
7627             </itemizedlist>
7628           </section>
7629
7630           <section id="SyndeticsSeries">
7631             <title>SyndeticsSeries</title>
7632
7633             <para>Default: Don't show</para>
7634
7635             <para>Asks: ___ information on other books in a title's series
7636             from Syndetics on item detail pages on the OPAC.</para>
7637
7638             <para>Values:</para>
7639
7640             <itemizedlist>
7641               <listitem>
7642                 <para>Don't show</para>
7643               </listitem>
7644
7645               <listitem>
7646                 <para>Show</para>
7647               </listitem>
7648             </itemizedlist>
7649
7650             <para>Description:</para>
7651
7652             <itemizedlist>
7653               <listitem>
7654                 <para>Each fiction title within a series is linked to the
7655                 complete series record. The record displays each title in
7656                 reading order and also displays the publication order, if
7657                 different. Alternate series titles are also displayed.
7658                 Automatic links provided by the ISBNs within local MARC
7659                 records are required to integrate Syndetics secured, high-
7660                 speed Internet servers to the library OPACs. For more
7661                 information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7662               </listitem>
7663             </itemizedlist>
7664           </section>
7665
7666           <section id="SyndeticsSummary">
7667             <title>SyndeticsSummary</title>
7668
7669             <para>Default: Don't show</para>
7670
7671             <para>Asks: ___ a summary of a title from Syndetics on item detail
7672             pages on the OPAC.</para>
7673
7674             <para>Values:</para>
7675
7676             <itemizedlist>
7677               <listitem>
7678                 <para>Don't show</para>
7679               </listitem>
7680
7681               <listitem>
7682                 <para>Show</para>
7683               </listitem>
7684             </itemizedlist>
7685
7686             <para>Description:</para>
7687
7688             <itemizedlist>
7689               <listitem>
7690                 <para>Providing more than 5.6 million summaries and
7691                 annotations derived from book jackets, edited publisher copy,
7692                 or independently written annotations from Book News, Inc.
7693                 Covering fiction and non-fiction, this summaries option
7694                 provides annotations on both trade and scholarly titles. For
7695                 more information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7696               </listitem>
7697             </itemizedlist>
7698           </section>
7699
7700           <section id="SyndeticsTOC">
7701             <title>SyndeticsTOC</title>
7702
7703             <para>Default: Don't show</para>
7704
7705             <para>Asks: ___ the table of contents of a title from Syndetics on
7706             item detail pages on the OPAC.</para>
7707
7708             <para>Values:</para>
7709
7710             <itemizedlist>
7711               <listitem>
7712                 <para>Don't show</para>
7713               </listitem>
7714
7715               <listitem>
7716                 <para>Show</para>
7717               </listitem>
7718             </itemizedlist>
7719
7720             <para>Description:</para>
7721
7722             <itemizedlist>
7723               <listitem>
7724                 <para>This preference allows staff and patrons to review the
7725                 Table of Contents from a wide variety of publications from
7726                 popular self-help books to conference proceedings. Specific
7727                 Information access is the main purpose for this option,
7728                 allowing patrons guidance to their preferred section of the
7729                 book. Special arrangements with selected book services is used
7730                 to obtain the table of contents for new publications each
7731                 year. Automatic links provided by the ISBNs within local MARC
7732                 records are required to integrate Syndetics secured,
7733                 high-speed Internet servers to the library OPACs. For more
7734                 information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7735               </listitem>
7736             </itemizedlist>
7737           </section>
7738         </section>
7739
7740         <section id="taggingprefs">
7741           <title>Tagging</title>
7742
7743           <section id="TagsEnabled">
7744             <title>TagsEnabled</title>
7745
7746             <para>Default: Allow</para>
7747
7748             <para>Asks: ___ patrons and staff to put tags on items.</para>
7749
7750             <para>Values:</para>
7751
7752             <itemizedlist>
7753               <listitem>
7754                 <para>Allow</para>
7755               </listitem>
7756
7757               <listitem>
7758                 <para>Don't allow</para>
7759               </listitem>
7760             </itemizedlist>
7761
7762             <para>Description:</para>
7763
7764             <itemizedlist>
7765               <listitem>
7766                 <para>Set to 'Allow' enable tagging. A tag is metadata, a word
7767                 added to identify an item. Tags allow patrons to classify
7768                 materials on their own. TagsEnabled is the main switch that
7769                 permits the tagging features. TagsEnable must be set to
7770                 'Allow' to allow for other tagging features.</para>
7771               </listitem>
7772             </itemizedlist>
7773           </section>
7774
7775           <section id="TagsModeration">
7776             <title>TagsModeration</title>
7777
7778             <para>Default: Don't require</para>
7779
7780             <para>Asks: ___ that tags submitted by patrons be reviewed by a
7781             staff member before being shown.</para>
7782
7783             <para>Values:</para>
7784
7785             <itemizedlist>
7786               <listitem>
7787                 <para>Don't require</para>
7788               </listitem>
7789
7790               <listitem>
7791                 <para>Require</para>
7792               </listitem>
7793             </itemizedlist>
7794
7795             <para>Description:</para>
7796
7797             <itemizedlist>
7798               <listitem>
7799                 <para>When set to 'Require,' all tags to be first filtered by
7800                 the tag moderator. Only approved tags will be visible to
7801                 patrons. When set to 'Don't require' tags will bypass the tag
7802                 moderator and patrons' tags to be immediately visible. When
7803                 this preference is enabled the moderator, a staff member,
7804                 would approve the tag in the Staff Client. The moderator will
7805                 have the option to approve or reject each pending tag
7806                 suggestion.</para>
7807               </listitem>
7808             </itemizedlist>
7809
7810             <para>When moderation is required all tags go through the tag
7811             moderation tool before becoming visible.</para>
7812
7813             <itemizedlist>
7814               <listitem>
7815                 <para><emphasis>Get there:</emphasis> More &gt; Tools &gt;
7816                 <link linkend="tagsmoderation">Tags</link></para>
7817               </listitem>
7818             </itemizedlist>
7819           </section>
7820
7821           <section id="TagsShowOnList">
7822             <title>TagsShowOnList</title>
7823
7824             <para>Default: 6</para>
7825
7826             <para>Asks: Show ___ tags on search results on the OPAC.</para>
7827
7828             <note>
7829               <para>Set the value to 0 (zero) to turn this feature off.</para>
7830             </note>
7831           </section>
7832
7833           <section id="TagsInputOnList">
7834             <title>TagsInputOnList</title>
7835
7836             <para>Default: Allow</para>
7837
7838             <para>Asks: ___ patrons to input tags on search results on the
7839             OPAC.</para>
7840
7841             <para>Values:</para>
7842
7843             <itemizedlist>
7844               <listitem>
7845                 <para>Allow</para>
7846
7847                 <screenshot>
7848                   <screeninfo>Tags on Search Results</screeninfo>
7849
7850                   <mediaobject>
7851                     <imageobject>
7852                       <imagedata fileref="images/admin/globalprefs/TagsInputOnList.png"/>
7853                     </imageobject>
7854                   </mediaobject>
7855                 </screenshot>
7856               </listitem>
7857
7858               <listitem>
7859                 <para>Don't allow</para>
7860               </listitem>
7861             </itemizedlist>
7862           </section>
7863
7864           <section id="TagsShowOnDetail">
7865             <title>TagsShowOnDetail</title>
7866
7867             <para>Default: 10</para>
7868
7869             <para>Asks: Show ___ tags on item detail pages on the OPAC.</para>
7870
7871             <note>
7872               <para>Set the value to 0 (zero) to turn this feature off.</para>
7873             </note>
7874           </section>
7875
7876           <section id="TagsInputOnDetail">
7877             <title>TagsInputOnDetail</title>
7878
7879             <para>Default: Allow</para>
7880
7881             <para>Asks: ___ patrons to input tags on item detail pages on the
7882             OPAC.</para>
7883
7884             <para>Values:</para>
7885
7886             <itemizedlist>
7887               <listitem>
7888                 <para>Allow</para>
7889
7890                 <screenshot>
7891                   <screeninfo>Add Tags on Detail</screeninfo>
7892
7893                   <mediaobject>
7894                     <imageobject>
7895                       <imagedata fileref="images/admin/globalprefs/TagsInputOnDetail.png"/>
7896                     </imageobject>
7897                   </mediaobject>
7898                 </screenshot>
7899               </listitem>
7900
7901               <listitem>
7902                 <para>Don't allow</para>
7903               </listitem>
7904             </itemizedlist>
7905           </section>
7906
7907           <section id="TagsExternalDictionary">
7908             <title>TagsExternalDictionary</title>
7909
7910             <para>Asks: Allow tags in the dictionary of the ispell executable
7911             ___ on the server to be approved without moderation.</para>
7912
7913             <para>Description:</para>
7914
7915             <itemizedlist>
7916               <listitem>
7917                 <para>The dictionary includes a list of accepted and rejected
7918                 tags. The accepted list includes all the tags that have been
7919                 pre-allowed. The rejected list includes tags that are not
7920                 allowed. This preference identifies the "accepted" dictionary
7921                 used. Ispell is an open source dictionary which can be used as
7922                 a list of accepted terms. Since the dictionary allows for
7923                 accurately spelled obscenities, the libraries policy may
7924                 dictate that modifications are made to the Ispell dictionary
7925                 if this preference is use. For more information about Ispell
7926                 <ulink url="http://www.gnu.org/software/ispell/ispell.html">http://www.gnu.org/software/ispell/ispell.html</ulink>.
7927                 Enter the path on your server to a local ispell executable,
7928                 used to set $Lingua::Ispell::path.</para>
7929               </listitem>
7930             </itemizedlist>
7931           </section>
7932         </section>
7933       </section>
7934
7935       <section id="l18nprefs">
7936         <title>I18N/L10N</title>
7937
7938         <para><emphasis> <emphasis>These preferences control your
7939         Internationalization and Localization settings.</emphasis>
7940         </emphasis></para>
7941
7942         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
7943         Global System Preferences &gt; I18N/L10N</para>
7944         <section id="AddressFormat">
7945           <title>AddressFormat</title>
7946           <para>Default: US style ([Street number], [Address] - [City], [Zip/Postal Code],
7947             [Country])</para>
7948           <para>Asks: Format postal addresses using ___</para>
7949           <para>Values:<itemizedlist>
7950               <listitem>
7951                 <para>German style ([Adress] [Street number] - [Zip/Postal Code] [City] - [Country])
7952                 </para>
7953               </listitem>
7954               <listitem>
7955                 <para>US style ([Street number], [Address] - [City], [Zip/Postal Code],
7956                   [Country])</para>
7957               </listitem>
7958             </itemizedlist>Description:<itemizedlist>
7959               <listitem>
7960                 <para>This preference will let you control how Koha displays patron addresses given
7961                   the information entered in the various fields on their record.</para>
7962               </listitem>
7963             </itemizedlist></para>
7964         </section>
7965         <section id="alphabet">
7966           <title>alphabet</title>
7967           <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>
7968           <para>Asks: Use the alphabet ___ for lists of browsable letters. This should be a space
7969             separated list of uppercase letters. </para>
7970           <para>Description:</para>
7971           <itemizedlist>
7972             <listitem>
7973               <para>This preference allows you define your own alphabet for browsing patrons in Koha.</para>
7974               <screenshot>
7975                   <screeninfo>Alphabet browse on patron module</screeninfo>
7976                   <mediaobject>
7977                     <imageobject>
7978                       <imagedata fileref="images/admin/globalprefs/alphabet.png"/>
7979                     </imageobject>
7980                   </mediaobject>
7981                 </screenshot>
7982             </listitem>
7983           </itemizedlist>
7984         </section>
7985
7986         <section id="CalendarFirstDayOfWeek">
7987           <title>CalendarFirstDayOfWeek</title>
7988
7989           <para>Default: Sunday</para>
7990
7991           <para>Asks: Use ___ as the first day of week in the calendar.</para>
7992
7993           <para>Values:</para>
7994
7995           <itemizedlist>
7996             <listitem>
7997               <para>Monday</para>
7998             </listitem>
7999
8000             <listitem>
8001               <para>Sunday</para>
8002             </listitem>
8003           </itemizedlist>
8004
8005           <para>Description:</para>
8006
8007           <itemizedlist>
8008             <listitem>
8009               <para>Using this preference you can control what day shows as
8010               the first day of the week in the calendar pop ups throughout
8011               Koha and on the Calendar tool. If you change this preference and
8012               don't see a change in your browser try clearing your cache since
8013               it makes changes to the Javascript on these pages.</para>
8014             </listitem>
8015           </itemizedlist>
8016         </section>
8017
8018         <section id="dateformat">
8019           <title>dateformat</title>
8020
8021           <para>Default: mm/dd/yyyy</para>
8022
8023           <para>Asks: Format dates like ___</para>
8024
8025           <para>Values:</para>
8026
8027           <itemizedlist>
8028             <listitem>
8029               <para>dd/mm/yyyy</para>
8030             </listitem>
8031
8032             <listitem>
8033               <para>mm/dd/yyyy</para>
8034             </listitem>
8035
8036             <listitem>
8037               <para>yyyy/mm/dd</para>
8038             </listitem>
8039           </itemizedlist>
8040
8041           <para>Description:</para>
8042
8043           <itemizedlist>
8044             <listitem>
8045               <para>This preference controls how the date is displayed. The
8046               options are the United States method, mm/dd/yyyy (04/24/2010),
8047               the metric method, dd/mm/yyyy (24/04/2010) or ISO, which is the
8048               International Standard of Organization, yyyy/mm/dd (2010/04/24).
8049               The International Standard of Organization would primarily be
8050               used by libraries with locations in multiple nations that may
8051               use different date formats, to have a single display type, or if
8052               the library would be in a region that does not use the United
8053               States or metric method. More information regarding the ISO date
8054               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>
8055             </listitem>
8056           </itemizedlist>
8057         </section>
8058
8059         <section id="languagepref">
8060           <title>language</title>
8061
8062           <para>Default: English</para>
8063
8064           <para>Asks: Enable the following languages on the staff
8065           interface</para>
8066
8067           <para>Values:</para>
8068
8069           <itemizedlist>
8070             <listitem>
8071               <para>English</para>
8072             </listitem>
8073           </itemizedlist>
8074
8075           <para>To install additional languages please refer to <ulink
8076               url="http://wiki.koha-community.org/wiki/Installation_of_additional_languages_for_OPAC_and_INTRANET_staff_client"
8077               >http://wiki.koha-community.org/wiki/Installation_of_additional_languages_for_OPAC_and_INTRANET_staff_client</ulink>
8078           </para>
8079         </section>
8080
8081         <section id="opaclanguages">
8082           <title>opaclanguages</title>
8083
8084           <para>Default: English</para>
8085
8086           <para>Asks: Enable the following languages on the OPAC</para>
8087
8088           <para>Values:</para>
8089
8090           <itemizedlist>
8091             <listitem>
8092               <para>English</para>
8093             </listitem>
8094           </itemizedlist>
8095
8096           <para>To install additional languages you need to run
8097           misc/translation/install-code.pl. For example, to install French you
8098           would run the following command <emphasis>install-code.pl
8099           fr-FR</emphasis> to make the templates, once they exist and are in
8100           the right place then they will show up as an option in this
8101           preference.</para>
8102         </section>
8103
8104         <section id="opaclanguagesdisplay">
8105           <title>opaclanguagesdisplay</title>
8106
8107           <para>Default: Don't allow</para>
8108
8109           <para>Asks: ___ patrons to select their language on the OPAC.</para>
8110
8111           <para>Values:</para>
8112
8113           <itemizedlist>
8114             <listitem>
8115               <para>Allow</para>
8116
8117               <screenshot>
8118                 <screeninfo>When this preference is on, patrons can choose
8119                 their language from a list at the bottom of the
8120                 OPAC</screeninfo>
8121
8122                 <mediaobject>
8123                   <imageobject>
8124                     <imagedata fileref="images/admin/globalprefs/opaclanguagesdisplay.png"/>
8125                   </imageobject>
8126                 </mediaobject>
8127               </screenshot>
8128             </listitem>
8129
8130             <listitem>
8131               <para>Don't allow</para>
8132             </listitem>
8133           </itemizedlist>
8134         </section>
8135         <section id="TimeFormat">
8136           <title>TimeFormat</title>
8137           <para>Default: 24 hour format</para>
8138           <para>Asks: Format times in ___ </para>
8139           <para>Values:<itemizedlist>
8140               <listitem>
8141                 <para>12 hour format (eg 02:18PM)</para>
8142               </listitem>
8143               <listitem>
8144                 <para>24 hour format (eg 14:18)</para>
8145               </listitem>
8146             </itemizedlist></para>
8147         </section>
8148       </section>
8149
8150       <section id="localprefs">
8151         <title>Local Use</title>
8152
8153         <para><emphasis> <emphasis>These preferences are defined
8154         locally.</emphasis> </emphasis></para>
8155
8156         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
8157         Global System Preferences &gt; Local Use<note>
8158             <para>Sometimes preferences which are either new or outdated will
8159             appear in this tab, if you didn't add any preferences to this tab
8160             then it's best to ignore preferences listed here.</para>
8161           </note></para>
8162       </section>
8163
8164       <section id="logs">
8165         <title>Logs</title>
8166
8167         <para>Logs keep track of transaction on the system. You can decide
8168         which actions you want to log and which you don't using these
8169         preferences.</para>
8170
8171         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
8172         Global System Preferences &gt; Logs</para>
8173
8174         <section id="AuthoritiesLog">
8175           <title>AuthoritiesLog</title>
8176
8177           <para>Default: Don't log</para>
8178
8179           <para>Asks: ___ changes to authority records.</para>
8180
8181           <para>Values:</para>
8182
8183           <itemizedlist>
8184             <listitem>
8185               <para>Don't log</para>
8186             </listitem>
8187
8188             <listitem>
8189               <para>Log</para>
8190             </listitem>
8191           </itemizedlist>
8192         </section>
8193
8194         <section id="BorrowersLog">
8195           <title>BorrowersLog</title>
8196
8197           <para>Default: Log</para>
8198
8199           <para>Asks: ___ changes to patron records.</para>
8200
8201           <para>Values:</para>
8202
8203           <itemizedlist>
8204             <listitem>
8205               <para>Don't log</para>
8206             </listitem>
8207
8208             <listitem>
8209               <para>Log</para>
8210             </listitem>
8211           </itemizedlist>
8212         </section>
8213
8214         <section id="CataloguingLog">
8215           <title>CataloguingLog</title>
8216
8217           <para>Default: Don't log</para>
8218
8219           <para>Asks: ___ any changes to bibliographic or item records.</para>
8220
8221           <para>Values:</para>
8222
8223           <itemizedlist>
8224             <listitem>
8225               <para>Don't log</para>
8226             </listitem>
8227
8228             <listitem>
8229               <para>Log</para>
8230             </listitem>
8231           </itemizedlist>
8232
8233           <important>
8234             <para>Since this occurs whenever a book is cataloged, edited, or
8235             checked in or out it can be very resource intensive - slowing down
8236             your system.</para>
8237           </important>
8238         </section>
8239
8240         <section id="FinesLog">
8241           <title>FinesLog</title>
8242
8243           <para>Default: Log</para>
8244
8245           <para>Asks: ___ when overdue fines are charged or automatically
8246           forgiven.</para>
8247
8248           <para>Values:</para>
8249
8250           <itemizedlist>
8251             <listitem>
8252               <para>Don't log</para>
8253             </listitem>
8254
8255             <listitem>
8256               <para>Log</para>
8257             </listitem>
8258           </itemizedlist>
8259         </section>
8260
8261         <section id="IssueLog">
8262           <title>IssueLog</title>
8263
8264           <para>Default: Log</para>
8265
8266           <para>Asks: ___ when items are checked out.</para>
8267
8268           <para>Values:</para>
8269
8270           <itemizedlist>
8271             <listitem>
8272               <para>Don't log</para>
8273             </listitem>
8274
8275             <listitem>
8276               <para>Log</para>
8277             </listitem>
8278           </itemizedlist>
8279         </section>
8280
8281         <section id="LetterLog">
8282           <title>LetterLog</title>
8283
8284           <para>Default: Log</para>
8285
8286           <para>Asks: ___ when an automatic claim notice is sent.</para>
8287
8288           <para>Values:</para>
8289
8290           <itemizedlist>
8291             <listitem>
8292               <para>Don't log</para>
8293             </listitem>
8294
8295             <listitem>
8296               <para>Log</para>
8297             </listitem>
8298           </itemizedlist>
8299
8300           <note>
8301             <para>This log tracks all notices that go to patrons including the
8302             overdue notices.</para>
8303           </note>
8304         </section>
8305
8306         <section id="ReturnLog">
8307           <title>ReturnLog</title>
8308
8309           <para>Default: Log</para>
8310
8311           <para>Asks: ___ when items are returned.</para>
8312
8313           <para>Values:</para>
8314
8315           <itemizedlist>
8316             <listitem>
8317               <para>Don't log</para>
8318             </listitem>
8319
8320             <listitem>
8321               <para>Log</para>
8322             </listitem>
8323           </itemizedlist>
8324         </section>
8325
8326         <section id="SubscriptionLog">
8327           <title>SubscriptionLog</title>
8328
8329           <para>Default: Log</para>
8330
8331           <para>Asks: ___ when serials are added, deleted or changed.</para>
8332
8333           <para>Values:</para>
8334
8335           <itemizedlist>
8336             <listitem>
8337               <para>Don't log</para>
8338             </listitem>
8339
8340             <listitem>
8341               <para>Log</para>
8342             </listitem>
8343           </itemizedlist>
8344         </section>
8345       </section>
8346
8347       <section id="opacprefs">
8348         <title>OPAC</title>
8349
8350         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
8351         Global System Preferences &gt; OPAC</para>
8352         <section id="advancedsearchopt">
8353           <title>Advanced Search Options</title>
8354           <para/>
8355           <section id="OpacAdvSearchMoreOptions">
8356             <title>OpacAdvSearchMoreOptions</title>
8357             <para>Default: Select All</para>
8358             <para>Asks: Show search options for the expanded view ___</para>
8359             <para>Values:<itemizedlist>
8360                 <listitem>
8361                   <para>[Select all]</para>
8362                 </listitem>
8363                 <listitem>
8364                   <para>Item types</para>
8365                 </listitem>
8366                 <listitem>
8367                   <para>Language</para>
8368                 </listitem>
8369                 <listitem>
8370                   <para>Location and availability</para>
8371                 </listitem>
8372                 <listitem>
8373                   <para>Publication date</para>
8374                 </listitem>
8375                 <listitem>
8376                   <para>Sorting</para>
8377                 </listitem>
8378                 <listitem>
8379                   <para>Subtypes</para>
8380                 </listitem>
8381               </itemizedlist></para>
8382             <para>Description:<itemizedlist>
8383                 <listitem>
8384                   <para>The settings in this preference will determine which search fields will show
8385                     when the patron is using the 'More options' mode on the advanced search
8386                     page.</para>
8387                 </listitem>
8388               </itemizedlist></para>
8389           </section>
8390           <section id="OpacAdvSearchOptions">
8391             <title>OpacAdvSearchOptions</title>
8392             <para>Default: Item types, Language, Location and availability, Publication date,
8393               Sorting</para>
8394             <para>Asks: Show search options ___ </para>
8395             <para>Values:<itemizedlist>
8396                 <listitem>
8397                   <para>[Select all]</para>
8398                 </listitem>
8399                 <listitem>
8400                   <para>Item types</para>
8401                 </listitem>
8402                 <listitem>
8403                   <para>Language</para>
8404                 </listitem>
8405                 <listitem>
8406                   <para>Location and availability</para>
8407                 </listitem>
8408                 <listitem>
8409                   <para>Publication date</para>
8410                 </listitem>
8411                 <listitem>
8412                   <para>Sorting</para>
8413                 </listitem>
8414                 <listitem>
8415                   <para>Subtypes</para>
8416                 </listitem>
8417               </itemizedlist></para>
8418             <para>Description:<itemizedlist>
8419                 <listitem>
8420                   <para>The settings in this preference will determine which search fields will show
8421                     when the patron is using the 'Fewer options' mode on the advanced search
8422                     page.</para>
8423                 </listitem>
8424               </itemizedlist></para>
8425           </section>
8426         </section>
8427
8428         <section id="opacappearanceprefs">
8429           <title>Appearance</title>
8430
8431           <para>These preferences control how things appear in the
8432           OPAC.</para>
8433
8434           <section id="AuthorisedValueImages">
8435             <title>AuthorisedValueImages</title>
8436
8437             <para>Default: Don't show</para>
8438
8439             <para>Asks: ___ images for authorized values (such as lost
8440             statuses and locations) in search results and item detail pages on
8441             the OPAC.</para>
8442
8443             <para>Values:</para>
8444
8445             <itemizedlist>
8446               <listitem>
8447                 <para>Don't show</para>
8448               </listitem>
8449
8450               <listitem>
8451                 <para>Show</para>
8452               </listitem>
8453             </itemizedlist>
8454
8455             <para><emphasis>Get there:</emphasis> More &gt; Administration
8456             &gt; <link linkend="authorizedvalues">Authorized
8457             Values</link></para>
8458           </section>
8459
8460           <section id="BiblioDefaultView">
8461             <title>BiblioDefaultView</title>
8462
8463             <para>Default: in simple form</para>
8464
8465             <para>Asks: By default, show bib records ___</para>
8466
8467             <para>Values:</para>
8468
8469             <itemizedlist>
8470               <listitem>
8471                 <para>as specified in the ISBD template.</para>
8472
8473                 <itemizedlist>
8474                   <listitem>
8475                     <para>See <link linkend="isbdpref">ISBD</link> preference
8476                     for more information</para>
8477                   </listitem>
8478                 </itemizedlist>
8479               </listitem>
8480
8481               <listitem>
8482                 <para>in simple form.</para>
8483               </listitem>
8484
8485               <listitem>
8486                 <para>in their MARC format.</para>
8487               </listitem>
8488             </itemizedlist>
8489
8490             <para>Description:</para>
8491
8492             <itemizedlist>
8493               <listitem>
8494                 <para>This preference determines the level of bibliographic
8495                 detail that the patron will see on the OPAC detail page. The
8496                 simple form displays the graphical interface; MARC format
8497                 displays the MARC21 cataloging view; ISBD displays the ISBD
8498                 (International Standard Bibliographic Description, AACR2)
8499                 view.</para>
8500               </listitem>
8501             </itemizedlist>
8502           </section>
8503
8504           <section id="COinSinOPACResults">
8505             <title>COinSinOPACResults</title>
8506
8507             <para>Default: Include</para>
8508
8509             <para>Asks: ___ COinS / OpenURL / Z39.88 in OPAC search
8510             results.</para>
8511
8512             <para>Values:</para>
8513
8514             <itemizedlist>
8515               <listitem>
8516                 <para>Don't include</para>
8517
8518                 <itemizedlist>
8519                   <listitem>
8520                     <para>If you choose not to include COinS on the search
8521                     results, it will still be loaded on the individual
8522                     bibliographic records.</para>
8523                   </listitem>
8524                 </itemizedlist>
8525               </listitem>
8526
8527               <listitem>
8528                 <para>Include</para>
8529
8530                 <itemizedlist>
8531                   <listitem>
8532                     <para>Enabling this feature will slow OPAC search response
8533                     times.</para>
8534                   </listitem>
8535                 </itemizedlist>
8536               </listitem>
8537             </itemizedlist>
8538
8539             <para>Description:</para>
8540
8541             <itemizedlist>
8542               <listitem>
8543                 <para>COinS stands for ContextObjects in Spans. COinS is a
8544                 method to embed bibliographic metadata in the HTML code of web
8545                 pages. This allows bibliographic software to publish
8546                 machine-readable bibliographic items and client reference
8547                 management software (such as Zotero) to retrieve bibliographic
8548                 metadata. The metadata can also be sent to an OpenURL
8549                 resolver. This allows, for instance, searching for a copy of a
8550                 book in one's own library.</para>
8551               </listitem>
8552             </itemizedlist>
8553           </section>
8554
8555           <section id="DisplayOPACiconsXSLT">
8556             <title>DisplayOPACiconsXSLT</title>
8557
8558             <para>Default: Don't show</para>
8559
8560             <para>Asks: On pages displayed with XSLT stylesheets on the OPAC,
8561             ___ icons for itemtype and authorized values.<important>
8562                 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link>
8563                 and/or <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
8564                 must be set to use an XSLT stylesheet for this to show
8565                 (default or custom)</para>
8566               </important></para>
8567
8568             <para>Values:</para>
8569
8570             <itemizedlist>
8571               <listitem>
8572                 <para>Don't show</para>
8573               </listitem>
8574
8575               <listitem>
8576                 <para>Show</para>
8577
8578                 <screenshot>
8579                   <screeninfo>DisplayOPACiconsXSLT</screeninfo>
8580
8581                   <mediaobject>
8582                     <imageobject>
8583                       <imagedata fileref="images/admin/globalprefs/DisplayOPACiconsXSLT.png"/>
8584                     </imageobject>
8585                   </mediaobject>
8586                 </screenshot>
8587               </listitem>
8588             </itemizedlist>
8589
8590             <para><note>
8591                 <para>See the <link linkend="XSLTiTypes">XSLT Icon
8592                 Guide</link> for more information on these icons.</para>
8593               </note></para>
8594           </section>
8595
8596           <section id="hidelostitems">
8597             <title>hidelostitems</title>
8598
8599             <para>Default: Don't show</para>
8600
8601             <para>Asks: ___ lost items on search and detail pages.</para>
8602
8603             <para>Description:</para>
8604
8605             <itemizedlist>
8606               <listitem>
8607                 <para>Items that are marked lost by the library can either be
8608                 shown or not shown on the OPAC. By setting the value to "Don't
8609                 show," the lost item is not shown on the OPAC. By setting the
8610                 value "Show," the lost item is shown on the OPAC for patrons
8611                 to view with a status of 'lost.'</para>
8612               </listitem>
8613             </itemizedlist>
8614
8615             <para>Values:</para>
8616
8617             <itemizedlist>
8618               <listitem>
8619                 <para>Don't show</para>
8620               </listitem>
8621
8622               <listitem>
8623                 <para>Show</para>
8624
8625                 <screenshot>
8626                   <screeninfo>Lost item showing in the OPAC</screeninfo>
8627
8628                   <mediaobject>
8629                     <imageobject>
8630                       <imagedata fileref="images/admin/globalprefs/hidelostitems.png"/>
8631                     </imageobject>
8632                   </mediaobject>
8633                 </screenshot>
8634               </listitem>
8635             </itemizedlist>
8636           </section>
8637           <section id="HighlightOwnItemsOnOPAC">
8638             <title>HighlightOwnItemsOnOPAC &amp; HighlightOwnItemsOnOPACWhich</title>
8639             <para>HighlightOwnItemsOnOPAC Default: Don't emphasize</para>
8640             <para>HighlightOwnItemsOnOPACWhich Default: patron's home library </para>
8641             <para>Asks: ___  results from the ___ by moving the results to the front and increasing
8642               the size or highlighting the rows for those results. </para>
8643             <para>HighlightOwnItemsOnOPAC Values:<itemizedlist>
8644                 <listitem>
8645                   <para>Don't emphasize</para>
8646                 </listitem>
8647                 <listitem>
8648                   <para>Emphasize</para>
8649                 </listitem>
8650               </itemizedlist></para>
8651             <para>HighlightOwnItemsOnOPACWhich Values:<itemizedlist>
8652                 <listitem>
8653                   <para>OPAC's branch based via the URL<itemizedlist>
8654                       <listitem>
8655                         <para>The library is chosen based on the Apache environment variable
8656                           BRANCHCODE. For example, this could be added to the OPAC section of
8657                           koha-httpd.conf: SetEnv BRANCHCODE "CPL"</para>
8658                       </listitem>
8659                     </itemizedlist></para>
8660                 </listitem>
8661                 <listitem>
8662                   <para>patron's home library<itemizedlist>
8663                       <listitem>
8664                         <para>The items emphasized will be those of the same library as the patron's
8665                           library. If no one is logged into the OPAC, no items will be
8666                           highlighted.</para>
8667                       </listitem>
8668                     </itemizedlist></para>
8669                 </listitem>
8670               </itemizedlist></para>
8671             <important>
8672               <para>This preference will only effect sites that are not using an XSLT stylesheet.
8673                 XSLT stylesheets are defined in the <link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> and <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> preferences.</para>
8674             </important>
8675           </section>
8676           <section id="GoogleIndicTransliteration">
8677             <title>GoogleIndicTransliteration</title>
8678             <para>Default: Don't show</para>
8679             <para>Asks: ___ GoogleIndicTransliteration on the OPAC. </para>
8680             <para>Values:<itemizedlist>
8681                 <listitem>
8682                   <para>Don't show</para>
8683                 </listitem>
8684                 <listitem>
8685                   <para>Show<screenshot>
8686                       <screeninfo/>
8687                       <mediaobject>
8688                         <imageobject>
8689                           <imagedata
8690                             fileref="images/admin/globalprefs/GoogleIndicTransliteration.png"/>
8691                         </imageobject>
8692                       </mediaobject>
8693                     </screenshot></para>
8694                 </listitem>
8695               </itemizedlist></para>
8696           </section>
8697
8698           <section id="LibraryName">
8699             <title>LibraryName</title>
8700
8701             <para>Asks: Show ___ as the name of the library on the
8702             OPAC.</para>
8703
8704             <note>
8705               <para>This value will appear in the title bar of the
8706               browser</para>
8707             </note>
8708
8709             <note>
8710               <para>Edit '<link linkend="opacheader">opacheader</link>' if
8711               you'd like to add a library name above your search box on the
8712               OPAC</para>
8713             </note>
8714
8715             <screenshot>
8716               <screeninfo>Browser title and address bar</screeninfo>
8717
8718               <mediaobject>
8719                 <imageobject>
8720                   <imagedata fileref="images/admin/globalprefs/LibraryName.png"/>
8721                 </imageobject>
8722               </mediaobject>
8723             </screenshot>
8724           </section>
8725           <section id="NoLoginInstructions">
8726             <title>NoLoginInstructions</title>
8727             <para>Asks: Show the following HTML on the OPAC login form when a patron is not logged
8728               in: </para>
8729             <para>Description:<itemizedlist>
8730                 <listitem>
8731                   <para>This preference allows you to override the default text seen on the log in
8732                     page in the Koha OPAC.  The default HTML
8733                     is:<programlisting>&lt;h5>Don't have a password yet?&lt;/h5>
8734 &lt;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.&lt;/p>
8735 &lt;h5>Don't have a library card?&lt;/h5>
8736 &lt;p> If you don't have a library card, stop by your local library to sign up.&lt;/p></programlisting></para>
8737                   <para>Any HTML in this box will replace the above text below the log in box.<screenshot>
8738                       <screeninfo>No login instructions</screeninfo>
8739                       <mediaobject>
8740                         <imageobject>
8741                           <imagedata fileref="images/admin/globalprefs/NoLoginInstructions.png"/>
8742                         </imageobject>
8743                       </mediaobject>
8744                     </screenshot></para>
8745                 </listitem>
8746               </itemizedlist></para>
8747           </section>
8748
8749           <section id="OpacAddMastheadLibraryPulldown">
8750             <title>OpacAddMastheadLibraryPulldown</title>
8751
8752             <para>Default: Don't add</para>
8753
8754             <para>Asks: ___ a library select pulldown menu on the OPAC
8755             masthead.</para>
8756
8757             <para>Values:</para>
8758
8759             <itemizedlist>
8760               <listitem>
8761                 <para>Add</para>
8762
8763                 <screenshot>
8764                   <screeninfo>Library select box on Koha OPAC</screeninfo>
8765
8766                   <mediaobject>
8767                     <imageobject>
8768                       <imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-add.png"/>
8769                     </imageobject>
8770                   </mediaobject>
8771                 </screenshot>
8772               </listitem>
8773
8774               <listitem>
8775                 <para>Don't Add</para>
8776
8777                 <screenshot>
8778                   <screeninfo>No library select box on Koha OPAC</screeninfo>
8779
8780                   <mediaobject>
8781                     <imageobject>
8782                       <imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-dontadd.png"/>
8783                     </imageobject>
8784                   </mediaobject>
8785                 </screenshot>
8786               </listitem>
8787             </itemizedlist>
8788           </section>
8789
8790           <section id="OPACBaseURL">
8791             <title>OPACBaseURL</title>
8792
8793             <para>Asks: The OPAC is located at http:// ___</para>
8794             <para>Description:<itemizedlist>
8795                 <listitem>
8796                   <para>This preference is looking for the URL of your public catalog (OPAC) without
8797                     the http:// in front of it (enter www.mycatalog.com instead of
8798                     http://www.mycatalog.com). Once it is filled in Koha will use it to generate
8799                     permanent links in your RSS feeds, for your social network share buttons and in
8800                     your staff client when generating links to bib records in the OPAC.</para>
8801                 </listitem>
8802               </itemizedlist></para>
8803             <important>
8804               <para>Do not include a trailing slash in the URL this will break links created using
8805                 this URL.  (example: www.google.com not www.google.com/)</para>
8806             </important>
8807
8808             <important>
8809               <para>This must be filled in with the URL of your public catalog for RSS, unAPI, and
8810                 search plugins to work.</para>
8811             </important>
8812
8813             <important>
8814               <para>This must be filled in with the URL of your public catalog to show 'OPAC View'
8815                 links from bib records in the staff client:</para>
8816             </important>
8817
8818             <screenshot>
8819               <screeninfo>With OPACBaseURL set, links to the OPAC will appear
8820               on each individual bib record in the staff client</screeninfo>
8821
8822               <mediaobject>
8823                 <imageobject>
8824                   <imagedata fileref="images/admin/globalprefs/OPACBaseURL.png"/>
8825                 </imageobject>
8826               </mediaobject>
8827             </screenshot>
8828           </section>
8829
8830           <section id="OpacAdditionalStylesheet">
8831             <title>OpacAdditionalStylesheet</title>
8832             <para>Asks: Include the additional CSS stylesheet ___ to override specified settings
8833               from the default stylesheet.</para>
8834             <para>Description:</para>
8835             <itemizedlist>
8836               <listitem>
8837                 <para>The preference can look for stylesheets in the template directory for your
8838                   OPAC language, for instance: /koha-tmpl/opac-tmpl/prog/en/css. If you upload a
8839                   custom file, opac-mystyles.css to this directory, you can specify it by entering
8840                   opac-mystyles.css in your opaccolorstylesheet system preference. This adds your
8841                   custom stylesheet as a linked stylesheet alongside the OPAC's default CSS files.
8842                   This method is preferable because linked stylesheets are cached by the user's
8843                   browser, meaning upon repeat visits to your site the user's browser will not have
8844                   to re-download the stylesheet, instead using the copy in the browser's
8845                   cache.</para>
8846               </listitem>
8847               <listitem>
8848                 <para>If you would rather, you can upload your CSS to another server and enter the
8849                   full URL pointing to it's location remember to begin the URL with http://</para>
8850               </listitem>
8851             </itemizedlist>
8852             <note>
8853               <para>Leave this field blank to disable it</para>
8854             </note>
8855             <para>
8856               <note>
8857                 <para>This file will add a linked CSS, not replace the existing default CSS.</para>
8858               </note>
8859             </para>
8860           </section>
8861
8862           <section id="opaccredits">
8863             <title>opaccredits</title>
8864
8865             <para>Asks: Include the following HTML in the footer of all pages
8866             in the OPAC:</para>
8867
8868             <note>
8869               <para>Click the 'Click to edit; link to enter HTML to appear at
8870               the bottom of every page in the OPAC</para>
8871             </note>
8872
8873             <screenshot>
8874               <screeninfo>HTML version of a footer for your OPAC</screeninfo>
8875
8876               <mediaobject>
8877                 <imageobject>
8878                   <imagedata fileref="images/admin/globalprefs/opaccredits-html.png"/>
8879                 </imageobject>
8880               </mediaobject>
8881             </screenshot>
8882
8883             <screenshot>
8884               <screeninfo>A sample of what can appear in your OPAC
8885               credits/footer</screeninfo>
8886
8887               <mediaobject>
8888                 <imageobject>
8889                   <imagedata fileref="images/admin/globalprefs/opaccredits.png"/>
8890                 </imageobject>
8891               </mediaobject>
8892             </screenshot>
8893
8894             <para>Description:</para>
8895
8896             <itemizedlist>
8897               <listitem>
8898                 <para>This setting is for credits that will appear at the
8899                 bottom of your OPAC pages. Credits traditionally encompass
8900                 copyright information, last date updated, hyperlinks or other
8901                 information represented in an HTML format. This is static
8902                 information and any updates must be entered manually.</para>
8903               </listitem>
8904             </itemizedlist>
8905
8906             <para>Learn more in the <link linkend="editableopac">OPAC Editable
8907             Regions</link> section.</para>
8908           </section>
8909           <section id="OpacCustomSearch">
8910             <title>OpacCustomSearch</title>
8911             <para>Asks: Replace the search box at the top of OPAC pages with the following
8912               HTML</para>
8913             <para>Description:<itemizedlist>
8914                 <listitem>
8915                   <para>This preference allows you to replace the default search box at the top of
8916                     the OPAC : <screenshot>
8917                       <screeninfo>Default search box</screeninfo>
8918                       <mediaobject>
8919                         <imageobject>
8920                           <imagedata fileref="images/admin/globalprefs/OpacCustomSearch-default.png"
8921                           />
8922                         </imageobject>
8923                       </mediaobject>
8924                     </screenshot></para>
8925                   <para>with any HTML you would like :<screenshot>
8926                       <screeninfo>Edited search box area</screeninfo>
8927                       <mediaobject>
8928                         <imageobject>
8929                           <imagedata fileref="images/admin/globalprefs/OpacCustomSearch.png"/>
8930                         </imageobject>
8931                       </mediaobject>
8932                     </screenshot></para>
8933                 </listitem>
8934               </itemizedlist></para>
8935           </section>
8936
8937           <section id="OPACDisplay856uAsImage">
8938             <title>OPACDisplay856uAsImage</title>
8939
8940             <para>Default: Neither details or results page</para>
8941
8942             <para>Asks: Display the URI in the 856u field as an image on:
8943             ___</para>
8944
8945             <para>Values:</para>
8946
8947             <itemizedlist>
8948               <listitem>
8949                 <para>Both results and details pages</para>
8950
8951                 <itemizedlist>
8952                   <listitem>
8953                     <important>
8954                       <para>Not implemented yet</para>
8955                     </important>
8956                   </listitem>
8957                 </itemizedlist>
8958               </listitem>
8959
8960               <listitem>
8961                 <para>Detail page only</para>
8962
8963                 <itemizedlist>
8964                   <listitem>
8965                     <important>
8966                       <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
8967                         needs to have a value in it for this preference to work.</para>
8968                     </important>
8969                   </listitem>
8970                 </itemizedlist>
8971
8972                 <screenshot>
8973                   <screeninfo>Showing the 856u as an image</screeninfo>
8974
8975                   <mediaobject>
8976                     <imageobject>
8977                       <imagedata fileref="images/admin/globalprefs/OPACDisplay856uAsImage.png"/>
8978                     </imageobject>
8979                   </mediaobject>
8980                 </screenshot>
8981               </listitem>
8982
8983               <listitem>
8984                 <para>Neither details or results page</para>
8985               </listitem>
8986
8987               <listitem>
8988                 <para>Results page only</para>
8989
8990                 <itemizedlist>
8991                   <listitem>
8992                     <important>
8993                       <para>Not yet implemented</para>
8994                     </important>
8995                   </listitem>
8996                 </itemizedlist>
8997               </listitem>
8998             </itemizedlist>
8999
9000             <para>Description:</para>
9001
9002             <itemizedlist>
9003               <listitem>
9004                 <para>In addition to this option being set, the corresponding
9005                 XSLT option must be turned on. Also, the corresponding 856q
9006                 field must have a valid MIME image extension (e.g., "jpg") or
9007                 MIME image type (i.e. starting with "image/"), or the generic
9008                 indicator "img" entered in the field. When all of the
9009                 requirements are met, an image file will be displayed instead
9010                 of the standard link text. Clicking on the image will open it
9011                 in the same way as clicking on the link text. When you click
9012                 on the image it should open to full size, in the current
9013                 window or in a new window depending on the value in the system
9014                 pref <link linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
9015
9016                 <screenshot>
9017                   <screeninfo>Sample 856 in MARC Record</screeninfo>
9018
9019                   <mediaobject>
9020                     <imageobject>
9021                       <imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
9022                     </imageobject>
9023                   </mediaobject>
9024                 </screenshot>
9025               </listitem>
9026             </itemizedlist>
9027           </section>
9028
9029           <section id="OpacExportOptions">
9030             <title>OpacExportOptions</title>
9031
9032             <para>Default:
9033             bibtex|dc|marcxml|marc8|utf8|marcstd|mods|ris</para>
9034
9035             <para>Asks: List export options that should be available from OPAC
9036             detail page separated by |: ___</para>
9037
9038             <para>Description:</para>
9039
9040             <itemizedlist>
9041               <listitem>
9042                 <para>In the OPAC on the right of each bib record there is a
9043                 menu that allows for saving the record in various formats.
9044                 This patch will allow you to define which options are in the
9045                 pull down menu. Available options are: BIBTEX (bibtex), Dublin
9046                 Core (dc), MARCXML (marcxml), MARC-8 encoded MARC (marc8),
9047                 Unicode/UTF-8 encoded MARC (utf8), Unicode/UTF-8 encoded MARC
9048                 without local use -9xx, x9x, xx9- fields and subfields
9049                 (marcstd), MODS (mods), and RIS (ris).</para>
9050               </listitem>
9051             </itemizedlist>
9052           </section>
9053           <section id="OPACFallback">
9054             <title>OPACFallback</title>
9055             <para>Default: bootstrap</para>
9056             <para>Asks: Use the ___ theme as the fallback theme on the OPAC. </para>
9057             <para>Description:<itemizedlist>
9058                 <listitem>
9059                   <para>This preference has no use right now, as Koha has only one theme, but if
9060                     your library has a custom theme it will show here as an option.  The purpose of
9061                     this preference is to provide a way to choose to what theme to fallback on when
9062                     you have a partial theme in place.</para>
9063                 </listitem>
9064               </itemizedlist></para>
9065           </section>
9066
9067           <section id="OpacFavicon">
9068             <title>OpacFavicon</title>
9069
9070             <para>Asks: Use the image at ___ for the OPAC's favicon.
9071             <important>
9072                 <para>This should be a complete URL, starting with
9073                 http://</para>
9074               </important></para>
9075
9076             <note>
9077               <para>Turn your logo into a favicon with the <ulink url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
9078             </note>
9079
9080             <para>Description:</para>
9081
9082             <itemizedlist>
9083               <listitem>
9084                 <para>The favicon is the little icon that appears next to the
9085                 URL in the address bar in most browsers. The default value for
9086                 this field (if left blank) is the small 'K' in the Koha
9087                 logo.</para>
9088
9089                 <screenshot>
9090                   <screeninfo>Default Koha Favicon</screeninfo>
9091
9092                   <mediaobject>
9093                     <imageobject>
9094                       <imagedata fileref="images/admin/globalprefs/favicon.png"/>
9095                     </imageobject>
9096                   </mediaobject>
9097                 </screenshot>
9098               </listitem>
9099             </itemizedlist>
9100           </section>
9101
9102           <section id="opacheader">
9103             <title>opacheader</title>
9104
9105             <para>Asks: Include the following HTML in the header of all pages
9106             in the OPAC</para>
9107
9108             <screenshot>
9109               <screeninfo>Sample HTML to be displayed at the top of my
9110               OPAC</screeninfo>
9111
9112               <mediaobject>
9113                 <imageobject>
9114                   <imagedata fileref="images/admin/globalprefs/opacheader-html.png"/>
9115                 </imageobject>
9116               </mediaobject>
9117             </screenshot>
9118
9119             <note>
9120               <para>This value will appear above the main content of your
9121               page</para>
9122             </note>
9123
9124             <screenshot>
9125               <screeninfo>OPAC display of the value from
9126               'opacheader'</screeninfo>
9127
9128               <mediaobject>
9129                 <imageobject>
9130                   <imagedata fileref="images/admin/globalprefs/opacheader.png"/>
9131                 </imageobject>
9132               </mediaobject>
9133             </screenshot>
9134
9135             <note>
9136               <para>Edit '<link linkend="LibraryName">LibraryName</link>' if
9137               you'd like to edit the contents of the &lt;title&gt; tag</para>
9138             </note>
9139
9140             <para>Learn more in the <link linkend="editableopac">OPAC Editable
9141             Regions</link> section.</para>
9142           </section>
9143
9144           <section id="OpacHighlightedWords">
9145             <title>OpacHighlightedWords &amp; NotHighlightedWords</title>
9146
9147             <para>OpacHighlightedWords Default: Don't highlight</para>
9148             <para>NotHighlightedWords Default: and|or|not</para>
9149
9150             <para>Asks: ___ words the patron searched for in their search results and detail pages;
9151               To prevent certain words from ever being highlighted, enter a list of stopwords here
9152               ___ (separate columns with |) </para>
9153
9154             <para>OpacHighlightedWords Values:</para>
9155
9156             <itemizedlist>
9157               <listitem>
9158                 <para>Don't highlight</para>
9159               </listitem>
9160
9161               <listitem>
9162                 <para>Highlight</para>
9163               </listitem>
9164             </itemizedlist>
9165           </section>
9166
9167           <section id="OpacKohaUrl">
9168             <title>OpacKohaUrl</title>
9169
9170             <para>Default: Don't show</para>
9171
9172             <para>Values:</para>
9173
9174             <itemizedlist>
9175               <listitem>
9176                 <para>Don't show</para>
9177               </listitem>
9178
9179               <listitem>
9180                 <para>Show</para>
9181               </listitem>
9182             </itemizedlist>
9183
9184             <para>Description:</para>
9185
9186             <itemizedlist>
9187               <listitem>
9188                 <para>When this preference is set to 'Show' text will appear
9189                 in the bottom right of the OPAC footer stating 'Powered by
9190                 Koha' and linking to the official Koha website.</para>
9191
9192                 <screenshot>
9193                   <screeninfo>Powered by Koha</screeninfo>
9194
9195                   <mediaobject>
9196                     <imageobject>
9197                       <imagedata fileref="images/admin/globalprefs/OpacKohaUrl.png"/>
9198                     </imageobject>
9199                   </mediaobject>
9200                 </screenshot>
9201               </listitem>
9202             </itemizedlist>
9203           </section>
9204
9205           <section id="opaclayoutstylesheet">
9206             <title>opaclayoutstylesheet</title>
9207
9208             <para>Default: opac.css</para>
9209
9210             <para>Asks: Use the CSS stylesheet /css/ ___ on all pages in the
9211             OPAC, instead of the default</para>
9212
9213             <para>Description:</para>
9214
9215             <itemizedlist>
9216               <listitem>
9217                 <para>This setting's function is to point to the *.css file
9218                 used to define the OPAC layout. A *.css file is a cascading
9219                 stylesheet which is used in conjunction with HTML to set how
9220                 the HTML page is formatted and will look on the OPAC. There
9221                 are two stylesheets that come with the system; opac.css and
9222                 opac2.css. A custom stylesheet may also be used. The
9223                 stylesheets listed in the opaclayoutstylesheet preference are
9224                 held on the Koha server.</para>
9225               </listitem>
9226             </itemizedlist>
9227
9228             <note>
9229               <para>Leave this field blank to disable it and let Koha use the
9230               default file instead</para>
9231             </note>
9232             <important>
9233               <para>Using a custom value in this preference causes Koha to completely ignore the
9234                 default layout stylesheet.</para>
9235             </important>
9236           </section>
9237           <section id="OpacLocationBranchToDisplay">
9238             <title>OpacLocationBranchToDisplay</title>
9239             <para>Default: holding library</para>
9240             <para>Asks: Display the ___ for items on the OPAC record details page. </para>
9241             <para>Values:<itemizedlist>
9242                 <listitem>
9243                   <para>holding library</para>
9244                 </listitem>
9245                 <listitem>
9246                   <para>home and holding library</para>
9247                 </listitem>
9248                 <listitem>
9249                   <para>home library</para>
9250                 </listitem>
9251               </itemizedlist></para>
9252             <para>Description:<itemizedlist>
9253                 <listitem>
9254                   <para>Defines whether to display the holding library, the home library, or both
9255                     for the opac details page.</para>
9256                 </listitem>
9257               </itemizedlist></para>
9258           </section>
9259           <section id="OpacLocationBranchToDisplayShelving">
9260             <title>OpacLocationBranchToDisplayShelving</title>
9261             <para>Default: holding library</para>
9262             <para>Asks: Display the shelving location under the ___ for items on the OPAC record
9263               details page. </para>
9264             <para>Values:</para>
9265             <itemizedlist>
9266               <listitem>
9267                 <para>holding library</para>
9268               </listitem>
9269               <listitem>
9270                 <para>home and holding library</para>
9271               </listitem>
9272               <listitem>
9273                 <para>home library</para>
9274               </listitem>
9275             </itemizedlist>
9276             <para>Description:<itemizedlist>
9277                 <listitem>
9278                   <para>Defines where the shelving location should be displayed, under the home
9279                     library, the holding library, or both.</para>
9280                 </listitem>
9281               </itemizedlist></para>
9282           </section>
9283
9284           <section id="OpacMaintenance">
9285             <title>OpacMaintenance</title>
9286
9287             <para>Default: Don't show</para>
9288
9289             <para>Asks: ___ a warning that the OPAC is under maintenance,
9290             instead of the OPAC itself. <note>
9291                 <para>this shows the same warning as when the database needs
9292                 to be upgraded, but unconditionally.</para>
9293               </note></para>
9294
9295             <para>Description:</para>
9296
9297             <itemizedlist>
9298               <listitem>
9299                 <para>This preference allows the system administrator to turn
9300                 off the OPAC during maintenance and display a message to
9301                 users. When this preference is switched to "Show" the OPAC is
9302                 not usable. The text of this message is not editable at this
9303                 time.</para>
9304               </listitem>
9305             </itemizedlist>
9306
9307             <para>Values:</para>
9308
9309             <itemizedlist>
9310               <listitem>
9311                 <para>Don't show</para>
9312               </listitem>
9313
9314               <listitem>
9315                 <para>Show</para>
9316
9317                 <itemizedlist>
9318                   <listitem>
9319                     <para>When this preference is set to show the maintenance
9320                     message the ability to search the OPAC is disabled and a
9321                     message appears</para>
9322
9323                     <screenshot>
9324                       <screeninfo>OPAC Maintenance Message</screeninfo>
9325
9326                       <mediaobject>
9327                         <imageobject>
9328                           <imagedata fileref="images/admin/globalprefs/opacmaintenance.png"/>
9329                         </imageobject>
9330                       </mediaobject>
9331                     </screenshot>
9332                   </listitem>
9333                 </itemizedlist>
9334               </listitem>
9335             </itemizedlist>
9336           </section>
9337
9338           <section id="OpacMainUserBlock">
9339             <title>OpacMainUserBlock</title>
9340
9341             <para>Default: Welcome to Koha... &lt;hr&gt;</para>
9342
9343             <para>Asks: Show the following HTML in its own column on the main
9344             page of the OPAC</para>
9345
9346             <para>Description: </para>
9347             <itemizedlist>
9348               <listitem>
9349                 <para>HTML entered in this field will appear in the center of the main page of your
9350                   OPAC</para>
9351               </listitem>
9352             </itemizedlist>
9353
9354             <screenshot>
9355               <screeninfo>Sample OpacMainUserBlock appears below the search
9356               bar</screeninfo>
9357
9358               <mediaobject>
9359                 <imageobject>
9360                   <imagedata fileref="images/admin/globalprefs/OpacMainUserBlock.png"/>
9361                 </imageobject>
9362               </mediaobject>
9363             </screenshot>
9364
9365             <para>Learn more in the <link linkend="editableopac">OPAC Editable
9366             Regions</link> section.</para>
9367           </section>
9368           <section id="OpacMaxItemsToDisplay">
9369             <title>OpacMaxItemsToDisplay</title>
9370             <para>Default: 50</para>
9371             <para>Asks: Display up to ___ items on the biblio detail page  </para>
9372             <para>Description:<itemizedlist>
9373                 <listitem>
9374                   <para>This preference will help with slow load times on the bibliographic detail
9375                     pages by limiting the number of items to display by default. If the biblio has
9376                     more items than this, a link is displayed instead that allows the user to choose
9377                     to display all items.</para>
9378                 </listitem>
9379               </itemizedlist></para>
9380           </section>
9381
9382           <section id="OPACMySummaryHTML">
9383             <title>OPACMySummaryHTML</title>
9384
9385             <para>Asks: Include a "Links" column on the "my summary" tab when
9386             a user is logged in to the OPAC, with the following HTML (leave
9387             blank to disable).</para>
9388
9389             <para>Description:</para>
9390
9391             <itemizedlist>
9392               <listitem>
9393                 <para>In this preference you can enter HTML that will appear
9394                 on the 'Checked Out' tab on the 'My Summary' section when
9395                 logged in to the OPAC. The placeholders {BIBLIONUMBER},
9396                 {TITLE}, {ISBN} and {AUTHOR} will be replaced with information
9397                 from the displayed record. This can be used to enter in
9398                 'share' links for social networks or generate searches against
9399                 other library catalogs.</para>
9400
9401                 <screenshot>
9402                   <screeninfo>Example of 'Links' column with a value in the
9403                   OPACMySummaryHTML preference</screeninfo>
9404
9405                   <mediaobject>
9406                     <imageobject>
9407                       <imagedata fileref="images/admin/globalprefs/OPACMySummaryHTML.png"/>
9408                     </imageobject>
9409                   </mediaobject>
9410                 </screenshot>
9411               </listitem>
9412             </itemizedlist>
9413
9414             <para>Sample Data:<programlisting>&lt;p&gt;&lt;a href="http://www.facebook.com/sharer.php?u=http://YOUROPAC.ORG/cgi-bin/koha/opac-detail.pl?biblionumber={BIBLIONUMBER}"&gt;Share on Facebook&lt;/a&gt;
9415 &lt;br /&gt;TITLE: {TITLE}
9416 &lt;br /&gt;AUTHOR: {AUTHOR}
9417 &lt;br /&gt;ISBN: {ISBN}
9418 &lt;br /&gt;BIBLIONUMBER: {BIBLIONUMBER}&lt;/p&gt;</programlisting></para>
9419           </section>
9420           <section id="OPACMySummaryNote">
9421             <title>OPACMySummaryNote</title>
9422             <para>Asks: Note to display on the patron summary page. </para>
9423             <para>Description:<itemizedlist>
9424                 <listitem>
9425                   <para>This preference will display text above the patron's summary and below the
9426                     welcome message when the patron logs in to the OPAC and view their 'my summary' tab.<screenshot>
9427                       <screeninfo>OPACMySummaryNote in the OPAC</screeninfo>
9428                       <mediaobject>
9429                         <imageobject>
9430                           <imagedata fileref="images/admin/globalprefs/OPACMySummaryNote.png"/>
9431                         </imageobject>
9432                       </mediaobject>
9433                     </screenshot></para>
9434                 </listitem>
9435               </itemizedlist></para>
9436           </section>
9437
9438           <section id="OpacNav">
9439             <title>OpacNav</title>
9440
9441             <para>Default: Important links here.</para>
9442
9443             <para>Asks: Show the following HTML on the left hand column of the
9444             main page and patron account on the OPAC (generally navigation
9445             links)</para>
9446
9447             <screenshot>
9448               <screeninfo>Sample navigation links</screeninfo>
9449
9450               <mediaobject>
9451                 <imageobject>
9452                   <imagedata fileref="images/admin/globalprefs/OpacNav.png"/>
9453                 </imageobject>
9454               </mediaobject>
9455             </screenshot>
9456
9457             <para>Learn more in the <link linkend="editableopac">OPAC Editable
9458             Regions</link> section.</para>
9459           </section>
9460
9461           <section id="OpacNavBottom">
9462             <title>OpacNavBottom</title>
9463
9464             <para>Asks: Show the following HTML on the left hand column of the
9465             main page and patron account on the OPAC, after <link linkend="OpacNav">OpacNav</link>, and before patron account links
9466             if available:</para>
9467
9468             <para>Description: When a patron is logged in to their account
9469             they see a series of tabs to access their account information.
9470             <link linkend="OpacNav">OpacNav</link> appears above this list of
9471             tabs and OpacNavBottom will appear below them. When not on the
9472             patron account pages the HTML in OpacNavBottom will just appear
9473             right below <link linkend="OpacNav">OpacNav</link>.</para>
9474
9475             <screenshot>
9476               <screeninfo>OpacNav and OpacNavBottom on Patron
9477               Account</screeninfo>
9478
9479               <mediaobject>
9480                 <imageobject>
9481                   <imagedata fileref="images/admin/globalprefs/OpacNavBottom.png"/>
9482                 </imageobject>
9483               </mediaobject>
9484             </screenshot>
9485           </section>
9486
9487           <section id="OpacNavRight">
9488             <title>OpacNavRight</title>
9489
9490             <para>Asks: Show the following HTML in the right hand column of
9491             the main page under the main login form.</para>
9492
9493             <para>Description: HTML entered in this preference will appear on
9494             the right hand side of the OPAC under the log in form. If the log
9495             in form is not visible this content will move up on the right
9496             column.</para>
9497
9498             <screenshot>
9499               <screeninfo>OpacNavRight</screeninfo>
9500
9501               <mediaobject>
9502                 <imageobject>
9503                   <imagedata fileref="images/admin/globalprefs/OpacNavRight.png"/>
9504                 </imageobject>
9505               </mediaobject>
9506             </screenshot>
9507           </section>
9508
9509           <section id="OPACNoResultsFound">
9510             <title>OPACNoResultsFound</title>
9511
9512             <para>No Default</para>
9513
9514             <para>Asks: Display this HTML when no results are found for a
9515             search in the OPAC</para>
9516
9517             <para>This HTML will display below the existing notice that no
9518             results were found for your search.</para>
9519
9520             <screenshot>
9521               <screeninfo>HTML in OPACNoResultsFound will appear below lines
9522               that look like this</screeninfo>
9523
9524               <mediaobject>
9525                 <imageobject>
9526                   <imagedata fileref="images/admin/globalprefs/OPACNoResultsFound.png"/>
9527                 </imageobject>
9528               </mediaobject>
9529             </screenshot>
9530             <note>
9531               <para>You can insert placeholders {QUERY_KW} that will be replaced with the keywords
9532                 of the query. </para>
9533             </note>
9534           </section>
9535
9536           <section id="OpacPublic">
9537             <title>OpacPublic</title>
9538
9539             <para>Default: Enable</para>
9540
9541             <para>Asks: ___ Koha OPAC as public. Private OPAC requires
9542             authentication before accessing the OPAC.</para>
9543
9544             <para>Values:</para>
9545
9546             <itemizedlist>
9547               <listitem>
9548                 <para>Don't enable</para>
9549               </listitem>
9550
9551               <listitem>
9552                 <para>Enable</para>
9553               </listitem>
9554             </itemizedlist>
9555
9556             <para>Description:</para>
9557
9558             <itemizedlist>
9559               <listitem>
9560                 <para>This preference determines if your OPAC is accessible
9561                 and searchable by anyone or only by members of the library. If
9562                 set to 'Don't enable' only members who are logged into the
9563                 OPAC can search. Most libraries will leave this setting at its
9564                 default of 'Enable' to allow their OPAC to be searched by
9565                 anyone and only require login for access to personalized
9566                 content.</para>
9567               </listitem>
9568             </itemizedlist>
9569           </section>
9570
9571           <section id="OPACResultsSidebar">
9572             <title>OPACResultsSidebar</title>
9573
9574             <para>Asks: Include the following HTML under the facets in OPAC
9575             search results</para>
9576
9577             <para>Description:</para>
9578
9579             <itemizedlist>
9580               <listitem>
9581                 <para>The HTML entered in this preference will appear on the
9582                 search results pages below the list of facets on the left side
9583                 of the screen.</para>
9584               </listitem>
9585             </itemizedlist>
9586           </section>
9587
9588           <section id="OPACSearchForTitleIn">
9589             <title>OPACSearchForTitleIn</title>
9590
9591             <para>Default: &lt;li&gt;&lt;a
9592             href="http://worldcat.org/search?q={TITLE}"
9593             target="_blank"&gt;Other Libraries (WorldCat)&lt;/a&gt;&lt;/li&gt;
9594             &lt;li&gt;&lt;a
9595             href="http://www.scholar.google.com/scholar?q={TITLE}"
9596             target="_blank"&gt;Other Databases (Google
9597             Scholar)&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a
9598             href="http://www.bookfinder.com/search/?author={AUTHOR}&amp;title={TITLE}&amp;st=xl&amp;ac=qr"
9599             target="_blank"&gt;Online Stores
9600             (Bookfinder.com)&lt;/a&gt;&lt;/li&gt;</para>
9601
9602             <para>Asks: Include a "More Searches" box on the detail pages of
9603             items on the OPAC, with the following HTML (leave blank to
9604             disable)</para>
9605
9606             <note>
9607               <para>The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE},
9608               {ISBN}, {ISSN} and {AUTHOR} will be replaced with information
9609               from the displayed record.</para>
9610             </note>
9611           </section>
9612           <section id="OpacSeparateHoldings">
9613             <title>OpacSeparateHoldings &amp; OpacSeparateHoldingsBranch </title>
9614             <para>OpacSeparateHoldings default: Don't separate</para>
9615             <para>OpacSeparateHoldingsBranch default: home library </para>
9616             <para>Asks: ___ items display into two tabs, where the first tab contains items whose
9617               ___ is the logged in user's library. The second tab will contain all other items. </para>
9618             <para>OpacSeparateHoldings values:<itemizedlist>
9619                 <listitem>
9620                   <para>Don't separate</para>
9621                 </listitem>
9622                 <listitem>
9623                   <para>Separate</para>
9624                 </listitem>
9625               </itemizedlist></para>
9626             <para>OpacSeparateHoldingsBranch values:<itemizedlist>
9627                 <listitem>
9628                   <para>holding library</para>
9629                 </listitem>
9630                 <listitem>
9631                   <para>home library</para>
9632                 </listitem>
9633               </itemizedlist></para>
9634             <para>Description:<itemizedlist>
9635                 <listitem>
9636                   <para>This preference lets you decide if you would like to have the holding
9637                     information on the bibliographic detail page in the OPAC split in to multiple
9638                     tabs. The default is to show all holdings on one tab.</para>
9639                   <screenshot>
9640                       <screeninfo>Separate holdings tabs</screeninfo>
9641                       <mediaobject>
9642                         <imageobject>
9643                           <imagedata fileref="images/admin/globalprefs/OpacSeparateHoldings.png"/>
9644                         </imageobject>
9645                       </mediaobject>
9646                     </screenshot>
9647                 </listitem>
9648               </itemizedlist></para>
9649           </section>
9650
9651           <section id="OPACShowBarcode">
9652             <title>OPACShowBarcode</title>
9653
9654             <para>Default: Don't show</para>
9655
9656             <para>Asks: ___ the item's barcode on the holdings tab.</para>
9657
9658             <para>Values:</para>
9659
9660             <itemizedlist>
9661               <listitem>
9662                 <para>Don't show</para>
9663
9664                 <screenshot>
9665                   <screeninfo>Barcode not shown in the OPAC</screeninfo>
9666
9667                   <mediaobject>
9668                     <imageobject>
9669                       <imagedata fileref="images/admin/globalprefs/OPACShowBarcode-noshow.png"/>
9670                     </imageobject>
9671                   </mediaobject>
9672                 </screenshot>
9673               </listitem>
9674
9675               <listitem>
9676                 <para>Show</para>
9677
9678                 <screenshot>
9679                   <screeninfo>Barcode shown in the OPAC</screeninfo>
9680
9681                   <mediaobject>
9682                     <imageobject>
9683                       <imagedata fileref="images/admin/globalprefs/OPACShowBarcode-show.png"/>
9684                     </imageobject>
9685                   </mediaobject>
9686                 </screenshot>
9687               </listitem>
9688             </itemizedlist>
9689
9690             <para>Description:</para>
9691
9692             <itemizedlist>
9693               <listitem>
9694                 <para>This preference allows you to control whether patrons
9695                 can see items' barcodes in the OPAC.</para>
9696               </listitem>
9697             </itemizedlist>
9698           </section>
9699
9700           <section id="OPACShowCheckoutName">
9701             <title>OPACShowCheckoutName</title>
9702
9703             <para>Default: Don't show</para>
9704
9705             <para>Asks: ___ the name of the patron that has an item checked
9706             out on item detail pages on the OPAC.</para>
9707
9708             <para>Values:</para>
9709
9710             <itemizedlist>
9711               <listitem>
9712                 <para>Don't show</para>
9713               </listitem>
9714
9715               <listitem>
9716                 <para>Show</para>
9717               </listitem>
9718             </itemizedlist>
9719
9720             <para>Description:</para>
9721
9722             <itemizedlist>
9723               <listitem>
9724                 <para>This preference allows all patrons to see who has the
9725                 item checked out if it is checked out. In small corporate
9726                 libraries (where the OPAC is behind a firewall and not
9727                 publicly available) this can be helpful so coworkers can just
9728                 contact the patron with the book themselves. In larger public
9729                 and academic libraries setting this to 'Show' would pose
9730                 serious privacy issues.</para>
9731               </listitem>
9732             </itemizedlist>
9733           </section>
9734
9735           <section id="OPACShowHoldQueueDetails">
9736             <title>OPACShowHoldQueueDetails</title>
9737
9738             <para>Default: Don't show any hold details</para>
9739
9740             <para>Asks: ___ to patrons in the OPAC.</para>
9741
9742             <para>Values:</para>
9743
9744             <itemizedlist>
9745               <listitem>
9746                 <para>Don't show any hold details</para>
9747               </listitem>
9748
9749               <listitem>
9750                 <para>Show holds</para>
9751
9752                 <screenshot>
9753                   <screeninfo>The holdings table on the bibliographic record
9754                   will show the number of holds</screeninfo>
9755
9756                   <mediaobject>
9757                     <imageobject>
9758                       <imagedata fileref="images/admin/globalprefs/OPACShowHoldQueueDetails-showholds.png"/>
9759                     </imageobject>
9760                   </mediaobject>
9761                 </screenshot>
9762               </listitem>
9763
9764               <listitem>
9765                 <para>Show holds and priority level</para>
9766               </listitem>
9767
9768               <listitem>
9769                 <para>Show priority level</para>
9770
9771                 <screenshot>
9772                   <screeninfo>Patron record in the OPAC shows where in line
9773                   the patron waits for their hold.</screeninfo>
9774
9775                   <mediaobject>
9776                     <imageobject>
9777                       <imagedata fileref="images/admin/globalprefs/OPACShowHoldQueueDetails-priority.png"/>
9778                     </imageobject>
9779                   </mediaobject>
9780                 </screenshot>
9781
9782                 <itemizedlist>
9783                   <listitem>
9784                     <para><link linkend="opacuserlogin">opacuserlogin</link>
9785                     needs to be set to 'allow'</para>
9786                   </listitem>
9787                 </itemizedlist>
9788               </listitem>
9789             </itemizedlist>
9790           </section>
9791
9792           <section id="OpacShowRecentComments">
9793             <title>OpacShowRecentComments</title>
9794
9795             <para>Default: Don't show</para>
9796
9797             <para>Asks: ___ a link to recent comments in the OPAC
9798             masthead.</para>
9799
9800             <para>Values:</para>
9801
9802             <itemizedlist>
9803               <listitem>
9804                 <para>Don't show</para>
9805               </listitem>
9806
9807               <listitem>
9808                 <para>Show</para>
9809               </listitem>
9810             </itemizedlist>
9811
9812             <para>Description:</para>
9813
9814             <itemizedlist>
9815               <listitem>
9816                 <para>If you have chosen to allow comments in your OPAC by
9817                 setting <link linkend="reviewson">reviewson</link> to 'Allow'
9818                 you can include a link to the recent comments under the search
9819                 box at the top of your OPAC with this preference.</para>
9820
9821                 <screenshot>
9822                   <screeninfo>Recent Comments link on OPAC</screeninfo>
9823
9824                   <mediaobject>
9825                     <imageobject>
9826                       <imagedata fileref="images/admin/globalprefs/OpacShowRecentComments.png"/>
9827                     </imageobject>
9828                   </mediaobject>
9829                 </screenshot>
9830               </listitem>
9831             </itemizedlist>
9832           </section>
9833
9834           <section id="OPACShowUnusedAuthorities">
9835             <title>OPACShowUnusedAuthorities</title>
9836
9837             <para>Default: Show</para>
9838
9839             <para>Asks: ___ unused authorities in the OPAC authority
9840             browser.</para>
9841
9842             <para>Values:</para>
9843
9844             <itemizedlist>
9845               <listitem>
9846                 <para>Do not show</para>
9847               </listitem>
9848
9849               <listitem>
9850                 <para>Show</para>
9851
9852                 <itemizedlist>
9853                   <listitem>
9854                     <important>
9855                       <para>Requires that the <link linkend="OpacAuthorities">OpacAuthorities</link>
9856                       preference is set to 'Allow'</para>
9857                     </important>
9858                   </listitem>
9859                 </itemizedlist>
9860               </listitem>
9861             </itemizedlist>
9862
9863             <para>Description:</para>
9864
9865             <itemizedlist>
9866               <listitem>
9867                 <para>When patrons search your authority file via the OPAC
9868                 they will see all authorities in your system even if you don't
9869                 have them linked to any bibliographic records. This preference
9870                 lets you determine what the default behavior is when searching
9871                 authorities via the OPAC. If you choose 'Do not show' it will
9872                 only show patrons authority records that are linked to bib
9873                 records in the search results. Otherwise the system will show
9874                 all authority records even if they aren't linked to
9875                 records.</para>
9876               </listitem>
9877             </itemizedlist>
9878           </section>
9879
9880           <section id="OpacStarRatings">
9881             <title>OpacStarRatings</title>
9882
9883             <para>Default: no</para>
9884
9885             <para>Asks: Show star-ratings on ___ pages.</para>
9886
9887             <para>Values:</para>
9888
9889             <itemizedlist>
9890               <listitem>
9891                 <para>no</para>
9892               </listitem>
9893
9894               <listitem>
9895                 <para>only details</para>
9896
9897                 <screenshot>
9898                   <screeninfo>Star Ratings on the Details Page</screeninfo>
9899
9900                   <mediaobject>
9901                     <imageobject>
9902                       <imagedata fileref="images/admin/globalprefs/OpacStarRatings-details.png"/>
9903                     </imageobject>
9904                   </mediaobject>
9905                 </screenshot>
9906               </listitem>
9907
9908               <listitem>
9909                 <para>results and details</para>
9910
9911                 <screenshot>
9912                   <screeninfo>OPAC Star Ratings on the Search
9913                   Results</screeninfo>
9914
9915                   <mediaobject>
9916                     <imageobject>
9917                       <imagedata fileref="images/admin/globalprefs/OpacStarRatings-results.png"/>
9918                     </imageobject>
9919                   </mediaobject>
9920                 </screenshot>
9921               </listitem>
9922             </itemizedlist>
9923
9924             <para>Description:</para>
9925
9926             <itemizedlist>
9927               <listitem>
9928                 <para>Star ratings are a way for your patrons to leave ratings
9929                 without having to leave a full review. Patrons who are not
9930                 logged in will only be able to see the stars, once logged in
9931                 patrons can click on the stars on the details page to leave
9932                 their own rating. Clicking on the stars on the search results
9933                 will not submit a rating.</para>
9934               </listitem>
9935             </itemizedlist>
9936           </section>
9937           <section id="OpacSuggestionManagedBy">
9938             <title>OpacSuggestionManagedBy</title>
9939             <para>Default: Show</para>
9940             <para>Asks: ___  the name of the staff member who managed a suggestion in OPAC. </para>
9941             <para>Values:<itemizedlist>
9942                 <listitem>
9943                   <para>Don't show</para>
9944                 </listitem>
9945                 <listitem>
9946                   <para>Show</para>
9947                 </listitem>
9948               </itemizedlist></para>
9949             <para>Description:<itemizedlist>
9950                 <listitem>
9951                   <para>If you're <link linkend="suggestionspref">allowing patrons to make purchase
9952                       suggestions</link> then they will see the 'my suggestions' tab when logged in.
9953                     This tab shows the patron the librarian who approved or rejected the purchase
9954                     suggestion. This preference controls if the patron sees the librarian's name or
9955                     not.</para>
9956                 </listitem>
9957               </itemizedlist></para>
9958           </section>
9959
9960           <section id="opacthemes">
9961             <title>opacthemes</title>
9962
9963             <para>Default: bootstrap</para>
9964
9965             <para>Asks: Use the ___ theme on the OPAC.</para>
9966
9967             <para>Values:</para>
9968
9969             <itemizedlist>
9970               <listitem>
9971                 <para>bootstrap</para>
9972                 <para>
9973                   <screenshot>
9974                     <screeninfo>Bootstrap Theme</screeninfo>
9975                     <mediaobject>
9976                       <imageobject>
9977                         <imagedata fileref="images/admin/globalprefs/opacthemes-bootstrap.png"/>
9978                       </imageobject>
9979                     </mediaobject>
9980                   </screenshot>
9981                 </para>
9982                 <para>This theme is completely responsive</para>
9983               </listitem>
9984             </itemizedlist>
9985           </section>
9986
9987           <section id="OPACURLOpenInNewWindow">
9988             <title>OPACURLOpenInNewWindow</title>
9989
9990             <para>Default: don't</para>
9991
9992             <para>Asks: When patrons click on a link to another website from
9993             your OPAC (like Amazon or OCLC), ___ open the website in a new
9994             window.</para>
9995
9996             <para>Values:</para>
9997
9998             <itemizedlist>
9999               <listitem>
10000                 <para>do</para>
10001               </listitem>
10002
10003               <listitem>
10004                 <para>don't</para>
10005               </listitem>
10006             </itemizedlist>
10007
10008             <para>Description:</para>
10009
10010             <itemizedlist>
10011               <listitem>
10012                 <para>This preference determines if URLs in the OPAC will open
10013                 in a new window or not. When clicking on a link in the OPAC, a
10014                 patron does not need to worry about navigating away from their
10015                 search results.</para>
10016               </listitem>
10017             </itemizedlist>
10018           </section>
10019
10020           <section id="OPACUserCSS">
10021             <title>OPACUserCSS</title>
10022
10023             <para>Asks: Include the following CSS on all pages in the
10024             OPAC</para>
10025
10026             <para>Description:</para>
10027
10028             <itemizedlist>
10029               <listitem>
10030                 <para>OPACUserCSS allows the administrator to enter styles that will overwrite the
10031                   OPAC's default CSS as defined in 'opaclayoutstylesheet' or 'opacstylesheet'.
10032                   Styles may be entered for any of the selectors found in the default style sheet.
10033                   The default stylesheet will likely be found at
10034                   http://your_koha_address/opac-tmpl/bootstrap/css/opac.css. Unlike <link
10035                     linkend="OpacAdditionalStylesheet">OpacAdditionalStylesheet</link> and <link
10036                     linkend="opaclayoutstylesheet">opaclayoutstylesheet</link> this preference will
10037                   embed the CSS directly on your OPAC pages.</para>
10038               </listitem>
10039             </itemizedlist>
10040           </section>
10041
10042           <section id="opacuserjs">
10043             <title>opacuserjs</title>
10044
10045             <para>Asks: Include the following JavaScript on all pages in the
10046             OPAC</para>
10047
10048             <screenshot>
10049               <screeninfo>OPAC login box before opacuserjs edit</screeninfo>
10050
10051               <mediaobject>
10052                 <imageobject>
10053                   <imagedata fileref="images/admin/globalprefs/opacuserjs-before.png"/>
10054                 </imageobject>
10055               </mediaobject>
10056             </screenshot>
10057
10058             <screenshot>
10059               <screeninfo>JavaScript in opacuserjs to change the OPAC login
10060               box</screeninfo>
10061
10062               <mediaobject>
10063                 <imageobject>
10064                   <imagedata fileref="images/admin/globalprefs/opacuserjs.png"/>
10065                 </imageobject>
10066               </mediaobject>
10067             </screenshot>
10068
10069             <screenshot>
10070               <screeninfo>New OPAC login box after editing
10071               opacuserjs</screeninfo>
10072
10073               <mediaobject>
10074                 <imageobject>
10075                   <imagedata fileref="images/admin/globalprefs/opacuserjs-after.png"/>
10076                 </imageobject>
10077               </mediaobject>
10078             </screenshot>
10079
10080             <para>Description:</para>
10081
10082             <itemizedlist>
10083               <listitem>
10084                 <para>This preference allows the administrator to enter
10085                 JavaScript or JQuery that will be embedded across all pages of
10086                 the OPAC. Administrators may use this preference to customize
10087                 some of the interactive sections of Koha, customizing the text
10088                 for the login prompts, for example. Sample JQuery scripts used
10089                 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>
10090               </listitem>
10091             </itemizedlist>
10092           </section>
10093
10094           <section id="OPACXSLTDetailsDisplay">
10095             <title>OPACXSLTDetailsDisplay</title>
10096
10097             <para>Default: default</para>
10098
10099             <para>Asks: Display OPAC details using XSLT stylesheet at
10100             ___</para>
10101
10102             <para>Values:</para>
10103
10104             <itemizedlist>
10105               <listitem>
10106                 <para>leave empty to not use the XSLT stylesheet</para>
10107
10108                 <itemizedlist>
10109                   <listitem>
10110                     <para>In previous versions of Koha this was the setting
10111                     that read 'normally'</para>
10112                   </listitem>
10113                 </itemizedlist>
10114               </listitem>
10115
10116               <listitem>
10117                 <para>enter "default" for the default one</para>
10118               </listitem>
10119
10120               <listitem>
10121                 <para>put a path to define a XSLT file</para>
10122
10123                 <itemizedlist>
10124                   <listitem>
10125                     <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
10126                   </listitem>
10127
10128                   <listitem>
10129                     <para>If in a multi-language system you can enter
10130                     {langcode} in the path to tell Koha to look in the right
10131                     language folder</para>
10132
10133                     <itemizedlist>
10134                       <listitem>
10135                         <para>ex:
10136                           /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACDetail.xsl</para>
10137                       </listitem>
10138
10139                       <listitem>
10140                         <para>ex.
10141                         http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
10142                       </listitem>
10143                     </itemizedlist>
10144                   </listitem>
10145                 </itemizedlist>
10146               </listitem>
10147
10148               <listitem>
10149                 <para>put an URL for an external specific stylesheet</para>
10150
10151                 <itemizedlist>
10152                   <listitem>
10153                     <para>ex: http://mykohaopac.org/stylesheet.xsl</para>
10154                   </listitem>
10155                 </itemizedlist>
10156               </listitem>
10157             </itemizedlist>
10158
10159             <para>Description:</para>
10160
10161             <itemizedlist>
10162               <listitem>
10163                 <para>XSLT stylesheets allow for the customization of the
10164                 details shows on the screen when viewing a bib record. This
10165                 preference will allow you either use the default look that
10166                 comes with Koha or design your own stylesheet.</para>
10167               </listitem>
10168             </itemizedlist>
10169           </section>
10170
10171           <section id="OPACXSLTResultsDisplay">
10172             <title>OPACXSLTResultsDisplay</title>
10173
10174             <para>Default: default</para>
10175
10176             <para>Asks: Display OPAC results using XSLT stylesheet at
10177             ___</para>
10178
10179             <para>Values:</para>
10180
10181             <itemizedlist>
10182               <listitem>
10183                 <para>leave empty to not use the XSLT stylesheet</para>
10184
10185                 <itemizedlist>
10186                   <listitem>
10187                     <para>In previous versions of Koha this was the setting
10188                     that read 'normally'</para>
10189                   </listitem>
10190                 </itemizedlist>
10191               </listitem>
10192
10193               <listitem>
10194                 <para>enter "default" for the default one</para>
10195               </listitem>
10196
10197               <listitem>
10198                 <para>put a path to define a XSLT file</para>
10199
10200                 <itemizedlist>
10201                   <listitem>
10202                     <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
10203                   </listitem>
10204
10205                   <listitem>
10206                     <para>If in a multi-language system you can enter
10207                     {langcode} in the path to tell Koha to look in the right
10208                     language folder</para>
10209
10210                     <itemizedlist>
10211                       <listitem>
10212                         <para>ex:
10213                           /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACResults.xsl</para>
10214                       </listitem>
10215
10216                       <listitem>
10217                         <para>ex.
10218                         http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
10219                       </listitem>
10220                     </itemizedlist>
10221                   </listitem>
10222                 </itemizedlist>
10223               </listitem>
10224
10225               <listitem>
10226                 <para>put an URL for an external specific stylesheet</para>
10227
10228                 <itemizedlist>
10229                   <listitem>
10230                     <para>ex: http://mykohaopac.org/stylesheet.xsl</para>
10231                   </listitem>
10232                 </itemizedlist>
10233               </listitem>
10234             </itemizedlist>
10235
10236             <para>Description:</para>
10237
10238             <itemizedlist>
10239               <listitem>
10240                 <para>XSLT stylesheets allow for the customization of the
10241                 details shows on the screen when viewing the search results.
10242                 This preference will allow you either use the default look
10243                 that comes with Koha or design your own stylesheet.</para>
10244               </listitem>
10245             </itemizedlist>
10246           </section>
10247         </section>
10248
10249         <section id="opacfeaturesprefs">
10250           <title>Features</title>
10251
10252           <para/>
10253
10254           <section id="numSearchRSSResults">
10255             <title>numSearchRSSResults</title>
10256
10257             <para>Default: 50</para>
10258
10259             <para>Asks: Display ___ search results in the RSS feed.</para>
10260
10261             <para>Description:</para>
10262
10263             <itemizedlist>
10264               <listitem>
10265                 <para>By default the RSS feed that is automatically generated
10266                 for every search results page will list 50 items. This can
10267                 sometimes be too much for some RSS feed readers and for some
10268                 people this isn't enough. This preference allows you to adjust
10269                 this number to show the best number of results for your
10270                 patrons.</para>
10271               </listitem>
10272             </itemizedlist>
10273           </section>
10274           <section id="OPACAcquisitionDetails">
10275             <title>OPACAcquisitionDetails</title>
10276             <para>Default: Don't display</para>
10277             <para>Asks: ___  the acquisition details on OPAC detail pages.</para>
10278             <para>Values:<itemizedlist>
10279                 <listitem>
10280                   <para>Display<screenshot>
10281                       <screeninfo>Acquisitions details in the OPAC</screeninfo>
10282                       <mediaobject>
10283                         <imageobject>
10284                           <imagedata fileref="images/admin/globalprefs/OPACAcquisitionDetails.png"/>
10285                         </imageobject>
10286                       </mediaobject>
10287                     </screenshot></para>
10288                 </listitem>
10289                 <listitem>
10290                   <para>Don't display</para>
10291                 </listitem>
10292               </itemizedlist></para>
10293             <para>Description:<itemizedlist>
10294                 <listitem>
10295                   <para>This preference shows the patrons how many items are on order in the
10296                     Holdings tab if you have the <link linkend="AcqCreateItem">AcqCreateItem</link>
10297                     set to 'cataloging the record'</para>
10298                 </listitem>
10299               </itemizedlist></para>
10300           </section>
10301
10302           <section id="OpacAuthorities">
10303             <title>OpacAuthorities</title>
10304
10305             <para>Default: Allow</para>
10306
10307             <para>Asks: ___ patrons to search your authority records.</para>
10308
10309             <para>Description:</para>
10310
10311             <itemizedlist>
10312               <listitem>
10313                 <para>This preference displays the link on the OPAC for the authority search. By
10314                   setting the preference to "Allow" patrons can use this search link of the
10315                   OPAC.</para>
10316               </listitem>
10317             </itemizedlist>
10318
10319             <para>Values:</para>
10320
10321             <itemizedlist>
10322               <listitem>
10323                 <para>Allow</para>
10324
10325                 <itemizedlist>
10326                   <listitem>
10327                     <para>A link labeled 'Authority search' will appear at the top of your OPAC
10328                       under the search box</para>
10329
10330                     <screenshot>
10331                       <screeninfo>'Browse by Subject' link under search box on
10332                       OPAC</screeninfo>
10333
10334                       <mediaobject>
10335                         <imageobject>
10336                           <imagedata fileref="images/admin/globalprefs/authoritysearch.png"/>
10337                         </imageobject>
10338                       </mediaobject>
10339                     </screenshot>
10340                   </listitem>
10341                 </itemizedlist>
10342               </listitem>
10343
10344               <listitem>
10345                 <para>Don't allow</para>
10346               </listitem>
10347             </itemizedlist>
10348           </section>
10349
10350           <section id="opacbookbag">
10351             <title>opacbookbag</title>
10352
10353             <para>Default: Allow</para>
10354
10355             <para>Asks: ___ patrons to store items in a temporary "Cart" on
10356             the OPAC.</para>
10357
10358             <para>Values:</para>
10359
10360             <itemizedlist>
10361               <listitem>
10362                 <para>Allow</para>
10363               </listitem>
10364
10365               <listitem>
10366                 <para>Don't allow</para>
10367               </listitem>
10368             </itemizedlist>
10369
10370             <para>Description:</para>
10371
10372             <itemizedlist>
10373               <listitem>
10374                 <para>This preference allows the user to temporarily save a
10375                 list of items found on the catalog. By using the Book Bag, or
10376                 Cart, the user can print out or email a list of items found.
10377                 The user does not need to be logged in. This list is temporary
10378                 and will be emptied, or cleared, at the end of the
10379                 session.</para>
10380               </listitem>
10381             </itemizedlist>
10382           </section>
10383
10384           <section id="OpacBrowser">
10385             <title>OpacBrowser</title>
10386
10387             <important>
10388               <para>This preference only applies to French systems at this
10389               time.</para>
10390             </important>
10391
10392             <para>Default: Don't allow</para>
10393
10394             <para>Asks: ___ patrons to browse subject authorities on
10395             OPAC</para>
10396
10397             <para>Values:</para>
10398
10399             <itemizedlist>
10400               <listitem>
10401                 <para>Allow</para>
10402               </listitem>
10403
10404               <listitem>
10405                 <para>Don't allow</para>
10406               </listitem>
10407             </itemizedlist>
10408
10409             <para><important>
10410                 <para>run the <link linkend="authbrowsercron">Authorities
10411                 Browser Cron Job</link> to create the browser list</para>
10412               </important></para>
10413           </section>
10414
10415           <section id="OpacBrowseResults">
10416             <title>OpacBrowseResults</title>
10417
10418             <para>Default: enable</para>
10419
10420             <para>Asks: ___ browsing and paging search results from the OPAC
10421             detail page.</para>
10422
10423             <para>Values:</para>
10424
10425             <itemizedlist>
10426               <listitem>
10427                 <para>disable</para>
10428               </listitem>
10429
10430               <listitem>
10431                 <para>enable</para>
10432
10433                 <screenshot>
10434                   <screeninfo>Browsing and Paging Search Results</screeninfo>
10435
10436                   <mediaobject>
10437                     <imageobject>
10438                       <imagedata fileref="images/admin/globalprefs/OpacBrowseResults.png"/>
10439                     </imageobject>
10440                   </mediaobject>
10441                 </screenshot>
10442               </listitem>
10443             </itemizedlist>
10444
10445             <para>Description:</para>
10446
10447             <itemizedlist>
10448               <listitem>
10449                 <para>This preference will control the option to return to
10450                 your results and/or browse them from the detail page in the
10451                 OPAC.</para>
10452               </listitem>
10453             </itemizedlist>
10454           </section>
10455           <section id="OpacCloud">
10456             <title>OpacCloud</title>
10457             <para><important>
10458                 <para>This preference only applies to French systems at this time.</para>
10459               </important>Default: Don't show</para>
10460             <para>Asks: ___  a subject cloud on OPAC</para>
10461             <para>Values:<itemizedlist>
10462                 <listitem>
10463                   <para>Don't show</para>
10464                 </listitem>
10465                 <listitem>
10466                   <para>Show</para>
10467                 </listitem>
10468               </itemizedlist></para>
10469             <para>
10470               <important>
10471                 <para>run the <link linkend="authbrowsercron">Authorities Browser Cron Job</link> to
10472                   create the browser list</para>
10473               </important>
10474             </para>
10475           </section>
10476
10477           <section id="OPACFinesTab">
10478             <title>OPACFinesTab</title>
10479
10480             <para>Default: Allow</para>
10481
10482             <para>Asks: ___ patrons to access the Fines tab on the My Account
10483             page on the OPAC.</para>
10484
10485             <para>Values:</para>
10486
10487             <itemizedlist>
10488               <listitem>
10489                 <para>Allow</para>
10490
10491                 <itemizedlist>
10492                   <listitem>
10493                     <para><link linkend="opacuserlogin">opacuserlogin</link>
10494                     needs to be set to 'allow'</para>
10495                   </listitem>
10496                 </itemizedlist>
10497               </listitem>
10498
10499               <listitem>
10500                 <para>Don't allow</para>
10501               </listitem>
10502             </itemizedlist>
10503           </section>
10504           <section id="OpacHoldNotes">
10505             <title>OpacHoldNotes</title>
10506             <para>Default: Do not allow</para>
10507             <para>Asks: ___  users to add a note when placing a hold.</para>
10508             <para>Values:<itemizedlist>
10509                 <listitem>
10510                   <para>Allow</para>
10511                   <screenshot>
10512                       <screeninfo>Holds notes in the OPAC</screeninfo>
10513                       <mediaobject>
10514                         <imageobject>
10515                           <imagedata fileref="images/admin/globalprefs/OpacHoldNotes.png"/>
10516                         </imageobject>
10517                       </mediaobject>
10518                     </screenshot>
10519                 </listitem>
10520                 <listitem>
10521                   <para>Do not allow</para>
10522                 </listitem>
10523               </itemizedlist></para>
10524           </section>
10525           <section id="OpacItemLocation">
10526             <title>OpacItemLocation</title>
10527             <para>Default: call number only</para>
10528             <para>Asks: Show ____ for items on the OPAC search results.</para>
10529             <para>Values:<itemizedlist>
10530                 <listitem>
10531                   <para>call number only</para>
10532                 </listitem>
10533                 <listitem>
10534                   <para>collection code</para>
10535                 </listitem>
10536                 <listitem>
10537                   <para>location</para>
10538                 </listitem>
10539               </itemizedlist></para>
10540             <para>Description: </para>
10541             <itemizedlist>
10542               <listitem>
10543                 <para>This setting allows users of the OPAC results XSLT stylesheet to choose to
10544                   display collection code or location in addition to call number.</para>
10545               </listitem>
10546             </itemizedlist>
10547           </section>
10548
10549           <section id="OpacPasswordChange">
10550             <title>OpacPasswordChange</title>
10551
10552             <para>Default: Allow</para>
10553
10554             <para>Asks: ___ patrons to change their own password on the
10555             OPAC.</para>
10556
10557             <para>Values:</para>
10558
10559             <itemizedlist>
10560               <listitem>
10561                 <para>Allow</para>
10562
10563                 <itemizedlist>
10564                   <listitem>
10565                     <para><link linkend="opacuserlogin">opacuserlogin</link>
10566                     needs to be set to 'allow'</para>
10567                   </listitem>
10568                 </itemizedlist>
10569               </listitem>
10570
10571               <listitem>
10572                 <para>Don't allow</para>
10573               </listitem>
10574             </itemizedlist>
10575
10576             <important>
10577               <para>Enabling this will break LDAP authentication.</para>
10578             </important>
10579           </section>
10580
10581           <section id="OPACPatronDetails">
10582             <title>OPACPatronDetails</title>
10583
10584             <para>Default: Allow</para>
10585
10586             <para>Asks: ___ patrons to notify the library of changes to their
10587             contact information from the OPAC.</para>
10588
10589             <para>Values:</para>
10590
10591             <itemizedlist>
10592               <listitem>
10593                 <para>Allow</para>
10594
10595                 <itemizedlist>
10596                   <listitem>
10597                     <para><link linkend="opacuserlogin">opacuserlogin</link>
10598                     needs to be set to 'allow'</para>
10599                   </listitem>
10600                 </itemizedlist>
10601               </listitem>
10602
10603               <listitem>
10604                 <para>Don't allow</para>
10605               </listitem>
10606             </itemizedlist>
10607
10608             <para>Description:</para>
10609
10610             <itemizedlist>
10611               <listitem>
10612                 <para>If patrons are allowed to notify the library of changes to their account then
10613                   staff will need to approve the changes via the staff client.  Notification of
10614                   patron account requests will appear on the dashaboard below the list of modules
10615                   with other pending actions.</para>
10616                 <screenshot>
10617                     <screeninfo>Patrons requesting modifications</screeninfo>
10618                     <mediaobject>
10619                       <imageobject>
10620                         <imagedata fileref="images/admin/globalprefs/OPACPatronDetails.png"/>
10621                       </imageobject>
10622                     </mediaobject>
10623                   </screenshot>
10624                 <para>Once you click the notification you will be presented with the changes the
10625                   patron would like to make to their account and from there you can choose how to
10626                   proceed.</para>
10627                 <screenshot>
10628                   <screeninfo>Patrons modifications</screeninfo>
10629                   <mediaobject>
10630                     <imageobject>
10631                       <imagedata fileref="images/admin/globalprefs/OPACPatronDetails-approve.png"/>
10632                     </imageobject>
10633                   </mediaobject>
10634                 </screenshot>
10635                 <note>
10636                   <para>You can control what fields patrons see and can modify via the OPAC by
10637                     setting the <link linkend="PatronSelfRegistrationBorrowerMandatoryField">PatronSelfRegistrationBorrowerMandatoryField</link>
10638                     <link linkend="PatronSelfRegistrationBorrowerUnwantedField">PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
10639                 </note>
10640               </listitem>
10641             </itemizedlist>
10642           </section>
10643
10644           <section id="OPACpatronimage">
10645             <title>OPACpatronimage</title>
10646
10647             <para>Default: Don't show</para>
10648
10649             <para>Asks: ___ patron images on the patron information page in
10650             the OPAC.</para>
10651
10652             <para>Values:</para>
10653
10654             <itemizedlist>
10655               <listitem>
10656                 <para>Don't show</para>
10657               </listitem>
10658
10659               <listitem>
10660                 <para>Show</para>
10661               </listitem>
10662             </itemizedlist>
10663
10664             <para>Description:</para>
10665
10666             <itemizedlist>
10667               <listitem>
10668                 <para>If <link linkend="patronimages">patronimages</link> is
10669                 set to allow the upload of patron images via the staff client,
10670                 then setting this preference to 'show' will show the patron
10671                 what image you have on file for them when they view their
10672                 personal information on their account in the OPAC.</para>
10673               </listitem>
10674             </itemizedlist>
10675           </section>
10676           <section id="OPACPopupAuthorsSearch">
10677             <title>OPACPopupAuthorsSearch</title>
10678             <para>Default: Don't display</para>
10679             <para>Asks: ___  the list of authors/subjects in a popup for a combined search on OPAC
10680               detail pages.</para>
10681             <para>Values:<itemizedlist>
10682                 <listitem>
10683                   <para>Display</para>
10684                   <para>
10685                     <screenshot>
10686                       <screeninfo>Subject search pop up</screeninfo>
10687                       <mediaobject>
10688                         <imageobject>
10689                           <imagedata fileref="images/admin/globalprefs/OPACPopupAuthorsSearch.png"/>
10690                         </imageobject>
10691                       </mediaobject>
10692                     </screenshot>
10693                     <itemizedlist>
10694                       <listitem>
10695                         <important>
10696                           <para>This will only display the pop up if you are not using an XSLT
10697                             stylesheet.  Review your <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> to find out what stylesheet you're
10698                             using.</para>
10699                         </important>
10700                       </listitem>
10701                     </itemizedlist>
10702                   </para>
10703                 </listitem>
10704                 <listitem>
10705                   <para>Don't display<itemizedlist>
10706                       <listitem>
10707                         <para>Authors and subjects will display as search links instead of pop up
10708                           menus.</para>
10709                       </listitem>
10710                     </itemizedlist></para>
10711                 </listitem>
10712               </itemizedlist></para>
10713             <para>Description:<itemizedlist>
10714                 <listitem>
10715                   <para>If this preference is set to 'Display' then clicking a subject or author
10716                     from the details page in the OPAC will present the searcher with a pop up box.
10717                     From this box you can check off any of the subjects or authors listed and search
10718                     them all at once by clicking 'Search' at the bottom of the pop up.  The default
10719                     behavior is for Koha to search just the clicked author or subject.</para>
10720                 </listitem>
10721               </itemizedlist></para>
10722           </section>
10723
10724           <section id="OpacTopissue">
10725             <title>OpacTopissue</title>
10726
10727             <para>Default: Don't allow</para>
10728
10729             <para>Asks: ___ patrons to access a list of the most checked out
10730             items on the OPAC.</para>
10731
10732             <para>Values:</para>
10733
10734             <itemizedlist>
10735               <listitem>
10736                 <para>Allow</para>
10737
10738                 <itemizedlist>
10739                   <listitem>
10740                     <para>A link to 'Most Popular' will appear at the top of
10741                     your OPAC</para>
10742
10743                     <screenshot>
10744                       <screeninfo>'Most Popular' link under the search
10745                       box</screeninfo>
10746
10747                       <mediaobject>
10748                         <imageobject>
10749                           <imagedata fileref="images/admin/globalprefs/OpacTopissue.png"/>
10750                         </imageobject>
10751                       </mediaobject>
10752                     </screenshot>
10753                   </listitem>
10754                 </itemizedlist>
10755               </listitem>
10756
10757               <listitem>
10758                 <para>Don't allow</para>
10759               </listitem>
10760             </itemizedlist>
10761
10762             <para>Description:</para>
10763
10764             <itemizedlist>
10765               <listitem>
10766                 <para>This preference allows the administrator to choose to
10767                 show the "Most Popular" link at the top of the OPAC under the
10768                 search box. The "Most Popular" page shows the top circulated
10769                 items in the library, as determined by the number of times a
10770                 title has been circulated. This allows users to see what
10771                 titles are popular in their community. It is recommended that
10772                 you leave this preference set to 'Don't allow' until you have
10773                 been live on Koha for a couple of months, otherwise the data
10774                 that it shows will not be an accurate portrayal of what's
10775                 popular in your library.</para>
10776
10777                 <screenshot>
10778                   <screeninfo>Sample top issues page</screeninfo>
10779
10780                   <mediaobject>
10781                     <imageobject>
10782                       <imagedata fileref="images/admin/globalprefs/topissues.png"/>
10783                     </imageobject>
10784                   </mediaobject>
10785                 </screenshot>
10786               </listitem>
10787             </itemizedlist>
10788           </section>
10789
10790           <section id="opacuserlogin">
10791             <title>opacuserlogin</title>
10792
10793             <para>Default: Allow</para>
10794
10795             <para>Asks: ___ patrons to log in to their accounts on the
10796             OPAC.</para>
10797
10798             <para>Values:</para>
10799
10800             <itemizedlist>
10801               <listitem>
10802                 <para>Allow</para>
10803               </listitem>
10804
10805               <listitem>
10806                 <para>Don't allow</para>
10807
10808                 <itemizedlist>
10809                   <listitem>
10810                     <para>The OPAC will still be searchable if patrons can't
10811                     log in, this just disables the patron account access via
10812                     the OPAC</para>
10813                   </listitem>
10814                 </itemizedlist>
10815               </listitem>
10816             </itemizedlist>
10817           </section>
10818
10819           <section id="QuoteOfTheDay">
10820             <title>QuoteOfTheDay</title>
10821
10822             <para>Default: Disable</para>
10823
10824             <para>Asks: ___ Quote of the Day display on OPAC home page</para>
10825
10826             <para>Values:</para>
10827
10828             <itemizedlist>
10829               <listitem>
10830                 <para>Disable</para>
10831               </listitem>
10832
10833               <listitem>
10834                 <para>Enable</para>
10835               </listitem>
10836             </itemizedlist>
10837
10838             <para>Description:</para>
10839
10840             <itemizedlist>
10841               <listitem>
10842                 <para>This feature will allow you to enter a series of quotes
10843                 that will then show on the OPAC homepage in random order. To
10844                 add/edit quotes, visit the <link linkend="QOTDEditor">Quote of
10845                 the Day Editor</link> under Tools.</para>
10846               </listitem>
10847             </itemizedlist>
10848           </section>
10849
10850           <section id="RequestOnOpac">
10851             <title>RequestOnOpac</title>
10852
10853             <para>Default: Allow</para>
10854
10855             <para>Asks: ___ patrons to place holds on items from the
10856             OPAC.</para>
10857
10858             <para>Values:</para>
10859
10860             <itemizedlist>
10861               <listitem>
10862                 <para>Allow</para>
10863
10864                 <itemizedlist>
10865                   <listitem>
10866                     <para><link linkend="opacuserlogin">opacuserlogin</link>
10867                     needs to be set to 'allow'</para>
10868                   </listitem>
10869                 </itemizedlist>
10870               </listitem>
10871
10872               <listitem>
10873                 <para>Don't allow</para>
10874               </listitem>
10875             </itemizedlist>
10876           </section>
10877
10878           <section id="reviewson">
10879             <title>reviewson</title>
10880
10881             <para>Default: Allow</para>
10882
10883             <para>Asks: ___ patrons to make comments on items on the
10884             OPAC.</para>
10885
10886             <para>Values:</para>
10887
10888             <itemizedlist>
10889               <listitem>
10890                 <para>Allow</para>
10891
10892                 <itemizedlist>
10893                   <listitem>
10894                     <para>Patrons comments/reviews all require moderation
10895                     before they appear in the OPAC</para>
10896                   </listitem>
10897
10898                   <listitem>
10899                     <para><link linkend="opacuserlogin">opacuserlogin</link>
10900                     needs to be set to 'Allow'</para>
10901                   </listitem>
10902                 </itemizedlist>
10903               </listitem>
10904
10905               <listitem>
10906                 <para>Don't allow</para>
10907               </listitem>
10908             </itemizedlist>
10909
10910             <para>Description:</para>
10911
10912             <itemizedlist>
10913               <listitem>
10914                 <para>This button allows the patrons to submit comments on
10915                 books they have read via the OPAC. If this preference is set
10916                 to "Allow" reviews are first sent to the staff client for
10917                 staff approval before the review is displayed in the OPAC. The
10918                 staff member who reviews and approves comments may find the
10919                 pending comments on the <link linkend="comments">Comments</link> tool. The staff member can
10920                 then choose to approve or delete the comments.</para>
10921               </listitem>
10922             </itemizedlist>
10923           </section>
10924
10925           <section id="ShowReviewer">
10926             <title>ShowReviewer</title>
10927
10928             <para>Default: full name</para>
10929
10930             <para>Asks: Show ___ of commenter with comments in OPAC.</para>
10931
10932             <para>Values:</para>
10933
10934             <itemizedlist>
10935               <listitem>
10936                 <para>first name</para>
10937               </listitem>
10938
10939               <listitem>
10940                 <para>first name and last initial</para>
10941               </listitem>
10942
10943               <listitem>
10944                 <para>full name</para>
10945               </listitem>
10946
10947               <listitem>
10948                 <para>last name</para>
10949               </listitem>
10950
10951               <listitem>
10952                 <para>no name</para>
10953               </listitem>
10954
10955               <listitem>
10956                 <para>username</para>
10957               </listitem>
10958             </itemizedlist>
10959
10960             <para>Description:</para>
10961
10962             <itemizedlist>
10963               <listitem>
10964                 <para>If you would like to protect your patron's privacy in
10965                 the OPAC you can choose to hide their names or parts of their
10966                 names from any of the comments they leave on bib records in
10967                 your system. <link linkend="reviewson">reviewson</link> needs
10968                 to be set to 'Allow' for this to preference to come in to
10969                 play</para>
10970               </listitem>
10971             </itemizedlist>
10972           </section>
10973
10974           <section id="ShowReviewerPhoto">
10975             <title>ShowReviewerPhoto</title>
10976
10977             <para>Default: Show</para>
10978
10979             <para>Asks: ___ reviewer's photo beside comments in OPAC.</para>
10980
10981             <para>Values:</para>
10982
10983             <itemizedlist>
10984               <listitem>
10985                 <para>Hide</para>
10986               </listitem>
10987
10988               <listitem>
10989                 <para>Show</para>
10990
10991                 <itemizedlist>
10992                   <listitem>
10993                     <para><link linkend="reviewson">reviewson</link> needs to
10994                     be set to 'Allow' and <link linkend="ShowReviewer">ShowReviewer</link> needs to be set
10995                     to 'Show' for this to preference to come in to play</para>
10996
10997                     <screenshot>
10998                       <screeninfo>ShowReviewerPhoto set to 'Show'</screeninfo>
10999
11000                       <mediaobject>
11001                         <imageobject>
11002                           <imagedata fileref="images/admin/globalprefs/ShowReviewerPhoto.png"/>
11003                         </imageobject>
11004                       </mediaobject>
11005                     </screenshot>
11006                   </listitem>
11007                 </itemizedlist>
11008               </listitem>
11009             </itemizedlist>
11010
11011             <para>Description:</para>
11012
11013             <itemizedlist>
11014               <listitem>
11015                 <para>This system preference allows libraries to show avatars
11016                 next to patron's comments in the OPAC. These avatars are
11017                 pulled from the <ulink url="https://www.libravatar.org">Libravatar</ulink> library,
11018                 an open source powered product that allows Internet users to
11019                 choose a small icon to display next to their name on various
11020                 different websites. The library has no control over the images
11021                 the patron chooses to display.</para>
11022               </listitem>
11023             </itemizedlist>
11024           </section>
11025
11026           <section id="SocialNetworks">
11027             <title>SocialNetworks</title>
11028
11029             <para>Default: Disable</para>
11030
11031             <para>Asks: ___ social network links in opac detail pages</para>
11032
11033             <para>Values:</para>
11034
11035             <itemizedlist>
11036               <listitem>
11037                 <para>Disable</para>
11038               </listitem>
11039
11040               <listitem>
11041                 <para>Enable</para>
11042
11043                 <screenshot>
11044                   <screeninfo>Social Networks</screeninfo>
11045
11046                   <mediaobject>
11047                     <imageobject>
11048                       <imagedata fileref="images/admin/globalprefs/SocialNetworks.png"/>
11049                     </imageobject>
11050                   </mediaobject>
11051                 </screenshot>
11052               </listitem>
11053             </itemizedlist>
11054
11055             <para>Description:</para>
11056
11057             <itemizedlist>
11058               <listitem>
11059                 <para>This preference will enable a line of social network
11060                 share buttons below the right hand column on the detail pages
11061                 of records in the OPAC.</para>
11062               </listitem>
11063             </itemizedlist>
11064
11065             <important>
11066               <para>In order for these share buttons to work when clicked you
11067               must have filled in your <link linkend="OPACBaseURL">OPACBaseURL</link> preference.</para>
11068             </important>
11069           </section>
11070
11071           <section id="suggestionspref">
11072             <title>suggestion</title>
11073
11074             <para>Default: Allow</para>
11075
11076             <para>Asks: ___ patrons to make purchase suggestions on the
11077             OPAC.</para>
11078
11079             <para>Values:</para>
11080
11081             <itemizedlist>
11082               <listitem>
11083                 <para>Allow</para>
11084
11085                 <itemizedlist>
11086                   <listitem>
11087                     <para><link linkend="opacuserlogin">opacuserlogin</link>
11088                     needs to be set to 'allow' unless <link linkend="AnonSuggestions">AnonSuggestions</link> is set to
11089                     'allow'</para>
11090                   </listitem>
11091                 </itemizedlist>
11092               </listitem>
11093
11094               <listitem>
11095                 <para>Don't allow</para>
11096               </listitem>
11097             </itemizedlist>
11098           </section>
11099         </section>
11100
11101         <section id="opacpolicyprefs">
11102           <title>Policy</title>
11103
11104           <para/>
11105
11106           <section id="AllowPurchaseSuggestionBranchChoice">
11107             <title>AllowPurchaseSuggestionBranchChoice</title>
11108
11109             <para>Default: Don't allow</para>
11110
11111             <para>Asks: ___ patrons to select branch when making a purchase
11112             suggestion</para>
11113
11114             <para>Values:</para>
11115
11116             <itemizedlist>
11117               <listitem>
11118                 <para>Allow</para>
11119               </listitem>
11120
11121               <listitem>
11122                 <para>Don't allow</para>
11123               </listitem>
11124             </itemizedlist>
11125
11126             <para>Description:</para>
11127
11128             <itemizedlist>
11129               <listitem>
11130                 <para>If your library system lets patrons make purchase
11131                 suggestions for a specific branch you can set this preference
11132                 to 'Allow' to add a branch selection option to the purchase
11133                 suggestion form.</para>
11134               </listitem>
11135             </itemizedlist>
11136           </section>
11137           <section id="BlockExpiredPatronOpacActions">
11138             <title>BlockExpiredPatronOpacActions</title>
11139             <para>Default: Don't block</para>
11140             <para>Asks: ___ expired patrons from OPAC actions such as placing a hold or renewing. </para>
11141             <para>Values:<itemizedlist>
11142                 <listitem>
11143                   <para>Block</para>
11144                 </listitem>
11145                 <listitem>
11146                   <para>Don't block</para>
11147                 </listitem>
11148               </itemizedlist></para>
11149             <para>Description:<itemizedlist>
11150                 <listitem>
11151                   <para>This preference lets you set a default value for how Koha handles
11152                     permissions for patrons who are expired. This preference can be overwritten by
11153                     the setting on <link linkend="patcats">individual patron
11154                     categories</link>.</para>
11155                 </listitem>
11156               </itemizedlist></para>
11157           </section>
11158
11159           <section id="OpacAllowPublicListCreation">
11160             <title>OpacAllowPublicListCreation</title>
11161
11162             <para>Default: Allow</para>
11163
11164             <para>Asks: ___ opac users to create public lists</para>
11165
11166             <para>Values:</para>
11167
11168             <itemizedlist>
11169               <listitem>
11170                 <para>Allow</para>
11171               </listitem>
11172
11173               <listitem>
11174                 <para>Don't allow</para>
11175               </listitem>
11176             </itemizedlist>
11177
11178             <para>Description:</para>
11179
11180             <itemizedlist>
11181               <listitem>
11182                 <para>Public lists are visible to anyone who visits your OPAC.
11183                 With this preference you can control whether or now patrons
11184                 are allowed to create these public lists. If this is set to
11185                 "Don't allow" then only staff will be able to create public
11186                 lists.</para>
11187               </listitem>
11188             </itemizedlist>
11189
11190             <important>
11191               <para>This preference will only be taken in to account if you
11192               have <link linkend="virtualshelves">virtualshelves</link> set to
11193               'Allow'</para>
11194             </important>
11195           </section>
11196
11197           <section id="OpacAllowSharingPrivateLists">
11198             <title>OpacAllowSharingPrivateLists</title>
11199
11200             <para>Default: Don't allow</para>
11201
11202             <para>Asks: ___ opac users to share private lists with other
11203             patrons.</para>
11204
11205             <para>Values:</para>
11206
11207             <itemizedlist>
11208               <listitem>
11209                 <para>Allow</para>
11210               </listitem>
11211
11212               <listitem>
11213                 <para>Don't allow</para>
11214               </listitem>
11215             </itemizedlist>
11216
11217             <para>Description:</para>
11218
11219             <itemizedlist>
11220               <listitem>
11221                 <para>This feature will add the option for patrons to share their lists with other
11222                   patrons. When this is set to 'Allow' patrons will see a share link at the top of
11223                   their list. When they click that link it will ask for the email of the patron they
11224                   would like to share with. Koha will then email the patron an invitation to see the
11225                   list.</para>
11226               </listitem>
11227             </itemizedlist>
11228           </section>
11229
11230           <section id="OPACFineNoRenewals">
11231             <title>OPACFineNoRenewals</title>
11232
11233             <para>Default: 99999</para>
11234
11235             <para>Asks: Only allow patrons to renew their own books on the
11236             OPAC if they have less than ___ USD in fines</para>
11237
11238             <note>
11239               <para>Leave this field blank to disable</para>
11240             </note>
11241
11242             <important>
11243               <para>To allow renewals in the OPAC, <link linkend="opacuserlogin">opacuserlogin</link> needs to be set to
11244               'allow'</para>
11245             </important>
11246           </section>
11247
11248           <section id="OpacHiddenItems">
11249             <title>OpacHiddenItems</title>
11250
11251             <para>Asks: Allows to define custom rules for hiding specific
11252             items at opac. <note>
11253                 <para>See docs/opac/OpacHiddenItems.txt in your Koha install
11254                 directory for more information</para>
11255               </note></para>
11256
11257             <para>Description:</para>
11258
11259             <itemizedlist>
11260               <listitem>
11261                 <para>In this field you can enter criteria for items you would
11262                 like to hide from display in the OPAC. This field takes any
11263                 combination of item fields (from the items table in the Koha
11264                 database) for blocking. For example a value of:</para>
11265
11266                 <para><programlisting>itype: [07, 10]
11267 location: [STAFF, ISO]</programlisting>Will block items with an itype code of
11268                 07 or 10 as well as items that have a shelving location of
11269                 STAFF or ISO.</para>
11270
11271                 <para>In items my items.itype 07 is defined in Item Types
11272                 Administration as Staff Assigned My items.itype 10 in Item
11273                 Types is Archival Copy The locations STAFF and ISO are in
11274                 Authorized Values for category=LOC STAFF means it's assigned
11275                 to the staff reading room and ISO means it is in the isolation
11276                 room.</para>
11277               </listitem>
11278             </itemizedlist>
11279           </section>
11280
11281           <section id="OpacRenewalAllowed">
11282             <title>OpacRenewalAllowed</title>
11283
11284             <para>Default: Don't allow</para>
11285
11286             <para>Asks: ___ patrons to renew their own books on the
11287             OPAC.</para>
11288
11289             <para>Values:</para>
11290
11291             <itemizedlist>
11292               <listitem>
11293                 <para>Allow</para>
11294
11295                 <itemizedlist>
11296                   <listitem>
11297                     <para><link linkend="opacuserlogin">opacuserlogin</link>
11298                     needs to be set to 'allow'</para>
11299                   </listitem>
11300                 </itemizedlist>
11301               </listitem>
11302
11303               <listitem>
11304                 <para>Don't allow</para>
11305
11306                 <itemizedlist>
11307                   <listitem>
11308                     <para>Staff will still be able to renew items for patrons
11309                     via the staff client</para>
11310                   </listitem>
11311                 </itemizedlist>
11312               </listitem>
11313             </itemizedlist>
11314
11315             <para>Description:</para>
11316
11317             <itemizedlist>
11318               <listitem>
11319                 <para>This preference allows the administration to choose if
11320                 patrons can renew their checked out materials via their
11321                 checked out history in the OPAC. It allows patrons to renew
11322                 their materials without having to contact the library or
11323                 having to return to the library.</para>
11324               </listitem>
11325             </itemizedlist>
11326           </section>
11327
11328           <section id="OpacRenewalBranch">
11329             <title>OpacRenewalBranch</title>
11330
11331             <para>Default: the branch the item was checked out from</para>
11332
11333             <para>Asks: Use ___ as branchcode to store in the statistics
11334             table</para>
11335
11336             <para>Values:</para>
11337
11338             <itemizedlist>
11339               <listitem>
11340                 <para>NULL</para>
11341               </listitem>
11342
11343               <listitem>
11344                 <para>'OPACRenew'</para>
11345               </listitem>
11346
11347               <listitem>
11348                 <para>the item's home branch</para>
11349               </listitem>
11350
11351               <listitem>
11352                 <para>the patron's home branch</para>
11353               </listitem>
11354
11355               <listitem>
11356                 <para>the branch the item was checked out from</para>
11357               </listitem>
11358             </itemizedlist>
11359
11360             <para>Description:</para>
11361
11362             <itemizedlist>
11363               <listitem>
11364                 <para>This value is used in the statistics table to help with
11365                 reporting. The statistics table in Koha keeps track of all
11366                 checkouts and renewals, this preference defines which branch
11367                 is entered in to the table when a patron renews an item for
11368                 themselves via the OPAC.</para>
11369               </listitem>
11370             </itemizedlist>
11371           </section>
11372
11373           <section id="OPACViewOthersSuggestions">
11374             <title>OPACViewOthersSuggestions</title>
11375
11376             <para>Default: Don't show</para>
11377
11378             <para>Asks: ___ purchase suggestions from other patrons on the
11379             OPAC.</para>
11380
11381             <para>Values:</para>
11382
11383             <itemizedlist>
11384               <listitem>
11385                 <para>Don't show</para>
11386               </listitem>
11387
11388               <listitem>
11389                 <para>Show</para>
11390
11391                 <itemizedlist>
11392                   <listitem>
11393                     <para><link linkend="opacuserlogin">opacuserlogin</link>
11394                     needs to be set to 'allow'</para>
11395                   </listitem>
11396                 </itemizedlist>
11397               </listitem>
11398             </itemizedlist>
11399           </section>
11400
11401           <section id="SearchMyLibraryFirst">
11402             <title>SearchMyLibraryFirst</title>
11403
11404             <para>Default: Don't limit</para>
11405
11406             <para>Asks: ___ patrons' searches to the library they are
11407             registered at.</para>
11408
11409             <para>Values:</para>
11410
11411             <itemizedlist>
11412               <listitem>
11413                 <para>Don't limit</para>
11414
11415                 <itemizedlist>
11416                   <listitem>
11417                     <para>Searching the OPAC will show results from all
11418                     libraries</para>
11419                   </listitem>
11420
11421                   <listitem>
11422                     <para>If you're a one branch system, choose 'Don't
11423                     limit'</para>
11424                   </listitem>
11425                 </itemizedlist>
11426               </listitem>
11427
11428               <listitem>
11429                 <para>Limit</para>
11430
11431                 <itemizedlist>
11432                   <listitem>
11433                     <para>Patrons will still be able to search other libraries
11434                     via the Advanced search page - but will be limited to
11435                     searches for their library only from the basic search
11436                     box</para>
11437                   </listitem>
11438
11439                   <listitem>
11440                     <para><link linkend="opacuserlogin">opacuserlogin</link>
11441                     needs to be set to 'allow'</para>
11442                   </listitem>
11443                 </itemizedlist>
11444               </listitem>
11445             </itemizedlist>
11446           </section>
11447
11448           <section id="singleBranchMode">
11449             <title>singleBranchMode</title>
11450
11451             <para>Default: Don't allow</para>
11452
11453             <para>Asks: ___ patrons to select their branch on the OPAC.</para>
11454
11455             <para>Values:</para>
11456
11457             <itemizedlist>
11458               <listitem>
11459                 <para>Allow</para>
11460
11461                 <itemizedlist>
11462                   <listitem>
11463                     <para><link linkend="opacuserlogin">opacuserlogin</link>
11464                     needs to be set to 'allow'</para>
11465                   </listitem>
11466                 </itemizedlist>
11467               </listitem>
11468
11469               <listitem>
11470                 <para>Don't allow</para>
11471               </listitem>
11472             </itemizedlist>
11473
11474             <para>Description:</para>
11475
11476             <itemizedlist>
11477               <listitem>
11478                 <para>This preference is for libraries that have branches but
11479                 do not want to share their items among other branches within
11480                 their system. If the preference is set to "Don't allow" then
11481                 holdings will be shown for all branches within a system. On
11482                 the "Home" screen of the OPAC users have the choice of
11483                 narrowing down results by item location. Setting this
11484                 preference to "Allow" will display only one branch's
11485                 holdings.</para>
11486               </listitem>
11487             </itemizedlist>
11488           </section>
11489         </section>
11490
11491         <section id="opacprivacyprefs">
11492           <title>Privacy</title>
11493
11494           <para/>
11495
11496           <section id="AnonSuggestions">
11497             <title>AnonSuggestions</title>
11498
11499             <para>Default: Don't allow</para>
11500
11501             <para>Asks: ___ patrons that aren't logged in to make purchase
11502             suggestions. <important>
11503                 <para>If set to 'Allow', suggestions are connected to the
11504                 <link linkend="AnonymousPatron">AnonymousPatron</link></para>
11505               </important></para>
11506
11507             <para>Values:</para>
11508
11509             <itemizedlist>
11510               <listitem>
11511                 <para>Allow</para>
11512               </listitem>
11513
11514               <listitem>
11515                 <para>Don't allow</para>
11516               </listitem>
11517             </itemizedlist>
11518           </section>
11519
11520           <section id="AnonymousPatron">
11521             <title>AnonymousPatron</title>
11522
11523             <para>Default: 0</para>
11524
11525             <para>Asks: Use borrowernumber ___ as the Anonymous Patron (for anonymous suggestions
11526               and reading history) </para>
11527             <note>
11528               <para>Before setting this preference <link linkend="addnewpatron">create a
11529                   patron</link> to be used for all anonymous suggestions and/or reading history
11530                 items. This patron can be any type and should be named something to make it clear to
11531                 you that they're anonymous (ex. Anonymous Patron).</para>
11532             </note>
11533             <important>
11534               <para>Remember to use the borrowernumber note the patron's cardnumber for this value.
11535                 The borrowernumber can be found on the patron record under 'Library use' on the right.<screenshot>
11536                   <screeninfo>Borrowernumber</screeninfo>
11537                   <mediaobject>
11538                     <imageobject>
11539                       <imagedata fileref="images/admin/globalprefs/AnonymousPatron.png"/>
11540                     </imageobject>
11541                   </mediaobject>
11542                 </screenshot></para>
11543             </important>
11544           </section>
11545
11546           <section id="EnableOpacSearchHistory">
11547             <title>EnableOpacSearchHistory</title>
11548
11549             <para>Default: Keep</para>
11550
11551             <para>Asks: ___ patron search history in the OPAC.</para>
11552
11553             <para>Values:</para>
11554
11555             <itemizedlist>
11556               <listitem>
11557                 <para>Don't keep</para>
11558               </listitem>
11559
11560               <listitem>
11561                 <para>Keep</para>
11562               </listitem>
11563             </itemizedlist>
11564           </section>
11565
11566           <section id="OPACPrivacy">
11567             <title>OPACPrivacy</title>
11568
11569             <para>Default: Don't allow</para>
11570
11571             <para>Asks: ___ patrons to choose their own privacy settings for
11572             their reading history. <important>
11573                 <para>This requires <link linkend="opacreadinghistory">opacreadinghistory</link> set to
11574                 'Allow' and <link linkend="AnonymousPatron">AnonymousPatron</link> to be set to
11575                 your anonymous patron's borrowernumber.</para>
11576               </important></para>
11577
11578             <para>Values:</para>
11579
11580             <itemizedlist>
11581               <listitem>
11582                 <para>Allow</para>
11583               </listitem>
11584
11585               <listitem>
11586                 <para>Don't allow</para>
11587               </listitem>
11588             </itemizedlist>
11589             <para>Description:<itemizedlist>
11590                 <listitem>
11591                   <para>The default privacy setting for each patron category can be set in the <link
11592                       linkend="patcats">Patrons Categories</link> area.  If you set this preference
11593                     to 'allow' then patrons can change that for themselves via the OPAC.</para>
11594                 </listitem>
11595               </itemizedlist></para>
11596           </section>
11597
11598           <section id="opacreadinghistory">
11599             <title>opacreadinghistory</title>
11600
11601             <para>Default: Allow</para>
11602
11603             <para>Asks: ___ patrons to see what books they have checked out in
11604             the past.</para>
11605
11606             <important>
11607               <para>Enabling this will make it so that patrons can view their circulation history in
11608                 the OPAC unless you have <link linkend="OPACPrivacy">OPACPrivacy</link> set to
11609                 'Allow.'</para>
11610             </important>
11611
11612             <important>
11613               <para>This data is stored in the system regardless of your
11614               choice, unless your patrons have chosen to never have their
11615               reading history kept.</para>
11616             </important>
11617           </section>
11618           <section id="TrackClicks">
11619             <title>TrackClicks</title>
11620             <para>Default: Don't track</para>
11621             <para>Asks: ___  links that patrons click on.</para>
11622             <para>Values:<itemizedlist>
11623                 <listitem>
11624                   <para>Don't track</para>
11625                 </listitem>
11626                 <listitem>
11627                   <para>Track</para>
11628                 </listitem>
11629                 <listitem>
11630                   <para>Track anonymously</para>
11631                 </listitem>
11632               </itemizedlist></para>
11633             <para>Description:<itemizedlist>
11634                 <listitem>
11635                   <para>By setting this preference to one of the track options you will allow Koha
11636                     to track every link clicked in Koha.  This data will be stored in a database
11637                     table so that you can run reports against that data.  If you choose to 'Track'
11638                     clicks then Koha will record both the link clicked and the logged in user who
11639                     clicked the link. If you choose to 'Track anonymously' then the borrowernumber
11640                     will not be recorded, but the rest of the data will.<note>
11641                       <para>Remember to update your local privacy policies and link to them from the
11642                         OPAC to notify your users that you are tracking their information.</para>
11643                     </note></para>
11644                 </listitem>
11645               </itemizedlist></para>
11646           </section>
11647         </section>
11648         <section id="opacselfregistrationprefs">
11649           <title>Self Registration</title>
11650           <section id="PatronSelfRegistration">
11651             <title>PatronSelfRegistration</title>
11652             <para>Default: Don't allow</para>
11653             <para>Asks: ___ library patrons to register an account via the OPAC.</para>
11654             <para>Values:<itemizedlist>
11655                 <listitem>
11656                   <para>Allow</para>
11657                 </listitem>
11658                 <listitem>
11659                   <para>Don't allow</para>
11660                 </listitem>
11661               </itemizedlist></para>
11662             <para>Description:</para>
11663             <itemizedlist>
11664               <listitem>
11665                 <para>Setting this preference to 'Allow' will provide a link on the OPAC to register
11666                   for a new account.  Using the other <link linkend="opacselfregistrationprefs">Self
11667                     Registration</link> system preferences you can control how this preference will function.</para>
11668                 <screenshot>
11669                     <screeninfo>Register link in the OPAC</screeninfo>
11670                     <mediaobject>
11671                       <imageobject>
11672                         <imagedata fileref="images/admin/globalprefs/PatronSelfRegistration.png"/>
11673                       </imageobject>
11674                     </mediaobject>
11675                   </screenshot>
11676               </listitem>
11677             </itemizedlist>
11678             <important>
11679               <para>Patrons registering via the OPAC will not need to be approved by a librarian.
11680                 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
11681                 to verify their identity before given circulation rights at the library. Once the
11682                 patron confirms their identiy the library staff can change the category to one with
11683                 permissions to check items out and place holds.</para>
11684             </important>
11685           </section>
11686           <section id="PatronSelfRegistrationAdditionalInstructions">
11687             <title>PatronSelfRegistrationAdditionalInstructions</title>
11688             <para>Asks: Display the following additional instructions for patrons who self register
11689               via the OPAC ( HTML is allowed ): </para>
11690             <para>Description:<itemizedlist>
11691                 <listitem>
11692                   <para>This preference takes any HTML you'd like to display on the page the patron
11693                     sees after successfully registering for their library card.</para>
11694                 </listitem>
11695               </itemizedlist></para>
11696           </section>
11697           <section id="PatronSelfRegistrationBorrowerMandatoryField">
11698             <title>PatronSelfRegistrationBorrowerMandatoryField</title>
11699             <para>Default: surname|firstname</para>
11700             <para>Asks: The following database columns must be filled in on the patron entry screen:
11701               ___</para>
11702             <para>Description:</para>
11703             <itemizedlist>
11704               <listitem>
11705                 <para>This preference allows you to define what fields patrons must fill in on their
11706                   self regisration form.  If any of the required fields are blank Koha will not let
11707                   the patron register.</para>
11708               </listitem>
11709             </itemizedlist>
11710             <important>
11711               <para>Separate columns with |</para>
11712             </important>
11713             <note>
11714               <para>For help with field names, ask your system administrator or <ulink url="http://schema.koha-community.org/tables/borrowers.html">view the database
11715                   structure</ulink> associated with the borrowers table.</para>
11716             </note>
11717             <note>
11718               <para>If you're going to require that patrons verify their accounts via email with the
11719                   <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link> preference the email field will
11720                 automatically be marked as required.</para>
11721             </note>
11722           </section>
11723           <section id="PatronSelfRegistrationBorrowerUnwantedField">
11724             <title>PatronSelfRegistrationBorrowerUnwantedField</title>
11725             <para>Asks: The following database columns will not appear on the patron entry screen:
11726               ___</para>
11727             <para>Description:</para>
11728             <itemizedlist>
11729               <listitem>
11730                 <para>Using this preference you can hide fields from the patron registraion and
11731                   update form in the OPAC.</para>
11732               </listitem>
11733             </itemizedlist>
11734             <important>
11735               <para>Separate columns with |</para>
11736             </important>
11737             <note>
11738               <para>For help with field names, ask your system administrator or <ulink url="http://schema.koha-community.org/tables/borrowers.html">view the database
11739                   structure</ulink> associated with the borrowers table.</para>
11740             </note>
11741           </section>
11742           <section id="PatronSelfRegistrationDefaultCategory">
11743             <title>PatronSelfRegistrationDefaultCategory</title>
11744             <para>Asks: Use the patron category code ___ as the default patron category for patrons
11745               registered via the OPAC. </para>
11746             <para>Description:</para>
11747             <itemizedlist>
11748               <listitem>
11749                 <para>Enter in the patron category code for the category that all new patrons
11750                   registered via the OPAC will be put in to.</para>
11751               </listitem>
11752             </itemizedlist>
11753             <important>
11754               <para>Patrons registering via the OPAC will not need to be approved by a librarian.
11755                 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
11756                 to verify their identity before given circulation rights at the library. Once the
11757                 patron confirms their identiy the library staff can change the category to one with
11758                 permissions to check items out and place holds.</para>
11759             </important>
11760             <important>
11761               <para>If you leave this blank or enter in an invalid code your patrons will still be
11762                 able to register but will not be given a username. There will be no errors on the
11763                 page to explain this, so be sure to enter a valid patron category code.</para>
11764             </important>
11765           </section>
11766           <section id="PatronSelfRegistrationExpireTemporaryAccountsDelay">
11767             <title>PatronSelfRegistrationExpireTemporaryAccountsDelay</title>
11768             <para>Default: 0</para>
11769             <para>Asks: Delete patrons registered via the OPAC, but not yet verified after ___
11770               days.</para>
11771             <para>Description:<itemizedlist>
11772                 <listitem>
11773                   <para>This prefence links to the <link linkend="deleteexpiredregistrationcron"
11774                       >delete_expired_opac_registrations.pl cron job</link>. If that cron is set to
11775                     run nightly it will clean up any registrations that have not been verified via
11776                     email in the number of days entered on this preference. This is dependent on
11777                       <link linkend="PatronSelfRegistrationVerifyByEmail"
11778                       >PatronSelfRegistrationVerifyByEmail</link> preference.</para>
11779                 </listitem>
11780               </itemizedlist></para>
11781           </section>
11782           <section id="PatronSelfRegistrationVerifyByEmail">
11783             <title>PatronSelfRegistrationVerifyByEmail</title>
11784             <para>Default: Don't require</para>
11785             <para>Asks: ___  that a self-registering patron verify his or herself via email.</para>
11786             <para>Values:<itemizedlist>
11787                 <listitem>
11788                   <para>Don't require</para>
11789                 </listitem>
11790                 <listitem>
11791                   <para>Require</para>
11792                 </listitem>
11793               </itemizedlist></para>
11794             <para>Description:<itemizedlist>
11795                 <listitem>
11796                   <para>If you require patrons to verify their accounts via email they will not be
11797                     able to log in to the OPAC until they acknowledge the email sent by Koha. If you
11798                     don't require this then patrons will be able to log in as soon as they fill in
11799                     the registration form. You can set the <link
11800                       linkend="PatronSelfRegistrationExpireTemporaryAccountsDelay"
11801                       >PatronSelfRegistrationExpireTemporaryAccountsDelay</link> preference to
11802                     delete the un-verified self registrations after a certain number of days.</para>
11803                 </listitem>
11804               </itemizedlist><note>
11805                 <para>If you're going to require that patrons verify their accounts via email then
11806                   the email field will automatically be marked as required.</para>
11807               </note></para>
11808           </section>
11809         </section>
11810
11811         <section id="shelfbrowseprefs">
11812           <title>Shelf Browser</title>
11813
11814           <para/>
11815
11816           <section id="OPACShelfBrowser">
11817             <title>OPACShelfBrowser</title>
11818
11819             <para>Default: Show</para>
11820
11821             <para>Asks: ___ a shelf browser on item details pages, allowing
11822             patrons to see what's near that item on the shelf.</para>
11823
11824             <para>Values:</para>
11825
11826             <itemizedlist>
11827               <listitem>
11828                 <para>Don't show</para>
11829               </listitem>
11830
11831               <listitem>
11832                 <para>Show</para>
11833
11834                 <screenshot>
11835                   <screeninfo>OPACShelfBrowser</screeninfo>
11836
11837                   <mediaobject>
11838                     <imageobject>
11839                       <imagedata fileref="images/admin/globalprefs/OPACShelfBrowser.png"/>
11840                     </imageobject>
11841                   </mediaobject>
11842                 </screenshot>
11843               </listitem>
11844             </itemizedlist>
11845
11846             <para>Description:</para>
11847
11848             <itemizedlist>
11849               <listitem>
11850                 <para>This preference allows patrons to view what is located
11851                 on the shelf near the item they looked up. The shelf browser
11852                 option appears on the details page to the right of each items'
11853                 call number. Clicking the 'Browse Shelf' link allows for a
11854                 virtual shelf browsing experience via the OPAC and lets
11855                 patrons see other books that may relate to their search and
11856                 items that sit on the shelf near the item they are looking
11857                 at.</para>
11858               </listitem>
11859             </itemizedlist>
11860
11861             <important>
11862               <para>This uses up a fairly large amount of resources on your
11863               server, and should be avoided if your collection has a large
11864               number of items.</para>
11865             </important>
11866           </section>
11867
11868           <section id="ShelfBrowserUsesCcode">
11869             <title>ShelfBrowserUsesCcode</title>
11870
11871             <para>Default: Don't use</para>
11872
11873             <para>Asks: ___ the item collection code when finding items for
11874             the shelf browser.</para>
11875
11876             <para>Values:</para>
11877
11878             <itemizedlist>
11879               <listitem>
11880                 <para>Don't use</para>
11881               </listitem>
11882
11883               <listitem>
11884                 <para>Use</para>
11885               </listitem>
11886             </itemizedlist>
11887
11888             <para>Description:</para>
11889
11890             <itemizedlist>
11891               <listitem>
11892                 <para>If your library uses collection codes then you might
11893                 want the shelf browser to take into consideration what
11894                 collection the books belong to when populating the virtual
11895                 shelf browser.</para>
11896               </listitem>
11897             </itemizedlist>
11898           </section>
11899
11900           <section id="ShelfBrowserUsesHomeBranch">
11901             <title>ShelfBrowserUsesHomeBranch</title>
11902
11903             <para>Default: Use</para>
11904
11905             <para>Asks: ___ the item home branch when finding items for the
11906             shelf browser.</para>
11907
11908             <para>Values:</para>
11909
11910             <itemizedlist>
11911               <listitem>
11912                 <para>Don't use</para>
11913               </listitem>
11914
11915               <listitem>
11916                 <para>Use</para>
11917               </listitem>
11918             </itemizedlist>
11919
11920             <para>Description:</para>
11921
11922             <itemizedlist>
11923               <listitem>
11924                 <para>If you have a multiple branch system you may want to
11925                 make sure that Koha takes into consideration what branch owns
11926                 the books when populating the virtual shelf browser for
11927                 accuracy.</para>
11928               </listitem>
11929             </itemizedlist>
11930           </section>
11931
11932           <section id="ShelfBrowserUsesLocation">
11933             <title>ShelfBrowserUsesLocation</title>
11934
11935             <para>Default: Use</para>
11936
11937             <para>Asks: ___ the item location when finding items for the shelf
11938             browser.</para>
11939
11940             <para>Values:</para>
11941
11942             <itemizedlist>
11943               <listitem>
11944                 <para>Don't use</para>
11945               </listitem>
11946
11947               <listitem>
11948                 <para>Use</para>
11949               </listitem>
11950             </itemizedlist>
11951
11952             <para>Description:</para>
11953
11954             <itemizedlist>
11955               <listitem>
11956                 <para>If your library uses shelving locations then you might
11957                 want the shelf browser to take into consideration what
11958                 shelving location the books belong to when populating the
11959                 virtual shelf browser.</para>
11960               </listitem>
11961             </itemizedlist>
11962           </section>
11963         </section>
11964       </section>
11965
11966       <section id="patronprefs">
11967         <title>Patrons</title>
11968
11969         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
11970         Global System Preferences &gt; Patrons</para>
11971
11972         <section id="generalpatronpref">
11973           <title>General</title>
11974           <section id="AutoEmailOPACUser">
11975             <title>AutoEmailOpacUser</title>
11976             <para>Default: Don't send</para>
11977             <para>Asks: ___ an email to newly created patrons with their account details.</para>
11978             <para>Description:</para>
11979             <itemizedlist>
11980               <listitem>
11981                 <para>AutoEmailOpacUser allows library users to be notified by email of their
11982                   account details when a new account is opened at the email address specified in the
11983                     <link linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
11984                   preference. The email contains the username and password given to or chosen by the
11985                   patron when signing up for their account and can be customized by editing the
11986                     <link linkend="ACCTDETAILS">ACCTDETAILS</link> notice.</para>
11987               </listitem>
11988             </itemizedlist>
11989             <para>Values:</para>
11990             <itemizedlist>
11991               <listitem>
11992                 <para>Don't send</para>
11993               </listitem>
11994               <listitem>
11995                 <para>Send</para>
11996               </listitem>
11997             </itemizedlist>
11998           </section>
11999           <section id="AutoEmailPrimaryAddress">
12000             <title>AutoEmailPrimaryAddress</title>
12001             <para>Default: alternate</para>
12002             <para>Asks: Use ___ patron email address for sending out emails.</para>
12003             <para>Values:</para>
12004             <itemizedlist>
12005               <listitem>
12006                 <para>alternate</para>
12007               </listitem>
12008               <listitem>
12009                 <para>first valid</para>
12010               </listitem>
12011               <listitem>
12012                 <para>home</para>
12013               </listitem>
12014               <listitem>
12015                 <para>work</para>
12016               </listitem>
12017             </itemizedlist>
12018             <para>Description:</para>
12019             <itemizedlist>
12020               <listitem>
12021                 <para>If you choose 'first valid' as the value for AutoEmailPrimaryAddress the
12022                   system will check the email fields in this order: home, work, then alternate.
12023                   Otherwise the system will use the email address you specify.</para>
12024               </listitem>
12025             </itemizedlist>
12026           </section>
12027           <section id="autoMemberNum">
12028             <title>autoMemberNum</title>
12029             <para>Default: Do</para>
12030             <para>Asks: ___ default the card number field on the patron addition screen to the next
12031               available card number</para>
12032             <para>Values:</para>
12033             <itemizedlist>
12034               <listitem>
12035                 <para>Do</para>
12036                 <itemizedlist>
12037                   <listitem>
12038                     <para>If the largest currently used card number is 26345000012941, then this
12039                       field will default to 26345000012942 for the next patron</para>
12040                   </listitem>
12041                 </itemizedlist>
12042               </listitem>
12043               <listitem>
12044                 <para>Don't</para>
12045               </listitem>
12046             </itemizedlist>
12047             <para>Description:</para>
12048             <itemizedlist>
12049               <listitem>
12050                 <para>This preference determines if the patron's barcode is automatically
12051                   calculated. This prevents the person setting up the library card account from
12052                   having to assign a number to the new card. If set to 'Do' the system will
12053                   calculate a new patron barcode by adding 1 to the maximum barcode already present
12054                   in the database.</para>
12055               </listitem>
12056             </itemizedlist>
12057           </section>
12058           <section id="BorrowerMandatoryField">
12059             <title>BorrowerMandatoryField</title>
12060             <para>Default: surname|cardnumber|barcode</para>
12061             <para>Asks: The following database columns must be filled in on the patron entry screen:
12062               ___</para>
12063             <para>Description:</para>
12064             <itemizedlist>
12065               <listitem>
12066                 <para>This preference enables the system administrator to choose which fields your
12067                   library would like required for patron accounts. Enter field names separated by |
12068                   (bar). This ensures that basic information is included in each patron record. If a
12069                   patron leaves one of the required fields blank an error message will issue and the
12070                   account will not be created.</para>
12071               </listitem>
12072             </itemizedlist>
12073             <important>
12074               <para>Separate columns with |</para>
12075             </important>
12076             <note>
12077               <para>For help with field names, ask your system administrator or <ulink
12078                   url="http://schema.koha-community.org/tables/borrowers.html">view the database
12079                   structure</ulink> associated with the borrowers table.</para>
12080             </note>
12081           </section>
12082           <section id="borrowerRelationship">
12083             <title>borrowerRelationship</title>
12084             <para>Default: father|mother</para>
12085             <para>Asks: Guarantors can be the following of those they guarantee ___</para>
12086             <para>Description:</para>
12087             <itemizedlist>
12088               <listitem>
12089                 <para>This preference enables the system administrator to define valid relationships
12090                   between a guarantor (usually a parent) &amp; a guarantee (usually a child).
12091                   Defining values for this field does not make the guarantor field required when
12092                   adding a guarantee type patron. This preference creates a drop down list
12093                   identifying the relationship of the guarantor to the guarantee. To disable the
12094                   ability to add children types in Koha you can leave this field blank.</para>
12095               </listitem>
12096             </itemizedlist>
12097             <important>
12098               <para>Input multiple choices separated by |</para>
12099             </important>
12100           </section>
12101           <section id="BorrowerRenewalPeriodBase">
12102             <title>BorrowerRenewalPeriodBase</title>
12103             <para>Default: current date</para>
12104             <para>Asks: When renewing borrowers, base the new expiry date on ___</para>
12105             <para>Values:</para>
12106             <itemizedlist>
12107               <listitem>
12108                 <para>current date.</para>
12109               </listitem>
12110               <listitem>
12111                 <para>current membership expiry date.</para>
12112               </listitem>
12113             </itemizedlist>
12114             <para>Description:</para>
12115             <itemizedlist>
12116               <listitem>
12117                 <para>This preference controls what the patron's new expiration date will be when
12118                   you renew their card. Using the 'current date' will add the subscription period to
12119                   today's date when calculating the new expiration date. Using 'current membership
12120                   expiry date' will add the subscription period to the old expiration date for the
12121                   patron when renewing their account.</para>
12122               </listitem>
12123             </itemizedlist>
12124           </section>
12125           <section id="BorrowersTitles">
12126             <title>BorrowersTitles</title>
12127             <para>Default: Mr|Mrs|Miss|Ms</para>
12128             <para>Asks: Borrowers can have the following titles ___</para>
12129             <para>Description:</para>
12130             <itemizedlist>
12131               <listitem>
12132                 <para>This preference allows the staff to choose the titles that can be assigned to
12133                   patrons. The choices present as a drop down list when creating a patron
12134                   record.</para>
12135               </listitem>
12136             </itemizedlist>
12137             <important>
12138               <para>Input multiple choices separated by |</para>
12139             </important>
12140           </section>
12141           <section id="BorrowerUnwantedField">
12142             <title>BorrowerUnwantedField</title>
12143             <para>Asks: The following database columns will not appear on the patron entry screen:
12144               ___</para>
12145             <para>Description:</para>
12146             <itemizedlist>
12147               <listitem>
12148                 <para>This preference enables the system administrator to choose which fields your
12149                   library doesn't need to see on the patron entry form. Enter field names separated
12150                   by | (bar).</para>
12151               </listitem>
12152             </itemizedlist>
12153             <important>
12154               <para>Separate columns with |</para>
12155             </important>
12156             <note>
12157               <para>For help with field names, ask your system administrator or <ulink
12158                   url="http://schema.koha-community.org/tables/borrowers.html">view the database
12159                   structure</ulink> associated with the borrowers table.</para>
12160             </note>
12161           </section>
12162           <section id="CardnumberLength">
12163             <title>CardnumberLength</title>
12164             <para>Asks: Card numbers for patrons must be ___ characters long. </para>
12165             <para>Description:<itemizedlist>
12166                 <listitem>
12167                   <para>The length can be a single number to specify an exact length, a range
12168                     separated by a comma (i.e., 'Min,Max'), or a maximum with no minimum (i.e.,
12169                     ',Max'). If 'cardnumber' is included in the <link
12170                       linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> list, the
12171                     minimum length, if not specified here, defaults to one. </para>
12172                 </listitem>
12173               </itemizedlist></para>
12174           </section>
12175           <section id="checkdigit">
12176             <title>checkdigit</title>
12177             <para>Default: Don't</para>
12178             <para>Asks: ___ check and construct borrower card numbers in the Katipo style.</para>
12179             <para>Values:</para>
12180             <itemizedlist>
12181               <listitem>
12182                 <para>Do</para>
12183               </listitem>
12184               <listitem>
12185                 <para>Don't</para>
12186               </listitem>
12187             </itemizedlist>
12188             <important>
12189               <para>This overrides <link linkend="autoMemberNum">autoMemberNum</link> if on.</para>
12190             </important>
12191           </section>
12192           <section id="EnableBorrowerFiles">
12193             <title>EnableBorrowerFiles</title>
12194             <para>Default: Don't</para>
12195             <para>Asks: ___ enable the ability to upload and attach arbitrary files to a borrower
12196               record.</para>
12197             <para>Values:</para>
12198             <itemizedlist>
12199               <listitem>
12200                 <para>Do</para>
12201               </listitem>
12202               <listitem>
12203                 <para>Don't</para>
12204               </listitem>
12205             </itemizedlist>
12206             <para>Description:</para>
12207             <itemizedlist>
12208               <listitem>
12209                 <para>When enabled this will add a 'Files' tab to the left of the patron detail page
12210                   where you can view and upload files to the patron record.</para>
12211               </listitem>
12212             </itemizedlist>
12213           </section>
12214           <section id="EnhancedMessagingPreferences">
12215             <title>EnhancedMessagingPreferences</title>
12216             <para>Default: Allow</para>
12217             <para>Asks: ___ patrons to choose which notices they receive and when they receive
12218               them.</para>
12219             <para>Values:</para>
12220             <itemizedlist>
12221               <listitem>
12222                 <para>Allow</para>
12223               </listitem>
12224               <listitem>
12225                 <para>Don't allow</para>
12226               </listitem>
12227             </itemizedlist>
12228             <important>
12229               <para>This only applies to certain kinds of notices, overdue notices will be sent
12230                 based on the library's rules, not the patron's choice.</para>
12231             </important>
12232             <para>Description:</para>
12233             <itemizedlist>
12234               <listitem>
12235                 <para>These messages are in addition to the overdue notices that the library sends.
12236                   The difference between these notices and overdues is that the patron can opt-in
12237                   and out of these. Setting this preference to 'Allow' will allow patrons to choose
12238                   to receive any one of the following messages:</para>
12239                 <itemizedlist>
12240                   <listitem>
12241                     <para>Item Checkout : A notice that lists all the of the items the patron has
12242                       just checked out and/or renewed, this is an electronic form of the checkout
12243                       receipt</para>
12244                   </listitem>
12245                   <listitem>
12246                     <para>Item Due : A notice on the day and item is due back at the library</para>
12247                   </listitem>
12248                   <listitem>
12249                     <para>Hold Filled : A notice when you have confirmed the hold is waiting for the
12250                       patron</para>
12251                   </listitem>
12252                   <listitem>
12253                     <para>Item Checkin : A notice that lists all the of the items the patron has
12254                       just checked in</para>
12255                   </listitem>
12256                   <listitem>
12257                     <para>Advanced Notice : A notice in advance of the patron's items being due (The
12258                       patron can choose the number of days in advance)</para>
12259                   </listitem>
12260                 </itemizedlist>
12261               </listitem>
12262             </itemizedlist>
12263           </section>
12264           <section id="ExtendedPatronAttributes">
12265             <title>ExtendedPatronAttributes</title>
12266             <para>Default: Enable</para>
12267             <para>Asks: ___ searching, editing and display of custom attributes on patrons.</para>
12268             <para>Values:</para>
12269             <itemizedlist>
12270               <listitem>
12271                 <para>Don't enable</para>
12272               </listitem>
12273               <listitem>
12274                 <para>Enable</para>
12275                 <itemizedlist>
12276                   <listitem>
12277                     <para>Define attributes in Koha administration</para>
12278                   </listitem>
12279                   <listitem>
12280                     <para>Get there: More &gt; Administration &gt; <link
12281                         linkend="patronattributetypes">Patron Attribute Types</link></para>
12282                   </listitem>
12283                 </itemizedlist>
12284               </listitem>
12285             </itemizedlist>
12286             <para>Description:</para>
12287             <itemizedlist>
12288               <listitem>
12289                 <para>Patron attributes are library-defined custom fields that can be applied to
12290                   patron records.</para>
12291               </listitem>
12292             </itemizedlist>
12293             <note>
12294               <para>Use custom attributes for fields that the default patron record does not support
12295                 such as driver's license number or student ID number.</para>
12296             </note>
12297           </section>
12298           <section id="intranetreadinghistory">
12299             <title>intranetreadinghistory</title>
12300             <para>Default: Allow</para>
12301             <para>Asks: ___ staff to access a patron's checkout history<important>
12302                 <para>If you have the <link linkend="OPACPrivacy">OPACPrivacy</link> preference set
12303                   to 'Allow' and the patron has decided to not have their history kept staff will
12304                   only see currently checked out items.</para>
12305               </important></para>
12306             <para>Values:</para>
12307             <itemizedlist>
12308               <listitem>
12309                 <para>Allow</para>
12310               </listitem>
12311               <listitem>
12312                 <para>Don't allow</para>
12313               </listitem>
12314             </itemizedlist>
12315             <important>
12316               <para>This data is stored in the system regardless of your choice.</para>
12317             </important>
12318           </section>
12319           <section id="MaxFine">
12320             <title>MaxFine</title>
12321             <para>Default: 9999</para>
12322             <para>Asks: The late fine for all checkouts will only go up to ___ USD.</para>
12323             <para>Description:</para>
12324             <itemizedlist>
12325               <listitem>
12326                 <para>This preference controls the default cap on fines accrued by the patron.
12327                   Leaving this preference blank means that there is no cap on the amount of fines a
12328                   patron can accrue. If you'd like, single item caps can be specified in the <link
12329                     linkend="circfinerules">circulation rules matrix</link>.</para>
12330               </listitem>
12331             </itemizedlist>
12332           </section>
12333           <section id="minPasswordLength">
12334             <title>minPasswordLength</title>
12335             <para>Default: 3</para>
12336             <para>Asks: Login passwords for staff and patrons must be at least ___ characters
12337               long.</para>
12338             <important>
12339               <para>This applies to both the staff login and the patron OPAC login.</para>
12340             </important>
12341           </section>
12342           <section id="NotifyBorrowerDeparture">
12343             <title>NotifyBorrowerDeparture</title>
12344             <para>Default: 30</para>
12345             <para>Asks: Show a notice that a patron is about to expire ___ days beforehand.</para>
12346             <para>Description:</para>
12347             <itemizedlist>
12348               <listitem>
12349                 <para>When the patron attempts to check out materials, a warning will appear in the
12350                   check out window of the Staff Client telling the librarian that the patrons
12351                   account is about to expire.</para>
12352               </listitem>
12353             </itemizedlist>
12354             <important>
12355               <para>This notice will appear on the patron's record in the staff client.</para>
12356             </important>
12357           </section>
12358           <section id="patronimages">
12359             <title>patronimages</title>
12360             <para>Default: Allow</para>
12361             <para>Asks: ___ images to be uploaded and shown for patrons on the staff client.</para>
12362             <para>Values:</para>
12363             <itemizedlist>
12364               <listitem>
12365                 <para>Allow</para>
12366               </listitem>
12367               <listitem>
12368                 <para>Don't allow</para>
12369               </listitem>
12370             </itemizedlist>
12371             <para>Description:<itemizedlist>
12372                 <listitem>
12373                   <para>If this preference is set to 'Allow' the staff will be able to upload images
12374                     of patrons either <link linkend="addpatronimages">one by one</link> or <link
12375                       linkend="uploadpatronimages">in bulk</link>. Patrons images will show on the
12376                     detail page to the left of the patron information. They can also show in the
12377                     OPAC if you set the <link linkend="OPACpatronimage">OPACpatronimage</link>
12378                     preference or in the self check out module if you set the <link
12379                       linkend="ShowPatronImageInWebBasedSelfCheck"
12380                       >ShowPatronImageInWebBasedSelfCheck</link> preference.</para>
12381                 </listitem>
12382               </itemizedlist></para>
12383           </section>
12384           <section id="PatronsPerPage">
12385             <title>PatronsPerPage</title>
12386             <para>Default: 20</para>
12387             <para>Asks: By default, show ___ results per page in the staff client.</para>
12388             <para>Description:<itemizedlist>
12389                 <listitem>
12390                   <para>This preference will let you define how many patrons to show on patron
12391                     search results pages.</para>
12392                 </listitem>
12393               </itemizedlist></para>
12394           </section>
12395           <section id="SMSSendDriver">
12396             <title>SMSSendDriver</title>
12397             <para>Asks: Use the SMS::Send:: ___ driver to send SMS messages.</para>
12398             <para>Some examples of values are:</para>
12399             <itemizedlist>
12400               <listitem>
12401                 <para>SMS::Send::Us::Ipipi</para>
12402               </listitem>
12403               <listitem>
12404                 <para>SMS::Send::US::TMobile</para>
12405               </listitem>
12406               <listitem>
12407                 <para>SMS::Send::US::Verizon</para>
12408               </listitem>
12409               <listitem>
12410                 <para>SMS::Send::IN::Unicel</para>
12411               </listitem>
12412             </itemizedlist>
12413             <para>Additional values can be found here: <ulink
12414                 url="http://search.cpan.org/search?query=sms%3A%3Asend&amp;mode=all"
12415                 >http://search.cpan.org/search?query=sms%3A%3Asend&amp;mode=all </ulink></para>
12416             <important>
12417               <para>Only drivers available as Perl modules will work in this preference, so make
12418                 sure a Perl module is available before choosing an SMS service.</para>
12419             </important>
12420             <para>Once a driver is entered in the preference an option will appear in the staff
12421               client and the OPAC on the patron messaging form to choose to receive messages as
12422               SMS</para>
12423             <screenshot>
12424               <screeninfo>SMSSendDriver Options</screeninfo>
12425               <mediaobject>
12426                 <imageobject>
12427                   <imagedata fileref="images/admin/globalprefs/SMSSendDriver.png"/>
12428                 </imageobject>
12429               </mediaobject>
12430             </screenshot>
12431             <important>
12432               <para>You must allow <link linkend="EnhancedMessagingPreferences"
12433                   >EnhancedMessagingPreferences</link> for this to work.</para>
12434             </important>
12435           </section>
12436           <section id="StatisticsFields">
12437             <title>StatisticsFields</title>
12438             <para>Default: location|itype|ccode</para>
12439             <para>Asks: Show the following fields from the items database table as columns on the
12440               statistics tab on the patron record: ___</para>
12441             <screenshot>
12442               <screeninfo>Statistics on Patron Record</screeninfo>
12443               <mediaobject>
12444                 <imageobject>
12445                   <imagedata fileref="images/admin/globalprefs/StatisticsFields.png"/>
12446                 </imageobject>
12447               </mediaobject>
12448             </screenshot>
12449             <important>
12450               <para>Enter the values separated by bars (|)</para>
12451             </important>
12452             <para>Description:</para>
12453             <itemizedlist>
12454               <listitem>
12455                 <para>This preference lets you set which fields will show on the patron record on
12456                   the Statistics tab.</para>
12457               </listitem>
12458             </itemizedlist>
12459           </section>
12460           <section id="TalkingTechItivaPhoneNotification">
12461             <title>TalkingTechItivaPhoneNotification</title>
12462             <para>Default: Disable</para>
12463             <para>Asks: ___ patron phone notifications using Talking Tech i-tiva (overdues, predues
12464               and holds notices currently supported).</para>
12465             <para>Values:</para>
12466             <itemizedlist>
12467               <listitem>
12468                 <para>Disable</para>
12469               </listitem>
12470               <listitem>
12471                 <para>Enable</para>
12472               </listitem>
12473             </itemizedlist>
12474             <para>Description:</para>
12475             <itemizedlist>
12476               <listitem>
12477                 <para>To learn more about setting up this third party product view the <link
12478                     linkend="talkingtechappendix">Talking Tech Appendix</link>.</para>
12479               </listitem>
12480             </itemizedlist>
12481             <important>
12482               <para>Requires that you have <link linkend="EnhancedMessagingPreferences"
12483                   >EnhancedMessagingPreferences</link> set to Allow to use.</para>
12484             </important>
12485           </section>
12486           <section id="uppercasesurnames">
12487             <title>uppercasesurnames</title>
12488             <para>Default: Don't</para>
12489             <para>Asks: ___ store and display surnames (last names) in upper case.</para>
12490             <para>Values:</para>
12491             <itemizedlist>
12492               <listitem>
12493                 <para>Do</para>
12494               </listitem>
12495               <listitem>
12496                 <para>Don't</para>
12497               </listitem>
12498             </itemizedlist>
12499           </section>
12500         </section>
12501         <section id="norwegianpref">
12502           <title>Norwegian patron database</title>
12503           <section id="NorwegianPatronDBEnable">
12504             <title>NorwegianPatronDBEnable &amp; NorwegianPatronDBEndpoint</title>
12505             <para>NorwegianPatronDBEnable Default: Disable</para>
12506             <para>Asks: ___ the ability to communicate with the Norwegian national patron database
12507               via the ___ endpoint. </para>
12508             <para>Values:<itemizedlist>
12509                 <listitem>
12510                   <para>Disable</para>
12511                 </listitem>
12512                 <listitem>
12513                   <para>Enable</para>
12514                 </listitem>
12515               </itemizedlist></para>
12516           </section>
12517           <section id="NorwegianPatronDBSearchNLAfterLocalHit">
12518             <title>NorwegianPatronDBSearchNLAfterLocalHit</title>
12519             <para>Default: Don't</para>
12520             <para>Asks: ___ search the Norwegian national patron database after a local search
12521               result was found.</para>
12522             <para>Values:</para>
12523             <itemizedlist>
12524               <listitem>
12525                 <para>Do</para>
12526               </listitem>
12527               <listitem>
12528                 <para>Don't</para>
12529               </listitem>
12530             </itemizedlist>
12531           </section>
12532           <section id="NorwegianPatronDBUsername">
12533             <title>NorwegianPatronDBUsername &amp; NorwegianPatronDBPassword</title>
12534             <para>Asks: Communicate with the Norwegian national patron database using the username
12535               ___ and the password ___. </para>
12536             <para>Description:<itemizedlist>
12537                 <listitem>
12538                   <para>You can get these from "Base Bibliotek", which is maintained by the
12539                     Norwegian National Library. </para>
12540                 </listitem>
12541               </itemizedlist></para>
12542           </section>
12543         </section>
12544       </section>
12545
12546       <section id="searchingprefs">
12547         <title>Searching</title>
12548
12549         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
12550         Global System Preferences &gt; Searching</para>
12551
12552         <section id="searchfeatureprefs">
12553           <title>Features</title>
12554
12555           <para/>
12556           <section id="EnableSearchHistory">
12557             <title>EnableSearchHistory</title>
12558             <para>Default: Don't keep</para>
12559             <para>Asks: ___ patron search history in the staff client.</para>
12560             <para>Values:<itemizedlist>
12561                 <listitem>
12562                   <para>Don't keep</para>
12563                 </listitem>
12564                 <listitem>
12565                   <para>Keep<screenshot>
12566                       <screeninfo>EnableSearchHistory</screeninfo>
12567                       <mediaobject>
12568                         <imageobject>
12569                           <imagedata fileref="images/admin/globalprefs/EnableSearchHistory.png"/>
12570                         </imageobject>
12571                       </mediaobject>
12572                     </screenshot></para>
12573                 </listitem>
12574               </itemizedlist>Description:<itemizedlist>
12575                 <listitem>
12576                   <para>This preference controls whether the staff client keeps search history for
12577                     logged in users. Search history will be accessible under the link to your
12578                     account in the top right of the staff client.</para>
12579                 </listitem>
12580               </itemizedlist></para>
12581           </section>
12582           <section id="IncludeSeeFromInSearches">
12583             <title>IncludeSeeFromInSearches</title>
12584             <para>Default: Don't include</para>
12585             <para>Asks: ___  <emphasis role="italic">see from</emphasis> (non-preferred form)
12586               headings in bibliographic searches. </para>
12587             <para>Values:<itemizedlist>
12588                 <listitem>
12589                   <para>Don't include</para>
12590                 </listitem>
12591                 <listitem>
12592                   <para>Include</para>
12593                 </listitem>
12594               </itemizedlist></para>
12595             <para>Description: <itemizedlist>
12596                 <listitem>
12597                   <para>When this preference is set to include the search engine indexer will insert
12598                       <emphasis role="italic">see from</emphasis> headings from authority records
12599                     into bibliographic records when indexing, so that a search on an obsolete term
12600                     will turn up relevant records.  For example when you search for cookery (the old
12601                     term) you get titles with the heading of cooking (the new term).</para>
12602                 </listitem>
12603               </itemizedlist><important>
12604                 <para>You will need to reindex your bibliographic database when changing this
12605                   preference. </para>
12606               </important></para>
12607           </section>
12608
12609           <section id="OpacGroupResults">
12610             <title>OpacGroupResults</title>
12611
12612             <para>Default: Don't use</para>
12613
12614             <para>Asks: ___ PazPar2 to group similar results on the
12615             OPAC.</para>
12616
12617             <para>Values:</para>
12618
12619             <itemizedlist>
12620               <listitem>
12621                 <para>Don't use</para>
12622               </listitem>
12623
12624               <listitem>
12625                 <para>Use</para>
12626               </listitem>
12627             </itemizedlist>
12628
12629             <important>
12630               <para>This requires that <ulink url="http://www.indexdata.com/pazpar2">PazPar2</ulink> is set up
12631               and running.</para>
12632             </important>
12633           </section>
12634
12635           <section id="QueryAutoTruncate">
12636             <title>QueryAutoTruncate</title>
12637
12638             <para>Default: automatically</para>
12639
12640             <para>Asks: Perform wildcard searching (where, for example, Har
12641             would match Harry and harp) ___ (The * character would be used
12642             like so: Har* or *logging.)</para>
12643
12644             <para>Values:</para>
12645
12646             <itemizedlist>
12647               <listitem>
12648                 <para>automatically</para>
12649               </listitem>
12650
12651               <listitem>
12652                 <para>only if * is added</para>
12653               </listitem>
12654             </itemizedlist>
12655
12656             <para>Description:</para>
12657
12658             <itemizedlist>
12659               <listitem>
12660                 <para>This setting allows for searches to be automatically
12661                 truncated or for additional characters to be added to the end
12662                 of a search string. When set to "automatically" the search
12663                 string automatically ends with a wildcard function. For
12664                 example, a search for the word "invent" with auto truncation
12665                 enabled will also retrieve results for inventor, invention,
12666                 inventory, etc. If you don't want this to happen automatically
12667                 you can still be perform wildcard searches manually by adding
12668                 an asterisk (*). Typing "invent*" even with auto truncation
12669                 disabled will retrieve the same inventor, invention, inventory
12670                 results. Auto truncation bypasses the necessity to type long
12671                 search strings in their entirety.</para>
12672               </listitem>
12673             </itemizedlist>
12674           </section>
12675
12676           <section id="QueryFuzzy">
12677             <title>QueryFuzzy</title>
12678
12679             <para>Default: Try</para>
12680
12681             <para>Asks: ___ to match similarly spelled words in a search (for
12682             example, a search for flang would also match flange and
12683             fang)</para>
12684
12685             <para>Values:</para>
12686
12687             <itemizedlist>
12688               <listitem>
12689                 <para>Don't try</para>
12690               </listitem>
12691
12692               <listitem>
12693                 <para>Try</para>
12694               </listitem>
12695             </itemizedlist>
12696
12697             <para>Description:</para>
12698
12699             <itemizedlist>
12700               <listitem>
12701                 <para>This preference enables "fuzzy" searching, in which the
12702                 search engine returns results that are similar to, but not
12703                 exactly matching, the word or words entered by the user. This
12704                 preference enables the search function to compensate for
12705                 slightly misspelled names or phrases.</para>
12706               </listitem>
12707             </itemizedlist>
12708
12709             <important>
12710               <para>Requires that <link linkend="UseICU">UseICU</link> set to 'Not using'</para>
12711             </important>
12712           </section>
12713
12714           <section id="QueryStemming">
12715             <title>QueryStemming</title>
12716
12717             <para>Default: Try</para>
12718
12719             <para>Asks: ___ to match words of the same base in a search</para>
12720
12721             <para>Values:</para>
12722
12723             <itemizedlist>
12724               <listitem>
12725                 <para>Don't try</para>
12726               </listitem>
12727
12728               <listitem>
12729                 <para>Try</para>
12730
12731                 <itemizedlist>
12732                   <listitem>
12733                     <para>A search for enabling would also match enable and
12734                     enabled</para>
12735                   </listitem>
12736                 </itemizedlist>
12737               </listitem>
12738             </itemizedlist>
12739
12740             <para>Description:</para>
12741
12742             <itemizedlist>
12743               <listitem>
12744                 <para>This preference enables word stemming. Stemming allows
12745                 the search function to return multiple versions of the same
12746                 word, as well as related terms (i.e., both fish and fishing
12747                 would be returned).</para>
12748               </listitem>
12749             </itemizedlist>
12750           </section>
12751
12752           <section id="QueryWeightFields">
12753             <title>QueryWeightFields</title>
12754
12755             <para>Default: Enable</para>
12756
12757             <para>Asks: ___ ranking of search results by relevance</para>
12758
12759             <para>Values:</para>
12760
12761             <itemizedlist>
12762               <listitem>
12763                 <para>Disable</para>
12764               </listitem>
12765
12766               <listitem>
12767                 <para>Enable</para>
12768               </listitem>
12769             </itemizedlist>
12770           </section>
12771
12772           <section id="TraceCompleteSubfields">
12773             <title>TraceCompleteSubfields</title>
12774
12775             <para>Default: Force</para>
12776
12777             <para>Asks: ___ subject tracings in the OPAC and Staff Client to
12778             search only for complete-subfield matches.</para>
12779
12780             <para>Values:</para>
12781
12782             <itemizedlist>
12783               <listitem>
12784                 <para>Don't force</para>
12785
12786                 <itemizedlist>
12787                   <listitem>
12788                     <para>Searches for subject keywords (example:
12789                     opac-search.pl?q=su:World%20Wide%20Web)</para>
12790                   </listitem>
12791                 </itemizedlist>
12792               </listitem>
12793
12794               <listitem>
12795                 <para>Force</para>
12796
12797                 <itemizedlist>
12798                   <listitem>
12799                     <para>Searches for complete subject fields (example:
12800                     opac-search.pl?q=su,complete-subfield:World%20Wide%20Web)</para>
12801                   </listitem>
12802                 </itemizedlist>
12803               </listitem>
12804             </itemizedlist>
12805
12806             <para>Description:</para>
12807
12808             <itemizedlist>
12809               <listitem>
12810                 <para>When TraceCompleteSubfields is set to "force," clicking
12811                 on links in non-authority controlled subject tracings will
12812                 only find other records where the entire subfields match.
12813                 Leaving it at "don't force" does a keyword search of the
12814                 subject indexes.</para>
12815               </listitem>
12816             </itemizedlist>
12817
12818             <important>
12819               <para>This preference assumes that you're using XSLT stylesheets
12820               as set in the <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
12821               preference.</para>
12822             </important>
12823           </section>
12824
12825           <section id="TraceSubjectSubdivisions">
12826             <title>TraceSubjectSubdivisions</title>
12827
12828             <para>Default: Include</para>
12829
12830             <para>Asks: ___ subdivisions for searches generated by clicking on
12831             subject tracings.</para>
12832
12833             <para>Values:</para>
12834
12835             <itemizedlist>
12836               <listitem>
12837                 <para>Don't include</para>
12838
12839                 <itemizedlist>
12840                   <listitem>
12841                     <para>Searches for subject keywords (example:
12842                     opac-search.pl?q=su,complete-subfield:%22Web%20sites%22)</para>
12843                   </listitem>
12844                 </itemizedlist>
12845               </listitem>
12846
12847               <listitem>
12848                 <para>Include</para>
12849
12850                 <itemizedlist>
12851                   <listitem>
12852                     <para>Searches for complete subject fields (example:
12853                     opac-search.pl?q=(su,complete-subfield:%22Web%20sites%22)%20and%20(su,complete-subfield:%22Design.%22))</para>
12854                   </listitem>
12855                 </itemizedlist>
12856               </listitem>
12857             </itemizedlist>
12858
12859             <para>Description:</para>
12860
12861             <itemizedlist>
12862               <listitem>
12863                 <para>When TraceSubjectSubdivisions is set to "Include," if
12864                 you click on a subject with subdivisions (subfields other than
12865                 'a') they will be searched along with the subject heading
12866                 (subfield 'a'). To have only the subject heading (subfield
12867                 'a') searched, set this preference to "Don't include."</para>
12868               </listitem>
12869             </itemizedlist>
12870
12871             <important>
12872               <para>This preference assumes that you're using XSLT stylesheets
12873               as set in the <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
12874               preference.</para>
12875             </important>
12876           </section>
12877
12878           <section id="UseICU">
12879             <title>UseICU</title>
12880
12881             <para>Default: Not using</para>
12882
12883             <para>Asks: ___ ICU Zebra indexing.</para>
12884
12885             <para>Values:</para>
12886
12887             <itemizedlist>
12888               <listitem>
12889                 <para>Not using</para>
12890               </listitem>
12891
12892               <listitem>
12893                 <para>Using</para>
12894               </listitem>
12895             </itemizedlist>
12896
12897             <para>Description:</para>
12898
12899             <itemizedlist>
12900               <listitem>
12901                 <para>ICU is a set of code libraries providing Unicode and
12902                 Globalization support for software applications. What this
12903                 means is ICU Zebra indexing is only necessary if you use
12904                 non-roman characters in your cataloging. If using ICU Zebra
12905                 indexing you will want to not use <link linkend="QueryFuzzy">QueryFuzzy</link>.</para>
12906               </listitem>
12907             </itemizedlist>
12908
12909             <important>
12910               <para>This setting will not affect Zebra indexing, it should
12911               only be used to tell Koha that you have activated ICU indexing
12912               if you have actually done so, since there is no way for Koha to
12913               figure this out on its own.</para>
12914             </important>
12915
12916             <important>
12917               <para>Talk to your system administrator when changing this
12918               preference to make sure that your system is set up properly for
12919               this to work.</para>
12920             </important>
12921           </section>
12922           <section id="UseQueryParser">
12923             <title>UseQueryParser</title>
12924             <para>Default: Do not try</para>
12925             <para>Asks: ___  to use the QueryParser module for parsing queries. <note>
12926                 <para>Enabling this will have no impact if you do not have QueryParser installed,
12927                   and everything will continue to work as usual.</para>
12928               </note></para>
12929             <para>Values:<itemizedlist>
12930                 <listitem>
12931                   <para>Do not try</para>
12932                 </listitem>
12933                 <listitem>
12934                   <para>Try</para>
12935                 </listitem>
12936               </itemizedlist></para>
12937             <para>Description:<itemizedlist>
12938                 <listitem>
12939                   <para>This preference enables an experimental new query parser which opens the
12940                     door for a more expressive and more-effective search syntax.</para>
12941                 </listitem>
12942               </itemizedlist></para>
12943           </section>
12944         </section>
12945
12946         <section id="searchresultsprefs">
12947           <title>Results Display</title>
12948
12949           <para/>
12950
12951           <section id="defaultSortField">
12952             <title>defaultSortField &amp; defaultSortOrder</title>
12953
12954             <para>defaultSortField Default: author</para>
12955
12956             <para>defaultSortOrder Default: ascending</para>
12957
12958             <para>Asks: By default, sort search results in the staff client by
12959             ___, ____</para>
12960
12961             <para>Description:</para>
12962
12963             <itemizedlist>
12964               <listitem>
12965                 <para>These preferences set the default sort field and sort
12966                 order for searches on the staff side. Regardless of your
12967                 choice, the other sort options are still available in the drop
12968                 down list on the advanced search page.</para>
12969               </listitem>
12970             </itemizedlist>
12971
12972             <para>defaultSortField Values:</para>
12973
12974             <itemizedlist>
12975               <listitem>
12976                 <para>author</para>
12977               </listitem>
12978
12979               <listitem>
12980                 <para>call number</para>
12981               </listitem>
12982
12983               <listitem>
12984                 <para>date added</para>
12985               </listitem>
12986
12987               <listitem>
12988                 <para>date of publication</para>
12989               </listitem>
12990
12991               <listitem>
12992                 <para>relevance</para>
12993               </listitem>
12994
12995               <listitem>
12996                 <para>title</para>
12997               </listitem>
12998
12999               <listitem>
13000                 <para>total number of checkouts</para>
13001               </listitem>
13002             </itemizedlist>
13003
13004             <para>defaultSortOrder Values:</para>
13005
13006             <itemizedlist>
13007               <listitem>
13008                 <para>ascending</para>
13009               </listitem>
13010
13011               <listitem>
13012                 <para>descending</para>
13013               </listitem>
13014
13015               <listitem>
13016                 <para>from A to Z</para>
13017               </listitem>
13018
13019               <listitem>
13020                 <para>from Z to A</para>
13021               </listitem>
13022             </itemizedlist>
13023           </section>
13024
13025           <section id="displayFacetCount">
13026             <title>displayFacetCount</title>
13027
13028             <para>Default: Don't show</para>
13029
13030             <para>Asks: ___ facet counts.</para>
13031
13032             <para>Description:</para>
13033
13034             <itemizedlist>
13035               <listitem>
13036                 <para>This preference lets you decide if you show how many
13037                 times a facet is used in your search results in the OPAC and
13038                 the staff client. The relevance of these numbers highly
13039                 depends on the value of the <link linkend="maxRecordsForFacets">maxRecordsForFacets</link>
13040                 preference. Showing these numbers can potentially effect the
13041                 performance of your searching, so test your system with
13042                 different values for this preference to see what works
13043                 best.</para>
13044               </listitem>
13045             </itemizedlist>
13046
13047             <para>Values:</para>
13048
13049             <itemizedlist>
13050               <listitem>
13051                 <para>Don't show</para>
13052               </listitem>
13053
13054               <listitem>
13055                 <para>Show</para>
13056
13057                 <screenshot>
13058                   <screeninfo>Number of times each Facet is found in
13059                   results</screeninfo>
13060
13061                   <mediaobject>
13062                     <imageobject>
13063                       <imagedata fileref="images/admin/globalprefs/displayFacetCount.png"/>
13064                     </imageobject>
13065                   </mediaobject>
13066                 </screenshot>
13067               </listitem>
13068             </itemizedlist>
13069           </section>
13070           <section id="DisplayLibraryFacets">
13071             <title>DisplayLibraryFacets</title>
13072             <para>Default: holding library</para>
13073             <para>Asks: Show facets for ___</para>
13074             <para>Values:<itemizedlist>
13075                 <listitem>
13076                   <para>both home and holding library</para>
13077                 </listitem>
13078                 <listitem>
13079                   <para>holding library</para>
13080                 </listitem>
13081                 <listitem>
13082                   <para>home library</para>
13083                 </listitem>
13084               </itemizedlist></para>
13085             <para>Description:<itemizedlist>
13086                 <listitem>
13087                   <para>This preferenc controls the libraries facet that displays on search results
13088                     in the staff and opac.  The value selected here will determin which library(s)
13089                     show in the facets when a search is run.</para>
13090                 </listitem>
13091               </itemizedlist></para>
13092           </section>
13093
13094           <section id="FacetLabelTruncationLength">
13095             <title>FacetLabelTruncationLength</title>
13096
13097             <para>Default: 20</para>
13098
13099             <para>Asks: Truncate facets length to ___ characters, in
13100             OPAC/staff interface.</para>
13101
13102             <para>Description:</para>
13103
13104             <itemizedlist>
13105               <listitem>
13106                 <para>In the OPAC and the staff client your facets are cut off
13107                 at 20 characters by default. Depending on your layout this may
13108                 be too many or two few letters, this preference lets you
13109                 decide what number is best for your library's design.</para>
13110               </listitem>
13111             </itemizedlist>
13112           </section>
13113           <section id="FacetMaxCount">
13114             <title>FacetMaxCount</title>
13115             <para>Default: 20</para>
13116             <para>Asks: Show up ___ to facets for each category.</para>
13117             <para>Description:<itemizedlist>
13118                 <listitem>
13119                   <para>This preference allows you to control how many possible limits show under
13120                     each heading (Author, Series, Topics, etc) on the facets in the OPAC.</para>
13121                 </listitem>
13122               </itemizedlist></para>
13123           </section>
13124
13125           <section id="maxItemsInSearchResults">
13126             <title>maxItemsInSearchResults</title>
13127
13128             <para>Default: 20</para>
13129
13130             <para>Asks: Show up to ___ items per biblio in the search
13131             results</para>
13132
13133             <para>Description:</para>
13134
13135             <itemizedlist>
13136               <listitem>
13137                 <para>This preference will let you set how many results
13138                 display by default when a search is run on the Staff
13139                 Client.</para>
13140               </listitem>
13141             </itemizedlist>
13142           </section>
13143
13144           <section id="maxRecordsForFacets">
13145             <title>maxRecordsForFacets</title>
13146
13147             <para>Default: 20</para>
13148
13149             <para>Asks: Build facets based on ___ records from the search
13150             results.</para>
13151
13152             <para>Description:</para>
13153
13154             <itemizedlist>
13155               <listitem>
13156                 <para>By default Koha only bases facets on the first page of
13157                 results (usually 20 results). This preference lets you tell
13158                 Koha to based the facet descriptions and numbers on any number
13159                 of search results returned. The higher this number the longer
13160                 it will take for your search results to return, so test with
13161                 various different values to find the best balance for your
13162                 library.</para>
13163               </listitem>
13164             </itemizedlist>
13165           </section>
13166
13167           <section id="numSearchResults">
13168             <title>numSearchResults</title>
13169
13170             <para>Default: 20</para>
13171
13172             <para>Asks: By default, show ___ results per page in the staff
13173             client.</para>
13174           </section>
13175
13176           <section id="opacdefaultsort">
13177             <title>OPACdefaultSortField &amp; OPACdefaultSortOrder</title>
13178
13179             <para>OPACdefaultSortField Default: relevance</para>
13180
13181             <para>OPACdefaultSortOrder Default: ascending</para>
13182
13183             <para>Asks: By default, sort search results in the OPAC by ___,
13184             ___</para>
13185
13186             <para>Description:</para>
13187
13188             <itemizedlist>
13189               <listitem>
13190                 <para>These preferences set the default sort field and sort
13191                 order for searches on the OPAC. Regardless of your choice, the
13192                 other sort options are still available in the drop down list
13193                 on the advanced search page.</para>
13194               </listitem>
13195             </itemizedlist>
13196
13197             <para>OPACdefaultSortField Values:</para>
13198
13199             <itemizedlist>
13200               <listitem>
13201                 <para>author</para>
13202               </listitem>
13203
13204               <listitem>
13205                 <para>call number</para>
13206               </listitem>
13207
13208               <listitem>
13209                 <para>date added</para>
13210               </listitem>
13211
13212               <listitem>
13213                 <para>date of publication</para>
13214               </listitem>
13215
13216               <listitem>
13217                 <para>relevance</para>
13218               </listitem>
13219
13220               <listitem>
13221                 <para>title</para>
13222               </listitem>
13223
13224               <listitem>
13225                 <para>total number of checkouts</para>
13226               </listitem>
13227             </itemizedlist>
13228
13229             <para>OPACdefaultSortOrder Values:</para>
13230
13231             <itemizedlist>
13232               <listitem>
13233                 <para>ascending</para>
13234               </listitem>
13235
13236               <listitem>
13237                 <para>descending</para>
13238               </listitem>
13239
13240               <listitem>
13241                 <para>from A to Z</para>
13242               </listitem>
13243
13244               <listitem>
13245                 <para>from Z to A</para>
13246               </listitem>
13247             </itemizedlist>
13248           </section>
13249
13250           <section id="OPACItemsResultsDisplay">
13251             <title>OPACItemsResultsDisplay</title>
13252
13253             <para>Default: Don't show</para>
13254
13255             <para>Asks: ___ an item's branch, location and call number in OPAC
13256             search results.</para>
13257
13258             <para>Values:</para>
13259
13260             <itemizedlist>
13261               <listitem>
13262                 <para>Don't show</para>
13263               </listitem>
13264
13265               <listitem>
13266                 <para>Show</para>
13267               </listitem>
13268             </itemizedlist>
13269
13270             <para>Description:</para>
13271
13272             <itemizedlist>
13273               <listitem>
13274                 <para>This setting selects the information about an item that
13275                 will display in the search results page of the OPAC. The
13276                 results can display the status of an item and/or full details
13277                 including branch, location, and call number. While the 'Show'
13278                 option allows for more information to be displayed on the
13279                 search results page, the information can be overwhelming for
13280                 large collections with multiple branches.</para>
13281               </listitem>
13282             </itemizedlist>
13283           </section>
13284
13285           <section id="OPACnumSearchResults">
13286             <title>OPACnumSearchResults</title>
13287
13288             <para>Default: 20</para>
13289
13290             <para>Asks: By default, show ___ results per page in the
13291             OPAC.</para>
13292           </section>
13293           <section id="SearchWithISBNVariations">
13294             <title>SearchWithISBNVariations</title>
13295             <para>Default: don't search</para>
13296             <para>Asks: When searching on the ISBN index, ___ on all variations of the ISBN.</para>
13297             <para>Values:<itemizedlist>
13298                 <listitem>
13299                   <para>don't search</para>
13300                 </listitem>
13301                 <listitem>
13302                   <para>search</para>
13303                 </listitem>
13304               </itemizedlist> Descriptions:<itemizedlist>
13305                 <listitem>
13306                   <para>With this preference set to search you'll be able to search for ISBNs even
13307                     if there are dashes or spaces in the field.  So if you search for 9781843345855
13308                     but the ISBN was cataloged as 978-1843345855 you'll still be able to find it if
13309                     this preference is set to 'search'.</para>
13310                 </listitem>
13311               </itemizedlist><important>
13312                 <para>This preference has no effect if <link linkend="UseQueryParser"
13313                     >UseQueryParser</link> is on</para>
13314               </important></para>
13315           </section>
13316         </section>
13317
13318         <section id="searchformprefs">
13319           <title>Search Form</title>
13320           <section id="AdvancedSearchLanguages">
13321             <title>AdvancedSearchLanguages</title>
13322             <para>Asks: Limit the languages listed in the advanced search drop-down to the ___ ISO
13323               639-2 language codes (separate values with | or ,).</para>
13324             <para>Description:<itemizedlist>
13325                 <listitem>
13326                   <para>This preference will allow you to decide what languages show in the pull
13327                     down menu on the advanced search page in the OPAC and the staff client.  If this
13328                     preference is left blank, all languages will show. To limit the languages that
13329                     are shown enter their <ulink
13330                       url="http://www.loc.gov/standards/iso639-2/php/code_list.php">ISO 639-2
13331                       language codes</ulink> separated by comma ( , ) or bar ( | ).  For example to
13332                     limit listing to French and Italian, enter ita|fre. </para>
13333                 </listitem>
13334               </itemizedlist></para>
13335           </section>
13336
13337           <section id="AdvancedSearchTypes">
13338             <title>AdvancedSearchTypes</title>
13339
13340             <para>Default: itemtype</para>
13341
13342             <para>Asks: Show tabs in OPAC and staff-side advanced search for
13343             limiting searches on the ___ fields (separate values with
13344             |).</para>
13345
13346             <para>Description:</para>
13347
13348             <itemizedlist>
13349               <listitem>
13350                 <para>On the advanced search page you can choose to allow
13351                 filters on one or all of the following: Item types
13352                 (itemtypes), Collection Codes (ccode) and Shelving Location
13353                 (loc). If you would like to be able to limit searches on item
13354                 type and shelving location for example you would enter
13355                 itemtypes|loc in the preference input box. The order of these
13356                 fields will determine the order of the tabs in the OPAC and
13357                 staff client advanced search screens. Values within the search
13358                 type are OR'ed together, while each different search type is
13359                 AND'ed together in the query limits. The current stored values
13360                 are supported without any required modification.Each set of
13361                 advanced search fields are displayed in tabs in both the OPAC
13362                 and staff client. The first value in the AdvancedSearchTypes
13363                 syspref is the selected tab; if no values are present,
13364                 "itemtypes" is used. For non-itemtype values, the value in
13365                 AdvancedSearchTypes must match the Authorised Value name, and
13366                 must be indexed with 'mc-' prefixing that name.</para>
13367
13368                 <screenshot>
13369                   <screeninfo>Searching by Item Type and Shelving
13370                   Location</screeninfo>
13371
13372                   <mediaobject>
13373                     <imageobject>
13374                       <imagedata fileref="images/admin/globalprefs/AdvancedSearchTypes.png"/>
13375                     </imageobject>
13376                   </mediaobject>
13377                 </screenshot>
13378               </listitem>
13379             </itemizedlist>
13380           </section>
13381
13382           <section id="expandedSearchOption">
13383             <title>expandedSearchOption</title>
13384
13385             <para>Default: don't show</para>
13386
13387             <para>Asks: By default, ___ "More options" on the OPAC and staff
13388             advanced search pages.</para>
13389
13390             <para>Values:</para>
13391
13392             <itemizedlist>
13393               <listitem>
13394                 <para>don't show</para>
13395               </listitem>
13396
13397               <listitem>
13398                 <para>show</para>
13399               </listitem>
13400             </itemizedlist>
13401           </section>
13402           <section id="IntranetNumbersPreferPhrase">
13403             <title>IntranetNumbersPreferPhrase</title>
13404             <para>Default: don't use</para>
13405             <para>Asks: By default, ___ the operator "phr" in the callnumber and standard number
13406               staff client searches </para>
13407             <para>Values:<itemizedlist>
13408                 <listitem>
13409                   <para>don't use</para>
13410                 </listitem>
13411                 <listitem>
13412                   <para>use</para>
13413                 </listitem>
13414               </itemizedlist></para>
13415             <para>Description:<itemizedlist>
13416                 <listitem>
13417                   <para>When searching by call number and standard number (biblionumber) in Koha
13418                     Staff Client you can choose to force the search to be a phrase search by setting
13419                     this preference to 'use.' This will allow for more accurate results over doing a
13420                     general keyword field search.</para>
13421                 </listitem>
13422               </itemizedlist></para>
13423           </section>
13424           <section id="OPACNumbersPreferPhrase">
13425             <title>OPACNumbersPreferPhrase</title>
13426             <para>Default: don't use</para>
13427             <para>Asks: By default, ___ the operator "phr" in the callnumber and standard number
13428               OPAC searches </para>
13429             <para>Values:<itemizedlist>
13430                 <listitem>
13431                   <para>don't use</para>
13432                 </listitem>
13433                 <listitem>
13434                   <para>use</para>
13435                 </listitem>
13436               </itemizedlist></para>
13437             <para>Description:<itemizedlist>
13438                 <listitem>
13439                   <para>When searching by call number and standard number (biblionumber) in the Koha
13440                     OPAC you can choose to force the search to be a phrase search by setting this
13441                     preference to 'use.' This will allow for more accurate results over doing a
13442                     general keyword field search.</para>
13443                 </listitem>
13444               </itemizedlist></para>
13445           </section>
13446         </section>
13447       </section>
13448
13449       <section id="serialsprefs">
13450         <title>Serials</title>
13451
13452         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
13453         Global System Preferences &gt; Serials</para>
13454
13455         <section id="opacSerialDefaultTab">
13456           <title>opacSerialDefaultTab</title>
13457
13458           <para>Default: Subscriptions tab</para>
13459
13460           <para>Asks: Show ___ as default tab for serials in OPAC. </para>
13461
13462           <para>Values:</para>
13463
13464           <itemizedlist>
13465             <listitem>
13466               <para>Holdings tab</para>
13467             </listitem>
13468
13469             <listitem>
13470               <para>Serial Collection tab</para>
13471               <important>
13472                 <para>Please note that the Serial Collection tab is currently available only for
13473                   systems using the UNIMARC standard.</para>
13474               </important>
13475               <screenshot>
13476                 <screeninfo>Serial Collection tab</screeninfo>
13477                 <mediaobject>
13478                   <imageobject>
13479                     <imagedata fileref="images/admin/globalprefs/opacSerialDefaultTab-colltab.png"/>
13480                   </imageobject>
13481                 </mediaobject>
13482               </screenshot>
13483             </listitem>
13484
13485             <listitem>
13486               <para>Subscriptions tab</para>
13487               <screenshot>
13488                   <screeninfo>Subscritions tab</screeninfo>
13489                   <mediaobject>
13490                     <imageobject>
13491                       <imagedata fileref="images/admin/globalprefs/opacSerialDefaultTab-subtab.png"
13492                       />
13493                     </imageobject>
13494                   </mediaobject>
13495                 </screenshot>
13496             </listitem>
13497           </itemizedlist>
13498         </section>
13499
13500         <section id="OPACSerialIssueDisplayCount">
13501           <title>OPACSerialIssueDisplayCount</title>
13502
13503           <para>Default: 3</para>
13504
13505           <para>Asks: Show the ___ previous issues of a serial on the
13506           OPAC.</para>
13507
13508           <para>Description:</para>
13509
13510           <itemizedlist>
13511             <listitem>
13512               <para>This preference allows the administrator to select the
13513               number of recent issues for each serial which appear in the OPAC
13514               when the serial is accessed. This is just the default value,
13515               patrons can always click to see a full list of serials.</para>
13516             </listitem>
13517           </itemizedlist>
13518         </section>
13519
13520         <section id="RenewSerialAddsSuggestion">
13521           <title>RenewSerialAddsSuggestion</title>
13522
13523           <para>Default: Don't add</para>
13524
13525           <para>Asks: ___ a suggestion for a biblio when its attached serial
13526           is renewed.</para>
13527
13528           <para>Values:</para>
13529
13530           <itemizedlist>
13531             <listitem>
13532               <para>Add</para>
13533             </listitem>
13534
13535             <listitem>
13536               <para>Don't add</para>
13537             </listitem>
13538           </itemizedlist>
13539
13540           <para>Description:</para>
13541
13542           <itemizedlist>
13543             <listitem>
13544               <para>If set to "Add", this preference will automatically add a
13545               serial to the Acquisitions Purchase Suggestions menu when
13546               clicking the 'renew' option. If you don't use the Acquisitions
13547               module to manage serials purchases it's best to leave this set
13548               as 'Don't add.'</para>
13549             </listitem>
13550           </itemizedlist>
13551         </section>
13552
13553         <section id="RoutingListAddReserves">
13554           <title>RoutingListAddReserves</title>
13555
13556           <para>Default: Place</para>
13557
13558           <para>Asks: ___ received serials on hold if they are on a routing
13559           list.</para>
13560
13561           <para>Values:</para>
13562
13563           <itemizedlist>
13564             <listitem>
13565               <para>Place</para>
13566             </listitem>
13567
13568             <listitem>
13569               <para>Don't place</para>
13570             </listitem>
13571           </itemizedlist>
13572         </section>
13573
13574         <section id="RoutingListNote">
13575           <title>RoutingListNote</title>
13576
13577           <para>Asks: Include following note on all routing lists</para>
13578
13579           <para>Description:</para>
13580
13581           <itemizedlist>
13582             <listitem>
13583               <para>Text entered in this box will appear below the routing
13584               list information.</para>
13585             </listitem>
13586           </itemizedlist>
13587         </section>
13588
13589         <section id="RoutingSerials">
13590           <title>RoutingSerials</title>
13591
13592           <para>Default: Don't add</para>
13593
13594           <para>Asks: ___ received serials to the routing list.</para>
13595
13596           <para>Description:</para>
13597
13598           <itemizedlist>
13599             <listitem>
13600               <para>This preference determines if serials routing lists are
13601               enabled or disabled for the library. When set to "Add", serials
13602               routing is enabled and a serial can be directed through a list
13603               of people by identifying who should receive it next. The list of
13604               people can be established for each serial to be passed using the
13605               Serials module. This preference can be used to ensure each
13606               person who needs to see a serial when it arrives at the library
13607               will get it. Learn more in the <link linkend="routinglist">routing list</link> section of this
13608               manual.</para>
13609             </listitem>
13610           </itemizedlist>
13611
13612           <para>Values:</para>
13613
13614           <itemizedlist>
13615             <listitem>
13616               <para>Add</para>
13617             </listitem>
13618
13619             <listitem>
13620               <para>Don't add</para>
13621             </listitem>
13622           </itemizedlist>
13623         </section>
13624
13625         <section id="StaffSerialIssueDisplayCount">
13626           <title>StaffSerialIssueDisplayCount</title>
13627
13628           <para>Default: 3</para>
13629
13630           <para>Asks: Show the ___ previous issues of a serial on the staff
13631           client.</para>
13632
13633           <para>Description:</para>
13634
13635           <itemizedlist>
13636             <listitem>
13637               <para>This preference allows the administrator to select the
13638               number of recent issues for each serial which appear in the
13639               Staff Client when the serial is accessed. This is just the
13640               default value, staff members can always click to see a full list
13641               of serials.</para>
13642             </listitem>
13643           </itemizedlist>
13644         </section>
13645
13646         <section id="SubscriptionDuplicateDroppedInput">
13647           <title>SubscriptionDuplicateDroppedInput</title>
13648
13649           <para>Asks: List of fields which must not be rewritten when a
13650           subscription is duplicated (Separated by pipe |) ___</para>
13651
13652           <para>Description:</para>
13653
13654           <itemizedlist>
13655             <listitem>
13656               <para>When duplicating a subscription sometimes you don't want
13657               all of the fields duplicated, using this preference you can list
13658               the fields that you don't want to be duplicated. These field
13659               names come from the subscription table in the Koha database.
13660               Learn what fields are in that table on the <ulink url="http://schema.koha-community.org/tables/subscription.html">Koha
13661               DB Schema</ulink> site.</para>
13662             </listitem>
13663           </itemizedlist>
13664         </section>
13665
13666         <section id="SubscriptionHistory">
13667           <title>SubscriptionHistory</title>
13668
13669           <para>Default: full history</para>
13670
13671           <para>Asks: When showing the subscription information for a
13672           bibliographic record, preselect ___ view of serial issues.</para>
13673
13674           <para>Values:</para>
13675
13676           <itemizedlist>
13677             <listitem>
13678               <para>brief history</para>
13679
13680               <screenshot>
13681                 <screeninfo>Brief History</screeninfo>
13682
13683                 <mediaobject>
13684                   <imageobject>
13685                     <imagedata fileref="images/admin/globalprefs/SubscriptionHistory-brief.png"/>
13686                   </imageobject>
13687                 </mediaobject>
13688               </screenshot>
13689             </listitem>
13690
13691             <listitem>
13692               <para>full history</para>
13693
13694               <screenshot>
13695                 <screeninfo>Full History</screeninfo>
13696
13697                 <mediaobject>
13698                   <imageobject>
13699                     <imagedata fileref="images/admin/globalprefs/SubscriptionHistory-full.png"/>
13700                   </imageobject>
13701                 </mediaobject>
13702               </screenshot>
13703             </listitem>
13704           </itemizedlist>
13705
13706           <para>Description:</para>
13707
13708           <itemizedlist>
13709             <listitem>
13710               <para>This preference determines what information appears in the
13711               OPAC when the user clicks the More Details option. The 'brief'
13712               option displays a one-line summary of the volume and issue
13713               numbers of all issues of that serial held by the library. The
13714               'full' option displays a more detailed breakdown of issues per
13715               year, including information such as the issue date and the
13716               status of each issue.</para>
13717             </listitem>
13718           </itemizedlist>
13719         </section>
13720       </section>
13721
13722       <section id="staffprefs">
13723         <title>Staff Client</title>
13724
13725         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
13726         Global System Preferences &gt; Staff Client</para>
13727
13728         <section id="staffappearprefs">
13729           <title>Appearance</title>
13730
13731           <para/>
13732
13733           <section id="Display856uAsImage">
13734             <title>Display856uAsImage</title>
13735
13736             <para>Default: Neither details or results page</para>
13737
13738             <para>Asks: Display the URI in the 856u field as an image on:
13739             ___</para>
13740
13741             <para>Values:</para>
13742
13743             <itemizedlist>
13744               <listitem>
13745                 <para>Both results and details pages</para>
13746
13747                 <itemizedlist>
13748                   <listitem>
13749                     <important>
13750                       <para>Not implemented yet</para>
13751                     </important>
13752                   </listitem>
13753                 </itemizedlist>
13754               </listitem>
13755
13756               <listitem>
13757                 <para>Detail page only</para>
13758
13759                 <itemizedlist>
13760                   <listitem>
13761                     <important>
13762                       <para><link linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link>
13763                       needs to be on for this preference to work.</para>
13764                     </important>
13765                   </listitem>
13766                 </itemizedlist>
13767
13768                 <screenshot>
13769                   <screeninfo>Showing the 856u as an image</screeninfo>
13770
13771                   <mediaobject>
13772                     <imageobject>
13773                       <imagedata fileref="images/admin/globalprefs/Display856uAsImage.png"/>
13774                     </imageobject>
13775                   </mediaobject>
13776                 </screenshot>
13777               </listitem>
13778
13779               <listitem>
13780                 <para>Neither details or results page</para>
13781               </listitem>
13782
13783               <listitem>
13784                 <para>Results page only</para>
13785
13786                 <itemizedlist>
13787                   <listitem>
13788                     <important>
13789                       <para>Not yet implemented</para>
13790                     </important>
13791                   </listitem>
13792                 </itemizedlist>
13793               </listitem>
13794             </itemizedlist>
13795
13796             <para>Description:</para>
13797
13798             <itemizedlist>
13799               <listitem>
13800                 <para>In addition to this option being set, the corresponding
13801                 XSLT option must be turned on. Also, the corresponding 856q
13802                 field must have a valid MIME image extension (e.g., "jpg") or
13803                 MIME image type (i.e. starting with "image/"), or the generic
13804                 indicator "img" entered in the field. When all of the
13805                 requirements are met, an image file will be displayed instead
13806                 of the standard link text. Clicking on the image will open it
13807                 in the same way as clicking on the link text. When you click
13808                 on the image it should open to full size, in the current
13809                 window or in a new window depending on the value in the system
13810                 pref <link linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
13811
13812                 <screenshot>
13813                   <screeninfo>Sample 856 Field</screeninfo>
13814
13815                   <mediaobject>
13816                     <imageobject>
13817                       <imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
13818                     </imageobject>
13819                   </mediaobject>
13820                 </screenshot>
13821               </listitem>
13822             </itemizedlist>
13823           </section>
13824           <section id="DisplayIconsXSLT">
13825             <title>DisplayIconsXSLT</title>
13826             <para>Default: Show</para>
13827             <para>Asks: ___ the format, audience, and material type icons in XSLT MARC21 results and
13828               detail pages in the staff client.<important>
13829                 <para><link linkend="XSLTResultsDisplay">XSLTResultsDisplay</link> and/or <link linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link> must be set to use an
13830                   XSLT stylesheet (default or custom) for these icons to show.</para>
13831               </important></para>
13832             <para>Values:</para>
13833             <itemizedlist>
13834               <listitem>
13835                 <para>Don't show</para>
13836               </listitem>
13837               <listitem>
13838                 <para>Show</para>
13839                 <screenshot>
13840                   <screeninfo>DisplayIconsXSLT</screeninfo>
13841                   <mediaobject>
13842                     <imageobject>
13843                       <imagedata fileref="images/admin/globalprefs/DisplayIconsXSLT.png"/>
13844                     </imageobject>
13845                   </mediaobject>
13846                 </screenshot>
13847               </listitem>
13848             </itemizedlist>
13849             <para>
13850               <note>
13851                 <para>See the <link linkend="XSLTiTypes">XSLT Icon Guide</link> for more information
13852                   on these icons.</para>
13853               </note>
13854             </para>
13855           </section>
13856
13857           <section id="intranet_includes">
13858             <title>intranet_includes</title>
13859
13860             <para>Default: includes</para>
13861
13862             <para>Asks: Use include files from the ___ directory in the
13863             template directory, instead of includes/. (Leave blank to
13864             disable)</para>
13865           </section>
13866
13867           <section id="intranetcolorstylesheet">
13868             <title>intranetcolorstylesheet</title>
13869
13870             <para>Asks: Include the additional CSS stylesheet ___ to override specified settings
13871               from the default stylesheet</para>
13872
13873             <para>Description:</para>
13874
13875             <itemizedlist>
13876               <listitem>
13877                 <para>This preference is used to set the background color and style of the Staff
13878                   Client. The value is a .css file. The system administrator should determine which
13879                   file is appropriate. Enter just a filename, a full local path or a complete URL
13880                   starting with http:// (if the file lives on a remote server). Please note that if
13881                   you just enter a filename, the file should be in the css subdirectory for each
13882                   active theme and language within the Koha templates directory. A full local path
13883                   is expected to start from your HTTP document root. </para>
13884               </listitem>
13885             </itemizedlist>
13886
13887             <important>
13888               <para>Leave this field blank to disable.</para>
13889             </important>
13890           </section>
13891
13892           <section id="IntranetFavicon">
13893             <title>IntranetFavicon</title>
13894
13895             <para>Asks: Use the image at ___ for the Staff Client's favicon.
13896             <important>
13897                 <para>This should be a complete URL, starting with
13898                 http://</para>
13899               </important></para>
13900
13901             <note>
13902               <para>Turn your logo into a favicon with the <ulink url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
13903             </note>
13904
13905             <para>Description:</para>
13906
13907             <itemizedlist>
13908               <listitem>
13909                 <para>The favicon is the little icon that appears next to the
13910                 URL in the address bar in most browsers. The default value for
13911                 this field (if left blank) is the small 'K' in the Koha
13912                 logo.</para>
13913
13914                 <screenshot>
13915                   <screeninfo>Default Koha Favicon</screeninfo>
13916
13917                   <mediaobject>
13918                     <imageobject>
13919                       <imagedata fileref="images/admin/globalprefs/favicon.png"/>
13920                     </imageobject>
13921                   </mediaobject>
13922                 </screenshot>
13923               </listitem>
13924             </itemizedlist>
13925           </section>
13926
13927           <section id="IntranetmainUserblock">
13928             <title>IntranetmainUserblock</title>
13929
13930             <para>Asks: Show the following HTML in its own column on the main
13931             page of the staff client</para>
13932
13933             <screenshot>
13934               <screeninfo>Sample HTML for IntranetmainUserblock</screeninfo>
13935
13936               <mediaobject>
13937                 <imageobject>
13938                   <imagedata fileref="images/admin/globalprefs/IntranetmainUserblock-html.png"/>
13939                 </imageobject>
13940               </mediaobject>
13941             </screenshot>
13942
13943             <screenshot>
13944               <screeninfo>Message from IntranetmainUserblock as it appears on
13945               the Staff Client main page</screeninfo>
13946
13947               <mediaobject>
13948                 <imageobject>
13949                   <imagedata fileref="images/admin/globalprefs/IntranetmainUserblock.png"/>
13950                 </imageobject>
13951               </mediaobject>
13952             </screenshot>
13953           </section>
13954
13955           <section id="IntranetNav">
13956             <title>IntranetNav</title>
13957
13958             <para>Asks: Show the following HTML in the More menu at the top of
13959             each page on the staff client (should be a list of links or
13960             blank)</para>
13961           </section>
13962
13963           <section id="IntranetSlipPrinterJS">
13964             <title>IntranetSlipPrinterJS</title>
13965
13966             <para>Asks: Use the following JavaScript for printing
13967             slips.</para>
13968
13969             <para>Description:</para>
13970
13971             <itemizedlist>
13972               <listitem>
13973                 <para>The most logical use of this preference is in
13974                 conjunction with the <ulink url="http://jsprintsetup.mozdev.org/">jsPrintSetup</ulink>
13975                 Firefox add-on. Learn more about this preference and the
13976                 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>
13977               </listitem>
13978             </itemizedlist>
13979           </section>
13980
13981           <section id="intranetstylesheet">
13982             <title>intranetstylesheet</title>
13983
13984             <para>Asks: Use the CSS stylesheet ___ on all pages in the staff interface, instead of
13985               the default css (used when leaving this field blank). </para>
13986
13987             <para>Description:</para>
13988
13989             <itemizedlist>
13990               <listitem>
13991                 <para>The Intranetstylesheet preference is a layout and design feature for the
13992                   intranet or staff client. This preference allows a library to customize the
13993                   appearance of the Staff Client. Enter just a filename, a full local path or a
13994                   complete URL starting with http:// (if the file lives on a remote server). Please
13995                   note that if you just enter a filename, the file should be in the css subdirectory
13996                   for each active theme and language within the Koha templates directory. A full
13997                   local path is expected to start from your HTTP document root. </para>
13998               </listitem>
13999             </itemizedlist>
14000           </section>
14001
14002           <section id="IntranetUserCSS">
14003             <title>IntranetUserCSS</title>
14004
14005             <para>Asks: Include the following CSS on all pages in the staff
14006             client</para>
14007           </section>
14008
14009           <section id="intranetuserjs">
14010             <title>intranetuserjs</title>
14011
14012             <para>Asks: Include the following JavaScript on all pages in the
14013             staff interface</para>
14014
14015             <para>Description:</para>
14016
14017             <itemizedlist>
14018               <listitem>
14019                 <para>This preference allows the administrator to enter
14020                 JavaScript or JQuery that will be embedded across all pages of
14021                 the Staff Client. Administrators may use this preference to
14022                 customize some of the interactive sections of Koha,
14023                 customizing the text for the login prompts, for example.
14024                 Sample JQuery scripts used by Koha libraries can be found on
14025                 the wiki: <ulink url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink>.</para>
14026               </listitem>
14027             </itemizedlist>
14028           </section>
14029
14030           <section id="SlipCSS">
14031             <title>SlipCSS</title>
14032
14033             <para>Asks: Include the stylesheet at ___ on Issue and Reserve
14034             Slips.<important>
14035                 <para>This should be a complete URL, starting with
14036                 http://</para>
14037               </important></para>
14038
14039             <para>Description:</para>
14040
14041             <itemizedlist>
14042               <listitem>
14043                 <para>If you would like to style your receipts or slips with a
14044                 consistent set of fonts and colors you can use this preference
14045                 to point Koha to a stylesheet specifically for your
14046                 slips.</para>
14047               </listitem>
14048             </itemizedlist>
14049           </section>
14050
14051           <section id="StaffAuthorisedValueImages">
14052             <title>StaffAuthorisedValueImages</title>
14053
14054             <para>Default: Show</para>
14055
14056             <para>Asks: ___ images for authorized values (such as lost
14057             statuses and locations) in search results.</para>
14058
14059             <para>Values:</para>
14060
14061             <itemizedlist>
14062               <listitem>
14063                 <para>Don't show</para>
14064               </listitem>
14065
14066               <listitem>
14067                 <para>Show</para>
14068               </listitem>
14069             </itemizedlist>
14070           </section>
14071
14072           <section id="staffClientBaseURL">
14073             <title>staffClientBaseURL</title>
14074
14075             <para>Asks: The staff client is located at http:// ___</para>
14076           </section>
14077
14078           <section id="template">
14079             <title>template</title>
14080
14081             <para>Default: prog</para>
14082
14083             <para>Asks: Use the ___ theme on the staff interface.</para>
14084
14085             <para>Values:</para>
14086
14087             <itemizedlist>
14088               <listitem>
14089                 <para>prog</para>
14090               </listitem>
14091             </itemizedlist>
14092             <important>
14093               <para>Do not include a trailing slash in the URL this will break links created using
14094                 this URL.  (example: www.google.com not www.google.com/)</para>
14095             </important>
14096           </section>
14097
14098           <section id="XSLTDetailsDisplay">
14099             <title>XSLTDetailsDisplay</title>
14100
14101             <para>Default: default</para>
14102
14103             <para>Asks: Display details in the staff client using XSLT
14104             stylesheet at ___</para>
14105
14106             <para>Values:</para>
14107
14108             <itemizedlist>
14109               <listitem>
14110                 <para>leave empty to not use the XSLT stylesheet</para>
14111
14112                 <itemizedlist>
14113                   <listitem>
14114                     <para>In previous versions of Koha this was the setting
14115                     that read 'normally'</para>
14116
14117                     <screenshot>
14118                       <screeninfo>Detail display without XSLT
14119                       stylesheets</screeninfo>
14120
14121                       <mediaobject>
14122                         <imageobject>
14123                           <imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-off.png"/>
14124                         </imageobject>
14125                       </mediaobject>
14126                     </screenshot>
14127                   </listitem>
14128                 </itemizedlist>
14129               </listitem>
14130
14131               <listitem>
14132                 <para>enter "default" for the default one</para>
14133
14134                 <screenshot>
14135                   <screeninfo>Detail display using XSLT
14136                   stylesheets</screeninfo>
14137
14138                   <mediaobject>
14139                     <imageobject>
14140                       <imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-on.png"/>
14141                     </imageobject>
14142                   </mediaobject>
14143                 </screenshot>
14144               </listitem>
14145
14146               <listitem>
14147                 <para>put a path to define a XSLT file</para>
14148
14149                 <itemizedlist>
14150                   <listitem>
14151                     <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
14152                   </listitem>
14153
14154                   <listitem>
14155                     <para>If in a multi-language system you can enter
14156                     {langcode} in the path to tell Koha to look in the right
14157                     language folder</para>
14158
14159                     <itemizedlist>
14160                       <listitem>
14161                         <para>ex:
14162                         /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
14163                       </listitem>
14164
14165                       <listitem>
14166                         <para>ex.
14167                         http://mykoha.org/{langcode}/stylesheet.xsl</para>
14168                       </listitem>
14169                     </itemizedlist>
14170                   </listitem>
14171                 </itemizedlist>
14172               </listitem>
14173
14174               <listitem>
14175                 <para>put an URL for an external specific stylesheet</para>
14176
14177                 <itemizedlist>
14178                   <listitem>
14179                     <para>ex: http://mykoha.org/stylesheet.xsl</para>
14180                   </listitem>
14181                 </itemizedlist>
14182               </listitem>
14183             </itemizedlist>
14184
14185             <para>Description:</para>
14186
14187             <itemizedlist>
14188               <listitem>
14189                 <para>XSLT stylesheets allow for the customization of the
14190                 details shows on the screen when viewing a bib record. This
14191                 preference will allow you either use the default look that
14192                 comes with Koha or design your own stylesheet.</para>
14193               </listitem>
14194             </itemizedlist>
14195           </section>
14196
14197           <section id="XSLTResultsDisplay">
14198             <title>XSLTResultsDisplay</title>
14199
14200             <para>Default: default</para>
14201
14202             <para>Asks: Display results in the staff client using XSLT
14203             stylesheet at ___</para>
14204
14205             <para>Values:</para>
14206
14207             <itemizedlist>
14208               <listitem>
14209                 <para>leave empty to not use the XSLT stylesheet</para>
14210
14211                 <itemizedlist>
14212                   <listitem>
14213                     <para>In previous versions of Koha this was the setting
14214                     that read 'normally'</para>
14215                   </listitem>
14216                 </itemizedlist>
14217               </listitem>
14218
14219               <listitem>
14220                 <para>enter "default" for the default one</para>
14221               </listitem>
14222
14223               <listitem>
14224                 <para>put a path to define a XSLT file</para>
14225
14226                 <itemizedlist>
14227                   <listitem>
14228                     <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
14229                   </listitem>
14230
14231                   <listitem>
14232                     <para>If in a multi-language system you can enter
14233                     {langcode} in the path to tell Koha to look in the right
14234                     language folder</para>
14235
14236                     <itemizedlist>
14237                       <listitem>
14238                         <para>ex:
14239                         /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
14240                       </listitem>
14241
14242                       <listitem>
14243                         <para>ex.
14244                         http://mykoha.org/{langcode}/stylesheet.xsl</para>
14245                       </listitem>
14246                     </itemizedlist>
14247                   </listitem>
14248                 </itemizedlist>
14249               </listitem>
14250
14251               <listitem>
14252                 <para>put an URL for an external specific stylesheet</para>
14253
14254                 <itemizedlist>
14255                   <listitem>
14256                     <para>ex: http://mykoha.org/stylesheet.xsl</para>
14257                   </listitem>
14258                 </itemizedlist>
14259               </listitem>
14260             </itemizedlist>
14261
14262             <para>Description:</para>
14263
14264             <itemizedlist>
14265               <listitem>
14266                 <para>XSLT stylesheets allow for the customization of the
14267                 details shows on the screen when viewing the search results.
14268                 This preference will allow you either use the default look
14269                 that comes with Koha or design your own stylesheet.</para>
14270               </listitem>
14271             </itemizedlist>
14272           </section>
14273         </section>
14274
14275         <section id="staffoptsprefs">
14276           <title>Options</title>
14277
14278           <section id="HidePatronName">
14279             <title>HidePatronName</title>
14280
14281             <para>Default: Show</para>
14282
14283             <para>Asks: ___ the names of patrons that have items checked out
14284             or on hold on detail pages or the "Place Hold" screen.</para>
14285
14286             <para>Values:</para>
14287
14288             <itemizedlist>
14289               <listitem>
14290                 <para>Don't show</para>
14291               </listitem>
14292
14293               <listitem>
14294                 <para>Show</para>
14295               </listitem>
14296             </itemizedlist>
14297           </section>
14298
14299           <section id="intranetbookbag">
14300             <title>intranetbookbag</title>
14301
14302             <para>Default: Show</para>
14303
14304             <para>Asks: ___ the cart option in the staff client.</para>
14305
14306             <para>Values:</para>
14307
14308             <itemizedlist>
14309               <listitem>
14310                 <para>Don't show</para>
14311               </listitem>
14312
14313               <listitem>
14314                 <para>Show</para>
14315               </listitem>
14316             </itemizedlist>
14317           </section>
14318           <section id="StaffDetailItemSelection ">
14319             <title>StaffDetailItemSelection</title>
14320             <para>Default: Enable</para>
14321             <para>Asks: ___  item selection in record detail page. </para>
14322             <para>Values:<itemizedlist>
14323                 <listitem>
14324                   <para>Disable</para>
14325                 </listitem>
14326                 <listitem>
14327                   <para>Enable</para>
14328                 </listitem>
14329               </itemizedlist></para>
14330             <para>Description:<itemizedlist>
14331                 <listitem>
14332                   <para>This preference lets you choose to show (or not show) checkboxes to the left
14333                     of every item in the holdings tab on the detail display of a record in the staff
14334                     client. Showing these checkboxes allows the staff members to select multiple
14335                     items to edit or delete at once.</para>
14336                   <screenshot>
14337                       <screeninfo>Items with the checkboxes enabled</screeninfo>
14338                       <mediaobject>
14339                         <imageobject>
14340                           <imagedata fileref="images/admin/globalprefs/StaffDetailItemSelection.png"
14341                           />
14342                         </imageobject>
14343                       </mediaobject>
14344                     </screenshot>
14345                 </listitem>
14346               </itemizedlist></para>
14347           </section>
14348
14349           <section id="viewISBD">
14350             <title>viewISBD</title>
14351
14352             <para>Default: Allow</para>
14353
14354             <para>Asks: ___ staff to view records in ISBD form on the staff
14355             client.</para>
14356
14357             <para>Values:</para>
14358
14359             <itemizedlist>
14360               <listitem>
14361                 <para>Allow</para>
14362               </listitem>
14363
14364               <listitem>
14365                 <para>Don't allow</para>
14366               </listitem>
14367             </itemizedlist>
14368           </section>
14369
14370           <section id="viewLabeledMARC">
14371             <title>viewLabeledMARC</title>
14372
14373             <para>Default: Allow</para>
14374
14375             <para>Asks: ___ staff to view records in labeled MARC form on the
14376             staff client.</para>
14377
14378             <para>Values:</para>
14379
14380             <itemizedlist>
14381               <listitem>
14382                 <para>Allow</para>
14383               </listitem>
14384
14385               <listitem>
14386                 <para>Don't allow</para>
14387               </listitem>
14388             </itemizedlist>
14389           </section>
14390
14391           <section id="viewMARC">
14392             <title>viewMARC</title>
14393
14394             <para>Default: Allow</para>
14395
14396             <para>Asks: ___ staff to view records in plain MARC form on the
14397             staff client.</para>
14398
14399             <para>Values:</para>
14400
14401             <itemizedlist>
14402               <listitem>
14403                 <para>Allow</para>
14404               </listitem>
14405
14406               <listitem>
14407                 <para>Don't allow</para>
14408               </listitem>
14409             </itemizedlist>
14410           </section>
14411         </section>
14412       </section>
14413       <section id="toolsprefs">
14414         <title>Tools</title>
14415         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt; Global System
14416           Preferences &gt; Tools</para>
14417         <section id="batchitemodprefs">
14418           <title>Batch Item Modification</title>
14419           <para>These preferences are in reference to the <link linkend="batchmodifyitems">Batch
14420               Item Modification</link> tool.</para>
14421           <section id="MaxItemsForBatch">
14422             <title>MaxItemsForBatch</title>
14423             <para>Default: 1000</para>
14424             <para>Asks: Process up to ___ items in a single modification or deletion batch. </para>
14425             <para>Description:<itemizedlist>
14426                 <listitem>
14427                   <para>In the <link linkend="batchdeleteitems">batch item delete tool</link> this
14428                     will prevent the display of more than the items you entered in this preference,
14429                     but you will be able to delete more than the number you enter here. In the <link
14430                       linkend="batchmodifyitems">batch item modification tool</link> this preference
14431                     will prevent the editing of more than the number entered here.</para>
14432                 </listitem>
14433               </itemizedlist></para>
14434           </section>
14435         </section>
14436         <section id="patcardprefs">
14437           <title>Patron Cards</title>
14438           <para>These preferences are in reference to the <link linkend="patroncardcreator">Patron
14439               Card Creator</link> tool.</para>
14440           <section id="ImageLimit">
14441             <title>ImageLimit</title>
14442             <para>Asks: Limit the number of creator images stored in the database to ___
14443               images.</para>
14444           </section>
14445         </section>
14446       </section>
14447
14448       <section id="webserviceprefs">
14449         <title>Web Services</title>
14450
14451         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
14452         Global System Preferences &gt; Web Services</para>
14453
14454         <section id="ilsdiprefs">
14455           <title>ILS-DI</title>
14456
14457           <para/>
14458
14459           <section id="ILS-DI">
14460             <title>ILS-DI</title>
14461
14462             <para>Default: Disable</para>
14463
14464             <para>Asks: ___ ILS-DI services for OPAC users</para>
14465
14466             <para>Values:</para>
14467
14468             <itemizedlist>
14469               <listitem>
14470                 <para>Disable</para>
14471               </listitem>
14472
14473               <listitem>
14474                 <para>Enable</para>
14475               </listitem>
14476             </itemizedlist>
14477           </section>
14478
14479           <section id="ILS-DIAuthorized_IPs">
14480             <title>ILS-DI:AuthorizedIPs</title>
14481
14482             <para>Asks: ___ allowed IPs to use the ILS-DI services</para>
14483           </section>
14484         </section>
14485
14486         <section id="oaiprefs">
14487           <title>OAI-PMH</title>
14488
14489           <section id="OAI-PMH">
14490             <title>OAI-PMH</title>
14491
14492             <para>Default: Disable</para>
14493
14494             <para>Asks: ___ Koha's OAI-PMH server.</para>
14495
14496             <para>Values:</para>
14497
14498             <itemizedlist>
14499               <listitem>
14500                 <para>Disable</para>
14501               </listitem>
14502
14503               <listitem>
14504                 <para>Enable</para>
14505               </listitem>
14506             </itemizedlist>
14507
14508             <para>Description:</para>
14509
14510             <itemizedlist>
14511               <listitem>
14512                 <para>For the Open Archives Initiative-Protocol for Metadata
14513                 Harvesting (OAI-PMH) there are two groups of 'participants':
14514                 Data Providers and Service Providers. Data Providers (open
14515                 archives, repositories) provide free access to metadata, and
14516                 may, but do not necessarily, offer free access to full texts
14517                 or other resources. OAI-PMH provides an easy to implement, low
14518                 barrier solution for Data Providers. Service Providers use the
14519                 OAI interfaces of the Data Providers to harvest and store
14520                 metadata. Note that this means that there are no live search
14521                 requests to the Data Providers; rather, services are based on
14522                 the harvested data via OAI-PMH. Koha at present can only act
14523                 as a Data Provider. It can not harvest from other
14524                 repositories. The biggest stumbling block to having Koha
14525                 harvest from other repositories is that MARC is the only
14526                 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>
14527                 for diagrams of how OAI-PMH works.</para>
14528               </listitem>
14529             </itemizedlist>
14530
14531             <para>Learn more about OAI-PMH at: <ulink url="http://www.openarchives.org/pmh/">http://www.openarchives.org/pmh/</ulink></para>
14532           </section>
14533
14534           <section id="OAI-PMHarchiveID">
14535             <title>OAI-PMH:archiveID</title>
14536
14537             <para>Default: KOHA-OAI-TEST</para>
14538
14539             <para>Asks: Identify records at this site with the prefix ___
14540             :</para>
14541           </section>
14542
14543           <section id="OAI-PMHAutoUpdateSets">
14544             <title>OAI-PMH:AutoUpdateSets</title>
14545
14546             <para>Default: Disable</para>
14547
14548             <para>Asks: ___ automatic update of OAI-PMH sets when a
14549             bibliographic record is created or updated.</para>
14550
14551             <para>Values:</para>
14552
14553             <itemizedlist>
14554               <listitem>
14555                 <para>Disable</para>
14556               </listitem>
14557
14558               <listitem>
14559                 <para>Enable</para>
14560               </listitem>
14561             </itemizedlist>
14562           </section>
14563
14564           <section id="OAI-PMHConfFile">
14565             <title>OAI-PMH:ConfFile</title>
14566
14567             <para>If this preference is left empty, Koha's OAI Server operates
14568             in normal mode, otherwise it operates in extended mode. In
14569             extended mode, it's possible to parameter other formats than
14570             marcxml or Dublin Core. OAI-PMH:ConfFile specify a YAML
14571             configuration file which list available metadata formats and XSL
14572             file used to create them from marcxml records.</para>
14573
14574             <para>For more information, see the <link linkend="oaiconfsample">sample conf file</link> in the
14575             appendix.</para>
14576           </section>
14577
14578           <section id="OAI-PMHMaxCount">
14579             <title>OAI-PMH:MaxCount</title>
14580
14581             <para>Default: 50</para>
14582
14583             <para>Asks: Only return ___ records at a time in response to a
14584             ListRecords or ListIdentifiers query.</para>
14585
14586             <para>Description:</para>
14587
14588             <itemizedlist>
14589               <listitem>
14590                 <para>This is the maximum number of records that would be
14591                 returned based on ListRecord or ListIdentifier queries from
14592                 harvesters. ListRecords harvest the entire records while the
14593                 ListIdentifier is an abbreviated form of ListRecords,
14594                 retrieving only headers rather than records.</para>
14595               </listitem>
14596             </itemizedlist>
14597           </section>
14598         </section>
14599         <section id="reportingservice">
14600           <title>Reporting</title>
14601           <section id="SvcMaxReportRows">
14602             <title>SvcMaxReportRows</title>
14603             <para>Default: 10</para>
14604             <para>Asks: Only return ___ rows of a report requested via the reports web
14605               service.</para>
14606             <para>Description:<itemizedlist>
14607                 <listitem>
14608                   <para>This value will be used to limit the number of results returned by <link linkend="publicreport">public reports</link>.</para>
14609                 </listitem>
14610               </itemizedlist></para>
14611           </section>
14612         </section>
14613       </section>
14614     </section>
14615
14616     <section id="basicparams">
14617       <title>Basic Parameters</title>
14618
14619       <para><emphasis>Get there:</emphasis> More &gt; Administration</para>
14620
14621       <important>
14622         <para>Configure all 'parameters' in the order they appear.</para>
14623       </important>
14624
14625       <section id="libsgroups">
14626         <title>Libraries &amp; Groups</title>
14627
14628         <para>When setting up your Koha system you will want to add
14629         information for every library that will be sharing your system. This
14630         data is used in several areas of Koha.</para>
14631
14632         <itemizedlist>
14633           <listitem>
14634             <para><emphasis>Get there:</emphasis> More &gt; Administration
14635             &gt; Basic Parameters &gt; Libraries and Groups</para>
14636           </listitem>
14637         </itemizedlist>
14638
14639         <para>When visiting this page you are presented with a list of the
14640         libraries and groups that have already been added to the
14641         system.</para>
14642
14643         <screenshot>
14644           <screeninfo>Library List</screeninfo>
14645
14646           <mediaobject>
14647             <imageobject>
14648               <imagedata fileref="images/admin/basicparams/librarylist.png"/>
14649             </imageobject>
14650           </mediaobject>
14651         </screenshot>
14652
14653         <screenshot>
14654           <screeninfo>Group Lists</screeninfo>
14655
14656           <mediaobject>
14657             <imageobject>
14658               <imagedata fileref="images/admin/basicparams/grouplists.png"/>
14659             </imageobject>
14660           </mediaobject>
14661         </screenshot>
14662
14663         <section id="addingalibrary">
14664           <title>Adding a Library</title>
14665
14666           <para>To add a new library:</para>
14667
14668           <itemizedlist>
14669             <listitem>
14670               <para>Click 'New Library'</para>
14671             </listitem>
14672
14673             <listitem>
14674               <para>The top of the form asks for some basics about the
14675               library</para>
14676
14677               <screenshot>
14678                 <screeninfo>Basic Library Info</screeninfo>
14679
14680                 <mediaobject>
14681                   <imageobject>
14682                     <imagedata fileref="images/admin/basicparams/newlibrary.png"/>
14683                   </imageobject>
14684                 </mediaobject>
14685               </screenshot>
14686
14687               <itemizedlist>
14688                 <listitem>
14689                   <para>The library code should not contain any spaces and be
14690                   10 or fewer characters. This code will be used as a unique
14691                   identifier in the database.</para>
14692                 </listitem>
14693
14694                 <listitem>
14695                   <para>The name will be displayed on the OPAC wherever the
14696                   library name displays to the public and should be a name
14697                   that makes sense to your patrons.</para>
14698                 </listitem>
14699
14700                 <listitem>
14701                   <para>If you have <link linkend="addinglibgroup">groups</link> set up you can choose
14702                   what group this library belongs to after entering in the
14703                   code and name</para>
14704                 </listitem>
14705               </itemizedlist>
14706             </listitem>
14707
14708             <listitem>
14709               <para>Next you can enter basic contact info about the
14710               branch</para>
14711
14712               <screenshot>
14713                 <screeninfo>Library Contact Info</screeninfo>
14714
14715                 <mediaobject>
14716                   <imageobject>
14717                     <imagedata fileref="images/admin/basicparams/librarycontact.png"/>
14718                   </imageobject>
14719                 </mediaobject>
14720               </screenshot>
14721
14722               <itemizedlist>
14723                 <listitem>
14724                   <para>The address and contact fields can be used to make
14725                   notices custom for each library</para>
14726                 </listitem>
14727
14728                 <listitem>
14729                   <para>The email address field is not required, but it should
14730                   be filled for every library in your system</para>
14731
14732                   <itemizedlist>
14733                     <listitem>
14734                       <important>
14735                         <para>Be sure to enter a library email address to make
14736                         sure that notices are sent to and from the right
14737                         address</para>
14738                       </important>
14739                     </listitem>
14740                   </itemizedlist>
14741                 </listitem>
14742
14743                 <listitem>
14744                   <para>If you'd like you can enter a different 'Reply-To' email address. This is
14745                     the email address that all replies will go to.<itemizedlist>
14746                       <listitem>
14747                         <para>
14748                           <note>
14749                             <para>If you do not fill in this value Koha will use the address in the
14750                                 <link linkend="ReplytoDefault">ReplytoDefault</link>
14751                               preference</para>
14752                           </note>
14753                         </para>
14754                       </listitem>
14755                     </itemizedlist></para>
14756                 </listitem>
14757                 <listitem>
14758                   <para>If you'd like you can also enter a different 'Return-Path' email address.
14759                     This is the email address that all bounced messages will go to.<itemizedlist>
14760                       <listitem>
14761                         <note>
14762                           <para>If you do not fill in this value Koha will use the address in the
14763                               <link linkend="ReturnpathDefault">ReturnpathDefault</link>
14764                             preference</para>
14765                         </note>
14766                       </listitem>
14767                     </itemizedlist></para>
14768                 </listitem>
14769                 <listitem>
14770                   <para>If the URL field is populated then the library name will be linked in the
14771                     holdings table on the OPAC</para>
14772                   <screenshot>
14773                     <screeninfo>Linked Library Name</screeninfo>
14774                     <mediaobject>
14775                       <imageobject>
14776                         <imagedata fileref="images/admin/basicparams/librarylink.png"/>
14777                       </imageobject>
14778                     </mediaobject>
14779                   </screenshot>
14780                 </listitem>
14781
14782                 <listitem>
14783                   <para>The OPAC Info box is for you to put information about
14784                   the library that will appear in the OPAC when the branch
14785                   name is moused over in the holdings table</para>
14786
14787                   <screenshot>
14788                     <screeninfo>OPAC Info</screeninfo>
14789
14790                     <mediaobject>
14791                       <imageobject>
14792                         <imagedata fileref="images/admin/basicparams/opacinfo.png"/>
14793                       </imageobject>
14794                     </mediaobject>
14795                   </screenshot>
14796                 </listitem>
14797
14798                 <listitem>
14799                   <para>IP Address does not have be filled in unless you plan
14800                   on limiting access to your staff client to a specific IP
14801                   Address</para>
14802
14803                   <itemizedlist>
14804                     <listitem>
14805                       <important>
14806                         <para>An IP address is required if you have enabled
14807                         <link linkend="AutoLocation">AutoLocation</link></para>
14808                       </important>
14809                     </listitem>
14810                   </itemizedlist>
14811                 </listitem>
14812
14813                 <listitem>
14814                   <para>Finally, if you have any notes you can put them here.
14815                   These will not show in the OPAC</para>
14816                 </listitem>
14817               </itemizedlist>
14818             </listitem>
14819           </itemizedlist>
14820
14821           <note>
14822             <para>Of the fields listed, only 'Library code' and 'Name' are
14823             required</para>
14824           </note>
14825
14826           <para/>
14827         </section>
14828
14829         <section id="editingalibrary">
14830           <title>Editing/Deleting a Library</title>
14831
14832           <para>You will be unable to delete any library that has patrons or
14833           items attached to it.</para>
14834
14835           <screenshot>
14836             <screeninfo>Staff will be presented with a warning when trying to
14837             delete a library that is being used</screeninfo>
14838
14839             <mediaobject>
14840               <imageobject>
14841                 <imagedata fileref="images/admin/basicparams/cannotdeletelibrary.png"/>
14842               </imageobject>
14843             </mediaobject>
14844           </screenshot>
14845
14846           <para>Each library will have an 'Edit' link to the right of it.
14847           Click this link to edit/alter details associated with the library in
14848           question.</para>
14849
14850           <important>
14851             <para>You will be unable to edit the 'Library code'</para>
14852           </important>
14853         </section>
14854
14855         <section id="addinglibgroup">
14856           <title>Adding a group</title>
14857
14858           <para>To add a Search Domain or Library Property Group click the
14859           'New Group' button at the top of the screen</para>
14860
14861           <screenshot>
14862             <screeninfo>Add group form</screeninfo>
14863
14864             <mediaobject>
14865               <imageobject>
14866                 <imagedata fileref="images/admin/basicparams/addlibgroup.png"/>
14867               </imageobject>
14868             </mediaobject>
14869           </screenshot>
14870           <para>Give the group a 'Category type; of 'searchdomain' and if you would like the group
14871             to show up in the library pull down at the top of the OPAC (with  <link
14872               linkend="OpacAddMastheadLibraryPulldown">OpacAddMastheadLibraryPulldown</link> set to
14873             'Add') and on the advanced search page you can check the 'Show in search pulldown'
14874             box.</para>
14875
14876           <para>Of the fields on the group form, 'Category code', 'Name', and 'Category type' are
14877             the only required fields</para>
14878
14879           <section id="searchdomaingroups">
14880             <title>Search Domain Groups</title>
14881
14882             <para>Search Domain Groups allow you to search a group of
14883             libraries at the same time instead of searching just one library
14884             or all libraries.</para>
14885
14886             <screenshot>
14887               <screeninfo>Search Domain Groups</screeninfo>
14888
14889               <mediaobject>
14890                 <imageobject>
14891                   <imagedata fileref="images/admin/basicparams/searchgroup.png"/>
14892                 </imageobject>
14893               </mediaobject>
14894             </screenshot>
14895
14896             <para>To see Search Domain Groups in action visit the staff client
14897             advanced search page in your Koha system:</para>
14898
14899             <screenshot>
14900               <screeninfo>Library group search on staff client</screeninfo>
14901
14902               <mediaobject>
14903                 <imageobject>
14904                   <imagedata fileref="images/admin/basicparams/stafflibgroupsearch.png"/>
14905                 </imageobject>
14906               </mediaobject>
14907             </screenshot>
14908           </section>
14909
14910           <section id="libpropertygroups">
14911             <title>Library Property Groups</title>
14912
14913             <para>You can assign specific categories to your libraries by
14914             adding groups for them</para>
14915
14916             <screenshot>
14917               <screeninfo>Library Property Groups</screeninfo>
14918
14919               <mediaobject>
14920                 <imageobject>
14921                   <imagedata fileref="images/admin/basicparams/groupproperties.png"/>
14922                 </imageobject>
14923               </mediaobject>
14924             </screenshot>
14925
14926             <para>Properties are then applied to libraries via the add or edit
14927             library form</para>
14928
14929             <screenshot>
14930               <screeninfo>Groups on the Add/Modify library form</screeninfo>
14931
14932               <mediaobject>
14933                 <imageobject>
14934                   <imagedata fileref="images/admin/basicparams/addlibrarytogroup.png"/>
14935                 </imageobject>
14936               </mediaobject>
14937             </screenshot>
14938           </section>
14939         </section>
14940       </section>
14941
14942       <section id="itemtypeadmin">
14943         <title>Item Types</title>
14944
14945         <para>Koha allows you to organize your collection by item types and
14946         collection codes.</para>
14947
14948         <itemizedlist>
14949           <listitem>
14950             <para><emphasis>Get there:</emphasis> More &gt; Administration
14951             &gt; Basic Parameters &gt; Item Types</para>
14952           </listitem>
14953         </itemizedlist>
14954
14955         <para>Item types typically refer to the material type (book, cd, dvd,
14956         etc), but can be used in any way that works for your library.</para>
14957
14958         <screenshot>
14959           <screeninfo>Item Types</screeninfo>
14960
14961           <mediaobject>
14962             <imageobject>
14963               <imagedata fileref="images/admin/basicparams/itemtypes.png"/>
14964             </imageobject>
14965           </mediaobject>
14966         </screenshot>
14967
14968         <section id="additemtype">
14969           <title>Adding Item Types</title>
14970
14971           <para>To add a new item type, simply click the 'New Item Type'
14972           button at the top of the Item Types page.</para>
14973
14974           <screenshot>
14975             <screeninfo>New Item Type</screeninfo>
14976
14977             <mediaobject>
14978               <imageobject>
14979                 <imagedata fileref="images/admin/basicparams/additemtype.png"/>
14980               </imageobject>
14981             </mediaobject>
14982           </screenshot>
14983
14984           <itemizedlist>
14985             <listitem>
14986               <para>In the 'Item Type' field, enter a short code for your item
14987               type</para>
14988             </listitem>
14989
14990             <listitem>
14991               <para>The description is the plain text definition of the item
14992               type</para>
14993             </listitem>
14994
14995             <listitem>
14996               <para>You can choose to have an image associated with your item
14997               type</para>
14998
14999               <itemizedlist>
15000                 <listitem>
15001                   <para>You can choose from a series of image
15002                   collections</para>
15003                 </listitem>
15004
15005                 <listitem>
15006                   <para>You can link to a remote image</para>
15007                 </listitem>
15008
15009                 <listitem>
15010                   <para>Or you can just have no image associated with the item
15011                   type</para>
15012                 </listitem>
15013
15014                 <listitem>
15015                   <important>
15016                     <para>To have your item type images appear in the OPAC you
15017                     need to set noItemTypeImages to 'Show'</para>
15018                   </important>
15019
15020                   <itemizedlist>
15021                     <listitem>
15022                       <para><emphasis>Get there: </emphasis>More &gt;
15023                       Administration &gt; Global System Preferences &gt; <link linkend="adminprefs">Admin</link></para>
15024                     </listitem>
15025                   </itemizedlist>
15026                 </listitem>
15027               </itemizedlist>
15028             </listitem>
15029
15030             <listitem>
15031               <para>For items that do not circulate, check the 'Not for loan'
15032               options</para>
15033
15034               <itemizedlist>
15035                 <listitem>
15036                   <para>Items marked 'Not for loan' will appear in the
15037                   catalog, but cannot be checked out to patrons</para>
15038                 </listitem>
15039               </itemizedlist>
15040             </listitem>
15041
15042             <listitem>
15043               <para id="rentalcharge">For items that you charge a rental fee
15044               for, enter the total fee you charge in the 'Rental charge'
15045               field</para>
15046
15047               <itemizedlist>
15048                 <listitem>
15049                   <important>
15050                     <para>Do not enter symbols in this field, only numbers and
15051                     decimal points (ex. $5.00 should be entered as 5 or
15052                     5.00)</para>
15053                   </important>
15054                 </listitem>
15055
15056                 <listitem>
15057                   <para>This will charge the patron on checkout</para>
15058                 </listitem>
15059               </itemizedlist>
15060             </listitem>
15061
15062             <listitem>
15063               <para>If you would like a message or alert to appear when items of this type are
15064                 checked in you can enter that in the 'Checkin message' box</para>
15065               <screenshot>
15066                 <screeninfo>Checkin message setup</screeninfo>
15067                 <mediaobject>
15068                   <imageobject>
15069                     <imagedata fileref="images/admin/basicparams/itemtype-msgsetup.png"/>
15070                   </imageobject>
15071                 </mediaobject>
15072               </screenshot>
15073               <para>
15074                 <itemizedlist>
15075                   <listitem>
15076                     <para>The Checkin message type can be a Message or an Alert.  The only
15077                       difference between these two is the styling. By default a Message is blue </para>
15078                     <screenshot>
15079                       <screeninfo>Checkin Message</screeninfo>
15080                       <mediaobject>
15081                         <imageobject>
15082                           <imagedata fileref="images/admin/basicparams/itemtype-msg.png"/>
15083                         </imageobject>
15084                       </mediaobject>
15085                     </screenshot>
15086                     <para>and an Alert is yellow.</para>
15087                     <screenshot>
15088                         <screeninfo>Checkin Alert</screeninfo>
15089                         <mediaobject>
15090                           <imageobject>
15091                             <imagedata fileref="images/admin/basicparams/itemtype-alert.png"/>
15092                           </imageobject>
15093                         </mediaobject>
15094                       </screenshot>
15095                   </listitem>
15096                 </itemizedlist>
15097               </para>
15098             </listitem>
15099             <listitem>
15100               <para>Some SIP devices need you to use a SIP-specific media type instead of Koha's
15101                 item type (usually lockers and sorters need this media type), if you use a device
15102                 like this you'll want to enter the SIP media type.</para>
15103             </listitem>
15104             <listitem>
15105               <para>When finished, click 'Save Changes'</para>
15106               <itemizedlist>
15107                 <listitem>
15108                   <note>
15109                     <para>All fields, with the exception of the 'Item Type' will be editable from
15110                       the Item Types list</para>
15111                   </note>
15112                 </listitem>
15113               </itemizedlist>
15114             </listitem>
15115
15116             <listitem>
15117               <para>Your new item type will now appear on the list</para>
15118
15119               <screenshot>
15120                 <screeninfo>New DVD Item Type</screeninfo>
15121
15122                 <mediaobject>
15123                   <imageobject>
15124                     <imagedata fileref="images/admin/basicparams/newitemtype.png"/>
15125                   </imageobject>
15126                 </mediaobject>
15127               </screenshot>
15128             </listitem>
15129           </itemizedlist>
15130         </section>
15131
15132         <section id="edititemtype">
15133           <title>Editing Item Types</title>
15134
15135           <para>Each item type has an Edit button beside it. To edit an item
15136           simply click the 'Edit' link.</para>
15137
15138           <important>
15139             <para>You will not be able to edit the code you assigned as the
15140             'Item Type' but you will be able to edit the description for the
15141             item.</para>
15142           </important>
15143         </section>
15144
15145         <section id="deleteitemtype">
15146           <title>Deleting Item Types</title>
15147
15148           <para>Each item has a Delete button beside it. To delete an item,
15149           simply click the 'Delete' link.</para>
15150
15151           <important>
15152             <para>You will not be able to delete item types that are being
15153             used by items within your system.</para>
15154           </important>
15155
15156           <screenshot>
15157             <screeninfo>Warning when you try to delete an item that is in
15158             use</screeninfo>
15159
15160             <mediaobject>
15161               <imageobject>
15162                 <imagedata fileref="images/admin/basicparams/nodeleteitemtype.png"/>
15163               </imageobject>
15164             </mediaobject>
15165           </screenshot>
15166         </section>
15167       </section>
15168
15169       <section id="authorizedvalues">
15170         <title>Authorized Values</title>
15171
15172         <para>Authorized values can be used in several areas of Koha. One
15173         reason you would add an authorized value category would be to control
15174         the values that can be entered into MARC fields by catalogers.</para>
15175
15176         <itemizedlist>
15177           <listitem>
15178             <para><emphasis>Get there:</emphasis> More &gt; Administration
15179             &gt; Basic Parameters &gt; Authorized Values</para>
15180           </listitem>
15181         </itemizedlist>
15182
15183         <section id="existingauthvalues">
15184           <title>Existing Values</title>
15185
15186           <para>Koha installs with pre-defined values that your library is
15187           likely to use, for instance 'Lost'.</para>
15188
15189           <itemizedlist>
15190             <listitem id="asort1">
15191               <para>Asort1</para>
15192               <itemizedlist>
15193                 <listitem>
15194                   <para>Used for acquisitions statistical purposes</para>
15195                 </listitem>
15196               </itemizedlist>
15197             </listitem>
15198
15199             <listitem id="asort2">
15200               <para>Asort2</para>
15201               <itemizedlist>
15202                 <listitem>
15203                   <para>Used for acquisitions statistical purposes</para>
15204                 </listitem>
15205               </itemizedlist>
15206             </listitem>
15207
15208             <listitem id="bornotes">
15209               <para>BOR_NOTES</para>
15210               <itemizedlist>
15211                 <listitem>
15212                   <para>Values for custom patron messages that appear on the circulation screen and
15213                     the OPAC. The value in the Description field should be the message text and is
15214                     limited to 200 characters.</para>
15215                   <screenshot>
15216                     <screeninfo>Borrower messages</screeninfo>
15217                     <mediaobject>
15218                       <imageobject>
15219                         <imagedata fileref="images/admin/basicparams/bor_notes.png"/>
15220                       </imageobject>
15221                     </mediaobject>
15222                   </screenshot>
15223                 </listitem>
15224               </itemizedlist>
15225             </listitem>
15226
15227             <listitem id="bsort1">
15228               <para>Bsort1</para>
15229               <itemizedlist>
15230                 <listitem>
15231                   <para>Values that can be entered to fill in the patron's sort 1 field</para>
15232                 </listitem>
15233               </itemizedlist>
15234             </listitem>
15235
15236             <listitem id="bsort2">
15237               <para>Bsort2</para>
15238               <itemizedlist>
15239                 <listitem>
15240                   <para>Values that can be entered to fill in the patron's sort 2 field</para>
15241                 </listitem>
15242               </itemizedlist>
15243             </listitem>
15244
15245             <listitem id="cartauth">
15246               <para>CART</para>
15247               <itemizedlist>
15248                 <listitem>
15249                   <para>Is the shelving cart location, used by <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link> and
15250                       <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link></para>
15251                 </listitem>
15252               </itemizedlist>
15253             </listitem>
15254
15255             <listitem id="ccode">
15256               <para>CCODE</para>
15257               <itemizedlist>
15258                 <listitem>
15259                   <para>Collection codes (appears when cataloging and working with items)</para>
15260                 </listitem>
15261               </itemizedlist>
15262             </listitem>
15263
15264             <listitem id="damageauth">
15265               <para>DAMAGED</para>
15266               <itemizedlist>
15267                 <listitem>
15268                   <para>Descriptions for items marked as damaged (appears when cataloging and
15269                     working with items)</para>
15270                 </listitem>
15271               </itemizedlist>
15272             </listitem>
15273
15274             <listitem id="hingsas">
15275               <para>DEPARTMENT<itemizedlist>
15276                   <listitem>
15277                     <para>Departments are required by and will be used in the <link
15278                         linkend="coursereserves">Course Reserves</link> module</para>
15279                   </listitem>
15280                 </itemizedlist></para>
15281             </listitem>
15282             <listitem>
15283               <para>HINGS_AS</para>
15284               <itemizedlist>
15285                 <listitem>
15286                   <para>General Holdings: Acquisition Status Designator :: This data element
15287                     specifies acquisition status for the unit at the time of the holdings
15288                     report.</para>
15289                 </listitem>
15290               </itemizedlist>
15291             </listitem>
15292
15293             <listitem id="hingsc">
15294               <para>HINGS_C</para>
15295               <itemizedlist>
15296                 <listitem>
15297                   <para>General Holdings: Completeness Designator</para>
15298                 </listitem>
15299               </itemizedlist>
15300             </listitem>
15301
15302             <listitem id="hingspf">
15303               <para>HINGS_PF</para>
15304               <itemizedlist>
15305                 <listitem>
15306                   <para>Physical Form Designators</para>
15307                 </listitem>
15308               </itemizedlist>
15309             </listitem>
15310
15311             <listitem id="hingsrd">
15312               <para>HINGS_RD</para>
15313               <itemizedlist>
15314                 <listitem>
15315                   <para>General Holdings: Retention Designator :: This data element specifies the
15316                     retention policy for the unit at the time of the holdings report.</para>
15317                 </listitem>
15318               </itemizedlist>
15319             </listitem>
15320
15321             <listitem id="hingsut">
15322               <para>HINGS_UT</para>
15323               <itemizedlist>
15324                 <listitem>
15325                   <para>General Holdings: Type of Unit Designator</para>
15326                 </listitem>
15327               </itemizedlist>
15328             </listitem>
15329
15330             <listitem id="shelvelocvals">
15331               <para>LOC</para>
15332               <itemizedlist>
15333                 <listitem>
15334                   <para>Shelving location (usually appears when adding or editing an item)</para>
15335                 </listitem>
15336               </itemizedlist>
15337             </listitem>
15338
15339             <listitem id="lost">
15340               <para>LOST</para>
15341               <itemizedlist>
15342                 <listitem>
15343                   <para>Descriptions for the items marked as lost (appears when adding or editing an
15344                     item)</para>
15345                 </listitem>
15346                 <listitem>
15347                   <important>
15348                     <para>Values given to lost statuses should be numeric and not alphabetical in
15349                       order for statuses to appear properly</para>
15350                   </important>
15351                 </listitem>
15352               </itemizedlist>
15353             </listitem>
15354
15355             <listitem id="manualinvvals">
15356               <para>MANUAL_INV</para>
15357               <itemizedlist>
15358                 <listitem>
15359                   <para>Values for manual invoicing types</para>
15360                 </listitem>
15361                 <listitem>
15362                   <para>
15363                     <important>
15364                       <para>The value set as the Authorized Value for the MANUAL_INV authorized
15365                         value category will appear as the Description and the Authorized Value
15366                         Description will be used as the amount. Enter monetary amounts in the
15367                         description without currency symbols.</para>
15368                     </important>
15369                   </para>
15370                 </listitem>
15371               </itemizedlist>
15372             </listitem>
15373
15374             <listitem id="notforloan">
15375               <para>NOT_LOAN</para>
15376               <itemizedlist>
15377                 <listitem>
15378                   <para>Reasons why a title is not for loan</para>
15379                 </listitem>
15380                 <listitem>
15381                   <important>
15382                     <para>Values given to lost statuses should be numeric and not alphabetical in
15383                       order for statuses to appear properly</para>
15384                   </important>
15385                 </listitem>
15386                 <listitem>
15387                   <note>
15388                     <para>Negative number values will still allow holds (use for on order statuses
15389                       for example) where as positive numbers will not allow holds or
15390                       checkouts</para>
15391                   </note>
15392                 </listitem>
15393               </itemizedlist>
15394             </listitem>
15395
15396             <listitem id="procauth">
15397               <para>ORDER_CANCELLATION_REASON<itemizedlist>
15398                   <listitem>
15399                     <para>Reasons why an order might have been cancelled</para>
15400                   </listitem>
15401                 </itemizedlist></para>
15402             </listitem>
15403             <listitem>
15404               <para>PROC</para>
15405               <itemizedlist>
15406                 <listitem>
15407                   <para>The location to be used for <link linkend="NewItemsDefaultLocation"
15408                       >NewItemsDefaultLocation</link> (change description as desired), also the
15409                     location expected by <link linkend="InProcessingToShelvingCart"
15410                       >InProcessingToShelvingCart</link>.</para>
15411                 </listitem>
15412               </itemizedlist>
15413             </listitem>
15414
15415             <listitem id="reportgroup">
15416               <para>REPORT_GROUP</para>
15417               <itemizedlist>
15418                 <listitem>
15419                   <para>A way to sort and filter your reports, the default values in this category
15420                     include the Koha modules (Accounts, Acquitisions, Catalog, Circulation,
15421                     Patrons)</para>
15422                   <screenshot>
15423                     <screeninfo>Report Groups</screeninfo>
15424                     <mediaobject>
15425                       <imageobject>
15426                         <imagedata fileref="images/admin/basicparams/report_group.png"/>
15427                       </imageobject>
15428                     </mediaobject>
15429                   </screenshot>
15430                 </listitem>
15431               </itemizedlist>
15432             </listitem>
15433
15434             <listitem id="reportsubgroup">
15435               <para>REPORT_SUBGROUP</para>
15436               <itemizedlist>
15437                 <listitem>
15438                   <para>Can be used to further sort and filter your reports. This category is empty
15439                     by default. Values here need to include the authorized value code from
15440                     REPORT_GROUP in the Description (OPAC) field to link the subgroup to the
15441                     appropriate group.</para>
15442                   <screenshot>
15443                     <screeninfo>Report Subgroups</screeninfo>
15444                     <mediaobject>
15445                       <imageobject>
15446                         <imagedata fileref="images/admin/basicparams/report_subgroup.png"/>
15447                       </imageobject>
15448                     </mediaobject>
15449                   </screenshot>
15450                 </listitem>
15451               </itemizedlist>
15452             </listitem>
15453
15454             <listitem id="restricted">
15455               <para>RESTRICTED</para>
15456               <itemizedlist>
15457                 <listitem>
15458                   <para>Restricted status of an item</para>
15459                 </listitem>
15460               </itemizedlist>
15461             </listitem>
15462
15463             <listitem id="suggestauthorized">
15464               <para>ROADTYPE<itemizedlist>
15465                   <listitem>
15466                     <para>Road types to be used in patron addresses</para>
15467                   </listitem>
15468                 </itemizedlist></para>
15469             </listitem>
15470             <listitem>
15471               <para>SIP_MEDIA_TYPE<itemizedlist>
15472                   <listitem>
15473                     <para>Used when <link linkend="additemtype">creating</link> or <link
15474                         linkend="edititemtype">editing</link> an item type to assign a SIP specific
15475                       media type for devices like lockers and sorters.</para>
15476                   </listitem>
15477                 </itemizedlist></para>
15478             </listitem>
15479             <listitem>
15480               <para>SUGGEST</para>
15481               <itemizedlist>
15482                 <listitem>
15483                   <para>List of patron suggestion reject or accept reasons (appears when managing
15484                     suggestions)</para>
15485                 </listitem>
15486               </itemizedlist>
15487             </listitem>
15488
15489             <listitem id="withdrawnauth">
15490               <para>WITHDRAWN</para>
15491               <itemizedlist>
15492                 <listitem>
15493                   <para>Description of a withdrawn item (appears when adding or editing an
15494                     item)</para>
15495                 </listitem>
15496               </itemizedlist>
15497             </listitem>
15498
15499             <listitem id="yesnoauth">
15500               <para>YES_NO</para>
15501               <itemizedlist>
15502                 <listitem>
15503                   <para>A generic authorized value field that can be used anywhere you need a simple
15504                     yes/no pull down menu.</para>
15505                 </listitem>
15506               </itemizedlist>
15507             </listitem>
15508           </itemizedlist>
15509         </section>
15510
15511         <section id="newauthvalcat">
15512           <title>Add new Authorized Value Category</title>
15513
15514           <para>In addition to the existing categories that come by default
15515           with Koha, librarians can add their own authorized value categories
15516           to control data that is entered into the system. To add a new
15517           category:</para>
15518
15519           <itemizedlist>
15520             <listitem>
15521               <para>Click 'New Category'</para>
15522
15523               <screenshot>
15524                 <screeninfo>New Authorized Category form</screeninfo>
15525
15526                 <mediaobject>
15527                   <imageobject>
15528                     <imagedata fileref="images/admin/basicparams/addauthcat.png"/>
15529                   </imageobject>
15530                 </mediaobject>
15531               </screenshot>
15532             </listitem>
15533
15534             <listitem>
15535               <para>Limit your Category to 10 characters (something short to
15536               make it clear what the category is for)</para>
15537
15538               <itemizedlist>
15539                 <listitem>
15540                   <important>
15541                     <para>Category cannot have spaces or special characters
15542                     other than underscores and hyphens in it.</para>
15543                   </important>
15544                 </listitem>
15545               </itemizedlist>
15546             </listitem>
15547
15548             <listitem>
15549               <para>When adding a new category you're asked to create at least
15550               one authorized value</para>
15551
15552               <itemizedlist>
15553                 <listitem>
15554                   <para>Enter a code for your Authorized Value into the
15555                   'Authorized value' field</para>
15556
15557                   <itemizedlist>
15558                     <listitem>
15559                       <important>
15560                         <para>Authorized value is limited to 80 characters and
15561                         cannot have spaces or special characters other than
15562                         underscores and hyphens in it.</para>
15563                       </important>
15564                     </listitem>
15565                   </itemizedlist>
15566                 </listitem>
15567
15568                 <listitem>
15569                   <para>Use the Description field for the actual value that will be displayed. If
15570                     you want something different to show in the OPAC, enter a 'Description
15571                     (OPAC)'</para>
15572                 </listitem>
15573                 <listitem>
15574                   <para>If you would like to limit this authorized value category to only specific
15575                     libraries you can choose them from the 'Branches limitation' menu. To have it
15576                     show for all libraries just choose 'All branches' at the top of the list.</para>
15577                 </listitem>
15578
15579                 <listitem>
15580                   <para>If you have <link linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
15581                   and/or <link linkend="AuthorisedValueImages">AuthorisedValueImages</link>
15582                   set to show images for authorized values you can choose the
15583                   image under 'Choose an icon'</para>
15584                 </listitem>
15585               </itemizedlist>
15586             </listitem>
15587
15588             <listitem>
15589               <para>Click 'Save'</para>
15590             </listitem>
15591
15592             <listitem>
15593               <para>Your new category and value will appear on the list of
15594               Authorized Values</para>
15595
15596               <screenshot>
15597                 <screeninfo>Custom Authorized Value on list of
15598                 values</screeninfo>
15599
15600                 <mediaobject>
15601                   <imageobject>
15602                     <imagedata fileref="images/admin/basicparams/authvallist.png"/>
15603                   </imageobject>
15604                 </mediaobject>
15605               </screenshot>
15606             </listitem>
15607           </itemizedlist>
15608         </section>
15609
15610         <section id="newauthval">
15611           <title>Add new Authorized Value</title>
15612
15613           <para>New authorized values can be added to any existing or new
15614           category. To add a value:</para>
15615
15616           <itemizedlist>
15617             <listitem>
15618               <para>Click 'New authorized value for ...'</para>
15619
15620               <screenshot>
15621                 <screeninfo>New Authorized Value form</screeninfo>
15622
15623                 <mediaobject>
15624                   <imageobject>
15625                     <imagedata fileref="images/admin/basicparams/addauthvalue.png"/>
15626                   </imageobject>
15627                 </mediaobject>
15628               </screenshot>
15629             </listitem>
15630
15631             <listitem>
15632               <para>Enter a code for your Authorized Value into the
15633               'Authorized value' field</para>
15634
15635               <itemizedlist>
15636                 <listitem>
15637                   <important>
15638                     <para>Authorized value is limited to 80 characters and
15639                     cannot have spaces or special characters other than
15640                     underscores and hyphens in it.</para>
15641                   </important>
15642                 </listitem>
15643               </itemizedlist>
15644             </listitem>
15645
15646             <listitem>
15647               <para>Use the Description field for the actual value that will be displayed. If you
15648                 want something different to show in the OPAC, enter a 'Description (OPAC)'</para>
15649             </listitem>
15650             <listitem>
15651               <para>If you would like to limit this authorized value category to only specific
15652                 libraries you can choose them from the 'Branches limitation' menu. To have it show
15653                 for all libraries just choose 'All branches' at the top of the list.</para>
15654             </listitem>
15655
15656             <listitem>
15657               <para>If you have <link linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
15658               and/or <link linkend="AuthorisedValueImages">AuthorisedValueImages</link> set
15659               to show images for authorized values you can choose the image
15660               under 'Choose an icon'</para>
15661             </listitem>
15662
15663             <listitem>
15664               <para>Click 'Save'</para>
15665             </listitem>
15666
15667             <listitem>
15668               <para>The new value will appear in the list along with existing
15669               values</para>
15670
15671               <screenshot>
15672                 <screeninfo>List of authorized values in MARC504
15673                 category</screeninfo>
15674
15675                 <mediaobject>
15676                   <imageobject>
15677                     <imagedata fileref="images/admin/basicparams/authvals.png"/>
15678                   </imageobject>
15679                 </mediaobject>
15680               </screenshot>
15681             </listitem>
15682           </itemizedlist>
15683         </section>
15684       </section>
15685     </section>
15686
15687     <section id="patscirc">
15688       <title>Patrons &amp; Circulation</title>
15689
15690       <para>Settings for controlling circulation and patron
15691       information.</para>
15692
15693       <section id="patcats">
15694         <title>Patron Categories</title>
15695
15696         <para>Patron categories allow you to organize your patrons into
15697         different roles, age groups, and patron types.</para>
15698
15699         <itemizedlist>
15700           <listitem>
15701             <para><emphasis>Get there:</emphasis> More &gt; Administration
15702             &gt; Patrons &amp; Circulation &gt; Patron Categories</para>
15703           </listitem>
15704         </itemizedlist>
15705
15706         <screenshot>
15707           <screeninfo>Patron category list</screeninfo>
15708
15709           <mediaobject>
15710             <imageobject>
15711               <imagedata fileref="images/admin/patroncirc/patroncatlist.png"/>
15712             </imageobject>
15713           </mediaobject>
15714         </screenshot>
15715
15716         <para>Patrons are assigned to one of six main categories:</para>
15717
15718         <itemizedlist>
15719           <listitem>
15720             <para>Adult</para>
15721
15722             <itemizedlist>
15723               <listitem>
15724                 <para>Most common patron type, usually used for a general
15725                 'Patron' category.</para>
15726               </listitem>
15727             </itemizedlist>
15728           </listitem>
15729
15730           <listitem>
15731             <para>Child</para>
15732
15733             <itemizedlist>
15734               <listitem>
15735                 <para>Children patrons can have a guardian to be attached to
15736                 them.</para>
15737               </listitem>
15738             </itemizedlist>
15739           </listitem>
15740
15741           <listitem>
15742             <para>Staff</para>
15743
15744             <itemizedlist>
15745               <listitem>
15746                 <para>Librarians (and library workers) should be assigned the
15747                 staff category so that you can <link linkend="patronpermissions">set their permissions</link> and
15748                 give them access to the staff client.</para>
15749               </listitem>
15750             </itemizedlist>
15751           </listitem>
15752
15753           <listitem>
15754             <para>Organizational</para>
15755
15756             <itemizedlist>
15757               <listitem>
15758                 <para>Organizational patrons are organizations. Organizations
15759                 can be used as guarantors for Professional patrons.</para>
15760               </listitem>
15761             </itemizedlist>
15762           </listitem>
15763
15764           <listitem>
15765             <para>Professional</para>
15766
15767             <itemizedlist>
15768               <listitem>
15769                 <para>Professional patrons can be linked to Organizational
15770                 patrons</para>
15771               </listitem>
15772             </itemizedlist>
15773           </listitem>
15774
15775           <listitem>
15776             <para>Statistical</para>
15777
15778             <itemizedlist>
15779               <listitem>
15780                 <para>This patron type is used strictly for statistical
15781                 purposes, such as in house use of items.</para>
15782               </listitem>
15783             </itemizedlist>
15784           </listitem>
15785         </itemizedlist>
15786
15787         <section id="addingpatroncat">
15788           <title>Adding a patron category</title>
15789
15790           <para>To add a new patron category click 'New Category' at the top
15791           of the page</para>
15792
15793           <screenshot>
15794             <screeninfo>New patron category form</screeninfo>
15795
15796             <mediaobject>
15797               <imageobject>
15798                 <imagedata fileref="images/admin/patroncirc/newpatroncat.png"/>
15799               </imageobject>
15800             </mediaobject>
15801           </screenshot>
15802
15803           <itemizedlist>
15804             <listitem>
15805               <para>The 'Category Code' is an identifier for your new
15806               code.</para>
15807
15808               <itemizedlist>
15809                 <listitem>
15810                   <important>
15811                     <para>The category code is limited to 10 characters
15812                     (numbers and letters)</para>
15813                   </important>
15814                 </listitem>
15815
15816                 <listitem>
15817                   <important>
15818                     <para>This field is required in order to save your patron
15819                     category. If left blank you will be presented with an
15820                     error.</para>
15821
15822                     <screenshot>
15823                       <screeninfo>Missing fields error</screeninfo>
15824
15825                       <mediaobject>
15826                         <imageobject>
15827                           <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
15828                         </imageobject>
15829                       </mediaobject>
15830                     </screenshot>
15831                   </important>
15832                 </listitem>
15833               </itemizedlist>
15834             </listitem>
15835
15836             <listitem>
15837               <para>Enter a plain text version of the category in the
15838               'Description' field.</para>
15839
15840               <itemizedlist>
15841                 <listitem>
15842                   <important>
15843                     <para>This field is required in order to save your patron
15844                     category. If left blank you will be presented with an
15845                     error.</para>
15846
15847                     <screenshot>
15848                       <screeninfo>Missing fields error</screeninfo>
15849
15850                       <mediaobject>
15851                         <imageobject>
15852                           <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
15853                         </imageobject>
15854                       </mediaobject>
15855                     </screenshot>
15856                   </important>
15857                 </listitem>
15858               </itemizedlist>
15859             </listitem>
15860
15861             <listitem>
15862               <para>Enrollment period (in months) should be filled in if you
15863               have a limited enrollment period for your patrons (eg. Student
15864               cards expire after 9 months or until a specific date)</para>
15865
15866               <itemizedlist>
15867                 <listitem>
15868                   <important>
15869                     <para>You cannot enter both a month limit and a date
15870                     until. Choose to enter either one or the other.</para>
15871                   </important>
15872                 </listitem>
15873
15874                 <listitem>
15875                   <important>
15876                     <para>This field is required in order to save your patron
15877                     category. If left blank you will be presented with an
15878                     error.</para>
15879
15880                     <screenshot>
15881                       <screeninfo>Missing fields error</screeninfo>
15882
15883                       <mediaobject>
15884                         <imageobject>
15885                           <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
15886                         </imageobject>
15887                       </mediaobject>
15888                     </screenshot>
15889                   </important>
15890                 </listitem>
15891               </itemizedlist>
15892             </listitem>
15893
15894             <listitem>
15895               <para>Some patron categories can have a minimum age (in years)
15896               requirement associated with them, enter this age in the 'Age
15897               required'</para>
15898
15899               <itemizedlist>
15900                 <listitem>
15901                   <important>
15902                     <para>This value will only be checked if <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
15903                     defines the dateofbirth as a required field on the patron
15904                     record</para>
15905                   </important>
15906                 </listitem>
15907               </itemizedlist>
15908             </listitem>
15909
15910             <listitem>
15911               <para>Patron categories can also have a maximum age (in years)
15912               associated with them (such as children), enter this age in the
15913               'Upperage limit'</para>
15914
15915               <itemizedlist>
15916                 <listitem>
15917                   <important>
15918                     <para>This value will only be checked if <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
15919                     defines the dateofbirth as a required field on the patron
15920                     record</para>
15921                   </important>
15922                 </listitem>
15923               </itemizedlist>
15924             </listitem>
15925
15926             <listitem>
15927               <para>If you charge a membership fee for your patrons (such as
15928               those who live in another region) you can enter that in the
15929               'Enrollment fee' field.</para>
15930
15931               <itemizedlist>
15932                 <listitem>
15933                   <important>
15934                     <para>Only enter numbers and decimals in this field</para>
15935                   </important>
15936                 </listitem>
15937               </itemizedlist>
15938             </listitem>
15939
15940             <listitem>
15941               <para>If you want your patron to receive overdue notices, set
15942               the 'Overdue notice required' to 'Yes'</para>
15943             </listitem>
15944
15945             <listitem>
15946               <para>You can decide on a patron category basis if lost items
15947               are shown in the staff client by making a choice from the 'Lost
15948               items in staff client' pull down</para>
15949
15950               <screenshot>
15951                 <screeninfo>Choose a value for 'Hide Lost Items'</screeninfo>
15952
15953                 <mediaobject>
15954                   <imageobject>
15955                     <imagedata fileref="images/admin/patroncirc/hidelostitemspatron.png"/>
15956                   </imageobject>
15957                 </mediaobject>
15958               </screenshot>
15959
15960               <itemizedlist>
15961                 <listitem>
15962                   <important>
15963                     <para>Note that this is only applicable in the staff
15964                     client, so changing this value on patron categories who do
15965                     not have access to the staff client won't make any
15966                     difference</para>
15967                   </important>
15968                 </listitem>
15969               </itemizedlist>
15970             </listitem>
15971
15972             <listitem>
15973               <para>If you charge patrons for placing holds on items, enter
15974               the fee amount in the 'Hold fee' field.</para>
15975
15976               <itemizedlist>
15977                 <listitem>
15978                   <important>
15979                     <para>Only enter numbers and decimals in this field</para>
15980                   </important>
15981                 </listitem>
15982               </itemizedlist>
15983             </listitem>
15984
15985             <listitem>
15986               <para>In the 'Category type' field choose one of the six main
15987               parent categories</para>
15988
15989               <screenshot>
15990                 <screeninfo>Six main patron categories</screeninfo>
15991
15992                 <mediaobject>
15993                   <imageobject>
15994                     <imagedata fileref="images/admin/patroncirc/patroncatpulldown.png"/>
15995                   </imageobject>
15996                 </mediaobject>
15997               </screenshot>
15998
15999               <itemizedlist>
16000                 <listitem>
16001                   <important>
16002                     <para>This field is required in order to save your patron
16003                     category. If left blank you will be presented with an
16004                     error.</para>
16005
16006                     <screenshot>
16007                       <screeninfo>Missing fields error</screeninfo>
16008
16009                       <mediaobject>
16010                         <imageobject>
16011                           <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
16012                         </imageobject>
16013                       </mediaobject>
16014                     </screenshot>
16015                   </important>
16016                 </listitem>
16017               </itemizedlist>
16018             </listitem>
16019
16020             <listitem>
16021               <para>The Branch Limitations let you limit this patron category to only some branches
16022                 in your library system.  Select 'All branches' if you would like any library to be
16023                 able to use this category.</para>
16024             </listitem>
16025             <listitem>
16026               <para>You can decide if this patron category is blocked from performing actions in the
16027                 OPAC if their card is expired using the next option.  By default it will follow the
16028                 rule set in the <link linkend="BlockExpiredPatronOpacActions"
16029                   >BlockExpiredPatronOpacActions</link> preference<screenshot>
16030                   <screeninfo>Block expired patrons</screeninfo>
16031                   <mediaobject>
16032                     <imageobject>
16033                       <imagedata fileref="images/admin/patroncirc/blockexpired.png"/>
16034                     </imageobject>
16035                   </mediaobject>
16036                 </screenshot></para>
16037             </listitem>
16038             <listitem>
16039               <para>Next you can choose the default privacy settings for this patron category.  This
16040                 setting can be edited by the patron via the OPAC if you allow it with the <link
16041                   linkend="OPACPrivacy">OPACPrivacy</link> system preference.<screenshot>
16042                   <screeninfo>Default privacy</screeninfo>
16043                   <mediaobject>
16044                     <imageobject>
16045                       <imagedata fileref="images/admin/patroncirc/defaultprivacy.png"/>
16046                     </imageobject>
16047                   </mediaobject>
16048                 </screenshot></para>
16049             </listitem>
16050             <listitem>
16051               <para>Finally you can assign advanced messaging preferences by default to a patron
16052                 category</para>
16053               <itemizedlist>
16054                 <listitem>
16055                   <para>
16056                     <important>
16057                       <para>Requires that you have <link linkend="EnhancedMessagingPreferences"
16058                           >EnhancedMessagingPreferences</link> enabled</para>
16059                     </important>
16060                   </para>
16061                 </listitem>
16062                 <listitem>
16063                   <para>These defaults will be applied to new patrons that are added to the system.
16064                     They will not edit the preferences of the existing patrons. Also, these can be
16065                     changed for individual patrons, this setting is just a default to make it easier
16066                     to set up messages for an entire category.<itemizedlist>
16067                       <listitem>
16068                         <note>
16069                           <para>After setting the default for the patron category you can force
16070                             those changes to all existing patrons by running the <emphasis
16071                               role="italic">borrowers-force-messaging-defaults</emphasis> script
16072                             found in the <emphasis role="italic">misc/maintenance</emphasis> folder.
16073                             Ask your system administrator for assistance with this script.</para>
16074                         </note>
16075                       </listitem>
16076                     </itemizedlist></para>
16077                 </listitem>
16078               </itemizedlist>
16079             </listitem>
16080           </itemizedlist>
16081         </section>
16082       </section>
16083       <section id="circfinerules">
16084         <title>Circulation and Fine Rules</title>
16085         <para>These rules define how your items are circulated, how/when fines are calculated and
16086           how holds are handled.</para>
16087         <itemizedlist>
16088           <listitem>
16089             <para><emphasis>Get there:</emphasis> More &gt; Administration &gt; Patrons &amp;
16090               Circulation &gt; Circulation and fines rules</para>
16091           </listitem>
16092         </itemizedlist>
16093         <para>The rules are applied from most specific to less specific, using the first found in
16094           this order:</para>
16095         <itemizedlist>
16096           <listitem>
16097             <para>same library, same patron type, same item type</para>
16098           </listitem>
16099           <listitem>
16100             <para>same library, same patron type, all item type</para>
16101           </listitem>
16102           <listitem>
16103             <para>same library, all patron types, same item type</para>
16104           </listitem>
16105           <listitem>
16106             <para>same library, all patron types, all item types</para>
16107           </listitem>
16108           <listitem>
16109             <para>default (all libraries), same patron type, same item type</para>
16110           </listitem>
16111           <listitem>
16112             <para>default (all libraries), same patron type, all item types</para>
16113           </listitem>
16114           <listitem>
16115             <para>default (all libraries), all patron types, same item type</para>
16116           </listitem>
16117           <listitem>
16118             <para>default (all libraries), all patron types, all item types</para>
16119           </listitem>
16120         </itemizedlist>
16121         <para>The <link linkend="CircControl">CircControl</link> and <link
16122             linkend="HomeOrHoldingBranch">HomeOrHoldingBranch</link> also come in to play when
16123           figuring out which circulation rule to follow.<itemizedlist>
16124             <listitem>
16125               <para>If CircControl is set to "the library you are logged in at" circ rules will be
16126                 selected based on the library you are logged in at </para>
16127             </listitem>
16128             <listitem>
16129               <para>If CircControl is set to "the library the patron is from" circ rules will be
16130                 selected based on the patron's library </para>
16131             </listitem>
16132             <listitem>
16133               <para>If CircControl is set to "the library the item is from" circ rules will be
16134                 selected based on the item's library where HomeOrHoldingBranch chooses if item's
16135                 home library is used or holding library is used.</para>
16136             </listitem>
16137             <listitem>
16138               <para>If <link linkend="IndependentBranches">IndependentBranches</link> is set to
16139                 'Prevent' then the value of HomeOrHoldingBranch is used in figuring out if the item
16140                 can be checked out. If the item's home library does not match the logged in library,
16141                 the item cannot be checked out unless you are a <link linkend="patronpermsdefined"
16142                   >superlibrarian</link>.</para>
16143             </listitem>
16144           </itemizedlist></para>
16145         <note>
16146           <para>If you are a single library system choose your branch name before creating rules
16147             (sometimes having only rules for the 'all libraries' option can cause issues with
16148             holds)</para>
16149         </note>
16150         <para>
16151           <important>
16152             <para>At the very least you will need to set a default circulation rule. This rule
16153               should be set for all item types, all libraries and all patron categories. That will
16154               catch all instances that do not match a specific rule. When checking out if you do not
16155               have a rule for all libraries, all item types and all patron types then you may see
16156               patrons getting blocked from placing holds. You will also want a rule for your
16157               specific library set for all item types and all patron types to avoid this holds
16158               issue. Koha needs to know what rule to fall back on.</para>
16159           </important>
16160         </para>
16161         <section id="defaultcircrules">
16162           <title>Default Circulation Rules</title>
16163           <para>Using the issuing rules matrix you can define rules that depend on patron/item type
16164             combos. To set your rules, choose a library from the pull down (or 'all libraries' if
16165             you want to apply these rules to all branches):</para>
16166           <screenshot>
16167             <screeninfo>Libraries to apply the rules to</screeninfo>
16168             <mediaobject>
16169               <imageobject>
16170                 <imagedata fileref="images/admin/patroncirc/selectissuinglibrary.png"/>
16171               </imageobject>
16172             </mediaobject>
16173           </screenshot>
16174           <para>From the matrix you can choose any combination of patron categories and item types
16175             to apply the rules to</para>
16176           <screenshot>
16177             <screeninfo>Setting issuing rules for your libraries</screeninfo>
16178             <mediaobject>
16179               <imageobject>
16180                 <imagedata fileref="images/admin/patroncirc/addcircrule.png"/>
16181               </imageobject>
16182             </mediaobject>
16183           </screenshot>
16184           <itemizedlist>
16185             <listitem>
16186               <para>First choose which patron category you'd like the rule to be applied to. If you
16187                 leave this to 'All' it will apply to all patron categories</para>
16188             </listitem>
16189             <listitem>
16190               <para>Choose the 'Item type' you would like this rule to apply to. If you leave this
16191                 to 'All' it will apply to all item types</para>
16192             </listitem>
16193             <listitem>
16194               <para>Limit the number of items a patron can have checked out at the same time by
16195                 entering a number in the 'Current checkouts allowed' field</para>
16196             </listitem>
16197             <listitem>
16198               <para>Define the period of time an item can be checked out to a patron by entering the
16199                 number of units (days or hours) in the 'Loan period' box.</para>
16200             </listitem>
16201             <listitem>
16202               <para>Choose which unit of time, Days or Hours, that the loan period and fines will be
16203                 calculated in in the 'Unit' column</para>
16204             </listitem>
16205             <listitem>
16206               <para>You can also define a hard due date for a specific patron category and item
16207                 type. A hard due date ignores your usual circulation rules and makes it so that all
16208                 items of the type defined are due on, before or after the date you specify.</para>
16209             </listitem>
16210             <listitem>
16211               <para>'Fine amount' should have the amount you would like to charge for overdue
16212                 items</para>
16213               <itemizedlist>
16214                 <listitem>
16215                   <important>
16216                     <para>Enter only numbers and decimal points (no currency symbols).</para>
16217                   </important>
16218                 </listitem>
16219               </itemizedlist>
16220             </listitem>
16221             <listitem>
16222               <para>Enter the 'Fine charging interval' in the unit you set (ex. charge fines every 1
16223                 day, or every 2 hours)</para>
16224             </listitem>
16225             <listitem>
16226               <para>The 'Fine grace period' is the period of time an item can be overdue before you
16227                 start charging fines.</para>
16228               <itemizedlist>
16229                 <listitem>
16230                   <important>
16231                     <para>This can only be set for the Day unit, not in Hours</para>
16232                   </important>
16233                 </listitem>
16234               </itemizedlist>
16235             </listitem>
16236             <listitem>
16237               <para>The 'Overdue fines cap' is the maximum fine for this patron and item
16238                 combination</para>
16239               <itemizedlist>
16240                 <listitem>
16241                   <important>
16242                     <para>If this field is left blank then Koha will not put a limit on the fines
16243                       this item will accrue. A maximum fine amount can be set using the <link linkend="MaxFine">MaxFine</link> system preference.</para>
16244                   </important>
16245                 </listitem>
16246               </itemizedlist>
16247             </listitem>
16248             <listitem>
16249               <para>If your library 'fines' patrons by suspending their account you can enter the
16250                 number of days their fine should be suspended in the 'Suspension in days'
16251                 field</para>
16252               <itemizedlist>
16253                 <listitem>
16254                   <important>
16255                     <para>This can only be set for the Day unit, not in Hours</para>
16256                   </important>
16257                 </listitem>
16258               </itemizedlist>
16259             </listitem>
16260             <listitem>
16261               <para>You can also define the maximum number of days a patron will be suspended in the
16262                 'Max suspension duration' setting</para>
16263             </listitem>
16264             <listitem>
16265               <para>Next decide if the patron can renew this item type and if so, enter how many
16266                 times they can renew it in the 'Renewals allowed' box</para>
16267             </listitem>
16268             <listitem>
16269               <para>If you're allowing renewals you can control how long the renewal loan period
16270                 will be (in the units you have chosen) in the 'Renewal period' box</para>
16271             </listitem>
16272             <listitem>
16273               <para>If you're allowing renewals you can control how soon before the due date patrons
16274                 can renew their materials with the 'No renewals before' box.<itemizedlist>
16275                   <listitem>
16276                     <para>Items can be renewed at any time if this value is left blank. Otherwise
16277                       items can only be renewed if the item is due after the number in units
16278                       (days/hours) entered in this box.</para>
16279                   </listitem>
16280                 </itemizedlist></para>
16281             </listitem>
16282             <listitem>
16283               <para>You can enable automatic renewals for certain items/patrons if you'd like. This
16284                 will renew automatically following your circulation rules unless there is a hold on
16285                 the item<itemizedlist>
16286                   <listitem>
16287                     <important>
16288                       <para>You will need to enable the <link linkend="autorenewcron">automatic
16289                           renewal cron job</link> for this to work.</para>
16290                     </important>
16291                   </listitem>
16292                   <listitem>
16293                     <important>
16294                       <para>This feature needs to have the "no renewal before" column filled in or
16295                         it will auto renew everyday after the due date </para>
16296                     </important>
16297                   </listitem>
16298                 </itemizedlist></para>
16299             </listitem>
16300             <listitem>
16301               <para>If the patron can place holds on this item type, enter the total numbers of
16302                 items (of this type) that can be put on hold in the 'Holds allowed' field</para>
16303             </listitem>
16304             <listitem>
16305               <para>Next you can decide if this patron/item combo are allowed to place holds on
16306                 items that are on the shelf (or available in the library) or not. If you choose 'no'
16307                 then items can only be placed on hold if checked out</para>
16308             </listitem>
16309             <listitem>
16310               <para>You can also decide if patrons are allowed to place item specific holds on the
16311                 item type in question.  The options are:<itemizedlist>
16312                   <listitem>
16313                     <para>Allow: Will allow patrons the option to choose next available or item
16314                       specific</para>
16315                   </listitem>
16316                   <listitem>
16317                     <para>Don't allow: Will only allow patrons to choose next available</para>
16318                   </listitem>
16319                   <listitem>
16320                     <para>Force: Will only allow patrons to choose an specific item</para>
16321                   </listitem>
16322                 </itemizedlist></para>
16323             </listitem>
16324             <listitem>
16325               <para>Finally, if you charge a <link linkend="rentalcharge">rental fee</link> for the
16326                 item type and want to give a specific patron type a discount on that fee, enter the
16327                 percentage discount (without the % symbol) in the 'Rental Discount' field</para>
16328             </listitem>
16329           </itemizedlist>
16330           <para>When finished, click 'Add' to save your changes. To modify a rule, simply click the
16331             'Edit' link to the right of the fule and edit the values that appear filled in at the
16332             bottom of the form.</para>
16333           <screenshot>
16334               <screeninfo>Edit circ and fine rule</screeninfo>
16335               <mediaobject>
16336                 <imageobject>
16337                   <imagedata fileref="images/admin/patroncirc/editcircfine.png"/>
16338                 </imageobject>
16339               </mediaobject>
16340             </screenshot>
16341           <para>If you would like to delete your rule, click the 'Delete' link to the right of the
16342             rule.</para>
16343           <para>To save time you can clone rules from one library to another by choosing the clone
16344             option above the rules matrix.</para>
16345           <screenshot>
16346             <screeninfo>Circulation &amp; Fine Rules Clone Tool</screeninfo>
16347             <mediaobject>
16348               <imageobject>
16349                 <imagedata fileref="images/admin/patroncirc/clonerules.png"/>
16350               </imageobject>
16351             </mediaobject>
16352           </screenshot>
16353           <para>After choosing to clone you will be presented with a confirmation message.</para>
16354           <screenshot>
16355             <screeninfo>Circulation &amp; Fine Rules Successfully Cloned Message</screeninfo>
16356             <mediaobject>
16357               <imageobject>
16358                 <imagedata fileref="images/admin/patroncirc/rulescloned.png"/>
16359               </imageobject>
16360             </mediaobject>
16361           </screenshot>
16362         </section>
16363         <section id="defaultcheckoutpolicy">
16364           <title>Default Checkouts and Hold Policy</title>
16365           <para>You can set a default maximum number of checkouts and hold policy that will be used
16366             if none is defined below for a particular item type or category.  This is the fall back
16367             rule for defaults.</para>
16368           <screenshot>
16369             <screeninfo>Default Checkouts and Hold Policy</screeninfo>
16370             <mediaobject>
16371               <imageobject>
16372                 <imagedata fileref="images/admin/patroncirc/defaultcheckholds.png"/>
16373               </imageobject>
16374             </mediaobject>
16375           </screenshot>
16376           <para>From this menu you can set a default to apply to all item types and patrons in the
16377             library if no other option is set in the forms below.</para>
16378           <itemizedlist>
16379             <listitem>
16380               <para>In 'Total Current Checkouts Allowed' enter the total number of items patrons can
16381                 have checked out at one time</para>
16382             </listitem>
16383             <listitem>
16384               <para>Control where patrons can place holds from using the 'Hold Policy' menu</para>
16385               <itemizedlist>
16386                 <listitem>
16387                   <para>From Any Library: Patrons from any library may put this item on hold.
16388                     (default if none is defined)</para>
16389                 </listitem>
16390                 <listitem>
16391                   <para>From Home Library: Only patrons from the item's home library may put this
16392                     book on hold.</para>
16393                 </listitem>
16394                 <listitem>
16395                   <para>No Holds Allowed: No patron may put this book on hold.</para>
16396                 </listitem>
16397               </itemizedlist>
16398             </listitem>
16399             <listitem>
16400               <para>Control where the item returns to once it is checked in</para>
16401               <itemizedlist>
16402                 <listitem>
16403                   <para>Item returns home</para>
16404                 </listitem>
16405                 <listitem>
16406                   <para>Item returns to issuing branch</para>
16407                 </listitem>
16408                 <listitem>
16409                   <para>Item floats</para>
16410                   <itemizedlist>
16411                     <listitem>
16412                       <para>When an item floats it stays where it was checked in and does not ever
16413                         return 'home'</para>
16414                     </listitem>
16415                   </itemizedlist>
16416                 </listitem>
16417               </itemizedlist>
16418             </listitem>
16419             <listitem>
16420               <para>Once your policy is set, you can unset it by clicking the 'Unset' link to the
16421                 right of the rule</para>
16422             </listitem>
16423           </itemizedlist>
16424         </section>
16425         <section id="checkoutperpatron">
16426           <title>Checkouts Per Patron</title>
16427           <para>For this library, you can specify the maximum number of loans that a patron of a
16428             given category can make, regardless of the item type.  </para>
16429           <screenshot>
16430             <screeninfo>Set default checkouts per patron category</screeninfo>
16431             <mediaobject>
16432               <imageobject>
16433                 <imagedata fileref="images/admin/patroncirc/checkoutsperpatron.png"/>
16434               </imageobject>
16435             </mediaobject>
16436           </screenshot>
16437           <note>
16438             <para>If the total amount loanable for a given patron category is left blank, no limit
16439               applies, except possibly for a limit you define for a specific item type.</para>
16440           </note>
16441           <para>For example, if you have a rule in the matrix that says Board patrons are allowed 10
16442             books and 5 DVDs but you want to make it so that Board patrons only have a total of 12
16443             things checked out at once.  If you enter 12 here and the patron has 10 books out
16444             already they will only be allowed 2 DVDs to equal the 12 total they're allowed.</para>
16445         </section>
16446         <section id="holdpolicies">
16447           <title>Item Hold Policies</title>
16448           <para>For this library, you can edit hold and return policies for a given item type,
16449             regardless of the patron's category.</para>
16450           <screenshot>
16451             <screeninfo>Hold policies per item type</screeninfo>
16452             <mediaobject>
16453               <imageobject>
16454                 <imagedata fileref="images/admin/patroncirc/holdsperitem.png"/>
16455               </imageobject>
16456             </mediaobject>
16457           </screenshot>
16458           <para>The various Hold Policies have the following effects:</para>
16459           <itemizedlist>
16460             <listitem>
16461               <para>From Any Library: Patrons from any library may put this item on hold. (default
16462                 if none is defined)</para>
16463             </listitem>
16464             <listitem>
16465               <para>From Home Library: Only patrons from the item's home library may put this book
16466                 on hold.</para>
16467             </listitem>
16468             <listitem>
16469               <para>No Holds Allowed: No patron may put this book on hold.</para>
16470             </listitem>
16471           </itemizedlist>
16472           <important>
16473             <para>Note that if the system preference <link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link> set to 'allow', these policies can be overridden by
16474               your circulation staff.</para>
16475           </important>
16476           <important>
16477             <para>These policies are based on the patron's home branch, not the branch that the
16478               reserving staff member is from.</para>
16479           </important>
16480           <para>The various Return Policies have the following effects:</para>
16481           <itemizedlist>
16482             <listitem>
16483               <para>Item returns home: The item will prompt the librarian to transfer the item to
16484                 its home library</para>
16485               <itemizedlist>
16486                 <listitem>
16487                   <important>
16488                     <para>If the <link linkend="AutomaticItemReturn">AutomaticItemReturn</link>
16489                       preference is set to automatically transfer the items home, then a prompt will
16490                       not appear</para>
16491                   </important>
16492                 </listitem>
16493               </itemizedlist>
16494             </listitem>
16495             <listitem>
16496               <para>Item returns to issuing branch: The item will prompt the librarian to transfer
16497                 the item back to the library where it was checked out</para>
16498               <itemizedlist>
16499                 <listitem>
16500                   <important>
16501                     <para>If the <link linkend="AutomaticItemReturn">AutomaticItemReturn</link>
16502                       preference is set to automatically transfer the items home, then a prompt will
16503                       not appear</para>
16504                   </important>
16505                 </listitem>
16506               </itemizedlist>
16507             </listitem>
16508             <listitem>
16509               <para>Item floats: The item will not be transferred from the branch it was checked in
16510                 at, instead it will remain there until transferred manually or checked in at another
16511                 branch</para>
16512             </listitem>
16513           </itemizedlist>
16514           <para>For example you might allow holds at your libraries but not what New items or DVDs to
16515             be placed on hold by other branches so you can set the 'Hold policy' to 'From home
16516             library' so that those items can only be placed on hold if the items' owning library and
16517             the patron's home library are the same.  You can also block holds completely on specific
16518             item types from this form.  This is also how you can set up floating item types and
16519             types that remain with their home library.</para>
16520         </section>
16521       </section>
16522       <section id="patronattributetypes">
16523         <title>Patron Attribute Types</title>
16524         <para>Patron attributes can be used to define custom fields to associate with your patron
16525           records. In order to enable the use of custom fields you need to set the <link linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link> system
16526           preference.</para>
16527         <itemizedlist>
16528           <listitem>
16529             <para><emphasis>Get there:</emphasis> More &gt; Administration &gt; Patrons &amp;
16530               Circulation &gt; Patron attribute types</para>
16531           </listitem>
16532         </itemizedlist>
16533         <para>A common use for this field would be for a student ID number or a Driver's license
16534           number.</para>
16535         <screenshot>
16536           <screeninfo>List of Patron Attributes</screeninfo>
16537           <mediaobject>
16538             <imageobject>
16539               <imagedata fileref="images/admin/patroncirc/attributes.png"/>
16540             </imageobject>
16541           </mediaobject>
16542         </screenshot>
16543         <section id="addpatattributes">
16544           <title>Adding Patron Attributes</title>
16545           <para>To add a new Patron Attribute Type, click the 'New Patron Attribute Type' button at
16546             the top of the page</para>
16547           <screenshot>
16548             <screeninfo>Add Patron Attribute Type form</screeninfo>
16549             <mediaobject>
16550               <imageobject>
16551                 <imagedata fileref="images/admin/patroncirc/addattribute.png"/>
16552               </imageobject>
16553             </mediaobject>
16554           </screenshot>
16555           <itemizedlist>
16556             <listitem>
16557               <para>In the 'Patron attribute type code', enter a short code to identify this
16558                 field</para>
16559               <itemizedlist>
16560                 <listitem>
16561                   <important>
16562                     <para>This field is limited to 10 characters (numbers and letters only)</para>
16563                   </important>
16564                 </listitem>
16565                 <listitem>
16566                   <important>
16567                     <para>This setting cannot be changed after an attribute is defined</para>
16568                   </important>
16569                 </listitem>
16570               </itemizedlist>
16571             </listitem>
16572             <listitem>
16573               <para>In the 'Description' field, enter a longer (plain text) explanation of what this
16574                 field will contain</para>
16575             </listitem>
16576             <listitem>
16577               <para>Check the box next to 'Repeatable' to let a patron record have multiple values
16578                 of this attribute.</para>
16579               <itemizedlist>
16580                 <listitem>
16581                   <important>
16582                     <para>This setting cannot be changed after an attribute is defined</para>
16583                   </important>
16584                 </listitem>
16585               </itemizedlist>
16586             </listitem>
16587             <listitem>
16588               <para>If 'Unique identifier' is checked, the attribute will be a unique identifier
16589                 which means, if a value is given to a patron record, the same value cannot be given
16590                 to a different record.</para>
16591               <itemizedlist>
16592                 <listitem>
16593                   <important>
16594                     <para>This setting cannot be changed after an attribute is defined</para>
16595                   </important>
16596                 </listitem>
16597               </itemizedlist>
16598             </listitem>
16599             <listitem>
16600               <para>Check 'Allow password' to make it possible to associate a password with this
16601                 attribute.</para>
16602             </listitem>
16603             <listitem>
16604               <para>Check 'Display in OPAC' to display this attribute on a patron's details page in
16605                 the OPAC.</para>
16606             </listitem>
16607             <listitem>
16608               <para>Check 'Searchable' to make this attribute searchable in the staff patron
16609                 search.</para>
16610             </listitem>
16611             <listitem>
16612               <para>Check 'Display in check-out' to make this attribute visible in the patron's
16613                 short detail display on the left of the checkout screen and other patron
16614                 pages</para>
16615               <screenshot>
16616                 <screeninfo>Show attribute in patron detail on the left</screeninfo>
16617                 <mediaobject>
16618                   <imageobject>
16619                     <imagedata fileref="images/admin/patroncirc/showattribute.png"/>
16620                   </imageobject>
16621                 </mediaobject>
16622               </screenshot>
16623             </listitem>
16624             <listitem>
16625               <para>Authorized value category; if one is selected, the patron record input page will
16626                 only allow values to be chosen from the authorized value list.</para>
16627               <itemizedlist>
16628                 <listitem>
16629                   <para>You will first need to add an authorized value list for it to appear in this
16630                     menu</para>
16631                   <itemizedlist>
16632                     <listitem>
16633                       <para><emphasis>Get there: </emphasis>More &gt; Administration &gt; Basic
16634                         Parameters &gt; <link linkend="authorizedvalues">Authorized
16635                         Values</link></para>
16636                     </listitem>
16637                   </itemizedlist>
16638                 </listitem>
16639                 <listitem>
16640                   <important>
16641                     <para>an authorized value list is not enforced during batch patron
16642                       import.</para>
16643                   </important>
16644                 </listitem>
16645               </itemizedlist>
16646             </listitem>
16647             <listitem>
16648               <para>If you would like this attribute to only be used by specific branches you can
16649                 choose those branches from the 'Branches limitation' list. Choose 'All branches' to
16650                 show it for all libraries.<itemizedlist>
16651                   <listitem>
16652                     <important>
16653                       <para>Note that items with locations already set on them will not be altered.
16654                         The branch limitation only limits the choosing of an authorized value based
16655                         on the home branch of the current staff login. All authorized values for
16656                         item records (LOC, LOST, CCODE, etc) will show in the OPAC for all
16657                         patrons.</para>
16658                     </important>
16659                   </listitem>
16660                 </itemizedlist></para>
16661             </listitem>
16662             <listitem>
16663               <para>If you'd like to only show this attribute on patrons of one type choose that
16664                 patron type from the 'Category' pull down</para>
16665             </listitem>
16666             <listitem>
16667               <para>If you have a lot of attributes it might be handy to group them so that you can
16668                 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
16669                 you can then change your attributes page to have sections of attributes</para>
16670               <screenshot>
16671                 <screeninfo>Patron Attributes Sorted</screeninfo>
16672                 <mediaobject>
16673                   <imageobject>
16674                     <imagedata fileref="images/admin/patroncirc/pa_class.png"/>
16675                   </imageobject>
16676                 </mediaobject>
16677               </screenshot>
16678             </listitem>
16679             <listitem>
16680               <para>Click Save to save your new attribute</para>
16681             </listitem>
16682           </itemizedlist>
16683           <para>Once added your attribute will appear on the list of attributes and also on the
16684             patron record add/edit form</para>
16685           <screenshot>
16686             <screeninfo>Patron Attributes list on the Patron add/edit form</screeninfo>
16687             <mediaobject>
16688               <imageobject>
16689                 <imagedata fileref="images/admin/patroncirc/patronattribute.png"/>
16690               </imageobject>
16691             </mediaobject>
16692           </screenshot>
16693           <para>If you have set up classes for organizing attributes they will appear that way on
16694             the add/edit patron form</para>
16695           <screenshot>
16696             <screeninfo>Grouped Attributes</screeninfo>
16697             <mediaobject>
16698               <imageobject>
16699                 <imagedata fileref="images/admin/patroncirc/pa_class-patron.png"/>
16700               </imageobject>
16701             </mediaobject>
16702           </screenshot>
16703         </section>
16704         <section id="editpatattributes">
16705           <title>Editing/Deleting Patron Attributes</title>
16706           <para>Each patron attribute has an edit and a delete link beside it on the list of
16707             attributes.</para>
16708           <para>Some fields in the attribute will not be editable once created:</para>
16709           <itemizedlist>
16710             <listitem>
16711               <para>Patron attribute type code</para>
16712             </listitem>
16713             <listitem>
16714               <para>Repeatable</para>
16715             </listitem>
16716             <listitem>
16717               <para>Unique identifier</para>
16718             </listitem>
16719           </itemizedlist>
16720           <para>You will be unable to delete an attribute if it's in use.</para>
16721           <screenshot>
16722             <screeninfo>Warning when trying to delete an attribute that is in use</screeninfo>
16723             <mediaobject>
16724               <imageobject>
16725                 <imagedata fileref="images/admin/patroncirc/deletepatronattr.png"/>
16726               </imageobject>
16727             </mediaobject>
16728           </screenshot>
16729         </section>
16730       </section>
16731       <section id="libtransferlimits">
16732         <title>Library Transfer Limits</title>
16733         <para>Limit the ability to transfer items between libraries based on the library sending,
16734           the library receiving, and the collection code involved.</para>
16735         <itemizedlist>
16736           <listitem>
16737             <para><emphasis>Get there:</emphasis> More &gt; Administration &gt; Patrons &amp;
16738               Circulation &gt; Library Transfer Limits</para>
16739           </listitem>
16740         </itemizedlist>
16741         <para>These rules only go into effect if the preference <link linkend="UseBranchTransferLimits">UseBranchTransferLimits</link> is set to
16742           'enforce'.</para>
16743         <para>Before you begin you will want to choose which library you are setting these limits
16744           for.</para>
16745         <screenshot>
16746           <screeninfo>Choose the library you're setting limits for</screeninfo>
16747           <mediaobject>
16748             <imageobject>
16749               <imagedata fileref="images/admin/patroncirc/librarytransferselect.png"/>
16750             </imageobject>
16751           </mediaobject>
16752         </screenshot>
16753         <para>Transfer limits are set based on the collections codes you have applied via the <link linkend="authorizedvalues">Authorized Value</link> administration area.</para>
16754         <screenshot>
16755           <screeninfo>Collection Code values assigned in the Authorized Value area</screeninfo>
16756           <mediaobject>
16757             <imageobject>
16758               <imagedata fileref="images/admin/patroncirc/collectcodes.png"/>
16759             </imageobject>
16760           </mediaobject>
16761         </screenshot>
16762         <para>Collection codes will appear as tabs above the checkboxes:</para>
16763         <screenshot>
16764           <screeninfo>Collection Code tabs</screeninfo>
16765           <mediaobject>
16766             <imageobject>
16767               <imagedata fileref="images/admin/patroncirc/limittocollcode.png"/>
16768             </imageobject>
16769           </mediaobject>
16770         </screenshot>
16771         <para>Check the boxes for the libraries that you accept checkins from for the item type you
16772           have selected at the top (in the example below - FIC)</para>
16773         <screenshot>
16774           <screeninfo>Example transfer limits set up</screeninfo>
16775           <mediaobject>
16776             <imageobject>
16777               <imagedata fileref="images/admin/patroncirc/transferlimits.png"/>
16778             </imageobject>
16779           </mediaobject>
16780         </screenshot>
16781         <para>In the above example, Centerville library will allow patrons to return items from all
16782           libraries except Liberty and Franklin to their branch.</para>
16783       </section>
16784       <section id="transportcostmatrix">
16785         <title>Transport cost matrix</title>
16786         <para>The Transport cost matrix lets a library system define relative costs to transport
16787           books to one another. In order for the system to use this matrix you must first set the
16788             <link linkend="UseTransportCostMatrix">UseTransportCostMatrix</link> preference to
16789           'Use'.  <important>
16790             <para>The Transport cost matrix takes precedence in controlling where holds are filled
16791               from, if the matrix is not used then Koha checks the <link linkend="holdqueueweight">StaticHoldsQueueWeight</link>.</para>
16792           </important></para>
16793         <para>Costs are decimal values between some arbitrary maximum value (e.g. 1 or 100) and 0
16794           which is the minimum (no) cost. For example, you could just use the distance between each
16795           library in miles as your 'cost', if that would accurately reflect the cost of transferring
16796           them. Perhaps post offices would be a better measure. Libraries sharing a post office
16797           would have a cost of 1, adjacent post offices would have a cost of 2, etc.</para>
16798         <para>To enter transport costs simply click in the cell you would like to alter, uncheck the
16799           'Disable' box and enter your 'cost'</para>
16800         <screenshot>
16801             <screeninfo>Transport cost matrix</screeninfo>
16802             <mediaobject>
16803               <imageobject>
16804                 <imagedata fileref="images/admin/patroncirc/transportcostmatrix.png"/>
16805               </imageobject>
16806             </mediaobject>
16807           </screenshot>
16808         <para>After entering in your cost, hit 'Enter' on your keyboard or click the 'Save' button
16809           at the bottom of the matrix to save your changes.</para>
16810       </section>
16811       <section id="itemcircalerts">
16812         <title>Item Circulation Alerts</title>
16813         <para>Libraries can decide if they want to have patrons automatically notified of
16814           circulation events (check ins and check outs).</para>
16815         <itemizedlist>
16816           <listitem>
16817             <para><emphasis>Get there:</emphasis> More &gt; Administration &gt; Patrons &amp;
16818               Circulation &gt; Item Circulation Alerts</para>
16819           </listitem>
16820         </itemizedlist>
16821         <para>These preferences are set based on patron types and item types.</para>
16822         <important>
16823           <para>These preference can be overridden by changes in the individual patron's messaging
16824             preferences.</para>
16825         </important>
16826         <para>To set up circulation alerts:</para>
16827         <itemizedlist>
16828           <listitem>
16829             <para>Choose your library from the pull down at the top of the screen</para>
16830             <screenshot>
16831               <screeninfo>Libraries to set Circulation Alerts</screeninfo>
16832               <mediaobject>
16833                 <imageobject>
16834                   <imagedata fileref="images/admin/patroncirc/librariesforalert.png"/>
16835                 </imageobject>
16836               </mediaobject>
16837             </screenshot>
16838             <itemizedlist>
16839               <listitem>
16840                 <para>To set preferences for all libraries, keep the menu set to 'Default'</para>
16841               </listitem>
16842             </itemizedlist>
16843           </listitem>
16844           <listitem>
16845             <para>By default all item types and all patrons are notified of check ins and check
16846               outs. To change this, click on the item/patron type combo that you would like to stop
16847               notices for.</para>
16848             <screenshot>
16849               <screeninfo>Circulation Alert Matrix</screeninfo>
16850               <mediaobject>
16851                 <imageobject>
16852                   <imagedata fileref="images/admin/patroncirc/alertmatrix.png"/>
16853                 </imageobject>
16854               </mediaobject>
16855             </screenshot>
16856             <itemizedlist>
16857               <listitem>
16858                 <para>In the above example, Juveniles and Kids will not receive check out
16859                   notices.</para>
16860               </listitem>
16861             </itemizedlist>
16862           </listitem>
16863         </itemizedlist>
16864       </section>
16865
16866       <section id="citytowns">
16867         <title>Cities and Towns</title>
16868
16869         <para>To standardize patron input you can define cities or towns
16870         within your region so that when new patrons are added librarians
16871         simply have to select the town from a list instead of having to type
16872         the town and zip (or postal) code information.</para>
16873
16874         <itemizedlist>
16875           <listitem>
16876             <para><emphasis>Get there:</emphasis> More &gt; Administration
16877             &gt; Patrons &amp; Circulation &gt; Cities and Towns</para>
16878           </listitem>
16879         </itemizedlist>
16880
16881         <section id="addingcity">
16882           <title>Adding a City</title>
16883
16884           <para>To add a new city, click the 'New City' button at the top of
16885           the page and enter the city name, state, zip/postal code and
16886           country.</para>
16887
16888           <screenshot>
16889             <screeninfo>New city entry form</screeninfo>
16890
16891             <mediaobject>
16892               <imageobject>
16893                 <imagedata fileref="images/admin/patroncirc/newcity.png"/>
16894               </imageobject>
16895             </mediaobject>
16896           </screenshot>
16897
16898           <para>One you click Submit, your city will be saved and will be
16899           listed on the Cities and Towns page</para>
16900
16901           <screenshot>
16902             <screeninfo>List of Cities</screeninfo>
16903
16904             <mediaobject>
16905               <imageobject>
16906                 <imagedata fileref="images/admin/patroncirc/cities.png"/>
16907               </imageobject>
16908             </mediaobject>
16909           </screenshot>
16910
16911           <para>Cities can be edited or deleted at any time.</para>
16912         </section>
16913
16914         <section id="citiesonpatform">
16915           <title>Viewing Cities on Patron Add Form</title>
16916
16917           <para>If you have defined local cities using the New city form, then
16918           when adding or editing a patron record you will see those cities in
16919           a pull down menu to make city selection easy.</para>
16920
16921           <screenshot>
16922             <screeninfo>Cities pull down on the patron record</screeninfo>
16923
16924             <mediaobject>
16925               <imageobject>
16926                 <imagedata fileref="images/admin/patroncirc/patroncity.png"/>
16927               </imageobject>
16928             </mediaobject>
16929           </screenshot>
16930
16931           <para>This will allow for easy entry of local cities into the patron
16932           record without risking the potential for typos or mistaken
16933           zip/postal codes.</para>
16934         </section>
16935       </section>
16936     </section>
16937
16938     <section id="catadmin">
16939       <title>Catalog Administration</title>
16940
16941       <para>Set these controls before you start cataloging on your Koha
16942       system.</para>
16943
16944       <itemizedlist>
16945         <listitem>
16946           <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
16947           Catalog</para>
16948         </listitem>
16949       </itemizedlist>
16950
16951       <section id="marcbibframeworks">
16952         <title>MARC Bibliographic Frameworks</title>
16953
16954         <para>Think of Frameworks as templates for creating new bibliographic
16955         records. Koha comes with some predefined frameworks that can be edited
16956         or deleted, and librarians can create their own frameworks for content
16957         specific to their libraries.</para>
16958
16959         <itemizedlist>
16960           <listitem>
16961             <para><emphasis>Get there:</emphasis> More &gt; Administration
16962             &gt; Catalog &gt; MARC Bibliographic Frameworks</para>
16963           </listitem>
16964         </itemizedlist>
16965
16966         <screenshot>
16967           <screeninfo>Frameworks List</screeninfo>
16968
16969           <mediaobject>
16970             <imageobject>
16971               <imagedata fileref="images/admin/cataloging/frameworks.png"/>
16972             </imageobject>
16973           </mediaobject>
16974         </screenshot>
16975
16976         <important>
16977           <para>Do not delete or edit the Default Framework since this will
16978           cause problems with your cataloging records - always create a new
16979           template based on the Default Framework, or alter the other
16980           Frameworks.</para>
16981         </important>
16982
16983         <para>After clicking the 'MARC structure' link to the right of each
16984         framework you can decide how many fields you want to see on one screen
16985         by using the pagination options at the top of the table.</para>
16986
16987         <screenshot>
16988           <screeninfo>Pagination options</screeninfo>
16989
16990           <mediaobject>
16991             <imageobject>
16992               <imagedata fileref="images/admin/cataloging/frameworkoptions.png"/>
16993             </imageobject>
16994           </mediaobject>
16995         </screenshot>
16996
16997         <section id="addframework">
16998           <title>Add New Framework</title>
16999
17000           <para>To add a new framework</para>
17001
17002           <itemizedlist>
17003             <listitem>
17004               <para>Click 'New Framework'</para>
17005
17006               <screenshot>
17007                 <screeninfo>Add Framework Form</screeninfo>
17008
17009                 <mediaobject>
17010                   <imageobject>
17011                     <imagedata fileref="images/admin/cataloging/addframework.png"/>
17012                   </imageobject>
17013                 </mediaobject>
17014               </screenshot>
17015
17016               <itemizedlist>
17017                 <listitem>
17018                   <para>Enter a code of 4 or fewer characters</para>
17019                 </listitem>
17020
17021                 <listitem>
17022                   <para>Use the Description field to enter a more detailed
17023                   definition of your framework</para>
17024                 </listitem>
17025               </itemizedlist>
17026             </listitem>
17027
17028             <listitem>
17029               <para>Click 'Submit'</para>
17030             </listitem>
17031
17032             <listitem>
17033               <para>Once your Framework is added click 'MARC structure' to the
17034               right of it on the list of Frameworks</para>
17035
17036               <screenshot>
17037                 <screeninfo>Choose basis for new Framework</screeninfo>
17038
17039                 <mediaobject>
17040                   <imageobject>
17041                     <imagedata fileref="images/admin/cataloging/startnewframework.png"/>
17042                   </imageobject>
17043                 </mediaobject>
17044               </screenshot>
17045
17046               <itemizedlist>
17047                 <listitem>
17048                   <para>You will be asked to choose a Framework to base your
17049                   new Framework off of, this will make it easier than starting
17050                   from scratch</para>
17051                 </listitem>
17052               </itemizedlist>
17053             </listitem>
17054
17055             <listitem>
17056               <para>Once your Framework appears on the screen you can edit or
17057               delete each field by following the instructions for <link linkend="editsubfields">editing subfields</link></para>
17058             </listitem>
17059           </itemizedlist>
17060         </section>
17061
17062         <section id="editframeworks">
17063           <title>Edit Existing Frameworks</title>
17064
17065           <para>Clicking 'Edit' to the right of a Framework will only allow
17066           you to edit the Description for the Framework:</para>
17067
17068           <screenshot>
17069             <screeninfo>Edit Framework</screeninfo>
17070
17071             <mediaobject>
17072               <imageobject>
17073                 <imagedata fileref="images/admin/cataloging/editframework.png"/>
17074               </imageobject>
17075             </mediaobject>
17076           </screenshot>
17077
17078           <para>To make edits to the fields associated with the Framework you
17079           must first click 'MARC Structure' and then follow the instructions
17080           for <link linkend="editsubfields">editing subfields</link></para>
17081         </section>
17082
17083         <section id="addsubfieldsframework">
17084           <title>Add subfields to Frameworks</title>
17085
17086           <para>To add a field to a Framework click the 'New Tag' button at
17087           the top of the Framework definition</para>
17088
17089           <screenshot>
17090             <screeninfo>New Tag Button</screeninfo>
17091
17092             <mediaobject>
17093               <imageobject>
17094                 <imagedata fileref="images/admin/cataloging/newtag.png"/>
17095               </imageobject>
17096             </mediaobject>
17097           </screenshot>
17098
17099           <para>This will open up a blank form for entering MARC field
17100           data</para>
17101
17102           <screenshot>
17103             <screeninfo>Add a new tag to framework</screeninfo>
17104
17105             <mediaobject>
17106               <imageobject>
17107                 <imagedata fileref="images/admin/cataloging/newtagform.png"/>
17108               </imageobject>
17109             </mediaobject>
17110           </screenshot>
17111
17112           <para>Enter the information about your new tag:</para>
17113
17114           <itemizedlist>
17115             <listitem>
17116               <para>The 'Tag' is the MARC field number</para>
17117             </listitem>
17118
17119             <listitem>
17120               <para>The 'Label for lib' is the text that will appear in the
17121               staff client when in the cataloging module</para>
17122             </listitem>
17123
17124             <listitem>
17125               <para>The 'Label for OPAC' is the text that will appear in the
17126               OPAC when viewing the MARC version of the record</para>
17127             </listitem>
17128
17129             <listitem>
17130               <para>If this field can be repeated, check the 'Repeatable'
17131               box</para>
17132             </listitem>
17133
17134             <listitem>
17135               <para>If this field is mandatory, check the 'Mandatory'
17136               box</para>
17137             </listitem>
17138
17139             <listitem>
17140               <para>If you want this field to be a pull down with limited
17141               possible answers, choose which 'Authorized value' list you want
17142               to use</para>
17143             </listitem>
17144           </itemizedlist>
17145
17146           <para>When you're finished, click 'Save Changes' and you will be
17147           presented with your new field</para>
17148
17149           <screenshot>
17150             <screeninfo>New tag and link to subfields</screeninfo>
17151
17152             <mediaobject>
17153               <imageobject>
17154                 <imagedata fileref="images/admin/cataloging/subfieldslink.png"/>
17155               </imageobject>
17156             </mediaobject>
17157           </screenshot>
17158
17159           <para>To the right of the new field is a link to 'Subfields,' you
17160           will need to add subfields before this tag will appear in your MARC
17161           editor. The process of entering the settings for the new subfield is
17162           the same as those found in the <link linkend="editsubfields">editing
17163           subfields in frameworks</link> section of this manual.</para>
17164         </section>
17165
17166         <section id="editsubfields">
17167           <title>Edit Framework Subfields</title>
17168
17169           <para>Frameworks are made up of MARC fields and subfields. To make
17170           edits to most Frameworks you must edit the fields and subfields.
17171           Clicking 'Edit' to the right of each subfield will allow you to make
17172           changes to the text associated with the field</para>
17173
17174           <screenshot>
17175             <screeninfo>Modify MARC Field</screeninfo>
17176
17177             <mediaobject>
17178               <imageobject>
17179                 <imagedata fileref="images/admin/cataloging/editfield.png"/>
17180               </imageobject>
17181             </mediaobject>
17182           </screenshot>
17183
17184           <itemizedlist>
17185             <listitem>
17186               <para>Each field has a tag (which is the MARC tag) that is uneditable</para>
17187
17188               <itemizedlist>
17189                 <listitem>
17190                   <para>The 'Label for lib' is what will show in the staff
17191                   client if you have <link linkend="advancedMARCeditor">advancedMARCeditor</link> set
17192                   to display labels</para>
17193                 </listitem>
17194
17195                 <listitem>
17196                   <para>The 'Label for OPAC' is what will show on the MARC
17197                   view in the OPAC</para>
17198                 </listitem>
17199
17200                 <listitem>
17201                   <para>If you check 'Repeatable' then the field will have a
17202                   plus sign next to it allowing you to add multiples of that
17203                   tag</para>
17204                 </listitem>
17205
17206                 <listitem>
17207                   <para>If you check 'Mandatory' the record will not be
17208                   allowed to save unless you have a value assigned to this
17209                   tag</para>
17210                 </listitem>
17211
17212                 <listitem>
17213                   <para>'Authorized value' is where you define an <link linkend="authorizedvalues">authorized value</link> that your
17214                   catalogers can choose from a pull down to fill this field
17215                   in</para>
17216                 </listitem>
17217               </itemizedlist>
17218             </listitem>
17219           </itemizedlist>
17220
17221           <para>To edit the subfields associated with the tag, click
17222           'Subfields' to the right of the tag on the 'MARC Structure'
17223           listing</para>
17224
17225           <itemizedlist>
17226             <listitem>
17227               <para>From the list of subfields you can click 'Delete' to the
17228               right of each to delete the subfields</para>
17229             </listitem>
17230
17231             <listitem>
17232               <para>To edit the subfields click 'Edit Subfields'</para>
17233             </listitem>
17234
17235             <listitem>
17236               <para>For each subfield you can set the following Basic constraint values</para>
17237               <screenshot>
17238                 <screeninfo>Editing the 504 Subfield</screeninfo>
17239                 <mediaobject>
17240                   <imageobject>
17241                     <imagedata fileref="images/admin/cataloging/editsubfield.png"/>
17242                   </imageobject>
17243                 </mediaobject>
17244               </screenshot>
17245
17246               <itemizedlist>
17247                 <listitem>
17248                   <para>Text for librarian</para>
17249
17250                   <itemizedlist>
17251                     <listitem>
17252                       <para>what appears before the subfield in the librarian
17253                       interface</para>
17254                     </listitem>
17255                   </itemizedlist>
17256                 </listitem>
17257
17258                 <listitem>
17259                   <para>Text for OPAC</para>
17260
17261                   <itemizedlist>
17262                     <listitem>
17263                       <para>what appears before the field in the OPAC.</para>
17264
17265                       <itemizedlist>
17266                         <listitem>
17267                           <para>If left empty, the text for librarian is used
17268                           instead</para>
17269                         </listitem>
17270                       </itemizedlist>
17271                     </listitem>
17272                   </itemizedlist>
17273                 </listitem>
17274
17275                 <listitem>
17276                   <para>Repeatable</para>
17277
17278                   <itemizedlist>
17279                     <listitem>
17280                       <para>the field will have a plus sign next to it
17281                       allowing you to add multiples of that tag</para>
17282                     </listitem>
17283                   </itemizedlist>
17284                 </listitem>
17285
17286                 <listitem>
17287                   <para>Mandatory</para>
17288
17289                   <itemizedlist>
17290                     <listitem>
17291                       <para>the record will not be allowed to save unless you
17292                       have a value assigned to this tag</para>
17293                     </listitem>
17294                   </itemizedlist>
17295                 </listitem>
17296
17297                 <listitem>
17298                   <para>Managed in tab</para>
17299
17300                   <itemizedlist>
17301                     <listitem>
17302                       <para>defines the tab where the subfield is shown. All
17303                       subfields of a given field must be in the same tab or
17304                       ignored. Ignore means that the subfield is not
17305                       managed.</para>
17306                     </listitem>
17307                   </itemizedlist>
17308                 </listitem>
17309               </itemizedlist>
17310             </listitem>
17311             <listitem>
17312               <para>For each subfield you can set the following Advanced constraint values</para>
17313               <screenshot>
17314                   <screeninfo>Advanced constraints</screeninfo>
17315                   <mediaobject>
17316                     <imageobject>
17317                       <imagedata fileref="images/admin/cataloging/advancedoptsubfield.png"/>
17318                     </imageobject>
17319                   </mediaobject>
17320                 </screenshot>
17321               <itemizedlist>
17322                 <listitem>
17323                   <para>Default value</para>
17324                   <itemizedlist>
17325                     <listitem>
17326                       <para>defines what you want to appear in the field by default, this will be
17327                         editable, but it saves time if you use the same note over and over or the
17328                         same value in a field often.</para>
17329                     </listitem>
17330                   </itemizedlist>
17331                 </listitem>
17332                 <listitem>
17333                   <para>Visibility</para>
17334                   <itemizedlist>
17335                     <listitem>
17336                       <para>allows you to select from where this subfield is visible/hidden, simply
17337                         check the boxes where you would like the field to show and uncheck the boxes
17338                         where you would like it hidden.</para>
17339                       <screenshot>
17340                           <screeninfo>Framework visibility</screeninfo>
17341                           <mediaobject>
17342                             <imageobject>
17343                               <imagedata fileref="images/admin/cataloging/frameworkvisibility.png"/>
17344                             </imageobject>
17345                           </mediaobject>
17346                         </screenshot>
17347                     </listitem>
17348                   </itemizedlist>
17349                 </listitem>
17350                 <listitem>
17351                   <para>Is a URL</para>
17352                   <itemizedlist>
17353                     <listitem>
17354                       <para>if checked, it means that the subfield is a URL and can be
17355                         clicked</para>
17356                     </listitem>
17357                   </itemizedlist>
17358                 </listitem>
17359                 <listitem>
17360                   <para>Link</para>
17361                   <itemizedlist>
17362                     <listitem>
17363                       <para>If you enter a field/subfield here (200b), a link appears after the
17364                         subfield in the MARC Detail view. This view is present only in the staff
17365                         client, not the OPAC. If the librarian clicks on the link, a search is done
17366                         on the database for the field/subfield with the same value. This can be used
17367                         for 2 main topics :</para>
17368                       <itemizedlist>
17369                         <listitem>
17370                           <para>on a field like author (200f in UNIMARC), put 200f here, you will be
17371                             able to see all bib records with the same author.</para>
17372                         </listitem>
17373                         <listitem>
17374                           <para>on a field that is a link (4xx) to reach another bib record. For
17375                             example, put 011a in 464$x, will find the serials that are with this
17376                             ISSN.</para>
17377                         </listitem>
17378                       </itemizedlist>
17379                     </listitem>
17380                     <listitem>
17381                       <warning>
17382                         <para>This value should not change after data has been added to your
17383                           catalog. If you need to change this value you must ask your system
17384                           administrator to run misc/batchRebuildBiblioTables.pl. </para>
17385                       </warning>
17386                     </listitem>
17387                   </itemizedlist>
17388                 </listitem>
17389                 <listitem>
17390                   <para>Koha link</para>
17391                   <itemizedlist>
17392                     <listitem>
17393                       <para>Koha is multi-MARC compliant. So, it does not know what the 245$a means,
17394                         neither what 200$f (those 2 fields being both the title in MARC21 and
17395                         UNIMARC). So, in this list you can "map" a MARC subfield to its meaning.
17396                         Koha constantly maintains consistency between a subfield and its meaning.
17397                         When the user want to search on "title", this link is used to find what is
17398                         searched (245 if you're MARC21, 200 if you're UNIMARC).</para>
17399                     </listitem>
17400                   </itemizedlist>
17401                 </listitem>
17402               </itemizedlist>
17403             </listitem>
17404             <listitem>
17405               <para>For each subfield you can set the following Other option values</para>
17406               <screenshot>
17407                   <screeninfo/>
17408                   <mediaobject>
17409                     <imageobject>
17410                       <imagedata fileref="images/admin/cataloging/otheroptssubfield.png"/>
17411                     </imageobject>
17412                   </mediaobject>
17413                 </screenshot>
17414               <itemizedlist>
17415                 <listitem>
17416                   <para>Authorized value</para>
17417                   <itemizedlist>
17418                     <listitem>
17419                       <para>means the value cannot by typed by the librarian, but must be chosen
17420                         from a pull down generated by the <link linkend="authorizedvalues"
17421                           >authorized value</link> list</para>
17422                     </listitem>
17423                     <listitem>
17424                       <para>In the example above, the 504a field will show the MARC504 Authorized
17425                         Values when cataloging</para>
17426                       <screenshot>
17427                         <screeninfo>Example of an Authorized Subfield</screeninfo>
17428                         <mediaobject>
17429                           <imageobject>
17430                             <imagedata fileref="images/admin/cataloging/504auth.png"/>
17431                           </imageobject>
17432                         </mediaobject>
17433                       </screenshot>
17434                     </listitem>
17435                   </itemizedlist>
17436                 </listitem>
17437                 <listitem>
17438                   <para>Thesaurus</para>
17439                   <itemizedlist>
17440                     <listitem>
17441                       <para>means that the value is not free text, but must be searched in the
17442                         authority/thesaurus of the selected category</para>
17443                     </listitem>
17444                   </itemizedlist>
17445                 </listitem>
17446                 <listitem>
17447                   <para>Plugin</para>
17448                   <itemizedlist>
17449                     <listitem>
17450                       <para>means the value is calculated or managed by a plugin. Plugins can do
17451                         almost anything.</para>
17452                     </listitem>
17453                     <listitem>
17454                       <para>Examples:<itemizedlist>
17455                           <listitem id="cnbrowseplugin">
17456                             <para>For call numbers there is an option to add a call number browser
17457                               next to the the call number subfield. Simply choose the cn_browser.pl
17458                               plugin. Learn more in the <link linkend="addingitems">cataloging
17459                                 section</link> of this manual.</para>
17460                           </listitem>
17461                           <listitem>
17462                             <para>In UNIMARC there are plugins for every 1xx fields that are coded
17463                               fields. The plugin is a huge help for cataloger! There are also two
17464                               plugins (unimarc_plugin_210c and unimarc_plugin_225a that can
17465                               "magically" find the editor from an ISBN, and the collection list for
17466                               the editor)</para>
17467                           </listitem>
17468                         </itemizedlist></para>
17469                     </listitem>
17470                   </itemizedlist>
17471                 </listitem>
17472               </itemizedlist>
17473             </listitem>
17474
17475             <listitem>
17476               <para>To save your changes simply click the 'Save Changes'
17477               button at the top of the screen</para>
17478             </listitem>
17479           </itemizedlist>
17480
17481           <para/>
17482         </section>
17483
17484         <section id="importexportframeworks">
17485           <title>Import/Export Frameworks</title>
17486
17487           <para>Next to each framework is a link to either import or export
17488           the framework.</para>
17489
17490           <section id="exportframeworks">
17491             <title>Export Framework</title>
17492
17493             <para>To export a framework simply click the 'Export' link to the
17494             right of framework title.</para>
17495
17496             <screenshot>
17497               <screeninfo>Export link next to framework</screeninfo>
17498
17499               <mediaobject>
17500                 <imageobject>
17501                   <imagedata fileref="images/admin/cataloging/importexport.png"/>
17502                 </imageobject>
17503               </mediaobject>
17504             </screenshot>
17505
17506             <para>When you click 'Export' you will be prompted to choose what
17507             format to export the file in.</para>
17508
17509             <screenshot>
17510               <screeninfo>Export formats</screeninfo>
17511
17512               <mediaobject>
17513                 <imageobject>
17514                   <imagedata fileref="images/admin/cataloging/exportoptions.png"/>
17515                 </imageobject>
17516               </mediaobject>
17517             </screenshot>
17518
17519             <para>A framework exported this way can be imported into any other
17520             Koha installation using the import framework option.</para>
17521           </section>
17522
17523           <section id="importframeworks">
17524             <title>Import Framework</title>
17525
17526             <para>An easy way to create a new framework is to import one created for your or another
17527               Koha installation. This framework would need to be exported from the other system
17528                 <link linkend="exportframeworks">using the instructions above</link> to be available
17529               for import here. </para>
17530             <para>To import a framework you first need to create <link linkend="addframework">a new
17531                 framework</link>. Once you have that framework, click 'Import' to the right of the
17532               new framework.</para>
17533
17534             <screenshot>
17535               <screeninfo>Import link next to framework</screeninfo>
17536
17537               <mediaobject>
17538                 <imageobject>
17539                   <imagedata fileref="images/admin/cataloging/importexport.png"/>
17540                 </imageobject>
17541               </mediaobject>
17542             </screenshot>
17543
17544             <para>You will be prompted to find a file on your computer to
17545             import into the framework.</para>
17546
17547             <screenshot>
17548               <screeninfo>Choose a file to import</screeninfo>
17549
17550               <mediaobject>
17551                 <imageobject>
17552                   <imagedata fileref="images/admin/cataloging/importfile.png"/>
17553                 </imageobject>
17554               </mediaobject>
17555             </screenshot>
17556
17557             <para>You will be asked to confirm your actions before the file is
17558             imported.</para>
17559
17560             <screenshot>
17561               <screeninfo>Confirm your desire to import</screeninfo>
17562
17563               <mediaobject>
17564                 <imageobject>
17565                   <imagedata fileref="images/admin/cataloging/importconfirm.png"/>
17566                 </imageobject>
17567               </mediaobject>
17568             </screenshot>
17569
17570             <para>As your file is uploaded you will see an image that will
17571             confirm that the system is working.</para>
17572
17573             <screenshot>
17574               <screeninfo>Import timer</screeninfo>
17575
17576               <mediaobject>
17577                 <imageobject>
17578                   <imagedata fileref="images/admin/cataloging/importtimer.png"/>
17579                 </imageobject>
17580               </mediaobject>
17581             </screenshot>
17582
17583             <para>Once your import is complete you will be brought to the
17584             framework edit tool where you can make any changes you need to the
17585             framework you imported.</para>
17586           </section>
17587         </section>
17588       </section>
17589
17590       <section id="kohamarcmapping">
17591         <title>Koha to MARC Mapping</title>
17592
17593         <para>While Koha stores the entire MARC record, it also stores common
17594         fields for easy access in various tables in the database. Koha to MARC
17595         Mapping is used to tell Koha where to find these values in the MARC
17596         record. In many cases you will not have to change the default values
17597         set by in this tool on installation, but it is important to know that
17598         the tool is here and can be used at any time.</para>
17599
17600         <itemizedlist>
17601           <listitem>
17602             <para><emphasis>Get there:</emphasis> More &gt; Administration
17603             &gt; Catalog &gt; Koha to MARC Mapping</para>
17604           </listitem>
17605         </itemizedlist>
17606
17607         <para>The Koha to MARC Mapping page offers you the option of choosing
17608         from one of three tables in the database to assign values to.</para>
17609
17610         <screenshot>
17611           <screeninfo>Koha to MARC Mapping Table Pull Down</screeninfo>
17612
17613           <mediaobject>
17614             <imageobject>
17615               <imagedata fileref="images/admin/cataloging/kohamarcmapping.png"/>
17616             </imageobject>
17617           </mediaobject>
17618         </screenshot>
17619
17620         <para>After choosing the table you would like to view, click 'OK.' To
17621         edit any mapping click on the 'Koha Filed' or the 'Edit' link.</para>
17622
17623         <screenshot>
17624           <screeninfo>Map MARC Field to Koha Field</screeninfo>
17625
17626           <mediaobject>
17627             <imageobject>
17628               <imagedata fileref="images/admin/cataloging/mapmarc.png"/>
17629             </imageobject>
17630           </mediaobject>
17631         </screenshot>
17632
17633         <para>Choose which MARC field you would like to map to this Koha Field
17634         and click the 'OK' button. If you would like to clear all mappings,
17635         click the 'Click to "Unmap"' button.</para>
17636
17637         <important>
17638           <para>At this time you can map only 1 MARC field to 1 Koha field.
17639           This means that you won't be able to map both the 100a and the 700a
17640           to the author field, you need to choose one or the other.</para>
17641         </important>
17642
17643         <para/>
17644       </section>
17645
17646       <section id="keywordmapping">
17647         <title>Keywords to MARC Mapping</title>
17648
17649         <para>This tool will allow you to map MARC fields to a set of
17650         predefined keywords.</para>
17651
17652         <itemizedlist>
17653           <listitem>
17654             <para><emphasis>Get there:</emphasis> More &gt; Administration
17655             &gt; Catalog &gt; Keywords to MARC Mapping</para>
17656           </listitem>
17657         </itemizedlist>
17658
17659         <important>
17660           <para>This tool only effects sites that are not using the XSLT
17661           Stylesheets.</para>
17662         </important>
17663
17664         <para>At this time the only keyword in use is 'subtitle.'</para>
17665
17666         <para>Using this tool you can define what MARC field prints to the
17667         detail screen of the bibliographic record using keywords. The
17668         following example will use the subtitle field.</para>
17669
17670         <para>Using the Framework pull down menu, choose the <link linkend="marcbibframeworks">Framework</link> you would like to apply
17671         this rule to. For example, the subtitle for books can be found in the
17672         245$b field.</para>
17673
17674         <screenshot>
17675           <screeninfo>Assigning Book Subtitle</screeninfo>
17676
17677           <mediaobject>
17678             <imageobject>
17679               <imagedata fileref="images/admin/cataloging/subtitlebookmapping.png"/>
17680             </imageobject>
17681           </mediaobject>
17682         </screenshot>
17683
17684         <para>However the subtitle for DVDs appears in 245$p</para>
17685
17686         <screenshot>
17687           <screeninfo>Assigning DVD Subtitle</screeninfo>
17688
17689           <mediaobject>
17690             <imageobject>
17691               <imagedata fileref="images/admin/cataloging/subtitledvdmapping.png"/>
17692             </imageobject>
17693           </mediaobject>
17694         </screenshot>
17695
17696         <para>Using this tool you can tell Koha to print the right field as
17697         the subtitle when viewing the bibliographic record in the OPAC.</para>
17698
17699         <screenshot>
17700           <screeninfo>Subtitle display in the OPAC</screeninfo>
17701
17702           <mediaobject>
17703             <imageobject>
17704               <imagedata fileref="images/admin/cataloging/subtitlebookinopac.png"/>
17705             </imageobject>
17706           </mediaobject>
17707         </screenshot>
17708
17709         <para>This tool can be used to chain together pieces of the record as
17710         well. If you want the series number to show in the title on your
17711         search results you simply have to map 490 $v to 'subtitle' along with
17712         the 245 $b. <note>
17713             <para>Chain together the fields you want to show after the item
17714             title in the order in which you want them to appear.</para>
17715           </note></para>
17716
17717         <para>Future developments will include additional keyword assigned
17718         fields.</para>
17719       </section>
17720
17721       <section id="marcbibframeworkstest">
17722         <title>MARC Bibliographic Framework Test</title>
17723
17724         <para>Checks the MARC structure.</para>
17725
17726         <itemizedlist>
17727           <listitem>
17728             <para><emphasis>Get there:</emphasis> More &gt; Administration
17729             &gt; Catalog &gt; MARC Bibliographic Framework Test</para>
17730           </listitem>
17731         </itemizedlist>
17732
17733         <para>If you change your MARC Bibliographic framework it's recommended
17734         that you run this tool to test for errors in your definition.</para>
17735
17736         <screenshot>
17737           <screeninfo>Framework Test</screeninfo>
17738
17739           <mediaobject>
17740             <imageobject>
17741               <imagedata fileref="images/admin/cataloging/frameworktest.png"/>
17742             </imageobject>
17743           </mediaobject>
17744         </screenshot>
17745       </section>
17746
17747       <section id="authoritiesadmin">
17748         <title>Authority Types</title>
17749
17750         <para>Authority Types are basically MARC Frameworks for Authority
17751         records and because of that they follow the same editing rules found
17752         in the <link linkend="marcbibframeworks">MARC Bibliographic
17753         Frameworks</link> section of this manual. Koha comes with many of the
17754         necessary Authority frameworks already installed. To learn how to add
17755         and edit Authority Types, simply review the <link linkend="marcbibframeworks">MARC Bibliographic Frameworks</link>
17756         section of this manual.</para>
17757
17758         <itemizedlist>
17759           <listitem>
17760             <para><emphasis>Get there:</emphasis> More &gt; Administration
17761             &gt; Catalog &gt; Authority Types</para>
17762           </listitem>
17763         </itemizedlist>
17764       </section>
17765
17766       <section id="classificationsources">
17767         <sectioninfo>
17768           <authorgroup>
17769             <author>
17770               <firstname>Savitra</firstname>
17771               <surname>Sirohi</surname>
17772               <affiliation>
17773                 <orgname>Nucsoft OSS Labs</orgname>
17774               </affiliation>
17775             </author>
17776
17777             <editor>
17778               <firstname>Nicole C.</firstname>
17779               <surname>Engard</surname>
17780               <contrib>Fixed typos, changed content where
17781                 necessary and added new screenshots.</contrib>
17782             </editor>
17783           </authorgroup>
17784
17785           <pubdate>2010</pubdate>
17786         </sectioninfo>
17787
17788         <title>Classification Sources</title>
17789
17790         <para>Source of classification or shelving scheme is an <link linkend="authorizedvalues"
17791             >Authorized Values</link> category that is mapped to field 952$2 and 942$2 in Koha's
17792           MARC Bibliographic frameworks and stored in the items.cn_source field in the
17793           database.</para>
17794
17795         <itemizedlist>
17796           <listitem>
17797             <para><emphasis>Get there:</emphasis> More &gt; Administration
17798             &gt; Catalog &gt; Classification sources</para>
17799           </listitem>
17800         </itemizedlist>
17801
17802         <screenshot>
17803           <screeninfo>Classification Sources</screeninfo>
17804
17805           <mediaobject>
17806             <imageobject>
17807               <imagedata fileref="images/admin/cataloging/classsources.png"/>
17808             </imageobject>
17809           </mediaobject>
17810         </screenshot>
17811
17812         <para>Commonly used values of this field are:</para>
17813
17814         <itemizedlist>
17815           <listitem>
17816             <para>ddc - Dewey Decimal Classification</para>
17817           </listitem>
17818
17819           <listitem>
17820             <para>lcc - Library of Congress Classification</para>
17821           </listitem>
17822         </itemizedlist>
17823
17824         <para>If you chose to install classification sources during Koha's
17825         installation, you would see other values too:</para>
17826
17827         <itemizedlist>
17828           <listitem>
17829             <para>ANSCR (sound recordings)</para>
17830           </listitem>
17831
17832           <listitem>
17833             <para>SuDOC classification</para>
17834           </listitem>
17835
17836           <listitem>
17837             <para>Universal Decimal Classification</para>
17838           </listitem>
17839
17840           <listitem>
17841             <para>Other/Generic Classification</para>
17842           </listitem>
17843         </itemizedlist>
17844
17845         <section id="addingclasssource">
17846           <title>Adding/Editing Classification Sources</title>
17847
17848           <para>You can add your own source of classification by using the New
17849           Classification Source button. To edit use the Edit link.</para>
17850
17851           <screenshot>
17852             <screeninfo>Add classification source</screeninfo>
17853
17854             <mediaobject>
17855               <imageobject>
17856                 <imagedata fileref="images/admin/cataloging/addclasssource.png"/>
17857               </imageobject>
17858             </mediaobject>
17859           </screenshot>
17860
17861           <para>When creating or editing:</para>
17862
17863           <itemizedlist>
17864             <listitem>
17865               <para>You will need to enter a code and a description.</para>
17866             </listitem>
17867
17868             <listitem>
17869               <para>Check the 'Source in use?' checkbox if you want the value
17870               to appear in the drop down list for this category.</para>
17871             </listitem>
17872
17873             <listitem>
17874               <para>Select the appropriate <link linkend="classfilingrules">filing rule</link> from the drop down
17875               list.</para>
17876             </listitem>
17877           </itemizedlist>
17878
17879           <para/>
17880         </section>
17881
17882         <section id="classfilingrules">
17883           <title>Classification Filing Rules</title>
17884
17885           <para>Filing rules determine the order in which items are placed on
17886           shelves.</para>
17887
17888           <para>Values that are pre-configured in Koha are:</para>
17889
17890           <itemizedlist>
17891             <listitem>
17892               <para>Dewey</para>
17893             </listitem>
17894
17895             <listitem>
17896               <para>LCC</para>
17897             </listitem>
17898
17899             <listitem>
17900               <para>Generic</para>
17901             </listitem>
17902           </itemizedlist>
17903
17904           <para>Filing rules are mapped to <link linkend="addingclasssource">Classification sources</link>. You can
17905           setup new filing rules by using the New Filing Rule button. To edit
17906           use the Edit link.</para>
17907
17908           <para>When creating or editing:</para>
17909
17910           <itemizedlist>
17911             <listitem>
17912               <para>Enter a code and a description</para>
17913             </listitem>
17914
17915             <listitem>
17916               <para>Choose an appropriate filing routine - dewey, generic or
17917               lcc</para>
17918             </listitem>
17919           </itemizedlist>
17920         </section>
17921       </section>
17922
17923       <section id="recordmatchingrules">
17924         <sectioninfo>
17925           <authorgroup>
17926             <author>
17927               <firstname>Joy</firstname>
17928               <surname>Nelson</surname>
17929               <affiliation>
17930                 <orgname>ByWater Solutions</orgname>
17931               </affiliation>
17932             </author>
17933
17934             <editor>
17935               <firstname>Nicole C.</firstname>
17936               <surname>Engard</surname>
17937               <contrib>Changed/edited content where necessary.</contrib>
17938             </editor>
17939           </authorgroup>
17940
17941           <pubdate>2013</pubdate>
17942         </sectioninfo>
17943         <title>Record Matching Rules</title>
17944
17945         <para>Record matching rules are used when importing MARC records into
17946         Koha.</para>
17947
17948         <itemizedlist>
17949           <listitem>
17950             <para><emphasis>Get there:</emphasis> More &gt; Administration
17951             &gt; Catalog &gt; Record Matching Rules</para>
17952           </listitem>
17953         </itemizedlist>
17954
17955         <para>The rules that you set up here will be referenced with you <link linkend="stagemarc">Stage MARC Records for Import</link>.</para>
17956         <para>It is important to understand the difference between Match Points and Match Checks
17957           before adding new matching rules to Koha.</para>
17958
17959        <para>Match Points are the criteria that you enter that must be met in order for an incoming
17960           record to match an existing MARC record in your catalog. You can have multiple match
17961           points on an import rule each with its own score. An incoming record will be compared
17962           against your existing records (‘one record at a time’) and given a score for each match
17963           point. When the total score of the matchpoints matches or exceeds the threshold given for
17964           the matching rule, Koha assumes a good match and imports/overlays according your
17965           specifications in the import process. An area to watch out for here is the sum of the
17966           match points. Doublecheck that the matches you want will add up to a successful
17967           match.</para>
17968
17969 <para>Example: </para>
17970         <para>Threshold of 1000 </para>
17971         <para>Match Point on 020$a 1000 </para>
17972         <para>Match Point on 022$a 1000 </para>
17973         <para>Match Point on 245$a 500 </para>
17974         <para>Match Point on 100$a 100</para>
17975
17976 <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>
17977
17978 <para>Match Checks are not commonly used in import rules. However, they can serve a couple of
17979           purposes in matching records. First, match checks can be used as the matching criteria
17980           instead of the match points if your indexes are stale and out of date. The match checks go
17981           right for the data instead of relying on the data in the indexes. (If you fear your
17982           indexes are out of date, a rebuild of your indexes would be a great idea and solve that
17983           situation!) The other use for a Match Check is as a “double check” or “veto” of your
17984           matching rule. For example, if you have a matching rule as below:</para>
17985 <para>Threshold of 1000 </para>
17986         <para>Match Point on 020$a 1000 </para>
17987         <para>Match Check on 245$a</para>
17988
17989 <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>
17990
17991 <para>When looking to create matching rules for your authority records the following indexes will be
17992           of use:</para>
17993         <table frame="void" id="authorityindexes">
17994           <caption>Authority Indexes</caption>
17995           <thead>
17996             <tr>
17997               <th>Index name</th>
17998               <th>Matches Marc Tag</th>
17999             </tr>
18000           </thead>
18001           <tbody>
18002             <tr>
18003               <td>LC-cardnumber</td>
18004               <td>010$a</td>
18005             </tr>
18006             <tr>
18007               <td>Personal-name</td>
18008               <td>100$a</td>
18009             </tr>
18010             <tr>
18011               <td>Corporate-name-heading</td>
18012               <td>110$a</td>
18013             </tr>
18014             <tr>
18015               <td>Meeting-name</td>
18016               <td>111$a</td>
18017             </tr>
18018             <tr>
18019               <td>Title-uniform</td>
18020               <td>130$a</td>
18021             </tr>
18022             <tr>
18023               <td>Chronological-term</td>
18024               <td>148$a</td>
18025             </tr>
18026             <tr>
18027               <td>Subject-topical</td>
18028               <td>150$a</td>
18029             </tr>
18030             <tr>
18031               <td>Name-geographic</td>
18032               <td>151$a</td>
18033             </tr>
18034             <tr>
18035               <td>Term-genre-form</td>
18036               <td>155$a</td>
18037             </tr>
18038           </tbody>
18039         </table>
18040         <section id="addrecordmatchrule">
18041           <title>Adding Matching Rules</title>
18042           <para>To create a new matching rule :</para>
18043           <itemizedlist>
18044             <listitem>
18045               <para>Click 'New Record Matching Rule'</para>
18046               <screenshot>
18047                 <screeninfo>Add record matching rule</screeninfo>
18048                 <mediaobject>
18049                   <imageobject>
18050                     <imagedata fileref="images/admin/cataloging/newmatchrule.png"/>
18051                   </imageobject>
18052                 </mediaobject>
18053               </screenshot>
18054               <itemizedlist>
18055                 <listitem>
18056                   <para>Choose a unique name and enter it in the 'Matching rule code' field</para>
18057                 </listitem>
18058                 <listitem>
18059                   <para>'Description' can be anything you want to make it clear to you what rule
18060                     you're picking</para>
18061                 </listitem>
18062                 <listitem>
18063                   <para>'Match threshold' is the total number of 'points' a biblio must earn to be
18064                     considered a 'match'</para>
18065                 </listitem>
18066                 <listitem>
18067                   <para>'Record type' is the type of import this rule will be used for - either
18068                     authority or bibliographic</para>
18069                 </listitem>
18070                 <listitem>
18071                   <para>Match points are set up to determine what fields to match on</para>
18072                 </listitem>
18073                 <listitem>
18074                   <para>'Search index' can be found by looking at the ccl.properties file on your
18075                     system which tells the zebra indexing what data to search for in the MARC
18076                     data".</para>
18077                 </listitem>
18078                 <listitem>
18079                   <para>'Score' - The number of 'points' a match on this field is worth. If the sum
18080                     of each score is greater than the match threshold, the incoming record is a
18081                     match to the existing record</para>
18082                 </listitem>
18083                 <listitem>
18084                   <para>Enter the MARC tag you want to match on in the 'Tag' field</para>
18085                 </listitem>
18086                 <listitem>
18087                   <para>Enter the MARC tag subfield you want to match on in the 'Subfields'
18088                     field</para>
18089                 </listitem>
18090                 <listitem>
18091                   <para>'Offset' - For use with control fields, 001-009</para>
18092                 </listitem>
18093                 <listitem>
18094                   <para>'Length' - For use with control fields, 001-009</para>
18095                 </listitem>
18096                 <listitem>
18097                   <para>Koha only has one 'Normalization rule' that removes extra characters such as
18098                     commas and semicolons. The value you enter in this field is irrelevant to the
18099                     normalization process.</para>
18100                 </listitem>
18101                 <listitem>
18102                   <para>'Required match checks' - ??</para>
18103                 </listitem>
18104               </itemizedlist>
18105             </listitem>
18106           </itemizedlist>
18107         </section>
18108         <section id="samplerecordmatch">
18109           <title>Sample Bibliographic Record Matching Rule: Control Number</title>
18110
18111           <screenshot>
18112             <screeninfo>LOC Matching Rule</screeninfo>
18113
18114             <mediaobject>
18115               <imageobject>
18116                 <imagedata fileref="images/admin/cataloging/samplematchrule.png"/>
18117               </imageobject>
18118             </mediaobject>
18119           </screenshot>
18120
18121           <itemizedlist>
18122             <listitem>
18123               <para>Match threshold: 100</para>
18124             </listitem>
18125             <listitem>
18126               <para>Record type: Bibliographic<itemizedlist>
18127                   <listitem>
18128                     <note>
18129                       <para>If you'd like a rule to match on the 001 in authority records you will
18130                         need the repeat all of these values and change just the record type to
18131                         'Authority record'</para>
18132                     </note>
18133                   </listitem>
18134                 </itemizedlist></para>
18135             </listitem>
18136
18137             <listitem>
18138               <para>Matchpoints (just the one):</para>
18139             </listitem>
18140
18141             <listitem>
18142               <para>Search index: Control-number</para>
18143             </listitem>
18144
18145             <listitem>
18146               <para>Score: 101</para>
18147             </listitem>
18148
18149             <listitem>
18150               <para>Tag: 001</para>
18151
18152               <itemizedlist>
18153                 <listitem>
18154                   <note>
18155                     <para>this field is for the control number assigned by the
18156                     organization creating, using, or distributing the
18157                     record</para>
18158                   </note>
18159                 </listitem>
18160               </itemizedlist>
18161             </listitem>
18162
18163             <listitem>
18164               <para>Subfields: a</para>
18165             </listitem>
18166
18167             <listitem>
18168               <para>Offset: 0</para>
18169             </listitem>
18170
18171             <listitem>
18172               <para>Length: 0</para>
18173             </listitem>
18174
18175             <listitem>
18176               <para>Normalization rule: Control-number</para>
18177             </listitem>
18178
18179             <listitem>
18180               <para>Required Match checks: none (remove the blank one)</para>
18181
18182               <screenshot>
18183                 <screeninfo>Remove match check</screeninfo>
18184
18185                 <mediaobject>
18186                   <imageobject>
18187                     <imagedata fileref="images/admin/cataloging/removematchcheck.png"/>
18188                   </imageobject>
18189                 </mediaobject>
18190               </screenshot>
18191             </listitem>
18192           </itemizedlist>
18193         </section>
18194       </section>
18195
18196       <section id="oaisetsconfig">
18197         <title>OAI Sets Configuration</title>
18198
18199         <para>On this page you can create, modify and delete OAI-PMH
18200         sets</para>
18201
18202         <section id="oaicreate">
18203           <title>Create a set</title>
18204
18205           <para>To create a set:</para>
18206
18207           <itemizedlist>
18208             <listitem>
18209               <para>Click on the link 'Add a new set'</para>
18210             </listitem>
18211
18212             <listitem>
18213               <para>Fill the mandatory fields 'setSpec' and 'setName'</para>
18214             </listitem>
18215
18216             <listitem>
18217               <para>Then you can add descriptions for this set. To do this
18218               click on 'Add description' and fill the newly created text box.
18219               You can add as many descriptions as you want.</para>
18220             </listitem>
18221
18222             <listitem>
18223               <para>Click on 'Save' button'</para>
18224             </listitem>
18225           </itemizedlist>
18226         </section>
18227
18228         <section id="oaimodify">
18229           <title>Modify/Delete a set</title>
18230
18231           <para>To modify a set, just click on the link 'Modify' on the same
18232           line of the set you want to modify. A form similar to set creation
18233           form will appear and allow you to modify the setSpec, setName and
18234           descriptions.</para>
18235
18236           <para>To delete a set, just click on the link 'Delete' on the same
18237           line of the set you want to delete.</para>
18238         </section>
18239
18240         <section id="oaimapping">
18241           <title>Define mappings</title>
18242
18243           <para>Here you can define how a set will be build (what records will
18244           belong to this set) by defining mappings. Mappings are a list of
18245           conditions on record content. A record only need to match one
18246           condition to belong to the set.</para>
18247
18248           <itemizedlist>
18249             <listitem>
18250               <para>Fill the fields 'Field', 'Subfield' and 'Value'. For
18251               example if you want to include in this set all records that have
18252               a 999$9 equal to 'XXX'. Fill 'Field' with 999, 'Subfield' with 9
18253               and 'Value' with XXX.</para>
18254             </listitem>
18255
18256             <listitem>
18257               <para>If you want to add another condition, click on 'OR' button
18258               and repeat step 1.</para>
18259             </listitem>
18260
18261             <listitem>
18262               <para>Click on 'Save'</para>
18263             </listitem>
18264           </itemizedlist>
18265
18266           <para>To delete a condition, just leave at least one of 'Field',
18267           'Subfield' or 'Value' empty and click on 'Save'.<note>
18268               <para>Actually, a condition is true if value in the
18269               corresponding subfield is strictly equal to what is defined if
18270               'Value'. A record having 999$9 = 'XXX YYY' will not belong to a
18271               set where condition is 999$9 = 'XXX'.</para>
18272             </note></para>
18273
18274           <para>And it is case sensitive : a record having 999$9 = 'xxx' will
18275           not belong to a set where condition is 999$9 = 'XXX'.</para>
18276         </section>
18277
18278         <section id="oaibuild">
18279           <title>Build sets</title>
18280
18281           <para>Once you have configured all your sets, you have to build the
18282           sets. This is done by calling the script
18283           misc/migration_tools/build_oai_sets.pl.</para>
18284         </section>
18285       </section>
18286       <section id="itemsearchadmin">
18287         <title>Item search fields</title>
18288         <para>From here you can add custom search fields to the <link
18289             linkend="searchguide-itemsearch">item search</link> option in the staff client.  <screenshot>
18290             <screeninfo/>
18291             <mediaobject>
18292               <imageobject>
18293                 <imagedata fileref="images/admin/cataloging/itemsearchfields.png"/>
18294               </imageobject>
18295             </mediaobject>
18296           </screenshot></para>
18297         <para>To add a new search term simply fill in the 'Add a new field' area:<itemizedlist>
18298             <listitem>
18299               <para>Name is a field for you to identify the search term</para>
18300             </listitem>
18301             <listitem>
18302               <para>Label is what will appear on the item search page</para>
18303             </listitem>
18304             <listitem>
18305               <para>MARC field allows you to pick which field you'd like to search in</para>
18306             </listitem>
18307             <listitem>
18308               <para>MARC subfield is the subfield you'd like to search in</para>
18309             </listitem>
18310             <listitem>
18311               <para>Authorised values category can be used to turn this search field in to a pull
18312                 down instead of a free text field</para>
18313             </listitem>
18314           </itemizedlist></para>
18315         <para>Once your new field is added it will be visible at the top of this page and on the
18316           item search page<screenshot>
18317             <screeninfo>Search option</screeninfo>
18318             <mediaobject>
18319               <imageobject>
18320                 <imagedata fileref="images/admin/cataloging/customsearch.png"/>
18321               </imageobject>
18322             </mediaobject>
18323           </screenshot></para>
18324       </section>
18325     </section>
18326
18327     <section id="acqadmin">
18328       <title>Acquisitions</title>
18329
18330       <para>The Koha Acquisitions module provides a way for the library to
18331       record orders placed with vendors and manage purchase budgets.</para>
18332
18333       <para>Before using the <link linkend="acqmodule">Acquisitions
18334       Module</link>, you will want to make sure that you have completed all of
18335       the set up.</para>
18336
18337       <itemizedlist>
18338         <listitem>
18339           <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
18340           Acquisitions</para>
18341         </listitem>
18342       </itemizedlist>
18343
18344       <section id="currexchangeadmin">
18345         <title>Currencies and Exchange Rates</title>
18346
18347         <para>If you place orders from more than one country you will want to
18348         input currency exchange rates so that your acquisitions module will
18349         properly calculate totals.</para>
18350
18351         <itemizedlist>
18352           <listitem>
18353             <para><emphasis>Get there:</emphasis> More &gt; Administration
18354             &gt; Acquisitions &gt; Currencies and Exchange Rates</para>
18355           </listitem>
18356         </itemizedlist>
18357
18358         <screenshot>
18359           <screeninfo>Currencies</screeninfo>
18360
18361           <mediaobject>
18362             <imageobject>
18363               <imagedata fileref="images/admin/acquisitions/currencies.png"/>
18364             </imageobject>
18365           </mediaobject>
18366         </screenshot>
18367
18368         <note>
18369           <para>This data is not automatically updated, so be sure to keep it
18370           up to date so that your accounting is kept correct.</para>
18371         </note>
18372         <para>The ISO code you enter will be used when importing MARC files via the staging tools,
18373           the tool will attempt to find and use the price of the currently active currency. </para>
18374
18375         <para>The active currency is the main currency you use in your
18376         library. Your active currency will have a check mark in the 'Active'
18377         column. If you don't have an active currency you will see an error
18378         message telling you to choose an active currency.</para>
18379
18380         <screenshot>
18381           <screeninfo>No active currency warning</screeninfo>
18382
18383           <mediaobject>
18384             <imageobject>
18385               <imagedata fileref="images/admin/acquisitions/nocurrency.png"/>
18386             </imageobject>
18387           </mediaobject>
18388         </screenshot>
18389       </section>
18390
18391       <section id="budgetplanning">
18392         <title>Budgets</title>
18393
18394         <para>Budgets are used for tracking accounting values related to acquisitions. For example
18395           you could create a Budget for the current year (ex. 2015) and then break that into <link
18396             linkend="funds">Funds</link> for different areas of the library (ex. Books, Audio,
18397           etc).</para>
18398
18399         <itemizedlist>
18400           <listitem>
18401             <para><emphasis>Get there:</emphasis> More &gt; Administration
18402             &gt; Acquisitions &gt; Budgets</para>
18403           </listitem>
18404         </itemizedlist>
18405
18406         <para>When visiting the main budget administration you will see two
18407         tabs, one for active and one for inactive budgets.</para>
18408
18409         <screenshot>
18410           <screeninfo>Budgets List</screeninfo>
18411
18412           <mediaobject>
18413             <imageobject>
18414               <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
18415             </imageobject>
18416           </mediaobject>
18417         </screenshot>
18418
18419         <section id="addbudget">
18420           <title>Adding budgets</title>
18421
18422           <para>Budgets can either be created <link linkend="addnewbudget">from scratch</link>, by
18423               <link linkend="duplicatebudget">duplicating the previous year's budget</link> or by
18424               <link linkend="closebudget">closing a previous year's budget</link>.</para>
18425           <section id="addnewbudget">
18426             <title>Add a new budget</title>
18427             <para>If you haven't used Koha before for acquisitions then you'll need to start fresh
18428               with a new budget. To add a new budget click the 'New Budget' button.</para>
18429             <screenshot>
18430               <screeninfo>New Budget Form</screeninfo>
18431               <mediaobject>
18432                 <imageobject>
18433                   <imagedata fileref="images/admin/acquisitions/newbudgetform.png"/>
18434                 </imageobject>
18435               </mediaobject>
18436             </screenshot>
18437             <itemizedlist>
18438               <listitem>
18439                 <para>Choose the time period this budget is for, whether it's an academic year, a
18440                   fiscal year, a quarter, etc.</para>
18441               </listitem>
18442               <listitem>
18443                 <para>The Description should be something that will help you identify the budget
18444                   when ordering</para>
18445               </listitem>
18446               <listitem>
18447                 <para>In the amount box do not use any symbols, simply enter the amount of the
18448                   budget with numbers and decimals.</para>
18449               </listitem>
18450               <listitem>
18451                 <para>Marking a budget active makes it usable when placing orders in the
18452                   acquisitions module, even if the order is placed after the budget end date. This
18453                   will allow you to record orders that were places in a previous budget
18454                   period.</para>
18455               </listitem>
18456               <listitem>
18457                 <para>Locking a budget means that Funds will not be able to be modified by
18458                   librarians</para>
18459               </listitem>
18460             </itemizedlist>
18461             <para>Once you have made your edits, click the 'Save Changes' button. You will be
18462               brought to a list of your existing budgets.</para>
18463             <screenshot>
18464               <screeninfo>List of Budgets</screeninfo>
18465               <mediaobject>
18466                 <imageobject>
18467                   <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
18468                 </imageobject>
18469               </mediaobject>
18470             </screenshot>
18471           </section>
18472           <section id="duplicatebudget">
18473             <title>Duplicate a budget</title>
18474             <para>To duplicate a budget from a previous year, click on the link for the budget name
18475               from the list of budgets</para>
18476             <screenshot>
18477               <screeninfo>Budgets List</screeninfo>
18478               <mediaobject>
18479                 <imageobject>
18480                   <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
18481                 </imageobject>
18482               </mediaobject>
18483             </screenshot>
18484             <para>On the screen listing the budget breakdown click the Edit button at the top and
18485               choose to Duplicate budget</para>
18486             <screenshot>
18487               <screeninfo>Duplicate Budget</screeninfo>
18488               <mediaobject>
18489                 <imageobject>
18490                   <imagedata fileref="images/admin/acquisitions/duplicatebudget.png"/>
18491                 </imageobject>
18492               </mediaobject>
18493             </screenshot>
18494             <para>You can also click the 'Actions' button to the right of the budget and choose 'Duplicate'.<screenshot>
18495                 <screeninfo>Duplicate budget</screeninfo>
18496                 <mediaobject>
18497                   <imageobject>
18498                     <imagedata fileref="images/admin/acquisitions/duplicateaction.png"/>
18499                   </imageobject>
18500                 </mediaobject>
18501               </screenshot></para>
18502             <para>In both cases you will be presented with a form where you simply need to enter the
18503               new start and end date and save the budget.</para>
18504             <screenshot>
18505               <screeninfo>New Duplicate Budget</screeninfo>
18506               <mediaobject>
18507                 <imageobject>
18508                   <imagedata fileref="images/admin/acquisitions/duplicatestartend.png"/>
18509                 </imageobject>
18510               </mediaobject>
18511             </screenshot>
18512             <para>Check the box for 'Mark the original budget as inactive' if the original budget
18513               should no longer be used. </para>
18514             <para>Check the box for 'Set all funds to zero' if you wish the new budget to contain
18515               all the same fund structures as the previous budget but no allocations until you
18516               manually enter an amount in the fund.</para>
18517             <para>This will not only duplicate your budget, but all of the funds associated with
18518               that budget so that you can reuse budgets and funds from year to year and so that you
18519               can move unreceived orders and if desired unspent funds from a previous budget to the
18520               new budget.</para>
18521           </section>
18522           <section id="closebudget">
18523             <sectioninfo>
18524               <authorgroup>
18525                 <author>
18526                   <firstname>Denise</firstname>
18527                   <surname>Hannibal</surname>
18528                   <affiliation>
18529                     <orgname>Washington University in St. Louis</orgname>
18530                   </affiliation>
18531                 </author>
18532                 <editor>
18533                   <firstname>Nicole C.</firstname>
18534                   <surname>Engard</surname>
18535                 </editor>
18536               </authorgroup>
18537               <pubdate>2014</pubdate>
18538             </sectioninfo>
18539             <title>Close a budget</title>
18540             <para>Close a budget to move or roll over unreceived orders and if desired unspent funds
18541               from a previous budget to a new budget. Before closing your budget you might want to
18542                 <link linkend="duplicatebudget">duplicate the previous year's budget</link> so that
18543               you have somewhere for the unreceived orders to roll to.</para>
18544             <para>Find the previous budget with unreceived orders on the Active budgets or the
18545               Inactive budgets tab and select 'Close' under 'Actions'. <screenshot>
18546                 <screeninfo>Close a budget</screeninfo>
18547                 <mediaobject>
18548                   <imageobject>
18549                     <imagedata fileref="images/admin/acquisitions/closebudget.png"/>
18550                   </imageobject>
18551                 </mediaobject>
18552               </screenshot></para>
18553             <note>
18554               <para>In order for the unreceived orders to be automatically moved to the new budget,
18555                 the fund structures in the previous budget must exist in the new budget. Budgets
18556                 without unreceived orders cannot be closed.</para>
18557             </note>
18558             <para>When you select 'Close' you will be presented with a form.<screenshot>
18559                 <screeninfo>Closing a budget</screeninfo>
18560                 <mediaobject>
18561                   <imageobject>
18562                     <imagedata fileref="images/admin/acquisitions/closebudgetoptions.png"/>
18563                   </imageobject>
18564                 </mediaobject>
18565               </screenshot></para>
18566             <para>Use the 'Select a budget' drop down to choose the new budget for the unreceived
18567               orders.</para>
18568             <para>Check the box for 'Move remaining unspent funds' to move the unspent amounts from
18569               the funds of the budget being closed to the selected budget.</para>
18570             <para>Once you have made your choices, click the 'Move unreceived orders' button. You
18571               will be presented with a dialog box that says 'You have chosen to move all unreceived
18572               orders from 'Budget X' to 'Budget Y'. This action cannot be reversed. Do you wish to
18573               continue?' Budget X is the budget to be closed and Budget Y is the selected budget. <screenshot>
18574                 <screeninfo>Close warning</screeninfo>
18575                 <mediaobject>
18576                   <imageobject>
18577                     <imagedata fileref="images/admin/acquisitions/closewarning.png"/>
18578                   </imageobject>
18579                 </mediaobject>
18580               </screenshot></para>
18581             <para>If everything seems correct click 'OK' and the unreceived orders and, if selected,
18582               unspent funds will be moved. </para>
18583             <para>Wait until the 'Report after moving unreceived orders from budget X to Y'
18584               displays. This will list the order numbers which have been impacted (grouped by fund)
18585               and detail if the unreceived order was moved or if there was a problem. For example,
18586               if the new budget does not contain a fund with the same name as the previous budget,
18587               the order will not be moved.</para>
18588             <screenshot>
18589               <screeninfo>Close report</screeninfo>
18590               <mediaobject>
18591                 <imageobject>
18592                   <imagedata fileref="images/admin/acquisitions/closereport.png"/>
18593                 </imageobject>
18594               </mediaobject>
18595             </screenshot>
18596           </section>
18597         </section>
18598       </section>
18599
18600       <section id="funds">
18601         <title>Funds</title>
18602
18603         <itemizedlist>
18604           <listitem>
18605             <para><emphasis>Get there:</emphasis> More &gt; Administration
18606             &gt; Acquisitions &gt; Funds</para>
18607           </listitem>
18608         </itemizedlist>
18609
18610         <section id="addbudgetfund">
18611           <title>Add a Fund</title>
18612
18613           <para>A fund is added to a budget.</para>
18614
18615           <para><important>
18616               <para>A <link linkend="addbudget">budget</link> must be defined
18617               before a fund can be created.</para>
18618             </important>To add a new fund click the New button and then choose
18619           which Budget you would like to add the fund to.</para>
18620
18621           <screenshot>
18622             <screeninfo>Choose which budget to add a fund to</screeninfo>
18623
18624             <mediaobject>
18625               <imageobject>
18626                 <imagedata fileref="images/admin/acquisitions/newfund.png"/>
18627               </imageobject>
18628             </mediaobject>
18629           </screenshot>
18630
18631           <para>In the form that appears you want to enter the basics about your fund.</para>
18632
18633           <screenshot>
18634             <screeninfo>New Fund Form</screeninfo>
18635
18636             <mediaobject>
18637               <imageobject>
18638                 <imagedata fileref="images/admin/acquisitions/newfundform.png"/>
18639               </imageobject>
18640             </mediaobject>
18641           </screenshot>
18642
18643           <para>The three first fields are required, the rest are
18644           optional</para>
18645
18646           <itemizedlist>
18647             <listitem>
18648               <para>Fund Code is a unique identifier for your fund</para>
18649             </listitem>
18650
18651             <listitem>
18652               <para>The Fund Name should be something that librarians will
18653               understand</para>
18654             </listitem>
18655
18656             <listitem>
18657               <para>Amount should be entered with only numbers and decimals, no other
18658                 characters</para>
18659             </listitem>
18660             <listitem>
18661               <para>Warning at (%) or Warning at (amount) can be filled in to make Koha warn you
18662                 before you spend a certain percentage or amount of your budget. This will prevent
18663                 you from overspending.</para>
18664             </listitem>
18665
18666             <listitem>
18667               <para>You can choose to assign this fund to a librarian. Doing
18668               so will make it so that only that librarian can make changes to
18669               the Fund</para>
18670             </listitem>
18671
18672             <listitem>
18673               <para>Choose which library will be using this fund</para>
18674             </listitem>
18675
18676             <listitem>
18677               <para>You can restrict who can order from this fund by choosing either the 'owner',
18678                 'owner and users' or 'owner, users and library' from the 'Restrict access to'
18679                 menu</para>
18680
18681               <screenshot>
18682                 <screeninfo>Restrict Fund Access</screeninfo>
18683
18684                 <mediaobject>
18685                   <imageobject>
18686                     <imagedata fileref="images/admin/acquisitions/restrictfund.png"/>
18687                   </imageobject>
18688                 </mediaobject>
18689               </screenshot>
18690               <itemizedlist>
18691                 <listitem>
18692                   <important>
18693                     <para>Without an owner, the access restriction will be ignored, be sure to enter
18694                       an owner as well as choose a restriction</para>
18695                   </important>
18696                 </listitem>
18697               </itemizedlist>
18698             </listitem>
18699
18700             <listitem>
18701               <para>Notes are simply for any descriptive notes you might want
18702               to add so that librarians know when to use this fund</para>
18703             </listitem>
18704
18705             <listitem>
18706               <para>Planning categories are used for statistical purposes. To
18707               learn more about planning categories, check out the <link linkend="planningcatfaq">Planning Category FAQ</link>.</para>
18708             </listitem>
18709           </itemizedlist>
18710
18711           <para>When complete, click 'Submit' and you will be brought to a
18712           list of all of the funds for the budget.</para>
18713
18714           <screenshot>
18715             <screeninfo>List of funds</screeninfo>
18716
18717             <mediaobject>
18718               <imageobject>
18719                 <imagedata fileref="images/admin/acquisitions/fundlist.png"/>
18720               </imageobject>
18721             </mediaobject>
18722           </screenshot>
18723           <para>The monetary columns in the fund table break down as follows:<orderedlist>
18724               <listitem>
18725                 <para>Base-level allocated is the "Amount" value you defined when creating the
18726                   fund</para>
18727               </listitem>
18728               <listitem>
18729                 <para>Base-level ordered is the ordered amount for this fund (without child
18730                   funds)</para>
18731               </listitem>
18732               <listitem>
18733                 <para>Total ordered is the base-level ordered for this fund and all its child
18734                   funds</para>
18735               </listitem>
18736               <listitem>
18737                 <para>Base-level spent is the spent amount for this fund (without child
18738                   funds)</para>
18739               </listitem>
18740               <listitem>
18741                 <para>Total spent is the base-level spent for this fund and all its child
18742                   funds</para>
18743               </listitem>
18744               <listitem>
18745                 <para>Base-level available is 1 - 2</para>
18746               </listitem>
18747               <listitem>
18748                 <para>Total available is 1 - 3</para>
18749               </listitem>
18750             </orderedlist></para>
18751
18752           <para>To the right of each fund you will find the 'Actions' button under which you will
18753             find the 'Edit,' 'Delete,' and 'Add Child Fund' options. </para>
18754           <screenshot>
18755             <screeninfo>Fund actions</screeninfo>
18756             <mediaobject>
18757               <imageobject>
18758                 <imagedata fileref="images/admin/acquisitions/fundactions.png"/>
18759               </imageobject>
18760             </mediaobject>
18761           </screenshot>
18762           <para>A child fund simply a sub-fund of the fund listed. An example would be to have a
18763             fund for 'Fiction' and under that have a fund for 'New Releases' and a fund for 'Science
18764             Fiction.' It is an optional way to further organize your finances.</para>
18765           <para>Funds with children will show with a small arrow to the left. Clicking that will
18766             show you the children funds.</para>
18767           <screenshot>
18768               <screeninfo>Child funds</screeninfo>
18769               <mediaobject>
18770                 <imageobject>
18771                   <imagedata fileref="images/admin/acquisitions/childfunds.png"/>
18772                 </imageobject>
18773               </mediaobject>
18774             </screenshot>
18775         </section>
18776
18777         <section id="fundsplanning">
18778           <title>Budget Planning</title>
18779
18780           <para>When viewing the list of funds click the 'Planning' button and
18781           choose how you would like to plan to spend your budget.</para>
18782
18783           <screenshot>
18784             <screeninfo>Planning pull down menu</screeninfo>
18785
18786             <mediaobject>
18787               <imageobject>
18788                 <imagedata fileref="images/admin/acquisitions/planningpulldown.png"/>
18789               </imageobject>
18790             </mediaobject>
18791           </screenshot>
18792
18793           <para>If you choose 'Plan by MONTHS' you will see the budgeted
18794           amount broken down by months:</para>
18795
18796           <screenshot>
18797             <screeninfo>Budget Planning Formula</screeninfo>
18798
18799             <mediaobject>
18800               <imageobject>
18801                 <imagedata fileref="images/admin/acquisitions/planningbymonths.png"/>
18802               </imageobject>
18803             </mediaobject>
18804           </screenshot>
18805
18806           <para>To hide some of the columns you can click the 'hide' link to the right (or below as
18807             in the screenshot above) the dates. To add more columns you can click the 'Show a
18808             column' link found below the 'Fund Remaining' heading.</para>
18809
18810           <screenshot>
18811             <screeninfo>Choose columns to add</screeninfo>
18812
18813             <mediaobject>
18814               <imageobject>
18815                 <imagedata fileref="images/admin/acquisitions/addplanningcol.png"/>
18816               </imageobject>
18817             </mediaobject>
18818           </screenshot>
18819
18820           <para>From here you can plan your budget spending by manually
18821           entering values or by clicking the 'Auto-fill row' button. If you
18822           choose to auto-fill the form the system will try to divide the
18823           amount accordingly, you may have to make some edits to split things
18824           more accurately.</para>
18825
18826           <screenshot>
18827             <screeninfo>Auto-filled columns</screeninfo>
18828
18829             <mediaobject>
18830               <imageobject>
18831                 <imagedata fileref="images/admin/acquisitions/autofill.png"/>
18832               </imageobject>
18833             </mediaobject>
18834           </screenshot>
18835
18836           <para>Once your changes are made, click the 'Save' button. If you
18837           would like to export your data as a CSV file you can do so by
18838           entering a file name in the 'Output to a file named' field and
18839           clicking the 'Output' button.</para>
18840
18841           <screenshot>
18842             <screeninfo>Export planning as CSV</screeninfo>
18843
18844             <mediaobject>
18845               <imageobject>
18846                 <imagedata fileref="images/admin/acquisitions/planningcsv.png"/>
18847               </imageobject>
18848             </mediaobject>
18849           </screenshot>
18850         </section>
18851       </section>
18852     </section>
18853
18854     <section id="additionaladmin">
18855       <title>Additional Parameters</title>
18856
18857       <itemizedlist>
18858         <listitem>
18859           <para><emphasis>Get there:</emphasis> More &gt; Administration &gt;
18860           Additional Parameters</para>
18861         </listitem>
18862       </itemizedlist>
18863
18864       <section id="z3950admin">
18865         <title>Z39.50/SRU servers</title>
18866
18867         <para>Z39.50 is a client–server protocol for searching and retrieving information from
18868           remote computer databases, in short it's a tool used for copy cataloging. </para>
18869         <para>SRU- Search/Retrieve via URL -  is a standard XML-based protocol for search queries,
18870           utilizing  CQL - Contextual Query Language - a standard syntax for representing queries. </para>
18871         <para>Using Koha you can connect to any Z39.50 or SRU target that is publicly available or
18872           that you have the log in information to and copy both bibliographic and/or authority
18873           records from that source.</para>
18874
18875         <itemizedlist>
18876           <listitem>
18877             <para><emphasis>Get there:</emphasis> More &gt; Administration &gt; Additional
18878               Parameters &gt; Z39.50/SRU Servers</para>
18879           </listitem>
18880         </itemizedlist>
18881
18882         <para>Koha comes with a default list of Z39.50/SRU targets set up that you can add to, edit
18883           or delete</para>
18884
18885         <screenshot>
18886           <screeninfo>List of Z39.50 Servers in Koha</screeninfo>
18887
18888           <mediaobject>
18889             <imageobject>
18890               <imagedata fileref="images/admin/additional/z39list.png"/>
18891             </imageobject>
18892           </mediaobject>
18893         </screenshot>
18894
18895         <para>To find additional Z39.50 targets you use IndexData's IRSpy: <ulink
18896             url="http://irspy.indexdata.com/">http://irspy.indexdata.com</ulink> or the Library of
18897           Congress's List of Targets <ulink url="http://www.loc.gov/z3950/"
18898             >http://www.loc.gov/z3950/</ulink>
18899         </para>
18900
18901         <section id="addztarget">
18902           <title>Add a Z39.50 Target</title>
18903
18904           <itemizedlist>
18905             <listitem>
18906               <para>From the main Z39.50 page, click 'New Z39.50
18907               Server'</para>
18908               <screenshot>
18909                 <screeninfo>New Z39.50 Server Form</screeninfo>
18910                 <mediaobject>
18911                   <imageobject>
18912                     <imagedata fileref="images/admin/additional/newz39.png"/>
18913                   </imageobject>
18914                 </mediaobject>
18915               </screenshot>
18916
18917               <itemizedlist>
18918                 <listitem>
18919                   <para>'Z39.50 server' should be populated with a name that will help you identify
18920                     the source (such as the library name).</para>
18921                 </listitem>
18922                 <listitem>
18923                   <para>'Hostname' will be the address to the Z39.50 target.</para>
18924                 </listitem>
18925                 <listitem>
18926                   <para>'Port' tells Koha what port to listen on to get results from this
18927                     target.</para>
18928                 </listitem>
18929                 <listitem>
18930                   <para>'Userid' and 'Password' are only required for servers that are password
18931                     protected.</para>
18932                 </listitem>
18933                 <listitem>
18934                   <para>Check the 'Preselected' box if you want this target to always be selected by
18935                     default.</para>
18936                 </listitem>
18937                 <listitem>
18938                   <para>'Rank' lets you enter where in the list you'd like this target to appear.<itemizedlist>
18939                       <listitem>
18940                         <para>If this is left blank the targets will be in alphabetical
18941                           order.</para>
18942                       </listitem>
18943                     </itemizedlist></para>
18944                 </listitem>
18945                 <listitem>
18946                   <para>'Syntax' is the MARC flavor you use.</para>
18947                 </listitem>
18948                 <listitem>
18949                   <para>'Encoding' tells the system how to read special characters.</para>
18950                 </listitem>
18951                 <listitem>
18952                   <para>'Timeout' is helpful for targets that take a long while. You can set the
18953                     timeout so that it doesn't keep trying the target if results aren't found in a
18954                     reasonable amount of time.</para>
18955                 </listitem>
18956                 <listitem>
18957                   <para>'Record type' lets you define if this is a bibliographic or an authority
18958                     target.</para>
18959                 </listitem>
18960                 <listitem>
18961                   <para>'XSLT file(s)' lets enter one or more (comma-separated) XSLT file names that
18962                     you want to apply on the search results.<itemizedlist>
18963                       <listitem>
18964                         <para>When retrieving records from external targets you may wish to automate
18965                           some changes to those records. XSLT's allow you to do this. Koha ships
18966                           with some sample XSLT files in the /koha-tmpl/intranet-tmpl/prog/en/xslt/
18967                           directory ready for use: <itemizedlist>
18968                             <listitem>
18969                               <para>Del952.xsl: Remove items (MARC21/NORMARC)</para>
18970                             </listitem>
18971                             <listitem>
18972                               <para>Del995.xsl: Remove items (UNIMARC)</para>
18973                             </listitem>
18974                             <listitem>
18975                               <para>Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
18976                                 (MARC21/NORMARC)</para>
18977                             </listitem>
18978                             <listitem>
18979                               <para>Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
18980                                 (UNIMARC)</para>
18981                             </listitem>
18982                           </itemizedlist></para>
18983                       </listitem>
18984                     </itemizedlist></para>
18985                 </listitem>
18986               </itemizedlist>
18987             </listitem>
18988           </itemizedlist>
18989         </section>
18990
18991         <section id="suggestztarget">
18992           <title>Suggested Bibliographic Z39.50 Targets</title>
18993           <para>Koha libraries with open Z39.50 targets can share and find connection information on
18994             the Koha wiki: <ulink url="http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources"
18995               >http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources</ulink>. You can also
18996             find open Z39.50 targets by visiting IRSpy: <ulink url="http://irspy.indexdata.com"
18997               >http://irspy.indexdata.com</ulink>.</para>
18998
18999           <para>The following targets have been used successfully by other
19000           Koha libraries (in the Americas):</para>
19001
19002           <itemizedlist>
19003             <listitem>
19004               <para>ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC</para>
19005             </listitem>
19006             <listitem>
19007               <para>CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210
19008               INNOPAC</para>
19009             </listitem>
19010
19011             <listitem>
19012               <para>GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC</para>
19013             </listitem>
19014
19015             <listitem>
19016               <para>HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210
19017               horizon</para>
19018             </listitem>
19019
19020             <listitem>
19021               <para>HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton_hills</para>
19022             </listitem>
19023
19024             <listitem>
19025               <para>LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB</para>
19026             </listitem>
19027
19028             <listitem>
19029               <para>LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210
19030               INNOPAC</para>
19031             </listitem>
19032
19033             <listitem>
19034               <para>MANITOBA PUBLIC library.gov.mb.ca:210 horizon</para>
19035             </listitem>
19036
19037             <listitem>
19038               <para>MILTON PL cat.mpl.on.ca:210 horizon</para>
19039             </listitem>
19040
19041             <listitem>
19042               <para>NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default</para>
19043             </listitem>
19044             <listitem>
19045               <para>NHUPAC 199.192.6.130:211 nh_nhupac</para>
19046             </listitem>
19047             <listitem>
19048               <para>OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC</para>
19049             </listitem>
19050             <listitem>
19051               <para>OHIOLINK olc1.ohiolink.edu:210 INNOPAC</para>
19052             </listitem>
19053             <listitem>
19054               <para>PUBCAT prod890.dol.state.vt.us:2300 unicorn</para>
19055             </listitem>
19056             <listitem>
19057               <para>SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210 ZSERVER</para>
19058             </listitem>
19059             <listitem>
19060               <para>SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON</para>
19061             </listitem>
19062
19063             <listitem>
19064               <para>TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200
19065               unicorn</para>
19066             </listitem>
19067
19068             <listitem>
19069               <para>TRI-UNI 129.97.129.194:7090 voyager</para>
19070             </listitem>
19071
19072             <listitem>
19073               <para>VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon</para>
19074             </listitem>
19075           </itemizedlist>
19076         </section>
19077         <section id="suggestauthz39">
19078           <title>Suggested Authority Z39.50 Targets</title>
19079           <para>The following targets have been used successfully by other Koha libraries (in the
19080             Americas):</para>
19081           <itemizedlist>
19082             <listitem>
19083               <para>LIBRARIESAUSTRALIA AUTHORITIES z3950-test.librariesaustralia.nla.gov.au:210
19084                 AuthTraining Userid: ANLEZ / Password: z39.50</para>
19085             </listitem>
19086             <listitem>
19087               <para>LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF </para>
19088             </listitem>
19089             <listitem>
19090               <para>LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF</para>
19091             </listitem>
19092           </itemizedlist>
19093         </section>
19094         <section id="addsru">
19095           <title>Add a SRU Target</title>
19096           <itemizedlist>
19097             <listitem>
19098               <para>From the main Z39.50/SRU page, click 'New SRU Server'</para>
19099               <screenshot>
19100                 <screeninfo>New SRU Server Form</screeninfo>
19101                 <mediaobject>
19102                   <imageobject>
19103                     <imagedata fileref="images/admin/additional/newsru.png"/>
19104                   </imageobject>
19105                 </mediaobject>
19106               </screenshot>
19107               <itemizedlist>
19108                 <listitem>
19109                   <para>'Server name' should be populated with a name that will help you identify
19110                     the source (such as the library name).</para>
19111                 </listitem>
19112                 <listitem>
19113                   <para>'Hostname' will be the address to the Z39.50 target.</para>
19114                 </listitem>
19115                 <listitem>
19116                   <para>'Port' tells Koha what port to listen on to get results from this
19117                     target.</para>
19118                 </listitem>
19119                 <listitem>
19120                   <para>'Userid' and 'Password' are only required for servers that are password
19121                     protected.</para>
19122                 </listitem>
19123                 <listitem>
19124                   <para>Check the 'Preselected' box if you want this target to always be selected by
19125                     default.</para>
19126                 </listitem>
19127                 <listitem>
19128                   <para>'Rank' lets you enter where in the list you'd like this target to appear.<itemizedlist>
19129                       <listitem>
19130                         <para>If this is left blank the targets will be in alphabetical
19131                           order.</para>
19132                       </listitem>
19133                     </itemizedlist></para>
19134                 </listitem>
19135                 <listitem>
19136                   <para>'Syntax' is the MARC flavor you use.</para>
19137                 </listitem>
19138                 <listitem>
19139                   <para>'Encoding' tells the system how to read special characters.</para>
19140                 </listitem>
19141                 <listitem>
19142                   <para>'Timeout' is helpful for targets that take a long while. You can set the
19143                     timeout so that it doesn't keep trying the target if results aren't found in a
19144                     reasonable amount of time.</para>
19145                 </listitem>
19146                 <listitem>
19147                   <para>'Additional SRU options' is where you can enter additional options of the
19148                     external server here, like sru_version=1.1 or schema=marc21, etc. Note that
19149                     these options are server dependent.</para>
19150                 </listitem>
19151                 <listitem>
19152                   <para>'SRU Search field mapping' lets you add or update the mapping from the
19153                     available fields on the Koha search form to the specific server dependent index
19154                     names. <itemizedlist>
19155                       <listitem>
19156                         <para>To further refine your searches, you could add the following index
19157                           names to the SRU search field mappings. To do this, edit the server and
19158                           click the Modify button next to this field.
19159                             <table cellpadding="4" cellspacing="4" frame="all">
19160                               <title>SRU Mapping</title>
19161
19162                               <tgroup align="left" cols="2" colsep="1" rowsep="1">
19163                               <tbody>
19164                                 <row>
19165                                   <entry>Title</entry>
19166                                   <entry>dc.title</entry>
19167                                 </row>
19168                                 <row>
19169                                   <entry>ISBN</entry>
19170                                   <entry>bath.isbn</entry>
19171                                 </row>
19172                                 <row>
19173                                   <entry>Any</entry>
19174                                   <entry>cql.anywhere</entry>
19175                                 </row>
19176                                 <row>
19177                                   <entry>Author</entry>
19178                                   <entry>dc.author</entry>
19179                                 </row>
19180                                 <row>
19181                                   <entry>ISSN</entry>
19182                                   <entry>bath.issn</entry>
19183                                 </row>
19184                                 <row>
19185                                   <entry>Subject</entry>
19186                                   <entry>dc.subject</entry>
19187                                 </row>
19188                                 <row>
19189                                   <entry>Standard ID</entry>
19190                                   <entry>bath.standardIdentifier</entry>
19191                                 </row>
19192                               </tbody>
19193                               </tgroup>
19194                           </table></para>
19195                       </listitem>
19196                     </itemizedlist></para>
19197                 </listitem>
19198                 <listitem>
19199                   <para>'XSLT file(s)' lets enter one or more (comma-separated) XSLT file names that
19200                     you want to apply on the search results.<itemizedlist>
19201                       <listitem>
19202                         <para>When retrieving records from external targets you may wish to automate
19203                           some changes to those records. XSLT's allow you to do this. Koha ships
19204                           with some sample XSLT files in the /koha-tmpl/intranet-tmpl/prog/en/xslt/
19205                           directory ready for use: <itemizedlist>
19206                             <listitem>
19207                               <para>Del952.xsl: Remove items (MARC21/NORMARC)</para>
19208                             </listitem>
19209                             <listitem>
19210                               <para>Del995.xsl: Remove items (UNIMARC)</para>
19211                             </listitem>
19212                             <listitem>
19213                               <para>Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
19214                                 (MARC21/NORMARC)</para>
19215                             </listitem>
19216                             <listitem>
19217                               <para>Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
19218                                 (UNIMARC)</para>
19219                             </listitem>
19220                           </itemizedlist></para>
19221                       </listitem>
19222                     </itemizedlist></para>
19223                 </listitem>
19224               </itemizedlist>
19225             </listitem>
19226           </itemizedlist>
19227         </section>
19228       </section>
19229       <section id="didyoumean">
19230         <title>Did you mean?</title>
19231         <para><emphasis>Get there:</emphasis> More &gt; Administration &gt; Additional Parameters
19232           &gt; Did you mean?</para>
19233         <para>Koha can offer 'Did you mean?' options on searches based on values in your <link linkend="catauthorities">authorities</link>.  <important>
19234             <para>Did you mean? only works in the OPAC at this time. The Intranet options are here
19235               for future development.</para>
19236           </important></para>
19237         <para>Using this page you can control which options Koha gives patrons on their search results.</para>
19238         <screenshot>
19239             <screeninfo>Did you mean?</screeninfo>
19240             <mediaobject>
19241               <imageobject>
19242                 <imagedata fileref="images/admin/additional/didyoumean.png"/>
19243               </imageobject>
19244             </mediaobject>
19245           </screenshot>
19246         <para>To turn on the 'Did you mean?' bar on your search results you need to check the box
19247           next to each plugin you would like to use. The two plugins you have to choose from are:<itemizedlist>
19248             <listitem>
19249               <para>The ExplodedTerms plugin suggests that the user try searching for
19250                 broader/narrower/related terms for a given search (e.g. a user searching for "New
19251                 York (State)" would click the link for narrower terms if they're also interested in
19252                 "New York (City)"). This is only relevant for libraries with highly hierarchical
19253                 authority data. </para>
19254             </listitem>
19255             <listitem>
19256               <para>The AuthorityFile plugin searches the authority file and suggests the user might
19257                 be interested in bibs linked to the top 5 authorities</para>
19258             </listitem>
19259           </itemizedlist></para>
19260         <para>If you want one plugin to take priority over another you simply drag it above the other.</para>
19261         <screenshot>
19262             <screeninfo>Drag and drop options</screeninfo>
19263             <mediaobject>
19264               <imageobject>
19265                 <imagedata fileref="images/admin/additional/didyoumeandrag.png"/>
19266               </imageobject>
19267             </mediaobject>
19268           </screenshot>
19269         <para>If you choose both plugins you will see several options at the top of your search results</para>
19270         <screenshot>
19271             <screeninfo>Both plugins</screeninfo>
19272             <mediaobject>
19273               <imageobject>
19274                 <imagedata fileref="images/admin/additional/didyoumeanopacexplode.png"/>
19275               </imageobject>
19276             </mediaobject>
19277           </screenshot>
19278         <para>If you choose just the AuthorityFile you'll see just authorities.</para>
19279         <screenshot>
19280             <screeninfo>AuthorityFile</screeninfo>
19281             <mediaobject>
19282               <imageobject>
19283                 <imagedata fileref="images/admin/additional/didyoumeanopacauth.png"/>
19284               </imageobject>
19285             </mediaobject>
19286           </screenshot>
19287       </section>
19288       <section id="admincolumns">
19289         <title>Column settings</title>
19290         <para>This administration area will help you hide or display columns on fixed tables
19291           throughout the staff client. </para>
19292         <itemizedlist>
19293           <listitem>
19294             <para><emphasis>Get there:</emphasis> Administration &gt; Additional Parameters > Column
19295               settings</para>
19296           </listitem>
19297         </itemizedlist>
19298         <screenshot>
19299           <screeninfo>Column settings</screeninfo>
19300           <mediaobject>
19301             <imageobject>
19302               <imagedata fileref="images/admin/additional/columns.png"/>
19303             </imageobject>
19304           </mediaobject>
19305         </screenshot>
19306         <para>Clicking on the module you'd like to edit tables for will show you the options
19307           available to you. </para>
19308         <para>This area lets you control the columns that show in the table in question. If nothing
19309           is hidden you will see no check marks in the 'is hidden by default' column.</para>
19310         <screenshot>
19311           <screeninfo>Column settings</screeninfo>
19312           <mediaobject>
19313             <imageobject>
19314               <imagedata fileref="images/admin/additional/setcurrencynohide.png"/>
19315             </imageobject>
19316           </mediaobject>
19317         </screenshot>
19318         <para>And will see all of the columns when viewing the table on its regular page.</para>
19319         <screenshot>
19320           <screeninfo>Columns on currency table</screeninfo>
19321           <mediaobject>
19322             <imageobject>
19323               <imagedata fileref="images/admin/additional/currenciesnohide.png"/>
19324             </imageobject>
19325           </mediaobject>
19326         </screenshot>
19327         <para>If columns are hidden they will have checks in the 'is hidden by default'
19328           column.</para>
19329         <screenshot>
19330           <screeninfo>Column settings</screeninfo>
19331           <mediaobject>
19332             <imageobject>
19333               <imagedata fileref="images/admin/additional/setcurrencyhide.png"/>
19334             </imageobject>
19335           </mediaobject>
19336         </screenshot>
19337         <para>And hidden when you view the table.</para>
19338         <screenshot>
19339           <screeninfo>Columns on currency table</screeninfo>
19340           <mediaobject>
19341             <imageobject>
19342               <imagedata fileref="images/admin/additional/currencieshide.png"/>
19343             </imageobject>
19344           </mediaobject>
19345         </screenshot>
19346         <para>You can also toggle columns using the 'Show/Hide Columns button in the top right of
19347           the page</para>
19348         <screenshot>
19349           <screeninfo>Toggle columns</screeninfo>
19350           <mediaobject>
19351             <imageobject>
19352               <imagedata fileref="images/admin/additional/togglecolumns.png"/>
19353             </imageobject>
19354           </mediaobject>
19355         </screenshot>
19356       </section>
19357     </section>
19358   </chapter>
19359
19360   <chapter id="tools">
19361     <title>Tools</title>
19362
19363     <para>Tools in Koha all perform some sort of action. Often many of the
19364     items listed under Tools in Koha are referred to as 'Reports' in other
19365     library management systems.</para>
19366
19367     <itemizedlist>
19368       <listitem>
19369         <para><emphasis>Get there:</emphasis> More &gt; Tools</para>
19370       </listitem>
19371     </itemizedlist>
19372
19373     <section id="patrontools">
19374       <title>Patrons and Circulation</title>
19375
19376       <para/>
19377       <section id="patronlists">
19378         <title>Patron lists</title>
19379         <itemizedlist>
19380           <listitem>
19381             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Patrons and Circulation &gt;
19382               Patron lists</para>
19383           </listitem>
19384         </itemizedlist>
19385         <para>Patron lists are a way to store a group of patrons for easy modification via the <link
19386             linkend="batchpatronmod">batch patron modification tool</link> or reporting.</para>
19387         <screenshot>
19388           <screeninfo>Patron lists</screeninfo>
19389           <mediaobject>
19390             <imageobject>
19391               <imagedata fileref="images/tools/patronlists/patronlists.png"/>
19392             </imageobject>
19393           </mediaobject>
19394         </screenshot>
19395         <para>To create a new list of patrons click the 'New patron list' button</para>
19396         <screenshot>
19397             <screeninfo>New patron list</screeninfo>
19398             <mediaobject>
19399               <imageobject>
19400                 <imagedata fileref="images/tools/patronlists/newpatronlist.png"/>
19401               </imageobject>
19402             </mediaobject>
19403           </screenshot>
19404         <para>Enter a list name and save the list.</para>
19405         <screenshot>
19406             <screeninfo>Empty patron list</screeninfo>
19407             <mediaobject>
19408               <imageobject>
19409                 <imagedata fileref="images/tools/patronlists/addtopatronlist.png"/>
19410               </imageobject>
19411             </mediaobject>
19412           </screenshot>
19413         <para>To add patrons to the list click the 'Add patrons' button to the right of the list
19414           name.</para>
19415           <screenshot>
19416             <screeninfo>Add patron to a list</screeninfo>
19417             <mediaobject>
19418               <imageobject>
19419                 <imagedata fileref="images/tools/patronlists/addpatrontolist.png"/>
19420               </imageobject>
19421             </mediaobject>
19422           </screenshot>
19423         <para>Enter the patron's name or cardnumber in the search box and click on the right result
19424           to add the patron.</para>
19425         <screenshot>
19426             <screeninfo>Patrons to add</screeninfo>
19427             <mediaobject>
19428               <imageobject>
19429                 <imagedata fileref="images/tools/patronlists/patronstoadd.png"/>
19430               </imageobject>
19431             </mediaobject>
19432           </screenshot>
19433         <para>Once you have all of the patrons you would like to add you can click the 'Update'
19434           button to save them to the list.</para>
19435           <screenshot>
19436             <screeninfo>List of patrons</screeninfo>
19437             <mediaobject>
19438               <imageobject>
19439                 <imagedata fileref="images/tools/patronlists/patronlist.png"/>
19440               </imageobject>
19441             </mediaobject>
19442           </screenshot>
19443       </section>
19444
19445       <section id="comments">
19446         <title>Comments</title>
19447
19448         <itemizedlist>
19449           <listitem>
19450             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Patrons
19451             and Circulation &gt; Comments</para>
19452           </listitem>
19453         </itemizedlist>
19454
19455         <para>All comments added by patrons via the OPAC to bibliographic
19456         records require moderation by the librarians. If there are comments
19457         awaiting moderation they will be listed on the main staff dashboard
19458         under the Tools label:</para>
19459
19460         <screenshot>
19461           <screeninfo>Comments pending approval</screeninfo>
19462
19463           <mediaobject>
19464             <imageobject>
19465               <imagedata fileref="images/tools/comments/commentswaiting.png"/>
19466             </imageobject>
19467           </mediaobject>
19468         </screenshot>
19469
19470         <para>To moderate comments click on the notification on the main
19471         dashboard or go directly to the Comments Tool and click 'Approve' or
19472         'Delete' to the right of the comments awaiting moderation.</para>
19473
19474         <screenshot>
19475           <screeninfo>Comment awaiting moderation</screeninfo>
19476
19477           <mediaobject>
19478             <imageobject>
19479               <imagedata fileref="images/tools/comments/commentmoderation.png"/>
19480             </imageobject>
19481           </mediaobject>
19482         </screenshot>
19483
19484         <para>If there are no comments to moderate you will see a message
19485         saying just that</para>
19486
19487         <screenshot>
19488           <screeninfo>No comments to moderate</screeninfo>
19489
19490           <mediaobject>
19491             <imageobject>
19492               <imagedata fileref="images/tools/comments/nocomments.png"/>
19493             </imageobject>
19494           </mediaobject>
19495         </screenshot>
19496
19497         <para>You can also review and unapprove comments you have approved in
19498         the past by choosing the 'Approved comments' tab</para>
19499
19500         <screenshot>
19501           <screeninfo>Approved comments</screeninfo>
19502
19503           <mediaobject>
19504             <imageobject>
19505               <imagedata fileref="images/tools/comments/commentapproved.png"/>
19506             </imageobject>
19507           </mediaobject>
19508         </screenshot>
19509       </section>
19510
19511       <section id="patronimport">
19512         <title>Patron Import</title>
19513
19514         <itemizedlist>
19515           <listitem>
19516             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Patrons
19517             and Circulation &gt; Import Patrons</para>
19518           </listitem>
19519         </itemizedlist>
19520
19521         <para>The patron import tool can be used at any time to add patrons in
19522         bulk. It is commonly used in universities and schools when a new batch
19523         of students registers.</para>
19524
19525         <section id="createpatronfile">
19526           <title>Creating Patron File</title>
19527
19528           <para>Your Koha installation comes with a blank CSV file that you
19529           can use as a template for your patron records. If you would like to
19530           create the file yourself, make sure that your file has the following
19531           fields in this order as the header row:</para>
19532
19533           <para>borrowernumber, cardnumber, surname, firstname, title, othernames, initials,
19534             streetnumber, streettype, address, address2, city, zipcode, country, email, phone,
19535             mobile, fax, emailpro, phonepro, B_streetnumber, B_streettype, B_address, B_address2,
19536             B_city, B_zipcode, B_country, B_email, B_phone, dateofbirth, branchcode, categorycode,
19537             dateenrolled, dateexpiry, gonenoaddress, lost, debarred, contactname, contactfirstname,
19538             contacttitle, guarantorid, borrowernotes, relationship, ethnicity, ethnotes, sex,
19539             password, flags, userid, opacnote, contactnote, sort1, sort2, altcontactfirstname,
19540             altcontactsurname, altcontactaddress1, altcontactaddress2, altcontactaddress3,
19541             altcontactzipcode, altcontactcountry, altcontactphone, smsalertnumber, patron_attributes<important>
19542               <para>The borrowernumber column should not be left blank. If you do not have data for
19543                 that column you should delete that column before importing your patrons.</para>
19544             </important></para>
19545
19546           <important>
19547             <para>The 'password' should be stored in plaintext, and will be converted to a Bcrypt
19548               hash.</para>
19549
19550                 <para>If your passwords are already encrypted, talk to your
19551                 systems administrator about options</para>
19552           </important>
19553
19554           <important>
19555             <para>Date formats should match your <link linkend="dateformat">system preference</link>, and must be
19556             zero-padded, e.g. '01/02/2008'.</para>
19557           </important>
19558
19559           <important>
19560             <para>The fields 'branchcode', 'categorycode' and all fields you have defined in the
19561                 <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> preference are
19562               required and must match valid entries in your database.</para>
19563           </important>
19564
19565           <note>
19566             <para>If loading <link linkend="patronattributetypes">patron
19567             attributes</link>, the 'patron_attributes' field should contain a
19568             comma-separated list of attribute types and values.</para>
19569
19570             <itemizedlist>
19571               <listitem>
19572                 <para>The attribute type code and a colon should precede each
19573                 value.</para>
19574
19575                 <itemizedlist>
19576                   <listitem>
19577                     <para>For example: <emphasis role="bold">INSTID:12345,LANG:fr</emphasis> or <emphasis role="bold">STARTDATE:January 1
19578                     2010,TRACK:Day</emphasis></para>
19579                   </listitem>
19580
19581                   <listitem>
19582                     <para>If an input record has more than one attribute, the
19583                     fields should either be entered as an unquoted string
19584                     (previous examples), or with each field wrapped in
19585                     separate double quotes and delimited by a comma:</para>
19586
19587                     <itemizedlist>
19588                       <listitem>
19589                         <para><emphasis role="bold">"STARTDATE:January 1,
19590                         2010","TRACK:Day"</emphasis></para>
19591                       </listitem>
19592
19593                       <listitem>
19594                         <para>This syntax would be required if the data might
19595                         have a comma in it, like a date string.</para>
19596                       </listitem>
19597                     </itemizedlist>
19598                   </listitem>
19599                 </itemizedlist>
19600               </listitem>
19601             </itemizedlist>
19602           </note>
19603         </section>
19604
19605         <section id="importpatrons">
19606           <title>Importing Patrons</title>
19607
19608           <para>Once you have created your file, you can use the Patron Import
19609           Tool to bring the data into Koha.</para>
19610
19611           <screenshot>
19612             <screeninfo>Import Patron Form</screeninfo>
19613
19614             <mediaobject>
19615               <imageobject>
19616                 <imagedata fileref="images/tools/importpatrons/importpatrons.png"/>
19617               </imageobject>
19618             </mediaobject>
19619           </screenshot>
19620
19621           <itemizedlist>
19622             <listitem>
19623               <para>Choose your CSV file and choose to match on 'Cardnumber'
19624               to prevent adding of duplicate card numbers to the system</para>
19625             </listitem>
19626
19627             <listitem>
19628               <para>Next you can choose default values to apply to all patrons
19629               you are importing</para>
19630
19631               <itemizedlist>
19632                 <listitem>
19633                   <para>ex. If you're importing patrons specific to one branch
19634                   you can use the field on the Import form to apply the branch
19635                   code to all those you are importing.</para>
19636                 </listitem>
19637               </itemizedlist>
19638             </listitem>
19639
19640             <listitem>
19641               <para>Finally you need to decide on what data you want to
19642               replace if there are duplicates.</para>
19643
19644               <screenshot>
19645                 <screeninfo>Record matching options</screeninfo>
19646
19647                 <mediaobject>
19648                   <imageobject>
19649                     <imagedata fileref="images/tools/importpatrons/patronmatching.png"/>
19650                   </imageobject>
19651                 </mediaobject>
19652               </screenshot>
19653
19654               <itemizedlist>
19655                 <listitem>
19656                   <para>A matching record is found using the field you chose
19657                   for matching criteria to prevent duplication</para>
19658                 </listitem>
19659
19660                 <listitem>
19661                   <para>If you included patron attributes in your file you can
19662                   decide whether to add your values to existing values or
19663                   erase existing values and enter only your new values.</para>
19664                 </listitem>
19665               </itemizedlist>
19666             </listitem>
19667           </itemizedlist>
19668         </section>
19669       </section>
19670
19671       <section id="notices">
19672         <title>Notices &amp; Slips</title>
19673
19674         <itemizedlist>
19675           <listitem>
19676             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Patrons
19677             and Circulation &gt; Notices &amp; Slips</para>
19678           </listitem>
19679         </itemizedlist>
19680
19681         <para>All notices and circulation receipts (or slips) generated by
19682         Koha can be customized using the Notices &amp; Slips Tool. The system
19683         comes with several predefined templates that will appear when you
19684         first visit this tool.</para>
19685
19686         <screenshot>
19687           <screeninfo>Notices &amp; Slips Tool</screeninfo>
19688
19689           <mediaobject>
19690             <imageobject>
19691               <imagedata fileref="images/tools/notices/notices.png"/>
19692             </imageobject>
19693           </mediaobject>
19694         </screenshot>
19695
19696         <para>Each notice can be edited, but only a few can be deleted, this
19697         is to prevent system errors should a message try to send without a
19698         template. Each notice and slip can be edited on a per library basis,
19699         by default you will see the notices for all libraries.</para>
19700
19701         <para>If you have a style you'd like applied to all slips you can
19702         point the <link linkend="SlipCSS">SlipCSS</link> preference to a
19703         stylesheet. The same is true for notices, using the <link linkend="NoticeCSS">NoticeCSS</link> preference to define a
19704         stylesheet.</para>
19705         <para>You will also want to review the <link linkend="noticesfieldguide">Notices &amp; Slips
19706             Field Guide</link> for more information on formatting these notices. </para>
19707
19708         <section id="addnotices">
19709           <title>Adding Notices &amp; Slips</title>
19710
19711           <para>To add a new notice or slip</para>
19712
19713           <itemizedlist>
19714             <listitem>
19715               <para>Click 'New Notice'</para>
19716
19717               <screenshot>
19718                 <screeninfo>New Notice Form</screeninfo>
19719
19720                 <mediaobject>
19721                   <imageobject>
19722                     <imagedata fileref="images/tools/notices/newnotice.png"/>
19723                   </imageobject>
19724                 </mediaobject>
19725               </screenshot>
19726             </listitem>
19727
19728             <listitem>
19729               <para>Choose which library this notice or slip is for<itemizedlist>
19730                   <listitem>
19731                     <important>
19732                       <para>Not all notices can be branch specific for more information review the
19733                           <link linkend="noticesfieldguide">Notices &amp; Slips Field Guide</link>
19734                         in this manual. </para>
19735                     </important>
19736                   </listitem>
19737                 </itemizedlist></para>
19738             </listitem>
19739
19740             <listitem>
19741               <para>Choose the module this notice is related to</para>
19742             </listitem>
19743
19744             <listitem>
19745               <para>The Code is limited to 20 characters</para>
19746
19747               <itemizedlist>
19748                 <listitem>
19749                   <important>
19750                     <para>When working with the overdue notices you want each
19751                     notice at each branch to have a unique code. Think about
19752                     using the branch code in front of the notice code for each
19753                     branch.</para>
19754                   </important>
19755                 </listitem>
19756               </itemizedlist>
19757             </listitem>
19758
19759             <listitem>
19760               <para>Use the name field to expand on your Code</para>
19761
19762               <itemizedlist>
19763                 <listitem>
19764                   <note>
19765                     <para>With overdue notices, be sure to put your branch
19766                     name in the description as well so that it will be visible
19767                     when setting up your <link linkend="noticetriggers">triggers</link>.</para>
19768                   </note>
19769                 </listitem>
19770               </itemizedlist>
19771             </listitem>
19772
19773             <listitem>
19774               <para>Next you can customize the notice for every possible delivery method<itemizedlist>
19775                   <listitem>
19776                     <para>Every notice should have an Email template set for it<screenshot>
19777                         <screeninfo>New Email notice</screeninfo>
19778                         <mediaobject>
19779                           <imageobject>
19780                             <imagedata fileref="images/tools/notices/newemail.png"/>
19781                           </imageobject>
19782                         </mediaobject>
19783                       </screenshot></para>
19784                   </listitem>
19785                   <listitem>
19786                     <para>If you're using the <link linkend="TalkingTechItivaPhoneNotification"
19787                         >TalkingTechItivaPhoneNotification</link> service you can set up a Phone notification<screenshot>
19788                         <screeninfo>New Phone notice</screeninfo>
19789                         <mediaobject>
19790                           <imageobject>
19791                             <imagedata fileref="images/tools/notices/newphone.png"/>
19792                           </imageobject>
19793                         </mediaobject>
19794                       </screenshot></para>
19795                   </listitem>
19796                   <listitem>
19797                     <para>If you plan on printing this notice you can set the Print template next<screenshot>
19798                         <screeninfo>New Print notice</screeninfo>
19799                         <mediaobject>
19800                           <imageobject>
19801                             <imagedata fileref="images/tools/notices/newprint.png"/>
19802                           </imageobject>
19803                         </mediaobject>
19804                       </screenshot></para>
19805                   </listitem>
19806                   <listitem>
19807                     <para>If you have enabled SMS notices with the <link linkend="SMSSendDriver"
19808                         >SMSSendDriver</link> preference you can set the text for your SMS notices next<screenshot>
19809                         <screeninfo>New SMS notice</screeninfo>
19810                         <mediaobject>
19811                           <imageobject>
19812                             <imagedata fileref="images/tools/notices/newsms.png"/>
19813                           </imageobject>
19814                         </mediaobject>
19815                       </screenshot></para>
19816                   </listitem>
19817                 </itemizedlist></para>
19818             </listitem>
19819             <listitem>
19820               <para>Each notice offers you the same options<itemizedlist>
19821                 <listitem>
19822                   <para>If you plan on writing the notice or slip in HTML check
19823                     the 'HTML Message' box, otherwise the content will be generated
19824                     as plain text</para>
19825                 </listitem>
19826
19827                 <listitem>
19828                   <para>Message Subject is what will appear in the subject line of
19829                     the email</para>
19830                 </listitem>
19831
19832                 <listitem>
19833                   <para>In the message body feel free to type whatever message you
19834                     feel is best, use the fields on the left hand side to enter
19835                     individualized data from the from database.</para>
19836
19837                   <itemizedlist>
19838                       <listitem>
19839                         <note>
19840                           <para>Review the <link linkend="noticesfieldguide">Notices &amp; Slip
19841                               Field Guide</link> for info on what fields can be used here.</para>
19842                         </note>
19843                       </listitem>
19844                     <listitem>
19845                       <important>
19846                         <para>Overdue notices can use &lt;&lt;items.content&gt;&gt; tags by themselves,
19847                           or use &lt;item&gt;&lt;/item&gt; to span all of the tags. Learn more about the
19848                           <link linkend="noticemarkup">Overdue Notice Markup</link></para>
19849                         <itemizedlist>
19850                           <listitem>
19851                             <para>On overdue notices make sure to use &lt;&lt;items.content&gt;&gt; tags
19852                               to print out the data related to all items that are overdue.</para>
19853                           </listitem>
19854                         </itemizedlist>
19855                         <itemizedlist>
19856                           <listitem>
19857                             <para>The other option, only for overdue notices, is to use the
19858                               &lt;item&gt;&lt;/item&gt; tags to span the line so that it will print out
19859                               multiple lines One example for the &lt;item&gt;&lt;/item&gt; tag option
19860                               is:</para>
19861                             <para>&lt;item&gt;"&lt;&lt;biblio.title&gt;&gt;" by
19862                               &lt;&lt;biblio.author&gt;&gt;, &lt;&lt;items.itemcallnumber&gt;&gt;,
19863                               Barcode: &lt;&lt;items.barcode&gt;&gt; , Checkout date:
19864                               &lt;&lt;issues.issuedate&gt;&gt;, Due date:
19865                               &lt;&lt;issues.date_due&gt;&gt; Fine: &lt;&lt;items.fine>> Due date:
19866                               &lt;&lt;issues.date_due&gt;&gt; &lt;/item&gt;</para>
19867                           </listitem>
19868                         </itemizedlist>
19869                       </important>
19870                     </listitem>
19871                     <listitem>
19872                       <important>
19873                         <para>Only the overdue notices take advantage of the &lt;item&gt;&lt;/item&gt;
19874                           tags, all other notices referencing items need to use
19875                           &lt;&lt;items.content&gt;&gt;</para>
19876                       </important>
19877                     </listitem>
19878                     <listitem>
19879                       <note>
19880                         <para>To add today's date you can use the &lt;&lt;today&gt;&gt; syntax</para>
19881                       </note>
19882                     </listitem>
19883                   </itemizedlist>
19884                 </listitem>
19885                 </itemizedlist></para>
19886             </listitem>
19887           </itemizedlist>
19888
19889           <section id="noticemarkup">
19890             <title>Overdue Notice Markup</title>
19891
19892             <para>When creating your overdue notices there are two tags in addition to the various
19893               database fields that you can use in your notices. You will also want to review the
19894                 <link linkend="noticesfieldguide">Notices &amp; Slips Field Guide</link> for
19895               information on formatting item information in these notices. <important>
19896                 <para>These new tags only work on the overdue notices, not other circulation related
19897                   notices at this time.</para>
19898               </important>These tags are &lt;item&gt; and &lt;/item&gt; which should enclose all
19899               fields from the biblio, biblioitems, and items tables.</para>
19900
19901             <para>An example of using these tags in a notice template might be like:</para>
19902
19903             <programlisting>   The following item(s) is/are currently overdue:
19904
19905    &lt;item&gt;"&lt;&lt;biblio.title&gt;&gt;" by &lt;&lt;biblio.author&gt;&gt;, &lt;&lt;items.itemcallnumber&gt;&gt;, Barcode: &lt;&lt;items.barcode&gt;&gt; Fine: &lt;&lt;items.fine>>&lt;/item&gt;</programlisting>
19906
19907             <para>Which, assuming two items were overdue, would result in a notice
19908               like:<programlisting>   The following item(s) is/are currently overdue:
19909
19910    "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: 3.50
19911    "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: 3.50</programlisting></para>
19912           </section>
19913         </section>
19914
19915         <section id="existingnotices">
19916           <title>Existing Notices &amp; Slips</title>
19917
19918           <para>Among the default notices are notices for several common actions within Koha. All of
19919             these notices can be customized by altering their text via the Notices &amp; Slips tool
19920             and their style using the <link linkend="NoticeCSS">NoticeCSS</link> preference to
19921             define a stylesheet. You will also want to review the <link linkend="noticesfieldguide"
19922               >Notices &amp; Slips Field Guide</link> for information on formatting item information
19923             in these notices. Here are some of what those notices do:</para>
19924
19925           <itemizedlist>
19926             <listitem>
19927               <para id="ACCTDETAILS">ACCTDETAILS</para>
19928
19929               <itemizedlist>
19930                 <listitem>
19931                   <para>Sent to patrons when their account is set up if the
19932                   <link linkend="AutoEmailOPACUser">AutoEmailOPACUser</link>
19933                   preference is set to 'Send'</para>
19934                 </listitem>
19935               </itemizedlist>
19936             </listitem>
19937
19938             <listitem>
19939               <para id="ACQCLAIM">ACQCLAIM (Acquisition Claim)</para>
19940
19941               <itemizedlist>
19942                 <listitem>
19943                   <para>Used in the claim acquisition module</para>
19944                 </listitem>
19945
19946                 <listitem>
19947                   <para><emphasis>Get there:</emphasis> More &gt; Acquisitions
19948                   &gt; Late issues</para>
19949                 </listitem>
19950               </itemizedlist>
19951             </listitem>
19952             <listitem>
19953               <para>CHECKIN<itemizedlist>
19954                   <listitem>
19955                     <para>This notice is sent as the 'Check in' notice for all items that are
19956                       checked in</para>
19957                   </listitem>
19958                   <listitem>
19959                     <para>This notice is used if two criteria are met:</para>
19960                     <orderedlist>
19961                       <listitem>
19962                         <para>The <link linkend="EnhancedMessagingPreferences"
19963                             >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
19964                       </listitem>
19965                       <listitem>
19966                         <para>The patron has requested to receive this notice</para>
19967                         <itemizedlist>
19968                           <listitem>
19969                             <para><emphasis>Get there: </emphasis>OPAC &gt; Login &gt; my
19970                               messaging</para>
19971                           </listitem>
19972                           <listitem>
19973                             <para><emphasis>Get there: </emphasis>Staff Client &gt; Patron Record
19974                               &gt; <link linkend="patnotices">Notices</link></para>
19975                           </listitem>
19976                         </itemizedlist>
19977                       </listitem>
19978                     </orderedlist>
19979                   </listitem>
19980                 </itemizedlist></para>
19981             </listitem>
19982             <listitem>
19983               <para>CHECKOUT<itemizedlist>
19984                   <listitem>
19985                     <para>This notice is sent as the 'Check out' notice for all items that are
19986                       checked out</para>
19987                   </listitem>
19988                   <listitem>
19989                     <para>This notice is used if two criteria are met:</para>
19990                     <orderedlist>
19991                       <listitem>
19992                         <para>The <link linkend="EnhancedMessagingPreferences"
19993                             >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
19994                       </listitem>
19995                       <listitem>
19996                         <para>The patron has requested to receive this notice</para>
19997                         <itemizedlist>
19998                           <listitem>
19999                             <para><emphasis>Get there: </emphasis>OPAC &gt; Login &gt; my
20000                               messaging</para>
20001                           </listitem>
20002                           <listitem>
20003                             <para><emphasis>Get there: </emphasis>Staff Client &gt; Patron Record
20004                               &gt; <link linkend="patnotices">Notices</link></para>
20005                           </listitem>
20006                         </itemizedlist>
20007                       </listitem>
20008                     </orderedlist>
20009                   </listitem>
20010                 </itemizedlist></para>
20011             </listitem>
20012             <listitem>
20013               <para>DUE<itemizedlist>
20014                   <listitem>
20015                     <para>This notice is sent as the 'Item due' for an item is due</para>
20016                   </listitem>
20017                   <listitem>
20018                     <para>This notice is used if two criteria are met:</para>
20019                     <orderedlist>
20020                       <listitem>
20021                         <para>The <link linkend="EnhancedMessagingPreferences"
20022                             >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
20023                       </listitem>
20024                       <listitem>
20025                         <para>The patron has requested to receive this notice</para>
20026                         <itemizedlist>
20027                           <listitem>
20028                             <para><emphasis>Get there: </emphasis>OPAC &gt; Login &gt; my
20029                               messaging</para>
20030                           </listitem>
20031                           <listitem>
20032                             <para><emphasis>Get there: </emphasis>Staff Client &gt; Patron Record
20033                               &gt; <link linkend="patnotices">Notices</link></para>
20034                           </listitem>
20035                         </itemizedlist>
20036                       </listitem>
20037                     </orderedlist>
20038                   </listitem>
20039                 </itemizedlist></para>
20040             </listitem>
20041             <listitem>
20042               <para>DUEDGST<itemizedlist>
20043                   <listitem>
20044                     <para>This notice is sent as the 'Item due' for all items that are due</para>
20045                   </listitem>
20046                   <listitem>
20047                     <para>This notice is used if two criteria are met:</para>
20048                     <orderedlist>
20049                       <listitem>
20050                         <para>The <link linkend="EnhancedMessagingPreferences"
20051                             >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
20052                       </listitem>
20053                       <listitem>
20054                         <para>The patron has requested to receive this notice as a digest</para>
20055                         <itemizedlist>
20056                           <listitem>
20057                             <para><emphasis>Get there: </emphasis>OPAC &gt; Login &gt; my
20058                               messaging</para>
20059                           </listitem>
20060                           <listitem>
20061                             <para><emphasis>Get there: </emphasis>Staff Client &gt; Patron Record
20062                               &gt; <link linkend="patnotices">Notices</link></para>
20063                           </listitem>
20064                         </itemizedlist>
20065                       </listitem>
20066                     </orderedlist>
20067                   </listitem>
20068                 </itemizedlist></para>
20069             </listitem>
20070
20071             <listitem>
20072               <para id="HOLDnotice">HOLD (Hold Available for Pickup)</para>
20073
20074               <itemizedlist>
20075                 <listitem>
20076                   <para>This notice is used if two criteria are met:</para>
20077
20078                   <orderedlist>
20079                     <listitem>
20080                       <para>The <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
20081                       is set to 'Allow'</para>
20082                     </listitem>
20083
20084                     <listitem>
20085                       <para>The patron has requested to receive this
20086                       notice</para>
20087
20088                       <itemizedlist>
20089                         <listitem>
20090                           <para><emphasis>Get there: </emphasis>OPAC &gt;
20091                           Login &gt; my messaging</para>
20092                         </listitem>
20093
20094                         <listitem>
20095                           <para><emphasis>Get there: </emphasis>Staff Client
20096                           &gt; Patron Record &gt; <link linkend="patnotices">Notices</link></para>
20097                         </listitem>
20098                       </itemizedlist>
20099                     </listitem>
20100                   </orderedlist>
20101                 </listitem>
20102
20103                 <listitem>
20104                   <para>When this notice references the branches table it is
20105                   referring to the pickup branch information.</para>
20106                 </listitem>
20107               </itemizedlist>
20108             </listitem>
20109
20110             <listitem>
20111               <para id="HOLDPLACED">HOLDPLACED (a notice to the library staff
20112               that a hold has been placed)</para>
20113
20114               <itemizedlist>
20115                 <listitem>
20116                   <para>This notice requires the <link linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
20117                   system preference to be set to 'Enable'</para>
20118                 </listitem>
20119
20120                 <listitem>
20121                   <para>When this notice references the branches table it is
20122                   referring to the pickup branch information.</para>
20123                 </listitem>
20124               </itemizedlist>
20125             </listitem>
20126
20127             <listitem>
20128               <para id="ODUE">ODUE (Overdue Notice)</para>
20129
20130               <itemizedlist>
20131                 <listitem>
20132                   <para>This notice is used to send Overdue Notices to
20133                   Patrons</para>
20134                 </listitem>
20135
20136                 <listitem>
20137                   <para>See a <link linkend="samplenotice">Sample Overdue
20138                   Notice</link></para>
20139                 </listitem>
20140
20141                 <listitem>
20142                   <para>Requires that you set <link linkend="noticetriggers">Overdue Notice/Status
20143                   Triggers</link></para>
20144                 </listitem>
20145               </itemizedlist>
20146             </listitem>
20147             <listitem>
20148               <para>PREDUE<itemizedlist>
20149                   <listitem>
20150                     <para>This notice is sent as the 'Advanced notice' for an item is due</para>
20151                   </listitem>
20152                   <listitem>
20153                     <para>This notice is used if two criteria are met:</para>
20154                     <orderedlist>
20155                       <listitem>
20156                         <para>The <link linkend="EnhancedMessagingPreferences"
20157                             >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
20158                       </listitem>
20159                       <listitem>
20160                         <para>The patron has requested to receive this notice</para>
20161                         <itemizedlist>
20162                           <listitem>
20163                             <para><emphasis>Get there: </emphasis>OPAC &gt; Login &gt; my
20164                               messaging</para>
20165                           </listitem>
20166                           <listitem>
20167                             <para><emphasis>Get there: </emphasis>Staff Client &gt; Patron Record
20168                               &gt; <link linkend="patnotices">Notices</link></para>
20169                           </listitem>
20170                         </itemizedlist>
20171                       </listitem>
20172                     </orderedlist>
20173                   </listitem>
20174                 </itemizedlist></para>
20175             </listitem>
20176             <listitem>
20177               <para>PREDUEDGST<itemizedlist>
20178                   <listitem>
20179                     <para>This notice is sent as the 'Advanced notice' for all items that are
20180                       due</para>
20181                   </listitem>
20182                   <listitem>
20183                     <para>This notice is used if two criteria are met:</para>
20184                     <orderedlist>
20185                       <listitem>
20186                         <para>The <link linkend="EnhancedMessagingPreferences"
20187                             >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
20188                       </listitem>
20189                       <listitem>
20190                         <para>The patron has requested to receive this notice as a digest</para>
20191                         <itemizedlist>
20192                           <listitem>
20193                             <para><emphasis>Get there: </emphasis>OPAC &gt; Login &gt; my
20194                               messaging</para>
20195                           </listitem>
20196                           <listitem>
20197                             <para><emphasis>Get there: </emphasis>Staff Client &gt; Patron Record
20198                               &gt; <link linkend="patnotices">Notices</link></para>
20199                           </listitem>
20200                         </itemizedlist>
20201                       </listitem>
20202                     </orderedlist>
20203                   </listitem>
20204                 </itemizedlist></para>
20205             </listitem>
20206             <listitem>
20207               <para>RENEWAL<itemizedlist>
20208                   <listitem>
20209                     <para>This notice is sent as the 'Check out' notice for all items that are
20210                       renewed</para>
20211                   </listitem>
20212                   <listitem>
20213                     <para>This notice is used if three criteria are met:</para>
20214                     <orderedlist>
20215                       <listitem>
20216                         <para>The <link linkend="EnhancedMessagingPreferences"
20217                             >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
20218                       </listitem>
20219                       <listitem>
20220                         <para>The <link linkend="RenewalSendNotice">RenewalSendNotice</link>
20221                           preference is set to 'Send'</para>
20222                       </listitem>
20223                       <listitem>
20224                         <para>The patron has requested to receive the checkout notice</para>
20225                         <itemizedlist>
20226                           <listitem>
20227                             <para><emphasis>Get there: </emphasis>OPAC &gt; Login &gt; my
20228                               messaging</para>
20229                           </listitem>
20230                           <listitem>
20231                             <para><emphasis>Get there: </emphasis>Staff Client &gt; Patron Record
20232                               &gt; <link linkend="patnotices">Notices</link></para>
20233                           </listitem>
20234                         </itemizedlist>
20235                       </listitem>
20236                     </orderedlist>
20237                   </listitem>
20238                 </itemizedlist></para>
20239             </listitem>
20240
20241             <listitem>
20242               <para id="RLIST">RLIST (Routing List)</para>
20243
20244               <itemizedlist>
20245                 <listitem>
20246                   <para>Used in the serials module to notify patrons/staff of
20247                   new issues of a serial</para>
20248
20249                   <itemizedlist>
20250                     <listitem>
20251                       <para><emphasis>Get there:</emphasis> More &gt; Serials
20252                       &gt; <link linkend="newsubscription">New
20253                       Subscription</link></para>
20254                     </listitem>
20255                   </itemizedlist>
20256                 </listitem>
20257
20258                 <listitem>
20259                   <para>You have the option to select the 'Routing List'
20260                   notice when creating a new subscription (Choose from the
20261                   'Patron notification' drop down).</para>
20262                 </listitem>
20263
20264                 <listitem>
20265                   <note>
20266                     <para>Notice also that if you'd like to notify patrons of
20267                     new serial issues, you can click on 'define a notice'
20268                     which will take you to the 'Notices' tool</para>
20269                   </note>
20270                 </listitem>
20271               </itemizedlist>
20272             </listitem>
20273             <listitem>
20274               <para>SHARE_ACCEPT<itemizedlist>
20275                   <listitem>
20276                     <para>Used to notify a patron when another patron has accepted their shared
20277                       list.</para>
20278                   </listitem>
20279                   <listitem>
20280                     <para>Requires that you set <link linkend="OpacAllowSharingPrivateLists"
20281                         >OpacAllowSharingPrivateLists</link> to 'Allow'</para>
20282                   </listitem>
20283                 </itemizedlist></para>
20284             </listitem>
20285             <listitem>
20286               <para>SHARE_INVITE <itemizedlist>
20287                   <listitem>
20288                     <para>Used to notify a patron that another patron would like to share a list
20289                       with them.</para>
20290                   </listitem>
20291                   <listitem>
20292                     <para>Requires that you set <link linkend="OpacAllowSharingPrivateLists"
20293                         >OpacAllowSharingPrivateLists</link> to 'Allow'</para>
20294                   </listitem>
20295                 </itemizedlist></para>
20296             </listitem>
20297           </itemizedlist>
20298
20299           <para>There are also a set of predefined slips (or receipts) listed
20300           on this page. All of these slips can be customized by altering their
20301           text via the Notices &amp; Slips tool and their style using the
20302           <link linkend="SlipCSS">SlipCSS</link> preference to define a
20303           stylesheet. Here is what those slips are used for:</para>
20304
20305           <itemizedlist>
20306             <listitem>
20307               <para>ISSUEQSLIP</para>
20308
20309               <itemizedlist>
20310                 <listitem>
20311                   <para>Used to print the quick slip in circulation</para>
20312                 </listitem>
20313
20314                 <listitem>
20315                   <para>The quick slip only includes items that were checked
20316                   out today</para>
20317                 </listitem>
20318               </itemizedlist>
20319             </listitem>
20320
20321             <listitem>
20322               <para>ISSUESLIP</para>
20323
20324               <itemizedlist>
20325                 <listitem>
20326                   <para>Used to print a full slip in circulation</para>
20327                 </listitem>
20328
20329                 <listitem>
20330                   <para>The slip or receipt will show items checked out today
20331                   as well as items that are still checked out</para>
20332                 </listitem>
20333               </itemizedlist>
20334             </listitem>
20335
20336             <listitem>
20337               <para>RESERVESLIP</para>
20338
20339               <itemizedlist>
20340                 <listitem>
20341                   <para>Used to print a holds slip</para>
20342                 </listitem>
20343
20344                 <listitem>
20345                   <para>The holds slip is generated when a hold is
20346                   confirmed</para>
20347                 </listitem>
20348               </itemizedlist>
20349             </listitem>
20350             <listitem>
20351               <para>TRANSFERSLIP</para>
20352               <itemizedlist>
20353                 <listitem>
20354                   <para>Used to print a transfer slip</para>
20355                 </listitem>
20356                 <listitem>
20357                   <para>The transfer slip is printed when you confirm a transfer from one branch to
20358                     another in your system</para>
20359                 </listitem>
20360               </itemizedlist>
20361             </listitem>
20362           </itemizedlist>
20363         </section>
20364       </section>
20365
20366       <section id="noticetriggers">
20367         <title>Overdue Notice/Status Triggers</title>
20368
20369         <itemizedlist>
20370           <listitem>
20371             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Patrons
20372             and Circulation &gt; Overdue Notice/Status Triggers</para>
20373           </listitem>
20374         </itemizedlist>
20375
20376         <para>In order to send the overdue notices that you defined using the
20377         <link linkend="notices">Notices</link> tool, you need to first set the
20378         triggers to have these messages.</para>
20379
20380         <important>
20381           <para>In order to have overdue notices sent to your patrons, you
20382           need to <link linkend="addingpatroncat">set that patron
20383           category</link> to require overdue notices.</para>
20384         </important>
20385
20386         <para><important>
20387             <para>Depending on the value of your <link linkend="OverdueNoticeCalendar"
20388                 >OverdueNoticeCalendar</link> preference the delay may or may not include days the
20389               library is closed based on the <link linkend="calholidays">holiday
20390               calendar</link>.</para>
20391           </important>The Overdue Notice/Status Triggers tool gives the librarian the power to send
20392           up to three notices to each patron type notifying them of overdue items</para>
20393
20394         <screenshot>
20395           <screeninfo>Overdue Notice/Status Triggers Tool</screeninfo>
20396
20397           <mediaobject>
20398             <imageobject>
20399               <imagedata fileref="images/tools/triggers.png"/>
20400             </imageobject>
20401           </mediaobject>
20402         </screenshot>
20403
20404         <itemizedlist>
20405           <listitem>
20406             <para>Delay is the number of days after an issue is due before an
20407             action is triggered.</para>
20408
20409             <itemizedlist>
20410               <listitem>
20411                 <important>
20412                   <para>If you want Koha to trigger an action (send a letter
20413                   or restrict member), a delay value is required.</para>
20414                 </important>
20415               </listitem>
20416             </itemizedlist>
20417           </listitem>
20418
20419           <listitem>
20420             <para>To send additional notices, click on the tabs for 'Second'
20421             and 'Third' notice</para>
20422           </listitem>
20423
20424           <listitem>
20425             <para>If you would like to prevent a patron from checking items out because of their
20426               overdue items, check the 'Restrict' box, this will put a notice on the patron's record
20427               at checkout informing the librarian that the patron cannot check out due to overdue items.<itemizedlist>
20428                 <listitem>
20429                   <para>If you choose to restrict a patron in this way you can also have Koha
20430                     automatically remove that restriction with the <link
20431                       linkend="AutoRemoveOverduesRestrictions">AutoRemoveOverduesRestrictions</link>
20432                     preference.</para>
20433                 </listitem>
20434               </itemizedlist></para>
20435           </listitem>
20436
20437           <listitem>
20438             <para>Next you can choose the delivery method for the overdue notice. You can choose
20439               from Email, Phone (if you are using the <link
20440                 linkend="TalkingTechItivaPhoneNotification">iTiva Talking Tech service</link>),
20441               Print and SMS (if you have set your <link linkend="SMSSendDriver"
20442               >SMSSendDriver</link>). <itemizedlist>
20443                 <listitem>
20444                   <note>
20445                     <para>The Feed option is not yet a feature in Koha, it is there for future
20446                       development.</para>
20447                   </note>
20448                 </listitem>
20449               </itemizedlist></para>
20450           </listitem>
20451           <listitem>
20452             <para>See a <link linkend="samplenotice">Sample Overdue Notice</link></para>
20453           </listitem>
20454         </itemizedlist>
20455       </section>
20456
20457       <section id="patroncardcreator">
20458         <title>Patron Card Creator</title>
20459
20460         <itemizedlist>
20461           <listitem>
20462             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Patron Card Creator</para>
20463           </listitem>
20464         </itemizedlist>
20465
20466         <para>The Patron Card Creator allow you to use layouts and templates which you design to
20467           print your custom patron cards on your printer. Here are some of the features of the
20468           Patron Card Creator module:</para>
20469
20470         <itemizedlist>
20471           <listitem>
20472             <para>Customize patron card layouts with text retrieved from the Koha patron data</para>
20473           </listitem>
20474
20475           <listitem>
20476             <para>Design custom card templates for printed patron cards (to match the label
20477               sheets)</para>
20478           </listitem>
20479
20480           <listitem>
20481             <para>Build and manage batches of patron cards to print</para>
20482           </listitem>
20483
20484           <listitem>
20485             <para>Export (as PDF) single or multiple batches to print</para>
20486           </listitem>
20487
20488           <listitem>
20489             <para>Export (as PDF) single or multiple patron cards from within a batch</para>
20490           </listitem>
20491         </itemizedlist>
20492
20493         <para><screenshot>
20494             <screeninfo>Patron Card Creator</screeninfo>
20495             <mediaobject>
20496               <imageobject>
20497                 <imagedata fileref="images/tools/patroncards/patroncardhome.png"/>
20498               </imageobject>
20499             </mediaobject>
20500           </screenshot>At the top of each screen within the Patron Card Creator, you will see a
20501           toolbar allowing quick access to relevant functions. The menu to the left of each screen
20502           also allows easy access to the different sections of the Patron Card Creator. The bread
20503           crumb trail at the top left of each screen will give specific indication as to where you
20504           are within the Patron Card Creator module and allow quick navigation to previously
20505           traversed sections. Finally, you can find more detailed information on each section of the
20506           Patron Card Creator by clicking the 'Help' link at the upper right-hand corner of every
20507           page.</para>
20508         <section id="cardlayouts">
20509           <title>Layouts</title>
20510           <itemizedlist>
20511             <listitem>
20512               <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Patron Card Creator &gt;
20513                 Manage layouts</para>
20514             </listitem>
20515           </itemizedlist>
20516           <para>A layout defines the text and images that will be printed on to the card and where
20517             it will appear. <note>
20518               <para>Up to three lines of text, the patron's number in barcode representation and up
20519                 to two images can be printed on to the card.</para>
20520             </note></para>
20521           <section id="addcardlayout">
20522             <title>Add a Layout</title>
20523             <para>If you have no layouts defined, you will add a new layout by clicking the 'New
20524               layout' button at the top of your screen.<screenshot>
20525                 <screeninfo>New layout button</screeninfo>
20526                 <mediaobject>
20527                   <imageobject>
20528                     <imagedata fileref="images/tools/patroncards/newbuttons.png"/>
20529                   </imageobject>
20530                 </mediaobject>
20531               </screenshot></para>
20532             <para>You may also choose to press 'Manage layout' on the left side. Here you are
20533               offered a list of available layouts you can select for editing. But at the top of the
20534               page there is still the 'New layout' button.</para>
20535             <screenshot>
20536               <screeninfo>Add New Layout</screeninfo>
20537               <mediaobject>
20538                 <imageobject>
20539                   <imagedata fileref="images/tools/patroncards/addlayout.png"/>
20540                 </imageobject>
20541               </mediaobject>
20542             </screenshot>
20543             <itemizedlist>
20544               <listitem>
20545                 <para>The name you assign to the layout is for your benefit, name it something that
20546                   will be easy to identify at a later date</para>
20547               </listitem>
20548               <listitem>
20549                 <para>The Units pull down is used to define what measurement scale you're going to
20550                   be using for your layout.</para>
20551                 <screenshot>
20552                   <screeninfo>Units of Measurement</screeninfo>
20553                   <mediaobject>
20554                     <imageobject>
20555                       <imagedata fileref="images/tools/patroncards/units.png"/>
20556                     </imageobject>
20557                   </mediaobject>
20558                 </screenshot>
20559                 <itemizedlist>
20560                   <listitem>
20561                     <note>
20562                       <para>A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch is 25.4 SI
20563                         Millimeters </para>
20564                     </note>
20565                   </listitem>
20566                 </itemizedlist>
20567               </listitem>
20568               <listitem>
20569                 <para>Next note if this layout is for the front or the back of the patron
20570                   card</para>
20571                 <itemizedlist>
20572                   <listitem>
20573                     <para>
20574                       <note>
20575                         <para>You will need a layout for both the front and back of your card if you
20576                           have 2-sided library cards, this option doesn't allow you to print two
20577                           sided cards, just lets you track which side of the card you're
20578                           designing.</para>
20579                       </note>
20580                     </para>
20581                   </listitem>
20582                 </itemizedlist>
20583               </listitem>
20584               <listitem>
20585                 <para>You have the option of adding up to 3 lines of text to your card. Your text
20586                   can be static text of your choosing and/or fields from the patron record. If you
20587                   want to print fields from the patron record you want to put the field names in
20588                   brackets like so - &lt;firstname&gt;<itemizedlist>
20589                     <listitem>
20590                       <note>
20591                         <para>A full list of field names can be found in the database schema at
20592                             <ulink url="http://schema.koha-community.org"
20593                             >http://schema.koha-community.org</ulink></para>
20594                       </note>
20595                     </listitem>
20596                   </itemizedlist></para>
20597               </listitem>
20598               <listitem>
20599                 <para>For each line of text, you can choose your font, font size and the location of
20600                   the text on the card using the lower X and Y coordinates</para>
20601               </listitem>
20602               <listitem>
20603                 <para>In order to show the barcode and the patron card number you will need to check
20604                   the 'Print Card Number as Barcode' option. This will turn the patron card number
20605                   into a barcode. If you want the number to print in human readable format you will
20606                   need to check the 'Print Card Number as Text Under Barcode' option.</para>
20607               </listitem>
20608               <listitem>
20609                 <para>Finally you can choose up to two images to print on the card.</para>
20610                 <itemizedlist>
20611                   <listitem>
20612                     <para>One can be the <link linkend="uploadpatronimages">patron image</link>
20613                       which you can resize to meet your needs.</para>
20614                   </listitem>
20615                   <listitem>
20616                     <para>The other image can be something like a library logo or symbol that you
20617                       uploaded using the '<link linkend="managecardimages">Manage Images</link>'
20618                       module of the Patron Card Creator Tool.</para>
20619                   </listitem>
20620                 </itemizedlist>
20621               </listitem>
20622             </itemizedlist>
20623             <para><important>
20624                 <para>It is the designers responsibility to define textlines, barcode and images
20625                   such that overlap is avoided.</para>
20626               </important>After saving, your layouts will appear on the 'Manage layouts'
20627               page.</para>
20628             <screenshot>
20629               <screeninfo>Manage Layouts</screeninfo>
20630               <mediaobject>
20631                 <imageobject>
20632                   <imagedata fileref="images/tools/patroncards/managelayouts.png"/>
20633                 </imageobject>
20634               </mediaobject>
20635             </screenshot>
20636           </section>
20637         </section>
20638
20639         <section id="patrontemplate">
20640           <title>Templates</title>
20641
20642           <itemizedlist>
20643             <listitem>
20644               <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Patron Card Creator &gt;
20645                 Manage templates</para>
20646             </listitem>
20647           </itemizedlist>
20648
20649           <para>A template describes the arrangement of labels on the label sheet/card stock you are
20650             using. This might be Avery 5160 for address labels, Gaylord 47-284 for spine labels or
20651             Avery 28371 for your patron cards, just to give a couple of examples. All of the
20652             information you will need for setting up a template may be on the packaging, and if not
20653             it can usually be found on the vendor's website or can be measured from a sample
20654             sheet.</para>
20655
20656           <section id="addcardtemplate">
20657             <title>Add a Template</title>
20658
20659             <para>To add a new template click on the 'New template' button at the top of your page
20660               which brings you to the Edit template form immediately. You may also choose to press
20661               'Manage templates' on the left side. Here you are offered a list of available
20662               templates you can select for editing. But in the top of the page there is still the
20663               'New template' button.</para>
20664             <screenshot>
20665               <screeninfo>New template button</screeninfo>
20666               <mediaobject>
20667                 <imageobject>
20668                   <imagedata fileref="images/tools/patroncards/newbuttons.png"/>
20669                 </imageobject>
20670               </mediaobject>
20671             </screenshot>
20672
20673             <para>Using the form that appears after pressing either 'Edit' or 'New template'you can
20674               define the template for your sheet of labels or cards. </para>
20675
20676             <screenshot>
20677               <screeninfo>Add Patron Card Template</screeninfo>
20678
20679               <mediaobject>
20680                 <imageobject>
20681                   <imagedata fileref="images/tools/patroncards/edittemplate.png"/>
20682                 </imageobject>
20683               </mediaobject>
20684             </screenshot>
20685
20686             <itemizedlist>
20687               <listitem>
20688                 <para>Template ID is simply a system generated unique id</para>
20689               </listitem>
20690
20691               <listitem>
20692                 <para>Template Code should be the name of this template to identify it on a list of
20693                   templates</para>
20694               </listitem>
20695
20696               <listitem>
20697                 <para>You can use the Template Description to add additional
20698                 information about the template</para>
20699               </listitem>
20700
20701               <listitem>
20702                 <para>The Units pull down is used to define what measurement scale you're going to
20703                   be using for the template. </para>
20704                 <screenshot>
20705                   <screeninfo>Measurement Units</screeninfo>
20706                   <mediaobject>
20707                     <imageobject>
20708                       <imagedata fileref="images/tools/patroncards/units.png"/>
20709                     </imageobject>
20710                   </mediaobject>
20711                 </screenshot>
20712                 <itemizedlist>
20713                   <listitem>
20714                     <note>
20715                       <para>A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch is 25.4 SI
20716                         Millimeters </para>
20717                     </note>
20718                   </listitem>
20719                 </itemizedlist>
20720               </listitem>
20721
20722               <listitem>
20723                 <para>The measurements (page height, page width, card width, card height) may be on
20724                   the packaging, and if not it can usually be found on the vendor's website or can
20725                   be measured from a sample sheet.</para>
20726               </listitem>
20727
20728               <listitem>
20729                 <para>A profile is a set of "adjustments" applied to a given template just prior to
20730                   printing which compensates for anomalies unique and peculiar to a given printer
20731                   (to which the profile is assigned). </para>
20732
20733                 <itemizedlist>
20734                   <listitem>
20735                     <para>Before defining a profile try printing some sample cards so that you can
20736                       take measurements to define a profile to perform the right adjustments for
20737                       your printer/template combination.</para>
20738                   </listitem>
20739
20740                   <listitem>
20741                     <para>After finding and documenting any anomalies in the printed document, then
20742                       you can <link linkend="addcardprofile">create a profile</link> and assign it
20743                       to the template.</para>
20744                   </listitem>
20745                   <listitem>
20746                     <para>
20747                       <important>
20748                         <para>Do not specify a profile unless needed, i.e. do not click to define a
20749                           printer profile. It is not possible to remove a profile from a template
20750                           but you can switch to another profile. </para>
20751                       </important>
20752                     </para>
20753                   </listitem>
20754                   <listitem>
20755                     <note>
20756                       <para>If you are using different printers you may be required to define
20757                         several templates that are identical only different profiles are
20758                         specified.</para>
20759                     </note>
20760                   </listitem>
20761                 </itemizedlist>
20762               </listitem>
20763             </itemizedlist>
20764
20765             <para>After saving, your templates will appear on the 'Manage templates' page.</para>
20766
20767             <screenshot>
20768               <screeninfo>Manage Templates</screeninfo>
20769
20770               <mediaobject>
20771                 <imageobject>
20772                   <imagedata fileref="images/tools/patroncards/managetemplates.png"/>
20773                 </imageobject>
20774               </mediaobject>
20775             </screenshot>
20776           </section>
20777         </section>
20778
20779         <section id="patronprofile">
20780           <title>Profiles</title>
20781
20782           <itemizedlist>
20783             <listitem>
20784               <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Patron Card Creator &gt;
20785                 Manage profiles</para>
20786             </listitem>
20787           </itemizedlist>
20788
20789           <para>A profile is a set of "adjustments" applied to a given <link
20790               linkend="patrontemplate">template</link> just prior to printing which compensates for
20791             anomalies unique and peculiar to a given printer. This means if you set a template up
20792             and then print a sample set of data and find that the items are not all aligned the same
20793             on each card, you need to set up a profile for each printer (or even different tray
20794             selections on the same printer) to make up for the differences in printing styles, such
20795             as the shifting of text to the left, right, top or bottom.</para>
20796
20797           <para>If your cards are printing just the way you want, you will not
20798           need a profile.</para>
20799
20800           <section id="addcardprofile">
20801             <title>Add a Profile</title>
20802
20803             <para>To add a new profile, you want to click on the 'Profiles'
20804             button at the top of your page and choose 'New Profile'</para>
20805
20806             <screenshot>
20807               <screeninfo>New Profile Button</screeninfo>
20808
20809               <mediaobject>
20810                 <imageobject>
20811                   <imagedata fileref="images/tools/patroncards/newbuttons.png"/>
20812                 </imageobject>
20813               </mediaobject>
20814             </screenshot>
20815             <para>To add a new profile, you want to click on the 'New profile' button at the top of
20816               your page. Using the form that appears you can define the values to correct the card
20817               misalignments on your label sheet. You may also choose 'Manage profiles' on the left
20818               side and select one of the currently available profiles for editing.</para>
20819
20820             <screenshot>
20821               <screeninfo>Add Printer Profile</screeninfo>
20822
20823               <mediaobject>
20824                 <imageobject>
20825                   <imagedata fileref="images/tools/patroncards/addprofile.png"/>
20826                 </imageobject>
20827               </mediaobject>
20828             </screenshot>
20829
20830             <itemizedlist>
20831               <listitem>
20832                 <para>The Printer Name and Paper Bin do not have to match your printer exactly, they
20833                   are for your reference so you can remember what printer you have set the profile
20834                   for. <itemizedlist>
20835                     <listitem>
20836                       <para>
20837                         <note>
20838                           <para>For example: if you want to use the Printer model number in printer
20839                             name you can, or you can call it 'the printer on my desk'</para>
20840                         </note>
20841                       </para>
20842                     </listitem>
20843                   </itemizedlist></para>
20844               </listitem>
20845
20846               <listitem>
20847                 <para>Template will be filled in once you have chosen which
20848                 template to apply the profile to on the <link linkend="addcardtemplate">template edit form</link></para>
20849               </listitem>
20850
20851               <listitem>
20852                 <para>The Units pull down is used to define what measurement
20853                 scale you're going to be using for your profile.</para>
20854
20855                 <screenshot>
20856                   <screeninfo>Units of Measurement</screeninfo>
20857
20858                   <mediaobject>
20859                     <imageobject>
20860                       <imagedata fileref="images/tools/patroncards/units.png"/>
20861                     </imageobject>
20862                   </mediaobject>
20863                 </screenshot>
20864                 <itemizedlist>
20865                   <listitem>
20866                     <note>
20867                       <para>A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch is 25.4 SI
20868                         Millimeters </para>
20869                     </note>
20870                   </listitem>
20871                 </itemizedlist>
20872               </listitem>
20873
20874               <listitem>
20875                 <para>Offset should be used when the entire image is off center either vertically or
20876                   horizontally. Creep describes a condition where the distance between the labels changes
20877                   across the page or up and down the page<itemizedlist>
20878                     <listitem>
20879                       <para>For offset and creep values, negative numbers move the printed
20880                         information up and to the left on the printed sheet and positive numbers
20881                         move down and to the right</para>
20882                     </listitem>
20883                   <listitem>
20884                     <para>Example: the text is printed 0 .25" from the left edge of the first label,
20885                       0 .28" from the left edge of the second label and 0 .31" from the left edge of
20886                       the third label. This means the horizontal creep should be set to (minus)
20887                       -0.03 " to make up for this difference.</para>
20888                   </listitem>
20889                 </itemizedlist></para>
20890               </listitem>
20891             </itemizedlist>
20892
20893             <para>After saving, your profiles will appear on the 'Manage
20894             Profiles' page.</para>
20895
20896             <screenshot>
20897               <screeninfo>Manage Profiles</screeninfo>
20898
20899               <mediaobject>
20900                 <imageobject>
20901                   <imagedata fileref="images/tools/patroncards/manageprofiles.png"/>
20902                 </imageobject>
20903               </mediaobject>
20904             </screenshot>
20905
20906             <para>Once you have saved your new profile, you can return to the
20907             list of templates and choose to edit the template that this
20908             profile is for.</para>
20909           </section>
20910         </section>
20911
20912         <section id="patroncardbatches">
20913           <title>Batches</title>
20914
20915           <itemizedlist>
20916             <listitem>
20917               <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Patron Card Creator &gt;
20918                 Manage batches</para>
20919             </listitem>
20920           </itemizedlist>
20921
20922           <para>A batch is a collection of patrons for whom you want to
20923           generate cards.</para>
20924
20925           <section id="addcardbatch">
20926             <title>Add a Batch</title>
20927
20928             <para>To add a new batch, you want to click on the 'New batches' button at the top of
20929               your page. Choosing the menu item 'Manage batches' on the left a list of already
20930               defined batches is displayed. In this display you can either select a batch for
20931               editing or add a new batch.</para>
20932
20933             <screenshot>
20934               <screeninfo>New Batch Button</screeninfo>
20935
20936               <mediaobject>
20937                 <imageobject>
20938                   <imagedata fileref="images/tools/patroncards/newbuttons.png"/>
20939                 </imageobject>
20940               </mediaobject>
20941             </screenshot>
20942             <para> For a new batch a message pops up and directs you to select patrons to be
20943               processed in this batch.<screenshot>
20944                 <screeninfo>No items in batch</screeninfo>
20945                 <mediaobject>
20946                   <imageobject>
20947                     <imagedata fileref="images/tools/patroncards/noitemsbatch.png"/>
20948                   </imageobject>
20949                 </mediaobject>
20950               </screenshot></para>
20951
20952             <para>After choosing the 'Add item(s)' button the Patron Search window pops up.<screenshot>
20953                 <screeninfo>Patron search</screeninfo>
20954                 <mediaobject>
20955                   <imageobject>
20956                     <imagedata fileref="images/tools/patroncards/patronsearch.png"/>
20957                   </imageobject>
20958                 </mediaobject>
20959               </screenshot></para>
20960             <para>From here you can search for patrons to add to your batch by any part of their
20961               name, their category and/or library. Entering * in the search box will display all the
20962               patrons. <screenshot>
20963                 <screeninfo>Patron search results</screeninfo>
20964                 <mediaobject>
20965                   <imageobject>
20966                     <imagedata fileref="images/tools/patroncards/addpatrons.png"/>
20967                   </imageobject>
20968                 </mediaobject>
20969               </screenshot></para>
20970             <para>From the results you can add patrons to the batch by clicking the 'Add' button.
20971               After adding patrons from the results you can start over and perform another search or
20972               click 'Close' at the bottom of the screen to indicate that you are done. You will then
20973               be presented with your batch.<screenshot>
20974                 <screeninfo>Patron batch</screeninfo>
20975                 <mediaobject>
20976                   <imageobject>
20977                     <imagedata fileref="images/tools/patroncards/batchsummary.png"/>
20978                   </imageobject>
20979                 </mediaobject>
20980               </screenshot></para>
20981             <para>If you are satisfied with your batch you can proceed to export. If you want to
20982               correct or even delete that batch the buttons to do so can be found at the top of your
20983               screen. You can always come back here through the 'Manage batches' menu item. </para>
20984             <para>If you would like to export all patron cards you can click 'Export batch'
20985               otherwise you can choose specific patrons to print cards for by checking the box to
20986               the right of their names and then choose 'Export item(s)' at the top. </para>
20987             <para>The export menu will ask you to choose a template, a layout and starting position
20988               (where on the sheet should printing begin).<note>
20989                 <para>For the starting position if the first 6 labels have already been used on your
20990                   sheet you can start printing on label in position 7 on the sheet. The labels are
20991                   numbered left to right from top to bottom.</para>
20992               </note><screenshot>
20993                 <screeninfo>Export batch</screeninfo>
20994                 <mediaobject>
20995                   <imageobject>
20996                     <imagedata fileref="images/tools/patroncards/export.png"/>
20997                   </imageobject>
20998                 </mediaobject>
20999               </screenshot></para>
21000             <para>Once you click 'Export' you will be presented with a PDF of your labels for printing<screenshot>
21001                 <screeninfo>PDF Export</screeninfo>
21002                 <mediaobject>
21003                   <imageobject>
21004                     <imagedata fileref="images/tools/patroncards/pdf.png"/>
21005                   </imageobject>
21006                 </mediaobject>
21007               </screenshot></para>
21008             <para>When you open the PDF you will see the cards for printing</para>
21009             <screenshot>
21010               <screeninfo>Final cards</screeninfo>
21011               <mediaobject>
21012                 <imageobject>
21013                   <imagedata fileref="images/tools/patroncards/cards.png"/>
21014                 </imageobject>
21015               </mediaobject>
21016             </screenshot>
21017             <para>The above image shows a layout that is made up of two textlines. The first one is
21018               just plain text, the second one is composed of the &lt;firstname> &lt;surname> fields.
21019               A patron image is printed (if available) and the barcode of patrons number is
21020               displayed in code 39. All this is printed on a template with three columns and 8 rows
21021               using position 1-3 here. When printing this PDF please take care that your printer
21022               doesn't rescale the PDF (e.g do not fit to paper size) otherwise the printer will not
21023               be able to print to the right place per your templates.</para>
21024           </section>
21025         </section>
21026
21027         <section id="managecardimages">
21028           <title>Manage Images</title>
21029
21030           <itemizedlist>
21031             <listitem>
21032               <para><emphasis>Get there:</emphasis> More &gt; Tools &gt;
21033               Patron Card Creator &gt; Manage Images</para>
21034             </listitem>
21035           </itemizedlist>
21036
21037           <para>Images uploaded using this tool will appear on the menu when
21038           creating <link linkend="cardlayouts">patron card layouts</link>. You
21039           are limited in how many images you can upload (not counting patron
21040           images) by the <link linkend="ImageLimit">ImageLimit</link> system
21041           preference.</para>
21042
21043           <important>
21044             <para>Images must be under 500k in size.</para>
21045           </important>
21046
21047           <note>
21048             <para>Pictures uploaded with this tool should be at least 300dpi
21049             which is the minimum quality for a printable image.</para>
21050           </note>
21051
21052           <para>In the center of the screen is a simple upload form, simply
21053           browse for the file on your computer and give it a name you'll
21054           recognize later.</para>
21055
21056           <screenshot>
21057             <screeninfo>Upload Images</screeninfo>
21058
21059             <mediaobject>
21060               <imageobject>
21061                 <imagedata fileref="images/tools/patroncards/imageupload.png"/>
21062               </imageobject>
21063             </mediaobject>
21064           </screenshot>
21065
21066           <para>Once the file is uploaded you will be presented with a
21067           confirmation message.</para>
21068
21069           <screenshot>
21070             <screeninfo>Image Uploaded</screeninfo>
21071
21072             <mediaobject>
21073               <imageobject>
21074                 <imagedata fileref="images/tools/patroncards/imageuploaded.png"/>
21075               </imageobject>
21076             </mediaobject>
21077           </screenshot>
21078
21079           <para>And the image will be listed with all of your others on the
21080           right hand side of the page.</para>
21081
21082           <screenshot>
21083             <screeninfo>Images</screeninfo>
21084
21085             <mediaobject>
21086               <imageobject>
21087                 <imagedata fileref="images/tools/patroncards/imagedelete.png"/>
21088               </imageobject>
21089             </mediaobject>
21090           </screenshot>
21091
21092           <para>To delete one or multiple of these images, click the checkbox
21093           to the right of each image you want to delete and click the 'Delete'
21094           button.</para>
21095         </section>
21096       </section>
21097
21098       <section id="anonpatrons">
21099         <title>Patrons (anonymize, bulk-delete)</title>
21100
21101         <itemizedlist>
21102           <listitem>
21103             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Patrons
21104             and Circulation &gt; Patrons (anonymize, bulk-delete)</para>
21105           </listitem>
21106         </itemizedlist>
21107         <para>This tool allows you to bulk anonymize circulation histories (this means that you keep
21108           records of how many times items were checked out - but not the patrons who checked the
21109           items out) or bulk delete patrons (remove them from the system completely).<important>
21110             <para>Patrons with outstanding fines or items checked out are not saved. They are not
21111               completely removed from the system (they are only moved to the delete_borrowers
21112               table), but this tool does not provide as many checks as one may desire.</para>
21113           </important></para>
21114         <important>
21115           <para>Before using this tool it is recommended that you backup your database. Changes made
21116             here are permanent.</para>
21117         </important>
21118         <important>
21119           <para>The anonymization will fail quietly if <link linkend="AnonymousPatron">AnonymousPatron</link> preference does not contain a valid value.</para>
21120         </important>
21121
21122         <screenshot>
21123           <screeninfo>Patron Anonymize/Bulk Delete Tool</screeninfo>
21124
21125           <mediaobject>
21126             <imageobject>
21127               <imagedata fileref="images/tools/anonymize/patronbulkdelete.png"/>
21128             </imageobject>
21129           </mediaobject>
21130         </screenshot>
21131
21132         <para>To either delete or anonymize patrons</para>
21133
21134         <itemizedlist>
21135           <listitem>
21136             <para>Check the 'Verify' box on the task you would like to complete (Delete or
21137               Anonymize)</para>
21138           </listitem>
21139
21140           <listitem>
21141             <para>Enter a date before which you want to alter the data</para>
21142           </listitem>
21143           <listitem>
21144             <para>If deleting patrons you can also choose to find patrons with a specific expiration
21145               date or category</para>
21146           </listitem>
21147
21148           <listitem>
21149             <para>Click 'Next'</para>
21150           </listitem>
21151
21152           <listitem>
21153             <para>A confirmation will appear asking if you're sure this is
21154             what you want to happen</para>
21155
21156             <screenshot>
21157               <screeninfo>Patron Anonymize/Bulk Delete
21158               Confirmation</screeninfo>
21159
21160               <mediaobject>
21161                 <imageobject>
21162                   <imagedata fileref="images/tools/anonymize/patronanonconfirm.png"/>
21163                 </imageobject>
21164               </mediaobject>
21165             </screenshot>
21166           </listitem>
21167
21168           <listitem>
21169             <para>Clicking 'Finish' will delete or anonymize your data</para>
21170
21171             <screenshot>
21172               <screeninfo>Completed Process</screeninfo>
21173
21174               <mediaobject>
21175                 <imageobject>
21176                   <imagedata fileref="images/tools/anonymize/patronanoncomplete.png"/>
21177                 </imageobject>
21178               </mediaobject>
21179             </screenshot>
21180           </listitem>
21181         </itemizedlist>
21182       </section>
21183
21184       <section id="batchpatronmod">
21185         <title>Batch patron modification</title>
21186
21187         <itemizedlist>
21188           <listitem>
21189             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Patrons
21190             and Circulation &gt; Batch patron modification</para>
21191           </listitem>
21192         </itemizedlist>
21193
21194         <para>With this tool you can make edits to a batch of patron records. Simply load in a file
21195           of cardnumbers (one per line), choose from a <link linkend="patronlists">list of
21196             patrons</link> or scan patron card numbers in to the box provided.</para>
21197
21198         <screenshot>
21199           <screeninfo>Batch patron modification</screeninfo>
21200
21201           <mediaobject>
21202             <imageobject>
21203               <imagedata fileref="images/tools/batchpatron/batchmodify.png"/>
21204             </imageobject>
21205           </mediaobject>
21206         </screenshot>
21207
21208         <para>Once you have the file loaded or the barcodes scanned click
21209         'Continue.' You will be presented with a list of the patrons and the
21210         changes you can make.</para>
21211
21212         <screenshot>
21213           <screeninfo>Patrons to modify</screeninfo>
21214
21215           <mediaobject>
21216             <imageobject>
21217               <imagedata fileref="images/tools/batchpatron/modifyform.png"/>
21218             </imageobject>
21219           </mediaobject>
21220         </screenshot>
21221
21222         <para>To the left of each text box there is a checkbox. Clicking that
21223         checkbox will clear our the field values. <important>
21224             <para>If the field is mandatory you will not be able to clear the
21225             value in it.</para>
21226           </important></para>
21227
21228         <para>If you have multiple patron attributes you can change them all
21229         by using the plus (+) sign to the right of the text box. This will
21230         allow you to add another attribute value.</para>
21231
21232         <screenshot>
21233           <screeninfo>Editing patron attributes</screeninfo>
21234
21235           <mediaobject>
21236             <imageobject>
21237               <imagedata fileref="images/tools/batchpatron/attributes.png"/>
21238             </imageobject>
21239           </mediaobject>
21240         </screenshot>
21241
21242         <para>Once you have made the changes you want, you can click 'Save'
21243         and Koha will present you with the changed patron records.</para>
21244       </section>
21245
21246       <section id="tagsmoderation">
21247         <title>Tag Moderation</title>
21248
21249         <itemizedlist>
21250           <listitem>
21251             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Patrons
21252             and Circulation &gt; Tags</para>
21253           </listitem>
21254         </itemizedlist>
21255
21256         <para>Depending on your <link linkend="taggingprefs">tagging system preferences</link>,
21257           librarians may need to approve tags before they are published on the OPAC. This is done
21258           via the Tag Moderation Tool. If there are tags awaiting moderation they will be listed on
21259           the main staff dashboard under the module labels:</para>
21260
21261         <screenshot>
21262           <screeninfo>Tags pending approval</screeninfo>
21263
21264           <mediaobject>
21265             <imageobject>
21266               <imagedata fileref="images/tools/tagging/pendingtags.png"/>
21267             </imageobject>
21268           </mediaobject>
21269         </screenshot>
21270
21271         <para>To moderate the tags visit the Tags tool. When first visiting
21272         the tool, you will be presented with a list of tags that are pending
21273         approval or rejection by a librarian</para>
21274
21275         <screenshot>
21276           <screeninfo>Tags pending moderation</screeninfo>
21277
21278           <mediaobject>
21279             <imageobject>
21280               <imagedata fileref="images/tools/tagging/tagpending.png"/>
21281             </imageobject>
21282           </mediaobject>
21283         </screenshot>
21284
21285         <itemizedlist>
21286           <listitem>
21287             <para>To see all of the titles this tag was added to simply click on the term<screenshot>
21288                 <screeninfo>Titles with a specific tag</screeninfo>
21289                 <mediaobject>
21290                   <imageobject>
21291                     <imagedata fileref="images/tools/tagging/taggedtitles.png"/>
21292                   </imageobject>
21293                 </mediaobject>
21294               </screenshot><itemizedlist>
21295                 <listitem>
21296                   <para>From this list of titles you can remove a tag without outright rejecting it
21297                     from being used in the future by clicking the 'Remove tag' button to the right
21298                     of the title.</para>
21299                 </listitem>
21300               </itemizedlist></para>
21301           </listitem>
21302           <listitem>
21303             <para>To approve a tag, you can either click the 'Approve' button in line with the term,
21304               or check all terms you want to approve and click 'Approve' below the table.</para>
21305           </listitem>
21306
21307           <listitem>
21308             <para>To reject a tag, you can either click the 'Reject' button in
21309             line with the term, or check all terms you want to approve and
21310             click 'Reject' below the table.</para>
21311           </listitem>
21312         </itemizedlist>
21313
21314         <para>Once a tag has been approved or rejected it will be moved to the
21315         appropriate list of tags. A summary of all tags will appear on the
21316         right of the screen.</para>
21317
21318         <screenshot>
21319           <screeninfo>Summary of tags</screeninfo>
21320
21321           <mediaobject>
21322             <imageobject>
21323               <imagedata fileref="images/tools/tagging/tagsummary.png"/>
21324             </imageobject>
21325           </mediaobject>
21326         </screenshot>
21327
21328         <para>Even though a tag is approved or rejected, it can still be moved
21329         to another list. When viewing approved tags each tag has the option to
21330         reject:</para>
21331
21332         <screenshot>
21333           <screeninfo>Approved Tags</screeninfo>
21334
21335           <mediaobject>
21336             <imageobject>
21337               <imagedata fileref="images/tools/tagging/tagapproved.png"/>
21338             </imageobject>
21339           </mediaobject>
21340         </screenshot>
21341
21342         <para>To check terms against the approved and rejected lists (and
21343         possibly against <link linkend="TagsExternalDictionary">the
21344         dictionary</link> you have assigned for tag moderation) simply enter
21345         the term into the search box on the bottom right of the screen to see
21346         the status of the term</para>
21347
21348         <screenshot>
21349           <screeninfo>Sample Check list test search</screeninfo>
21350
21351           <mediaobject>
21352             <imageobject>
21353               <imagedata fileref="images/tools/tagging/tagblacklisttest-neither.png"/>
21354             </imageobject>
21355           </mediaobject>
21356         </screenshot>
21357         <para>Finally you can find tags by using the filters on the left.</para>
21358         <screenshot>
21359           <screeninfo>Tag filters</screeninfo>
21360           <mediaobject>
21361             <imageobject>
21362               <imagedata fileref="images/tools/tagging/tagfilters.png"/>
21363             </imageobject>
21364           </mediaobject>
21365         </screenshot>
21366       </section>
21367
21368       <section id="uploadpatronimages">
21369         <title>Upload Patron Images</title>
21370
21371         <itemizedlist>
21372           <listitem>
21373             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Patrons
21374             and Circulation &gt; Upload Patron Images</para>
21375           </listitem>
21376         </itemizedlist>
21377
21378         <para>Patron images can be uploaded in bulk if you are <link linkend="patronimages">allowing patron images</link> to be attached to
21379         patron records. These images can also be used when creating <link linkend="patroncardcreator">patron cards</link>.</para>
21380
21381         <itemizedlist>
21382           <listitem>
21383             <para>Create a txt file and title it "DATALINK.TXT" or
21384             "IDLINK.TXT"</para>
21385           </listitem>
21386
21387           <listitem>
21388             <para>On each line in the text file enter the patron's card number
21389             followed by comma (or tab) and then the image file name</para>
21390
21391             <screenshot>
21392               <screeninfo>Sample file and image</screeninfo>
21393
21394               <mediaobject>
21395                 <imageobject>
21396                   <imagedata fileref="images/tools/patronphotos/uploadphotosfile.png"/>
21397                 </imageobject>
21398               </mediaobject>
21399             </screenshot>
21400
21401             <itemizedlist>
21402               <listitem>
21403                 <para>Make sure that your TXT file is a plain text document,
21404                 not RTF.</para>
21405               </listitem>
21406             </itemizedlist>
21407           </listitem>
21408
21409           <listitem>
21410             <para>Zip up the text file and the image files</para>
21411           </listitem>
21412
21413           <listitem>
21414             <para>Go to the Upload Patron Images Tool</para>
21415
21416             <screenshot>
21417               <screeninfo>Upload Image Tool for Single Image</screeninfo>
21418
21419               <mediaobject>
21420                 <imageobject>
21421                   <imagedata fileref="images/tools/patronphotos/uploadimagetool.png"/>
21422                 </imageobject>
21423               </mediaobject>
21424             </screenshot>
21425           </listitem>
21426
21427           <listitem>
21428             <para>For a single image, simply point to the image file and enter
21429             the patron card number</para>
21430           </listitem>
21431
21432           <listitem>
21433             <para>For multiple images, choose to upload a zip file</para>
21434           </listitem>
21435
21436           <listitem>
21437             <para>After uploading you will be presented with a
21438             confirmation</para>
21439
21440             <screenshot>
21441               <screeninfo>Image Upload Confirmation</screeninfo>
21442
21443               <mediaobject>
21444                 <imageobject>
21445                   <imagedata fileref="images/tools/patronphotos/imageuploadconfirm.png"/>
21446                 </imageobject>
21447               </mediaobject>
21448             </screenshot>
21449           </listitem>
21450         </itemizedlist>
21451
21452         <important>
21453           <para>There is a limit of 100K on the size of the picture uploaded and it is recommended
21454             that the image be 200x300 pixels, but smaller images will work as well.</para>
21455         </important>
21456       </section>
21457     </section>
21458
21459
21460
21461     <section id="catalogtools">
21462       <title>Catalog</title>
21463
21464       <para/>
21465
21466       <section id="batchmodifyitems">
21467         <title>Batch item modification</title>
21468
21469         <itemizedlist>
21470           <listitem>
21471             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Catalog
21472             &gt; Batch item modification</para>
21473           </listitem>
21474         </itemizedlist>
21475
21476         <para>This tool will allow you to modify a batch of item records in
21477         Koha.</para>
21478
21479         <screenshot>
21480           <screeninfo>Batch Modification Tool</screeninfo>
21481
21482           <mediaobject>
21483             <imageobject>
21484               <imagedata fileref="images/tools/batchmod/batchmod.png"/>
21485             </imageobject>
21486           </mediaobject>
21487         </screenshot>
21488
21489         <para>From the tool you can choose to upload a file of barcodes or item ids, or you can scan
21490           items one by one into the box below the upload tool. You can also decide the items edited
21491           should be populated with the default values you have defined in your <link
21492             linkend="marcbibframeworks">default framework</link>.</para>
21493         <para>Once you have your file uploaded or the barcodes listed you can click
21494           'Continue.'</para>
21495
21496         <screenshot>
21497           <screeninfo>Batch Modify Summary</screeninfo>
21498
21499           <mediaobject>
21500             <imageobject>
21501               <imagedata fileref="images/tools/batchmod/batchmodsummary.png"/>
21502             </imageobject>
21503           </mediaobject>
21504         </screenshot>
21505
21506         <para>You will be presented with a summary of the items you want to modify. From here you
21507           can uncheck the items you don't want to modify before making changes in the form below.
21508           You can also hide columns you don't need to see to prevent having to scroll from left to
21509           right to see the entire item form.<note>
21510             <para>To uncheck all items thar are currently checked out you can click the 'Clear on
21511               loan' link at the top of the form.</para>
21512           </note></para>
21513
21514         <para>Using the edit form you can choose which fields to make edits
21515         to. By checking the checkbox to the right of each field you can clear
21516         the values in that field for the records you are modifying.</para>
21517
21518         <screenshot>
21519           <screeninfo>Choose fields you want to change in bulk</screeninfo>
21520
21521           <mediaobject>
21522             <imageobject>
21523               <imagedata fileref="images/tools/batchmod/batchmodform.png"/>
21524             </imageobject>
21525           </mediaobject>
21526         </screenshot>
21527
21528         <para>Once you have made you changes you will be presented with the
21529         resulting items.</para>
21530
21531         <screenshot>
21532           <screeninfo>Item results summary</screeninfo>
21533
21534           <mediaobject>
21535             <imageobject>
21536               <imagedata fileref="images/tools/batchmod/batchmodresults.png"/>
21537             </imageobject>
21538           </mediaobject>
21539         </screenshot>
21540
21541         <note>
21542           <para>You can also edit items on one bib record in a batch by going
21543           to the bib record and clicking Edit &gt; Edit items in batch</para>
21544         </note>
21545
21546         <screenshot>
21547           <screeninfo>Edit items in a batch</screeninfo>
21548
21549           <mediaobject>
21550             <imageobject>
21551               <imagedata fileref="images/tools/batchmod/editinbatch.png"/>
21552             </imageobject>
21553           </mediaobject>
21554         </screenshot>
21555       </section>
21556
21557       <section id="batchdeleteitems">
21558         <title>Batch item deletion</title>
21559
21560         <itemizedlist>
21561           <listitem>
21562             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Catalog
21563             &gt; Batch item deletion</para>
21564           </listitem>
21565         </itemizedlist>
21566
21567         <para>This tool will allow you to delete a batch of item records from
21568         Koha.</para>
21569
21570         <para>From the tool you can choose to upload a file of barcodes or
21571         item ids, or you can scan items one by one into the box below the
21572         upload tool.</para>
21573
21574         <screenshot>
21575           <screeninfo>Batch Deletion Tool</screeninfo>
21576
21577           <mediaobject>
21578             <imageobject>
21579               <imagedata fileref="images/tools/batchdelete/batchdel.png"/>
21580             </imageobject>
21581           </mediaobject>
21582         </screenshot>
21583
21584         <para>Once you have your file uploaded or the barcodes scanned you can
21585         click 'Continue.'</para>
21586
21587         <para>You will be presented with a confirmation screen. From here you can uncheck the items
21588           you don't want to delete and decide if Koha should delete the bib record if the last item
21589           is being deleted before clicking 'Delete selected items.'  If you'd like you can delete
21590           the bibliogrphic record if you're deleting the last item by clicking the checkbox next to
21591           'Delete records if no items remain'.</para>
21592
21593         <screenshot>
21594           <screeninfo>Confirm Deletion</screeninfo>
21595
21596           <mediaobject>
21597             <imageobject>
21598               <imagedata fileref="images/tools/batchdelete/confirmbatchdel.png"/>
21599             </imageobject>
21600           </mediaobject>
21601         </screenshot>
21602
21603         <para>If your file (or list of scanned barcodes) has more than 1000
21604         barcodes, Koha will be unable to present you with a list of the items.
21605         You will still be able to delete them, but not able to choose which
21606         items specifically to delete or delete the biblio records.</para>
21607
21608         <screenshot>
21609           <screeninfo>More than 1000 records in the file</screeninfo>
21610
21611           <mediaobject>
21612             <imageobject>
21613               <imagedata fileref="images/tools/batchdelete/toomanytodelete.png"/>
21614             </imageobject>
21615           </mediaobject>
21616         </screenshot>
21617
21618         <para>If the items are checked out you will be presented with an error
21619         after clicking 'Delete selected items' and the items will not be
21620         deleted.</para>
21621
21622         <screenshot>
21623           <screeninfo>Items not Deleted</screeninfo>
21624
21625           <mediaobject>
21626             <imageobject>
21627               <imagedata fileref="images/tools/batchdelete/nobatchdel.png"/>
21628             </imageobject>
21629           </mediaobject>
21630         </screenshot>
21631
21632         <para>If the items can be deleted they will be and you will be
21633         presented with a confirmation of your deletion.</para>
21634
21635         <screenshot>
21636           <screeninfo>Batch Deletion Confirmation</screeninfo>
21637
21638           <mediaobject>
21639             <imageobject>
21640               <imagedata fileref="images/tools/batchdelete/batchdeldone.png"/>
21641             </imageobject>
21642           </mediaobject>
21643         </screenshot>
21644       </section>
21645       <section id="batchrecorddelete">
21646         <title>Batch record deletion</title>
21647         <para>This tool will take a batch of record numbers for either bibliographic records or
21648           authority records and allow you to delete all those records and any items attached to them
21649           in a batch.  <screenshot>
21650             <screeninfo>Batch record deletion</screeninfo>
21651             <mediaobject>
21652               <imageobject>
21653                 <imagedata fileref="images/tools/batchrecorddel/tool.png"/>
21654               </imageobject>
21655             </mediaobject>
21656           </screenshot></para>
21657         <para>First you need to tell the tool if you're deleting bibliographic or authority records.
21658           Next you can load a file with biblionumbers or authids or enter a list of those numbers in
21659           the box provided.  Once you submit the form you will be presented with a summary of the
21660           records you are trying to delete.<screenshot>
21661             <screeninfo>Summary</screeninfo>
21662             <mediaobject>
21663               <imageobject>
21664                 <imagedata fileref="images/tools/batchrecorddel/summary.png"/>
21665               </imageobject>
21666             </mediaobject>
21667           </screenshot></para>
21668         <para>If a record you want to delete can't be deleted it will be highlighted.  </para>
21669         <para>Check the records you want to delete and click the 'Delete selected records' button to
21670           finish the process.</para>
21671       </section>
21672       <section id="batchrecordmod">
21673         <title>Batch Record Modification</title>
21674         <itemizedlist>
21675           <listitem>
21676             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Catalog &gt; Batch record
21677               modification</para>
21678           </listitem>
21679         </itemizedlist>
21680         <para>This tool will allow you to edit batches of bibliographic and/or authority records
21681           using <link linkend="marcmodtemplates">MARC Modification Templates</link>. Before visiting
21682           this tool you will want to set up at least one MARC modification template.</para>
21683         <screenshot>
21684           <screeninfo>Batch record modification</screeninfo>
21685           <mediaobject>
21686             <imageobject>
21687               <imagedata fileref="images/tools/batchbibmod/batchbibmod.png"/>
21688             </imageobject>
21689           </mediaobject>
21690         </screenshot>
21691         <para>When you visit the tool it will ask you:</para>
21692         <itemizedlist>
21693           <listitem>
21694             <para>Choose whether you're editing bibliographic or authority records</para>
21695           </listitem>
21696           <listitem>
21697             <para>Enter the biblionumbers or authids<itemizedlist>
21698                 <listitem>
21699                   <para>You can upload a file of these numbers or</para>
21700                 </listitem>
21701                 <listitem>
21702                   <para>Enter the numbers (one per line) in the box provided</para>
21703                 </listitem>
21704               </itemizedlist></para>
21705           </listitem>
21706           <listitem>
21707             <para>Finally choose the MARC Modification Template you'd like to use to edit these
21708               records.</para>
21709           </listitem>
21710         </itemizedlist>
21711         <para>Once you've entered your critera click 'Continue'<screenshot>
21712             <screeninfo>Records to edit</screeninfo>
21713             <mediaobject>
21714               <imageobject>
21715                 <imagedata fileref="images/tools/batchbibmod/recordstoedit.png"/>
21716               </imageobject>
21717             </mediaobject>
21718           </screenshot></para>
21719         <para>You will be presented with a list of records that will be edited. Next to each one is
21720           a checkbox so you can uncheck any items you would rather not edit at this time. </para>
21721         <para>Clicking Preview MARC will allow you to see what edits will be made when you finalize
21722           the edit.<screenshot>
21723             <screeninfo>Modified MARC Preview</screeninfo>
21724             <mediaobject>
21725               <imageobject>
21726                 <imagedata fileref="images/tools/batchbibmod/marcpreview.png"/>
21727               </imageobject>
21728             </mediaobject>
21729           </screenshot></para>
21730         <para>Once you're sure everything is the way you want you can click the 'Modify selected
21731           records' button and your records will be modified.</para>
21732       </section>
21733
21734       <section id="exportbibs">
21735         <title>Export Data (MARC &amp; Authorities)</title>
21736
21737         <itemizedlist>
21738           <listitem>
21739             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Catalog
21740             &gt; Export Data</para>
21741           </listitem>
21742         </itemizedlist>
21743
21744         <para>Koha comes with a tool that will allow you to export your
21745         bibliographic, holdings and/or authority data in bulk. This can be
21746         used to send your records to fellow libraries, organizations or
21747         services; or simply for backup purposes.</para>
21748
21749         <section id="exportmarc">
21750           <title>Export Bibliographic Records</title>
21751
21752           <para>At the top of the screen you need to pick what data you're
21753           exporting. If you're exporting bibliographic records with or without
21754           the holdings information you want to click the 'Export bibliographic
21755           records' tab.</para>
21756
21757           <itemizedlist>
21758             <listitem>
21759               <para>Fill in the form in order to limit your export to a
21760               specific range (all fields are optional)</para>
21761
21762               <screenshot>
21763                 <screeninfo>Select Records to Export</screeninfo>
21764
21765                 <mediaobject>
21766                   <imageobject>
21767                     <imagedata fileref="images/tools/exportmarc/marcexport-pt1.png"/>
21768                   </imageobject>
21769                 </mediaobject>
21770               </screenshot>
21771
21772               <itemizedlist>
21773                 <listitem>
21774                   <para>Choose to limit your export by any one or more of the
21775                   following options</para>
21776
21777                   <itemizedlist>
21778                     <listitem>
21779                       <para>Limit to a bib number range</para>
21780                     </listitem>
21781
21782                     <listitem>
21783                       <para>Limit to a specific item type<itemizedlist>
21784                           <listitem>
21785                             <important>
21786                               <para>This limit will use the type you have defined in the <link
21787                                   linkend="item-level_itypes">item-level_itypes</link> preference.
21788                                 If you have the item-level_itypes preference set to 'specific item'
21789                                 and you have no items attached to a bib record it will not be
21790                                 exported.  To get all bib records of a specific type you will need
21791                                 your item-level_itypes preference set to 'biblio record'.</para>
21792                             </important>
21793                           </listitem>
21794                         </itemizedlist></para>
21795                     </listitem>
21796
21797                     <listitem>
21798                       <para>Limit to a specific library or group of libraries</para>
21799                     </listitem>
21800
21801                     <listitem>
21802                       <para>Limit to a call number range</para>
21803                     </listitem>
21804
21805                     <listitem>
21806                       <para>Limit to an acquisition date range</para>
21807                     </listitem>
21808                   </itemizedlist>
21809                 </listitem>
21810
21811                 <listitem>
21812                   <para>If you'd like you can load a file of biblionumbers for the records you would
21813                     like to export</para>
21814                   <screenshot>
21815                     <screeninfo>File of Records to Export</screeninfo>
21816                     <mediaobject>
21817                       <imageobject>
21818                         <imagedata fileref="images/tools/exportmarc/fileexport.png"/>
21819                       </imageobject>
21820                     </mediaobject>
21821                   </screenshot>
21822                 </listitem>
21823                 <listitem>
21824                   <para>Next choose what to skip when exporting</para>
21825                   <screenshot>
21826                     <screeninfo>Export options</screeninfo>
21827                     <mediaobject>
21828                       <imageobject>
21829                         <imagedata fileref="images/tools/exportmarc/marcexport-pt2.png"/>
21830                       </imageobject>
21831                     </mediaobject>
21832                   </screenshot>
21833                   <itemizedlist>
21834                     <listitem>
21835                       <para>By default items will be exported, if you would like to only export
21836                         bibliographic data, check the 'Don't export items' box</para>
21837                     </listitem>
21838                     <listitem>
21839                       <para>To limit your export only to items from the library you're logged in as
21840                         (if you leave the 'Library' field set to 'All') or to the library you
21841                         selected above check the 'Remove non-local items' box</para>
21842                     </listitem>
21843                     <listitem>
21844                       <para>You can also choose what fields you don't want to export. This can be
21845                         handy if you're sharing your data, you can remove all local fields before
21846                         sending your data to another library</para>
21847                     </listitem>
21848                   </itemizedlist>
21849                 </listitem>
21850
21851                 <listitem>
21852                   <para>Finally choose the file type and file name</para>
21853
21854                   <screenshot>
21855                     <screeninfo>File export format</screeninfo>
21856
21857                     <mediaobject>
21858                       <imageobject>
21859                         <imagedata fileref="images/tools/exportmarc/marcexport-pt3.png"/>
21860                       </imageobject>
21861                     </mediaobject>
21862                   </screenshot>
21863
21864                   <itemizedlist>
21865                     <listitem>
21866                       <para>Choose to export your data in marc or marcxml
21867                       format</para>
21868                     </listitem>
21869
21870                     <listitem>
21871                       <para>Choose the name you want your file to save
21872                       as</para>
21873                     </listitem>
21874                   </itemizedlist>
21875                 </listitem>
21876
21877                 <listitem>
21878                   <para>Click 'Export bibliographic records'</para>
21879                 </listitem>
21880               </itemizedlist>
21881             </listitem>
21882           </itemizedlist>
21883         </section>
21884
21885         <section id="exportauthority">
21886           <title>Export Authority Records</title>
21887
21888           <para>At the top of the screen you need to pick what data you're
21889           exporting. If you're exporting authority records you want to click
21890           the 'Export authority records' tab.</para>
21891
21892           <itemizedlist>
21893             <listitem>
21894               <para>Fill in the form in order to limit your export to a
21895               specific range or type of authority record (all fields are
21896               optional)</para>
21897
21898               <screenshot>
21899                 <screeninfo>Export authorities</screeninfo>
21900
21901                 <mediaobject>
21902                   <imageobject>
21903                     <imagedata fileref="images/tools/exportmarc/authexport-pt1.png"/>
21904                   </imageobject>
21905                 </mediaobject>
21906               </screenshot>
21907             </listitem>
21908
21909             <listitem>
21910               <para>Or you can choose a file of authids to export<screenshot>
21911                   <screeninfo>Authorities file</screeninfo>
21912                   <mediaobject>
21913                     <imageobject>
21914                       <imagedata fileref="images/tools/exportmarc/authexport-pt1-5.png"/>
21915                     </imageobject>
21916                   </mediaobject>
21917                 </screenshot></para>
21918             </listitem>
21919             <listitem>
21920               <para>Next choose fields that you would like to exclude from the export separated by a
21921                 space (no commas)</para>
21922               <screenshot>
21923                 <screeninfo>Authority export options</screeninfo>
21924                 <mediaobject>
21925                   <imageobject>
21926                     <imagedata fileref="images/tools/exportmarc/authexport-pt2.png"/>
21927                   </imageobject>
21928                 </mediaobject>
21929               </screenshot>
21930               <itemizedlist>
21931                 <listitem>
21932                   <para>If you'd like to exclude all subfields of the 200 for example just enter
21933                     200</para>
21934                 </listitem>
21935                 <listitem>
21936                   <para>If you'd like to exclude a specific subfield enter it beside the field value
21937                     100a will exclude just the subfield 'a' of the 100</para>
21938                 </listitem>
21939               </itemizedlist>
21940             </listitem>
21941
21942             <listitem>
21943               <para>Finally choose the file type and file name</para>
21944
21945               <screenshot>
21946                 <screeninfo>Export format</screeninfo>
21947
21948                 <mediaobject>
21949                   <imageobject>
21950                     <imagedata fileref="images/tools/exportmarc/authexport-pt3.png"/>
21951                   </imageobject>
21952                 </mediaobject>
21953               </screenshot>
21954
21955               <itemizedlist>
21956                 <listitem>
21957                   <para>Choose to export your data in marc or marcxml
21958                   format</para>
21959                 </listitem>
21960
21961                 <listitem>
21962                   <para>Choose the name you want your file to save as</para>
21963                 </listitem>
21964               </itemizedlist>
21965             </listitem>
21966
21967             <listitem>
21968               <para>Click 'Export authority records'</para>
21969             </listitem>
21970           </itemizedlist>
21971         </section>
21972       </section>
21973
21974       <section id="inventory">
21975         <title>Inventory/Stocktaking</title>
21976
21977         <itemizedlist>
21978           <listitem>
21979             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Catalog
21980             &gt; Inventory/Stocktaking</para>
21981           </listitem>
21982         </itemizedlist>
21983
21984         <para>Koha's Inventory Tool can be used in one of two ways, the first
21985         is by printing out a shelf list that you can then mark items off on,
21986         or by uploading a text files of barcodes gathered by a portable
21987         scanner.</para>
21988
21989         <para>If you do not have the ability to use your barcode scanner on
21990         the floor of the library, the first option available to you is to
21991         generate a shelf list based on criteria you enter.</para>
21992
21993         <screenshot>
21994           <screeninfo>Inventory &amp; Stocktaking Tool</screeninfo>
21995
21996           <mediaobject>
21997             <imageobject>
21998               <imagedata fileref="images/tools/inventory/generateshelflist.png"/>
21999             </imageobject>
22000           </mediaobject>
22001         </screenshot>
22002
22003         <para>Choose which library, shelving location, call number range, item
22004         status and when the item was last seen to generate a shelf list that
22005         you can then print to use while walking around the library checking
22006         your collection</para>
22007
22008         <screenshot>
22009           <screeninfo>Shelf List</screeninfo>
22010
22011           <mediaobject>
22012             <imageobject>
22013               <imagedata fileref="images/tools/inventory/shelflist.png"/>
22014             </imageobject>
22015           </mediaobject>
22016         </screenshot>
22017
22018         <para>Alternatively you can export the list to a CSV file for altering
22019         in an application on your desktop. Simply check the box next to
22020         'Export to csv file' to generate this file.</para>
22021
22022         <para>Once you have found the items on your shelves you can return to
22023         this list and check off the items you found to have the system update
22024         the last seen date to today.</para>
22025
22026         <para>If you have a portable scanner (or a laptop and USB scanner) you
22027         can walk through the library with the scanner in hand and scan
22028         barcodes as you come across them. Once finished you can then upload
22029         the text file generated by the scanner to Koha</para>
22030
22031         <screenshot>
22032           <screeninfo>Barcode Import for Inventory Tool</screeninfo>
22033
22034           <mediaobject>
22035             <imageobject>
22036               <imagedata fileref="images/tools/inventory/importbarcodes.png"/>
22037             </imageobject>
22038           </mediaobject>
22039         </screenshot>
22040
22041         <para>Choose the text file and the date you want to mark all items as seen and then scroll
22042           to the very bottom and click 'Submit.'</para>
22043       </section>
22044
22045       <section id="labelcreator">
22046         <title>Label Creator</title>
22047
22048         <itemizedlist>
22049           <listitem>
22050             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Catalog
22051             &gt; Label Creator</para>
22052           </listitem>
22053         </itemizedlist>
22054
22055         <para>The Label Creator allow you to use layouts and templates which
22056         you design to print a nearly unlimited variety of labels including
22057         barcodes. Here are some of the features of the Label Creator
22058         module:</para>
22059
22060         <itemizedlist>
22061           <listitem>
22062             <para>Customize label layouts</para>
22063           </listitem>
22064
22065           <listitem>
22066             <para>Design custom label templates for printed labels</para>
22067           </listitem>
22068
22069           <listitem>
22070             <para>Build and manage batches of labels</para>
22071           </listitem>
22072
22073           <listitem>
22074             <para>Export single or multiple batches</para>
22075           </listitem>
22076
22077           <listitem>
22078             <para>Export single or multiple labels from within a batch</para>
22079           </listitem>
22080
22081           <listitem>
22082             <para>Export label data in one of three formats:</para>
22083
22084             <itemizedlist>
22085               <listitem>
22086                 <para>PDF - Readable by any standard PDF reader, making labels
22087                 printable directly on a printer</para>
22088               </listitem>
22089
22090               <listitem>
22091                 <para>CSV - Export label data after your chosen layout is
22092                 applied allowing labels to be imported in to a variety of
22093                 applications</para>
22094               </listitem>
22095
22096               <listitem>
22097                 <para>XML - Included as an alternate export format</para>
22098               </listitem>
22099             </itemizedlist>
22100           </listitem>
22101         </itemizedlist>
22102
22103         <para>At the top of each screen within the Label Creator, you will see
22104         a toolbar allowing quick access to relevant functions. The menu to the
22105         left of each screen also allows easy access to the different sections
22106         of the Label Creator. The bread crumb trail near the top of each
22107         screen will give specific indication as to where you are within the
22108         Label Creator module and allow quick navigation to previously
22109         traversed sections. And finally, you can find more detailed
22110         information on each section of the Label Creator by clicking the
22111         online help link at the upper left-hand corner of every page.</para>
22112
22113         <section id="labeltemplates">
22114           <title>Templates</title>
22115
22116           <itemizedlist>
22117             <listitem>
22118               <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Label
22119               Creator &gt; Templates</para>
22120             </listitem>
22121           </itemizedlist>
22122
22123           <para>A template is based on the label/card stock you are using.
22124           This might be Avery 5160 for address labels, Gaylord 47-284 for
22125           spine labels or Avery 28371 for your patron cards, just to give a
22126           couple of examples. These labels will include all of the information
22127           you will need for setting up a Koha, this information may be on the
22128           packaging, and if not it can usually be found on the vendor's
22129           website.</para>
22130
22131           <section id="addlabeltemplate">
22132             <title>Add a Template</title>
22133
22134             <para>To add a new template, you want to click on the 'New template' button at the top
22135               of the Label Creator.</para>
22136
22137             <screenshot>
22138               <screeninfo>New Label Template Option</screeninfo>
22139
22140               <mediaobject>
22141                 <imageobject>
22142                   <imagedata fileref="images/tools/labelcreator/newtemplate.png"/>
22143                 </imageobject>
22144               </mediaobject>
22145             </screenshot>
22146
22147             <para>Using the form that appears you can define the template for
22148             your sheet of labels or cards.</para>
22149
22150             <screenshot>
22151               <screeninfo>Label Template Form</screeninfo>
22152
22153               <mediaobject>
22154                 <imageobject>
22155                   <imagedata fileref="images/tools/labelcreator/labelform.png"/>
22156                 </imageobject>
22157               </mediaobject>
22158             </screenshot>
22159
22160             <itemizedlist>
22161               <listitem>
22162                 <para>Template ID will be automatically generated after saving
22163                 your template, this is simply a system generated unique
22164                 id</para>
22165               </listitem>
22166
22167               <listitem>
22168                 <para>Template Code should be something you can use to
22169                 identify your template on a list of templates</para>
22170               </listitem>
22171
22172               <listitem>
22173                 <para>You can use the Template Description to add additional
22174                 information about the template</para>
22175               </listitem>
22176
22177               <listitem>
22178                 <para>The Units pull down is used to define what measurement
22179                 scale you're going to be using for the template. This should
22180                 probably match the unit of measurement used on the template
22181                 description provided by the product vendor.</para>
22182
22183                 <screenshot>
22184                   <screeninfo>Measurement Units</screeninfo>
22185
22186                   <mediaobject>
22187                     <imageobject>
22188                       <imagedata fileref="images/tools/patroncards/units.png"/>
22189                     </imageobject>
22190                   </mediaobject>
22191                 </screenshot>
22192               </listitem>
22193
22194               <listitem>
22195                 <para>The measurements, number of columns and number of rows
22196                 can be found on the vendor product packaging or
22197                 website.</para>
22198
22199                 <itemizedlist>
22200                   <listitem>
22201                     <important>
22202                       <para>If you do not supply a left text margin in the
22203                       template, a 3/16" (13.5 point) left text margin will
22204                       apply by default.</para>
22205                     </important>
22206                   </listitem>
22207                 </itemizedlist>
22208               </listitem>
22209
22210               <listitem>
22211                 <para>A profile is a set of "adjustments" applied to a given
22212                 template just prior to printing which compensates for
22213                 anomalies unique and peculiar to a given printer (to which the
22214                 profile is assigned).</para>
22215
22216                 <itemizedlist>
22217                   <listitem>
22218                     <para>Before picking a profile try printing some sample
22219                     labels so that you can easily define a profile that is
22220                     right for your printer/template combination.</para>
22221                   </listitem>
22222
22223                   <listitem>
22224                     <para>After finding any anomalies in the printed document,
22225                     <link linkend="addlabelprofile">create a profile</link>
22226                     and assign it to the template.</para>
22227                   </listitem>
22228                 </itemizedlist>
22229               </listitem>
22230             </itemizedlist>
22231
22232             <para>After saving, your templates will appear on the 'Manage
22233             Templates' page.</para>
22234
22235             <screenshot>
22236               <screeninfo>List of label templates</screeninfo>
22237
22238               <mediaobject>
22239                 <imageobject>
22240                   <imagedata fileref="images/tools/labelcreator/labeltemplates.png"/>
22241                 </imageobject>
22242               </mediaobject>
22243             </screenshot>
22244           </section>
22245         </section>
22246
22247         <section id="labelprofiles">
22248           <title>Profiles</title>
22249
22250           <itemizedlist>
22251             <listitem>
22252               <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Label
22253               Creator &gt; Profiles</para>
22254             </listitem>
22255           </itemizedlist>
22256
22257           <para>A profile is a set of "adjustments" applied to a given <link linkend="addlabeltemplate">template</link> just prior to printing
22258           which compensates for anomalies unique and peculiar to a given
22259           printer (to which the profile is assigned). This means if you set a
22260           template up and then print a sample set of data and find that the
22261           items are not all aligned the same on each label, you need to set up
22262           a profile for each printer to make up for the differences in
22263           printing styles, such as the shifting of text to the left, right,
22264           top or bottom.</para>
22265
22266           <para>If your labels are printing just the way you want, you will
22267           not need a profile.</para>
22268
22269           <section id="addlabelprofile">
22270             <title>Add a Profile</title>
22271
22272             <para>To add a new profile, you want to click on the 'New profile' button at the top of
22273               the Label Creator tool.</para>
22274
22275             <screenshot>
22276               <screeninfo>New Profile Button</screeninfo>
22277
22278               <mediaobject>
22279                 <imageobject>
22280                   <imagedata fileref="images/tools/labelcreator/newprofile.png"/>
22281                 </imageobject>
22282               </mediaobject>
22283             </screenshot>
22284
22285             <para>Using the form that appears you can create a profile to fix
22286             any problems with your template.</para>
22287
22288             <screenshot>
22289               <screeninfo>Create a Printer Profile</screeninfo>
22290
22291               <mediaobject>
22292                 <imageobject>
22293                   <imagedata fileref="images/tools/labelcreator/newprofileform.png"/>
22294                 </imageobject>
22295               </mediaobject>
22296             </screenshot>
22297
22298             <itemizedlist>
22299               <listitem>
22300                 <para>The Printer Name and Paper Bin do not have to match your
22301                 printer exactly, they are for your reference so you can
22302                 remember what printer you have set the profile for. So if you
22303                 want to use the Printer model number in printer name or you
22304                 can call it 'the printer on my desk'</para>
22305               </listitem>
22306
22307               <listitem>
22308                 <para>Template will be filled in once you have chosen which
22309                 template to apply the profile to on the <link linkend="addlabeltemplate">template edit form</link></para>
22310               </listitem>
22311
22312               <listitem>
22313                 <para>The Units pull down is used to define what measurement
22314                 scale you're going to be using for your profile.</para>
22315
22316                 <screenshot>
22317                   <screeninfo>Units of Measurement</screeninfo>
22318
22319                   <mediaobject>
22320                     <imageobject>
22321                       <imagedata fileref="images/tools/patroncards/units.png"/>
22322                     </imageobject>
22323                   </mediaobject>
22324                 </screenshot>
22325               </listitem>
22326
22327               <listitem>
22328                 <para>Offset describes what happens when the entire image is
22329                 off center either vertically or horizontally and creep
22330                 describes a condition where the distance between the labels
22331                 changes across the page or up and down the page</para>
22332
22333                 <itemizedlist>
22334                   <listitem>
22335                     <para>For these values, negative numbers move the error up
22336                     and to the left and positive numbers move the error down
22337                     and to the right</para>
22338                   </listitem>
22339
22340                   <listitem>
22341                     <para>Example: the text is .25" from the left edge of the
22342                     first label, .28" from the left edge of the second label
22343                     and .31" from the left edge of the third label. This means
22344                     the horizontal creep should be set to .03" to make up for
22345                     this difference.</para>
22346                   </listitem>
22347                 </itemizedlist>
22348               </listitem>
22349             </itemizedlist>
22350
22351             <para>After saving, your profiles will appear on the 'Manage
22352             Profiles' page.</para>
22353
22354             <screenshot>
22355               <screeninfo>List of Profiles</screeninfo>
22356
22357               <mediaobject>
22358                 <imageobject>
22359                   <imagedata fileref="images/tools/labelcreator/profiles.png"/>
22360                 </imageobject>
22361               </mediaobject>
22362             </screenshot>
22363
22364             <para>Once you have saved your new profile, you can return to the
22365             list of templates and choose to edit the template that this
22366             profile is for.</para>
22367           </section>
22368         </section>
22369
22370         <section id="labellayouts">
22371           <title>Layouts</title>
22372
22373           <itemizedlist>
22374             <listitem>
22375               <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Label
22376               Creator &gt; Layouts</para>
22377             </listitem>
22378           </itemizedlist>
22379
22380           <para>A layout is used to define the fields you want to appear on
22381           your labels.</para>
22382
22383           <section id="addlabellayout">
22384             <title>Add a Layout</title>
22385
22386             <para>To add a new layout, you want to click on the 'New layout' button at the top of
22387               the Label Creator tool.</para>
22388
22389             <screenshot>
22390               <screeninfo>New Layout Button</screeninfo>
22391
22392               <mediaobject>
22393                 <imageobject>
22394                   <imagedata fileref="images/tools/labelcreator/newlayout.png"/>
22395                 </imageobject>
22396               </mediaobject>
22397             </screenshot>
22398
22399             <para>Using the form that appears you can create a profile to fix
22400             any problems with your template.</para>
22401
22402             <screenshot>
22403               <screeninfo>Add New Layout</screeninfo>
22404
22405               <mediaobject>
22406                 <imageobject>
22407                   <imagedata fileref="images/tools/labelcreator/layoutform.png"/>
22408                 </imageobject>
22409               </mediaobject>
22410             </screenshot>
22411
22412             <itemizedlist>
22413               <listitem>
22414                 <para>The name of your layout can be anything you'd like to
22415                 help you identify it later.</para>
22416               </listitem>
22417
22418               <listitem>
22419                 <para>If this is a barcode label you'll want to choose the
22420                 encoding (Code 39 is the most common)</para>
22421               </listitem>
22422
22423               <listitem>
22424                 <para>The layout type can be any combination of bibliographic
22425                 information and/or barcode. For example a spine label would
22426                 just be Biblio whereas a label for your circulation staff to
22427                 use to checkout the book would probably be
22428                 Biblio/Barcode.</para>
22429               </listitem>
22430
22431               <listitem>
22432                 <para>The Bibliographic Data to Print includes any of the data
22433                 fields that may be mapped to your MARC frameworks. You can
22434                 choose from the preset list of fields or you can click on
22435                 'List Fields' and enter your own data. In 'List Fields', you
22436                 can specify MARC subfields as a 4-character tag-subfield
22437                 string: (ie. 254a for the title field), You can also enclose a
22438                 whitespace-separated list of fields to concatenate on one line
22439                 in double quotes. (ie. "099a 099b" or "itemcallnumber
22440                 barcode"). The fields available are from the database tables
22441                 list below. Finally you could add in static text strings in
22442                 single-quote (ie. 'Some static text here.')</para>
22443
22444                 <itemizedlist>
22445                   <listitem>
22446                     <para>You can use the schema viewer (<ulink url="http://schema.koha-community.org">http://schema.koha-community.org</ulink>)
22447                     with the following tables to find field names to
22448                     use:</para>
22449
22450                     <itemizedlist>
22451                       <listitem>
22452                         <para>Currently all fields in the following tables are
22453                         used: items, biblioitems, biblio, branches</para>
22454
22455                         <screenshot>
22456                           <screeninfo>List fields</screeninfo>
22457
22458                           <mediaobject>
22459                             <imageobject>
22460                               <imagedata fileref="images/tools/labelcreator/listlabelfields.png"/>
22461                             </imageobject>
22462                           </mediaobject>
22463                         </screenshot>
22464                       </listitem>
22465                     </itemizedlist>
22466                   </listitem>
22467                 </itemizedlist>
22468               </listitem>
22469
22470               <listitem>
22471                 <para>Choose if the label maker should print out the
22472                 guidelines around each label</para>
22473               </listitem>
22474
22475               <listitem>
22476                 <para>Choose if you'd like Koha to try to split your call
22477                 numbers (usually used on Spine Labels)</para>
22478               </listitem>
22479
22480               <listitem>
22481                 <para>Finally choose your text settings such as alignment,
22482                 font type and size.</para>
22483               </listitem>
22484             </itemizedlist>
22485
22486             <para>After saving, your layouts will appear on the 'Manage
22487             Layouts' page.</para>
22488           </section>
22489         </section>
22490
22491         <section id="labelbatches">
22492           <title>Batches</title>
22493
22494           <itemizedlist>
22495             <listitem>
22496               <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Label
22497               Creator &gt; Batches</para>
22498             </listitem>
22499           </itemizedlist>
22500
22501           <para>Batches are made up of the barcodes you would like to print.
22502           Once in this tool you can search for the item records you would like
22503           to print out labels for.</para>
22504
22505           <section id="addlabelbatch">
22506             <title>Add a Batch</title>
22507
22508             <para>Batches can be created in one of two ways. The first is to
22509             click the 'Create Label Batch' link on the '<link linkend="managestaged">Staged MARC Management</link>' page:</para>
22510
22511             <screenshot>
22512               <screeninfo>Create Label Batch Link on Staged Records
22513               List</screeninfo>
22514
22515               <mediaobject>
22516                 <imageobject>
22517                   <imagedata fileref="images/tools/labelcreator/labelfromstaged.png"/>
22518                 </imageobject>
22519               </mediaobject>
22520             </screenshot>
22521
22522             <para>The other is to choose to create a new batch from the label
22523             creator tool</para>
22524
22525             <screenshot>
22526               <screeninfo>Create New Batch</screeninfo>
22527
22528               <mediaobject>
22529                 <imageobject>
22530                   <imagedata fileref="images/tools/labelcreator/newbatch.png"/>
22531                 </imageobject>
22532               </mediaobject>
22533             </screenshot>
22534
22535             <para>You will be brought to an empty batch with an 'Add item(s)'
22536             button at the top of the page and a box to scan barcodes in
22537             to.</para>
22538
22539             <screenshot>
22540               <screeninfo>Add Items</screeninfo>
22541
22542               <mediaobject>
22543                 <imageobject>
22544                   <imagedata fileref="images/tools/labelcreator/addbatchitems.png"/>
22545                 </imageobject>
22546               </mediaobject>
22547             </screenshot>
22548
22549             <para>You can either scan barcodes in to the box provided and
22550             click the 'Add item(s)' button or you can click the 'Add item(s)'
22551             button with the barcodes box empty. Clicking 'Add item(s)' with
22552             nothing in the barcodes box will open a search window for you to
22553             find the items you want to add to the batch.</para>
22554
22555             <screenshot>
22556               <screeninfo>Search for items for a Batch</screeninfo>
22557
22558               <mediaobject>
22559                 <imageobject>
22560                   <imagedata fileref="images/tools/labelcreator/searchforbatch.png"/>
22561                 </imageobject>
22562               </mediaobject>
22563             </screenshot>
22564
22565             <para>From the search results, click the check box next to the
22566             items you want to add to the batch and click the 'Add checked'
22567             button. You can also add items one by one by clicking the 'Add'
22568             link to the left of each item.</para>
22569
22570             <screenshot>
22571               <screeninfo>Batch search results</screeninfo>
22572
22573               <mediaobject>
22574                 <imageobject>
22575                   <imagedata fileref="images/tools/labelcreator/batchsearchresults.png"/>
22576                 </imageobject>
22577               </mediaobject>
22578             </screenshot>
22579
22580             <para>Once you have added all of the items click the 'Done'
22581             button. The resulting page will list the items you have
22582             selected.</para>
22583
22584             <screenshot>
22585               <screeninfo>List of items in the batch</screeninfo>
22586
22587               <mediaobject>
22588                 <imageobject>
22589                   <imagedata fileref="images/tools/labelcreator/itemsinbarch.png"/>
22590                 </imageobject>
22591               </mediaobject>
22592             </screenshot>
22593
22594             <para>To print your labels, click the 'Export Batch' button. To
22595             print only some of the labels, click the 'Export Item(s)' button.
22596             Either way you will be presented with a confirmation screen where
22597             you can choose your template and layout.</para>
22598
22599             <screenshot>
22600               <screeninfo>Start batch export</screeninfo>
22601
22602               <mediaobject>
22603                 <imageobject>
22604                   <imagedata fileref="images/tools/labelcreator/exportbatch.png"/>
22605                 </imageobject>
22606               </mediaobject>
22607             </screenshot>
22608
22609             <para>You will then be presented with three download options: PDF,
22610             Excel, and CSV.</para>
22611
22612             <screenshot>
22613               <screeninfo>Batch save options</screeninfo>
22614
22615               <mediaobject>
22616                 <imageobject>
22617                   <imagedata fileref="images/tools/labelcreator/savebatch.png"/>
22618                 </imageobject>
22619               </mediaobject>
22620             </screenshot>
22621
22622             <para>After saving your file, simply print to the blank labels you
22623             have in your library.</para>
22624           </section>
22625         </section>
22626       </section>
22627
22628       <section id="quicklabelcreator">
22629         <title>Quick Spine Label Creator</title>
22630
22631         <itemizedlist>
22632           <listitem>
22633             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Catalog
22634             &gt; Quick Spine Label Creator</para>
22635           </listitem>
22636         </itemizedlist>
22637
22638         <note>
22639           <para>This tool does not use the label layouts or templates, it
22640           simply prints a spine label in the first spot on the label
22641           sheet.</para>
22642
22643           <itemizedlist>
22644             <listitem>
22645               <para>Define the fields you want to print on the spine label in
22646               the <link linkend="SpineLabelFormat">SpineLabelFormat</link>
22647               system preference</para>
22648             </listitem>
22649
22650             <listitem>
22651               <para>Format your label printing by editing spinelabel.css found
22652               in koha-tmpl/intranet-tmpl/prog/en/css/</para>
22653             </listitem>
22654           </itemizedlist>
22655         </note>
22656
22657         <para>To use this tool you simply need the barcode for the book you'd
22658         like to print the spine label for.</para>
22659
22660         <screenshot>
22661           <screeninfo>Quick Spine Label Creator</screeninfo>
22662
22663           <mediaobject>
22664             <imageobject>
22665               <imagedata fileref="images/tools/quickspinelable.png"/>
22666             </imageobject>
22667           </mediaobject>
22668         </screenshot>
22669       </section><section id="rotatingcollections">
22670         <sectioninfo>
22671           <authorgroup>
22672             <author>
22673               <firstname>Cindy</firstname>
22674               <surname>Murdock Ames</surname>
22675               <affiliation>
22676                 <orgname>Meadville Public Library | CCFLS</orgname>
22677               </affiliation>
22678             </author>
22679             <editor>
22680               <firstname>Nicole C.</firstname>
22681               <surname>Engard</surname>
22682             </editor>
22683           </authorgroup>
22684           <pubdate>2014</pubdate>
22685         </sectioninfo>
22686         <title>Rotating Collections</title>
22687         <itemizedlist>
22688           <listitem>
22689             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Catalog &gt; Rotating Collections</para>
22690           </listitem>
22691         </itemizedlist>
22692
22693         <para>Rotating Collections is a tool for managing collections of materials that frequently get shifted from library to library.
22694           It adds the ability to store not only an item's home library and current location but also information about where it is supposed
22695           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
22696           collection is checked in, library staff is notified that the item is part of a rotating collection and which branch it should be
22697           sent to if it is not at the correct one.</para>
22698
22699         <important>
22700           <para>The <link linkend="AutomaticItemReturn">AutomaticItemReturn</link> system preference must
22701             be set to "Don't automatically transfer items to their home library when they are
22702             returned" for Rotating Collections to function properly.</para>
22703         </important>
22704
22705         <itemizedlist>
22706           <listitem>
22707             <para>To create a new rotating collection, click the "New Collection" button, fill in the Title and Description, and click Submit.
22708               Once submitted you'll see "Collection Name added successfully"; click "Return to rotating collections home" to return to the main
22709               Rotating Collections management page (or click Rotating Collections in the sidebar).</para>
22710           </listitem>
22711
22712           <listitem>
22713             <para>To add items to a collection, click "Add or remove items" next to the collection's name in the list of collections.
22714               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
22715               Submit if necessary.</para>
22716           </listitem>
22717
22718           <listitem>
22719             <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
22720               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,
22721               clicking Submit or hitting Enter if necessary.  Note:  The "Remove item from collection" checkbox will remain checked as long as you are on
22722               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>
22723           </listitem>
22724         </itemizedlist>
22725
22726         <section id="transferrotatingcollection">
22727           <title>Transfer a Rotating Collection</title>
22728
22729           <para>Transferring a collection will:</para>
22730           <itemizedlist>
22731             <listitem>
22732               <para>Change the current location of the items in that collection to the library it is to be transferred to</para>
22733             </listitem>
22734             <listitem>
22735               <para>Initiate a transfer from its original current location/holding library to the current location/holding library it is to be rotated to.
22736                 When a library receives a collection they will need to check in the items to complete the transfer.</para>
22737             </listitem>
22738           </itemizedlist>
22739
22740           <para>You can transfer a collection in one of two ways:</para>
22741
22742           <itemizedlist>
22743             <listitem>
22744               <para>From the main Rotating Collections page, click on Transfer next to the title of the collection you wish to transfer; choose
22745                 the library you wish to transfer the collection to and click "Transfer collection".</para>
22746             </listitem>
22747             <listitem>
22748               <para>Or, from the "add or remove items" page for a collection, you can click the Transfer button, choose the library you wish to
22749                 transfer the collection to and click "Transfer Collection".</para>
22750             </listitem>
22751           </itemizedlist>
22752
22753           <important>
22754             <para>In order to complete the transfer process, the library receiving the rotating collection should check in all items from the collection
22755               as they receive them.  This will clear the transfer so that the items are no longer shown as being "in transit".</para>
22756           </important>
22757
22758           <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
22759             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>
22760
22761           <screenshot>
22762             <screeninfo>Rotating Collection Item Notification</screeninfo>
22763             <mediaobject>
22764               <imageobject>
22765                 <imagedata fileref="images/tools/rotatingcollections/rotatingcollectionnotice.png"/>
22766               </imageobject>
22767             </mediaobject>
22768           </screenshot>
22769         </section>
22770       </section>
22771       <section id="marcmodtemplates">
22772         <title>MARC modification templates</title>
22773         <para>The MARC Modification Templates system gives Koha users the power to make alterations
22774           to MARC records automatically while staging MARC records for import. </para>
22775         <para>This tool is useful for altering MARC records from various venders/sources work with
22776           your MARC framework. The system essentially allows one to create a basic script using
22777           actions to Copy, Move, Add, Update and Delete fields. </para>
22778         <para>Start by adding a new template (a template can be made up of one or more actions) by
22779           entering a name and clicking 'Create template'.</para>
22780         <screenshot>
22781             <screeninfo>Add a new template</screeninfo>
22782             <mediaobject>
22783               <imageobject>
22784                 <imagedata fileref="images/tools/marcmodtemplates/addtemplate.png"/>
22785               </imageobject>
22786             </mediaobject>
22787           </screenshot>
22788         <para>Next you can add actions to the template by filling in the Action box.  For example if
22789           you're loading in a batch of files from your EBook vendor you might want to add the biblio
22790           item type of EBOOK to the 942$c.<screenshot>
22791             <screeninfo>Add action</screeninfo>
22792             <mediaobject>
22793               <imageobject>
22794                 <imagedata fileref="images/tools/marcmodtemplates/addaction.png"/>
22795               </imageobject>
22796             </mediaobject>
22797           </screenshot><itemizedlist>
22798             <listitem>
22799               <para>Choose 'Add/Update'</para>
22800             </listitem>
22801             <listitem>
22802               <para>Enter the field 942 and subfield c</para>
22803             </listitem>
22804             <listitem>
22805               <para>Enter the value of 'EBOOK' (or whatever your ebook item type code is)</para>
22806             </listitem>
22807             <listitem>
22808               <para>Provide a description so you can identify this action later</para>
22809             </listitem>
22810             <listitem>
22811               <para>Click 'Add action'</para>
22812             </listitem>
22813           </itemizedlist></para>
22814         <para>Each action can also have an optional condition to check the value or existance of
22815           another field. For example you might want to add the call number to the item record if
22816           it's not already there.</para>
22817         <screenshot>
22818           <screeninfo>Add conditional action</screeninfo>
22819           <mediaobject>
22820             <imageobject>
22821               <imagedata fileref="images/tools/marcmodtemplates/ifexample.png"/>
22822             </imageobject>
22823           </mediaobject>
22824         </screenshot>
22825         <itemizedlist>
22826           <listitem>
22827             <para>Choose 'Copy'</para>
22828           </listitem>
22829           <listitem>
22830             <para>Decide if you want to copy the first occurance or all occurances of the
22831               field</para>
22832           </listitem>
22833           <listitem>
22834             <para>Enter the field 090 (or other biblio call number field) and subfield a to
22835               copy</para>
22836           </listitem>
22837           <listitem>
22838             <para>Enter the 952 field and o subfield to copy to</para>
22839           </listitem>
22840           <listitem>
22841             <para>Choose 'if'</para>
22842           </listitem>
22843           <listitem>
22844             <para>Enter the 952 field and o subfield</para>
22845           </listitem>
22846           <listitem>
22847             <para>Choose "doesn't exist"</para>
22848           </listitem>
22849           <listitem>
22850             <para>Provide a description so you can identify this action later</para>
22851           </listitem>
22852           <listitem>
22853             <para>Click 'Add action'</para>
22854           </listitem>
22855         </itemizedlist>
22856         <para>The Copy &amp; Move actions also support Regular Expressions, which can be used to
22857           automatically modify field values during the copy/move. An example would be to strip out
22858           the '$' character in field 020$c.</para>
22859         <screenshot>
22860           <screeninfo>Add regex action</screeninfo>
22861           <mediaobject>
22862             <imageobject>
22863               <imagedata fileref="images/tools/marcmodtemplates/regexexample.png"/>
22864             </imageobject>
22865           </mediaobject>
22866         </screenshot>
22867         <itemizedlist>
22868           <listitem>
22869             <para>Choose 'Copy'</para>
22870           </listitem>
22871           <listitem>
22872             <para>Decide if you want to copy the first occurance or all occurances of the
22873               field</para>
22874           </listitem>
22875           <listitem>
22876             <para>Enter the field 020 and subfield c to copy</para>
22877           </listitem>
22878           <listitem>
22879             <para>Enter the 020 field and c subfield to copy to</para>
22880           </listitem>
22881           <listitem>
22882             <para>Check the 'RegEx' box and enter your regular expression (in this case s/\$//
22883               )</para>
22884           </listitem>
22885           <listitem>
22886             <para>Choose 'if'</para>
22887           </listitem>
22888           <listitem>
22889             <para>Enter the 020 field and c subfield</para>
22890           </listitem>
22891           <listitem>
22892             <para>Choose "matches"</para>
22893           </listitem>
22894           <listitem>
22895             <para>Check the 'RegEx' box and enter your regular expression (in this case m/^\$/
22896               )</para>
22897           </listitem>
22898           <listitem>
22899             <para>Provide a description so you can identify this action later</para>
22900           </listitem>
22901           <listitem>
22902             <para>Click 'Add action'</para>
22903           </listitem>
22904         </itemizedlist>
22905         <note>
22906           <para>The value for an update can include variables that change each time the template is
22907             used. Currently, the system supports two variables, __BRANCHCODE__ which is replaced
22908             with the branchcode of the library currently using the template, and __CURRENTDATE__
22909             which is replaced with the current date in ISO format ( YYYY-MM-DD ).</para>
22910         </note>
22911         <para>You could also use regular expressions to add your library's proxy URL in front of
22912           links in your MARC record.<screenshot>
22913             <screeninfo>Add proxy URL</screeninfo>
22914             <mediaobject>
22915               <imageobject>
22916                 <imagedata fileref="images/tools/marcmodtemplates/proxyurl.png"/>
22917               </imageobject>
22918             </mediaobject>
22919           </screenshot><itemizedlist>
22920             <listitem>
22921               <para>Choose 'Copy'</para>
22922             </listitem>
22923             <listitem>
22924               <para>Decide if you want to copy the first occurance or all occurances of the
22925                 field</para>
22926             </listitem>
22927             <listitem>
22928               <para>Enter the field 856 and subfield u to copy</para>
22929             </listitem>
22930             <listitem>
22931               <para>Enter the 856 field and u subfield to copy to</para>
22932             </listitem>
22933             <listitem>
22934               <para>Check the 'RegEx' box and enter your regular expression (in this case
22935                 s/^/PROXY_URL/ )</para>
22936             </listitem>
22937             <listitem>
22938               <para>Provide a description so you can identify this action later</para>
22939             </listitem>
22940             <listitem>
22941               <para>Click 'Add action'</para>
22942             </listitem>
22943           </itemizedlist></para>
22944         <para>Once your actions are saved you can view them at the top of the screen. Actions can be
22945           moved around using the arrows to the left of them. </para>
22946         <screenshot>
22947           <screeninfo>View actions</screeninfo>
22948           <mediaobject>
22949             <imageobject>
22950               <imagedata fileref="images/tools/marcmodtemplates/viewactions.png"/>
22951             </imageobject>
22952           </mediaobject>
22953         </screenshot>
22954         <para>Depending on your actions the order may be very important. For example you don't want
22955           to delete a field before you copy it to another field.</para>
22956         <para>To add another template you can either start fresh or click the 'Duplicate current
22957           template' checkbox to create a copy of an existing template to start with.</para>
22958         <screenshot>
22959           <screeninfo>Duplicate template</screeninfo>
22960           <mediaobject>
22961             <imageobject>
22962               <imagedata fileref="images/tools/marcmodtemplates/duplicate.png"/>
22963             </imageobject>
22964           </mediaobject>
22965         </screenshot>
22966         <para>Once your template is saved you will be able to pick it when using the <link
22967             linkend="stagemarc">Stage MARC Records for Import</link> tool.</para>
22968         <screenshot>
22969           <screeninfo>Choose template</screeninfo>
22970           <mediaobject>
22971             <imageobject>
22972               <imagedata fileref="images/tools/marcmodtemplates/templatechoice.png"/>
22973             </imageobject>
22974           </mediaobject>
22975         </screenshot>
22976       </section>
22977
22978       <section id="stagemarc">
22979         <title>Stage MARC Records for Import</title>
22980
22981         <itemizedlist>
22982           <listitem>
22983             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Catalog
22984             &gt; Stage MARC records for import</para>
22985           </listitem>
22986         </itemizedlist>
22987
22988         <para>This tool can be used to import both bibliographic and authority
22989         records that are saved in MARC format. Importing records into Koha
22990         includes two steps. The first is to stage records for import.</para>
22991
22992         <itemizedlist>
22993           <listitem>
22994             <para>First find the MARC file on your computer</para>
22995
22996             <screenshot>
22997               <screeninfo>Stage MARC Records for Import</screeninfo>
22998
22999               <mediaobject>
23000                 <imageobject>
23001                   <imagedata fileref="images/tools/marcimport/stagemarc-pt1.png"/>
23002                 </imageobject>
23003               </mediaobject>
23004             </screenshot>
23005           </listitem>
23006
23007           <listitem>
23008             <para>Next you will be presented with options for record matching
23009             and item imports</para>
23010
23011             <screenshot>
23012               <screeninfo>Upload options</screeninfo>
23013
23014               <mediaobject>
23015                 <imageobject>
23016                   <imagedata fileref="images/tools/marcimport/stagemarc-pt2.png"/>
23017                 </imageobject>
23018               </mediaobject>
23019             </screenshot>
23020
23021             <itemizedlist>
23022               <listitem>
23023                 <para>Enter 'Comments about this file' to identify your upload
23024                 when going to the '<link linkend="managestaged">Manage Staged
23025                 MARC Records</link>' tool</para>
23026               </listitem>
23027
23028               <listitem>
23029                 <para>Tell Koha which type of file this is, bibliographic or
23030                 authority</para>
23031
23032                 <screenshot>
23033                   <screeninfo>Record type</screeninfo>
23034
23035                   <mediaobject>
23036                     <imageobject>
23037                       <imagedata fileref="images/tools/marcimport/recordtype.png"/>
23038                     </imageobject>
23039                   </mediaobject>
23040                 </screenshot>
23041               </listitem>
23042
23043               <listitem>
23044                 <para>Choose the character encoding</para>
23045
23046                 <screenshot>
23047                   <screeninfo>Chracter encoding</screeninfo>
23048
23049                   <mediaobject>
23050                     <imageobject>
23051                       <imagedata fileref="images/tools/marcimport/encoding.png"/>
23052                     </imageobject>
23053                   </mediaobject>
23054                 </screenshot>
23055               </listitem>
23056
23057               <listitem>
23058                 <para>Choose if you would like to use a <link linkend="marcmodtemplates">MARC
23059                     Modification Template</link> to alter the data you're about to import</para>
23060                 <screenshot>
23061                   <screeninfo>Choose modification template</screeninfo>
23062                   <mediaobject>
23063                     <imageobject>
23064                       <imagedata fileref="images/tools/marcimport/templatechoice.png"/>
23065                     </imageobject>
23066                   </mediaobject>
23067                 </screenshot>
23068               </listitem>
23069               <listitem>
23070                 <para>Choose whether or not you want to look for matching records</para>
23071                 <screenshot>
23072                   <screeninfo>Look for matches</screeninfo>
23073                   <mediaobject>
23074                     <imageobject>
23075                       <imagedata fileref="images/tools/marcimport/matches.png"/>
23076                     </imageobject>
23077                   </mediaobject>
23078                 </screenshot>
23079                 <itemizedlist>
23080                   <listitem>
23081                     <para>You can set up <link linkend="recordmatchingrules">record matching
23082                         rules</link> through the administration area</para>
23083                     <screenshot>
23084                       <screeninfo>Matching rules</screeninfo>
23085                       <mediaobject>
23086                         <imageobject>
23087                           <imagedata fileref="images/tools/marcimport/matchrule.png"/>
23088                         </imageobject>
23089                       </mediaobject>
23090                     </screenshot>
23091                     <itemizedlist>
23092                       <listitem>
23093                         <para>When using the ISBN matching rule Koha will find only exact matches.
23094                           If you find that the ISBN match is not working to your satisfaction you
23095                           can change the <link linkend="AggressiveMatchOnISBN"
23096                             >AggressiveMatchOnISBN</link> preference to 'Do' and then run your
23097                           import again.</para>
23098                       </listitem>
23099                     </itemizedlist>
23100                   </listitem>
23101                 </itemizedlist>
23102               </listitem>
23103
23104               <listitem>
23105                 <para>Next choose what to do with matching records if they are
23106                 found</para>
23107               </listitem>
23108
23109               <listitem>
23110                 <para>Finally choose what to do with records that are
23111                 unique</para>
23112               </listitem>
23113
23114               <listitem>
23115                 <para>Next you can choose whether or not to import the item
23116                 data found in the MARC records (if the file you're loading is
23117                 a bibliographic file)</para>
23118
23119                 <screenshot>
23120                   <screeninfo>Import items</screeninfo>
23121
23122                   <mediaobject>
23123                     <imageobject>
23124                       <imagedata fileref="images/tools/marcimport/checkitems.png"/>
23125                     </imageobject>
23126                   </mediaobject>
23127                 </screenshot>
23128
23129               <itemizedlist>
23130                 <listitem><para>From here you can choose to always add items regardless of matching status, add them only if a
23131                       matching bib was found, add items only if there was no matching bib record,
23132                       replace items if a matching bib was found (The match will look at the
23133                       itemnumbers and barcodes to match on for items. Itemnumbers take precendence
23134                       over barcodes), or Ignore items and not add them.</para></listitem>
23135               </itemizedlist>
23136               </listitem>
23137             </itemizedlist>
23138           </listitem>
23139           <listitem>
23140             <para>Click 'Stage for import'</para>
23141           </listitem>
23142
23143           <listitem>
23144             <para>You will be presented with a confirmation of your MARC
23145             import</para>
23146
23147             <screenshot>
23148               <screeninfo>MARC Import Confirmation</screeninfo>
23149
23150               <mediaobject>
23151                 <imageobject>
23152                   <imagedata fileref="images/tools/marcimport/stagemarc-results.png"/>
23153                 </imageobject>
23154               </mediaobject>
23155             </screenshot>
23156           </listitem>
23157
23158           <listitem>
23159             <para>To complete the process continue to the <link linkend="managestaged">Managed Staged MARC Records
23160             Tool</link></para>
23161           </listitem>
23162         </itemizedlist>
23163       </section>
23164
23165       <section id="managestaged">
23166         <title>Staged MARC Record Management</title>
23167
23168         <itemizedlist>
23169           <listitem>
23170             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Catalog
23171             &gt; Staged MARC Record Management</para>
23172           </listitem>
23173         </itemizedlist>
23174
23175         <para>Once you have <link linkend="stagemarc">staged</link> your
23176         records for import you can complete the import using this tool.</para>
23177
23178         <screenshot>
23179           <screeninfo>List of Staged MARC Records</screeninfo>
23180
23181           <mediaobject>
23182             <imageobject>
23183               <imagedata fileref="images/tools/marcimport/managestaged.png"/>
23184             </imageobject>
23185           </mediaobject>
23186         </screenshot>
23187
23188         <itemizedlist>
23189           <listitem>
23190             <para>From the list of staged records, click on the file name that
23191             you want to finish importing</para>
23192
23193             <itemizedlist>
23194               <listitem>
23195                 <para>You will note that records that have already been
23196                 imported will say so under 'Status'</para>
23197               </listitem>
23198             </itemizedlist>
23199           </listitem>
23200
23201           <listitem>
23202             <para>A summary of your import will appear along with the option
23203             to change your matching rules</para>
23204
23205             <screenshot>
23206               <screeninfo>Manage Staged Records Batch</screeninfo>
23207
23208               <mediaobject>
23209                 <imageobject>
23210                   <imagedata fileref="images/tools/marcimport/managestagedrecords.png"/>
23211                 </imageobject>
23212               </mediaobject>
23213             </screenshot>
23214           </listitem>
23215
23216           <listitem>
23217             <para>Below the summary is the option to import the batch of bib
23218             records using a specific framework</para>
23219
23220             <screenshot>
23221               <screeninfo>Choose Framework to Import Into</screeninfo>
23222
23223               <mediaobject>
23224                 <imageobject>
23225                   <imagedata fileref="images/tools/marcimport/importframework.png"/>
23226                 </imageobject>
23227               </mediaobject>
23228             </screenshot>
23229
23230             <itemizedlist>
23231               <listitem>
23232                 <para>Choosing a framework other than 'Default' isn't
23233                 necessary, but it's helpful for running reports and having the
23234                 right bib level item type selected on import.</para>
23235               </listitem>
23236             </itemizedlist>
23237           </listitem>
23238
23239           <listitem>
23240             <para>Below the framework selection there will be a list of the
23241             records that will be imported</para>
23242
23243             <screenshot>
23244               <screeninfo>List of Staged Records</screeninfo>
23245
23246               <mediaobject>
23247                 <imageobject>
23248                   <imagedata fileref="images/tools/marcimport/stagedrecords.png"/>
23249                 </imageobject>
23250               </mediaobject>
23251             </screenshot>
23252
23253             <itemizedlist>
23254               <listitem>
23255                 <para>Review your summary before completing your import to make sure that your
23256                   matching rule worked and that the records appear as you expect them to</para>
23257               </listitem>
23258               <listitem>
23259                 <para>Matches will appear with info under the 'Match details column'</para>
23260                 <screenshot>
23261                   <screeninfo>Matched record</screeninfo>
23262                   <mediaobject>
23263                     <imageobject>
23264                       <imagedata fileref="images/tools/marcimport/matchfound.png"/>
23265                     </imageobject>
23266                   </mediaobject>
23267                 </screenshot>
23268                 <para>and when clicking the 'View' link under 'Diff' you can see the difference
23269                   between versions.</para>
23270                 <screenshot>
23271                   <screeninfo>Record differences</screeninfo>
23272                   <mediaobject>
23273                     <imageobject>
23274                       <imagedata fileref="images/tools/marcimport/stagediff.png"/>
23275                     </imageobject>
23276                   </mediaobject>
23277                 </screenshot>
23278               </listitem>
23279             </itemizedlist>
23280           </listitem>
23281
23282           <listitem>
23283             <para>Click 'Import into catalog' to complete the import</para>
23284
23285             <screenshot>
23286               <screeninfo>Import summary</screeninfo>
23287
23288               <mediaobject>
23289                 <imageobject>
23290                   <imagedata fileref="images/tools/marcimport/importedrecords.png"/>
23291                 </imageobject>
23292               </mediaobject>
23293             </screenshot>
23294           </listitem>
23295
23296           <listitem>
23297             <para>Once your import is complete a link to the new bib records
23298             will appear to the right of each title that was imported</para>
23299           </listitem>
23300
23301           <listitem>
23302             <para>You can also undo your import by clicking the 'Undo import
23303             into catalog' button</para>
23304           </listitem>
23305         </itemizedlist>
23306
23307         <para>Records imported using this tool remain in the 'reservoir' until
23308         they are cleaned. These items will appear when searching the catalog
23309         from the <link linkend="cataloging">Cataloging</link> tool:</para>
23310
23311         <screenshot>
23312           <screeninfo>Reservoir Results</screeninfo>
23313
23314           <mediaobject>
23315             <imageobject>
23316               <imagedata fileref="images/tools/marcimport/reservoirresults.png"/>
23317             </imageobject>
23318           </mediaobject>
23319         </screenshot>
23320
23321         <para>To clean items out of the 'reservoir':</para>
23322
23323         <itemizedlist>
23324           <listitem>
23325             <para>Visit the main screen of the Manage Staged MARC Records
23326             tool</para>
23327
23328             <screenshot>
23329               <screeninfo>List of Staged MARC Records</screeninfo>
23330
23331               <mediaobject>
23332                 <imageobject>
23333                   <imagedata fileref="images/tools/marcimport/managestaged.png"/>
23334                 </imageobject>
23335               </mediaobject>
23336             </screenshot>
23337           </listitem>
23338
23339           <listitem>
23340             <para>To clean a batch, click the 'Clean' button to the
23341             right</para>
23342           </listitem>
23343
23344           <listitem>
23345             <para>You will be presented with a confirmation message</para>
23346
23347             <screenshot>
23348               <screeninfo>Clean MARC Records Confirmation</screeninfo>
23349
23350               <mediaobject>
23351                 <imageobject>
23352                   <imagedata fileref="images/tools/marcimport/cleanbatch.png"/>
23353                 </imageobject>
23354               </mediaobject>
23355             </screenshot>
23356
23357             <itemizedlist>
23358               <listitem>
23359                 <para>Accept the deletion and the records will be removed from
23360                 the reservoir and the status will be changed to
23361                 'cleaned'</para>
23362               </listitem>
23363             </itemizedlist>
23364           </listitem>
23365         </itemizedlist>
23366       </section>
23367
23368       <section id="uploadlocalimages">
23369         <title>Upload Local Cover Image</title>
23370
23371         <itemizedlist>
23372           <listitem>
23373             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Catalog
23374             &gt; Upload Local Cover Image</para>
23375           </listitem>
23376         </itemizedlist>
23377
23378         <para>This tool will allow you to upload cover images for the materials in your catalog. To
23379           access this tool, staff will need the <link linkend="toolspermissions"
23380             >upload_local_cover_images permission</link>. In order for images to show in the staff
23381           client and/or OPAC you will need to set your <link linkend="LocalCoverImages"
23382             >LocalCoverImages</link> and/or <link linkend="OPACLocalCoverImages"
23383             >OPACLocalCoverImages</link> preferences to 'Display.' Images can be uploaded in batches
23384           or one by one.<note>
23385             <para>Koha does not have a maximum file size limit for this tool, but Apache may limit
23386               the maximum size of uploads (talk to your sys admin).</para>
23387           </note><note>
23388             <para>When you want to upload multiple images onto a bib record, they will display left
23389               to right (then top to bottom, depending on screen real estate) in order of uploading,
23390               and the one on the left (the first one uploaded) will be the one used as a thumbnail
23391               cover in search results and on the detail page. There is no way to reorder cover
23392               images uploaded in this way, so be sure to upload them in the order you'd like them to appear.<screenshot>
23393                 <screeninfo>Multiple cover images on one record</screeninfo>
23394                 <mediaobject>
23395                   <imageobject>
23396                     <imagedata fileref="images/tools/uploadlocalimg/multiplecovers.png"/>
23397                   </imageobject>
23398                 </mediaobject>
23399               </screenshot></para>
23400           </note></para>
23401
23402         <para>If uploading a single image:</para>
23403
23404         <itemizedlist>
23405           <listitem>
23406             <para>Visit the tool and click the 'Browse' button to browse to
23407             the image on your local machine.</para>
23408
23409             <screenshot>
23410               <screeninfo>Upload single cover image</screeninfo>
23411
23412               <mediaobject>
23413                 <imageobject>
23414                   <imagedata fileref="images/tools/uploadlocalimg/uploadsingle.png"/>
23415                 </imageobject>
23416               </mediaobject>
23417             </screenshot>
23418           </listitem>
23419
23420           <listitem>
23421             <para>Click 'Upload file'</para>
23422           </listitem>
23423
23424           <listitem>
23425             <para>Choose 'Image file' under the 'File type' section</para>
23426           </listitem>
23427
23428           <listitem>
23429             <para>Enter the biblionumber for the record you're attaching this
23430             image to. This is not the same as the barcode, this is the system
23431             generated number assigned by Koha.</para>
23432
23433             <itemizedlist>
23434               <listitem>
23435                 <para>Find the biblionumber by looking at the end of the URL
23436                 in the address bar when on the detail page</para>
23437
23438                 <screenshot>
23439                   <screeninfo>Biblionumber in URL</screeninfo>
23440
23441                   <mediaobject>
23442                     <imageobject>
23443                       <imagedata fileref="images/tools/uploadlocalimg/bibnumurl.png"/>
23444                     </imageobject>
23445                   </mediaobject>
23446                 </screenshot>
23447               </listitem>
23448
23449               <listitem>
23450                 <para>or by clicking on the MARC tab on the detail page in the
23451                 staff client</para>
23452
23453                 <screenshot>
23454                   <screeninfo>Biblionumber on MARC Record</screeninfo>
23455
23456                   <mediaobject>
23457                     <imageobject>
23458                       <imagedata fileref="images/tools/uploadlocalimg/bibnummarc.png"/>
23459                     </imageobject>
23460                   </mediaobject>
23461                 </screenshot>
23462               </listitem>
23463             </itemizedlist>
23464           </listitem>
23465
23466           <listitem>
23467             <para>If you would like to replace any other cover images you may
23468             have uploaded in the past, check the 'Replace existing covers' box
23469             under the 'Options' section</para>
23470           </listitem>
23471
23472           <listitem>
23473             <para>Click 'Process images'</para>
23474           </listitem>
23475
23476           <listitem>
23477             <para>You will be presented with a summary of the upload and a
23478             link to the record you have just added the image to</para>
23479           </listitem>
23480         </itemizedlist>
23481
23482         <para>If uploading a batch of images at once you will need to prepare
23483         a ZIP file first.</para>
23484
23485         <itemizedlist>
23486           <listitem>
23487             <para>Enter in to the ZIP file all the images you are
23488             uploading</para>
23489           </listitem>
23490
23491           <listitem>
23492             <para>Also include a text file (*.TXT) named either datalink.txt
23493             or idlink.txt listing the biblionumber followed by the image name
23494             for each image one per line</para>
23495
23496             <itemizedlist>
23497               <listitem>
23498                 <para>ex. 4091,image4091.jpg</para>
23499
23500                 <screenshot>
23501                   <screeninfo>ZIP File Contents</screeninfo>
23502
23503                   <mediaobject>
23504                     <imageobject>
23505                       <imagedata fileref="images/tools/uploadlocalimg/zipfiles.png"/>
23506                     </imageobject>
23507                   </mediaobject>
23508                 </screenshot>
23509               </listitem>
23510             </itemizedlist>
23511           </listitem>
23512
23513           <listitem>
23514             <para>Browse your local computer to the ZIP file</para>
23515           </listitem>
23516
23517           <listitem>
23518             <para>Click 'Upload file'</para>
23519           </listitem>
23520
23521           <listitem>
23522             <para>Choose 'Zip file' under the 'File type' section</para>
23523           </listitem>
23524
23525           <listitem>
23526             <para>If you would like to replace any other cover images you may
23527             have uploaded in the past, check the 'Replace existing covers' box
23528             under the 'Options' section</para>
23529           </listitem>
23530
23531           <listitem>
23532             <para>Click 'Process images'</para>
23533           </listitem>
23534
23535           <listitem>
23536             <para>You will be presented with a summary of the upload</para>
23537
23538             <screenshot>
23539               <screeninfo>Upload Summary</screeninfo>
23540
23541               <mediaobject>
23542                 <imageobject>
23543                   <imagedata fileref="images/tools/uploadlocalimg/uploadsummary.png"/>
23544                 </imageobject>
23545               </mediaobject>
23546             </screenshot>
23547           </listitem>
23548         </itemizedlist>
23549
23550         <important>
23551           <para>The source image is used to generate a 140 x 200 px thumbnail image and a 600 x 800
23552             px full-size image. The original sized image uploaded will not be stored by Koha</para>
23553         </important>
23554
23555         <para>You will be able to see your cover images in the staff client on
23556         the detail page under the 'Image' tab in the holdings table at the
23557         bottom</para>
23558
23559         <screenshot>
23560           <screeninfo>Cover images in the staff client</screeninfo>
23561
23562           <mediaobject>
23563             <imageobject>
23564               <imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
23565             </imageobject>
23566           </mediaobject>
23567         </screenshot>
23568
23569         <para>In the OPAC the cover images will also appear in the images tab,
23570         as well as next to the title and on the search results.</para>
23571         <para>If you would like to remove a cover image you can click 'Delete image' below the image
23572           if you have the <link linkend="toolspermissions">upload_local_cover_images
23573             permission</link>.</para>
23574       </section>
23575     </section>
23576
23577     <section id="additionaltools">
23578       <title>Additional Tools</title>
23579
23580       <para/>
23581
23582       <section id="calholidays">
23583         <title>Calendar</title>
23584
23585         <itemizedlist>
23586           <listitem>
23587             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt;
23588             Additional Tools &gt; Calendar</para>
23589           </listitem>
23590         </itemizedlist>
23591
23592         <para>Libraries can define library closings and holidays to be used
23593         when calculating due dates. You can make use of the Calendar by
23594         turning on the proper system preferences:</para>
23595
23596         <itemizedlist>
23597           <listitem>
23598             <para><emphasis>Get there: </emphasis>More &gt; Administration
23599             &gt; Global System Preferences &gt; Circulation &gt; <link linkend="useDaysMode">useDaysMode</link></para>
23600
23601             <itemizedlist>
23602               <listitem>
23603                 <para>Choose the method for calculating due date - either
23604                 include days the library is closed in the calculation or don't
23605                 include them.</para>
23606               </listitem>
23607             </itemizedlist>
23608           </listitem>
23609
23610           <listitem>
23611             <para><emphasis>Get there:</emphasis> More &gt; Administration
23612             &gt; Global System Preferences &gt; Circulation &gt; <link linkend="finesCalendar">finescalendar</link></para>
23613
23614             <itemizedlist>
23615               <listitem>
23616                 <para>This will check the holiday calendar before charging
23617                 fines</para>
23618               </listitem>
23619             </itemizedlist>
23620           </listitem>
23621         </itemizedlist>
23622
23623         <screenshot>
23624           <screeninfo>Calendar &amp; Holidays Tools</screeninfo>
23625
23626           <mediaobject>
23627             <imageobject>
23628               <imagedata fileref="images/tools/calendar/calendar.png"/>
23629             </imageobject>
23630           </mediaobject>
23631         </screenshot>
23632
23633         <section id="addevents">
23634           <title>Adding Events</title>
23635
23636           <para>Before adding events, choose the library you would like to
23637           apply the closings to. When adding events you will be asked if you
23638           would like to apply the event to one branch or all branches. To add
23639           events, simply</para>
23640
23641           <itemizedlist>
23642             <listitem>
23643               <para>Click on the date on the calendar that you would like to
23644               apply the closing to</para>
23645
23646               <screenshot>
23647                 <screeninfo>Calendar Add Form</screeninfo>
23648
23649                 <mediaobject>
23650                   <imageobject>
23651                     <imagedata fileref="images/tools/calendar/calendaradd.png"/>
23652                   </imageobject>
23653                 </mediaobject>
23654               </screenshot>
23655             </listitem>
23656
23657             <listitem>
23658               <para>In the form that appears above the calendar, enter the
23659               closing information (for more info on each option click the
23660               question mark [?] to the right of the option)</para>
23661
23662               <itemizedlist>
23663                 <listitem>
23664                   <para>Library will be filled in automatically based on the
23665                   library you chose from the pull down at the top of the
23666                   page</para>
23667                 </listitem>
23668
23669                 <listitem>
23670                   <para>The day information will also be filled in
23671                   automatically based on the date you clicked on the
23672                   calendar</para>
23673                 </listitem>
23674
23675                 <listitem>
23676                   <para>In the description enter the reason the library is
23677                   closed</para>
23678                 </listitem>
23679
23680                 <listitem>
23681                   <para>Next you can choose if this event is a one time event
23682                   or if it is repeatable.</para>
23683
23684                   <itemizedlist>
23685                     <listitem>
23686                       <para>If this is a one day holiday choose 'Holiday only
23687                       on this day'</para>
23688                     </listitem>
23689
23690                     <listitem>
23691                       <para>If this is a weekly closing (like a weekend day)
23692                       then you can choose 'Holiday repeated every same day of
23693                       the week'</para>
23694                     </listitem>
23695
23696                     <listitem>
23697                       <para>If this is an annual holiday closing choose
23698                       'Holiday repeated yearly on the same date'</para>
23699                     </listitem>
23700
23701                     <listitem>
23702                       <para>If the library is going to be closed for the week
23703                       or a range of time choose 'Holiday on a range' and enter
23704                       a 'To Date' at the top</para>
23705                     </listitem>
23706
23707                     <listitem>
23708                       <para>If the library is going to be closed for a range
23709                       of time each year (such as summer holidays for schools)
23710                       choose 'Holiday repeated yearly on a range' and enter a
23711                       'To Date' at the top</para>
23712                     </listitem>
23713                   </itemizedlist>
23714                 </listitem>
23715
23716                 <listitem>
23717                   <para>Finally decide if this event should be applied to all
23718                   libraries or just the one you have originally
23719                   selected</para>
23720
23721                   <itemizedlist>
23722                     <listitem>
23723                       <para>If you'd rather enter all the holidays and then
23724                       copy them all to another branch all at once you can use
23725                       the copy menu below the calendar</para>
23726
23727                       <screenshot>
23728                         <screeninfo>Copy holidays</screeninfo>
23729
23730                         <mediaobject>
23731                           <imageobject>
23732                             <imagedata fileref="images/tools/calendar/copyholidays.png"/>
23733                           </imageobject>
23734                         </mediaobject>
23735                       </screenshot>
23736                     </listitem>
23737                   </itemizedlist>
23738                 </listitem>
23739               </itemizedlist>
23740             </listitem>
23741
23742             <listitem>
23743               <para>After saving you will see the event listed in the summary
23744               to the right the calendar</para>
23745
23746               <screenshot>
23747                 <screeninfo>Calendar Summary</screeninfo>
23748
23749                 <mediaobject>
23750                   <imageobject>
23751                     <imagedata fileref="images/tools/calendar/calendarsummary.png"/>
23752                   </imageobject>
23753                 </mediaobject>
23754               </screenshot>
23755             </listitem>
23756           </itemizedlist>
23757         </section>
23758
23759         <section id="editevents">
23760           <title>Editing Events</title>
23761
23762           <para>To edit events</para>
23763
23764           <itemizedlist>
23765             <listitem>
23766               <para>Click on the event on the calendar that you want to change
23767               (do this by clicking on the date on the calendar, not the event
23768               listed in the summary)</para>
23769
23770               <screenshot>
23771                 <screeninfo>Edit holiday form</screeninfo>
23772
23773                 <mediaobject>
23774                   <imageobject>
23775                     <imagedata fileref="images/tools/calendar/calendaredit.png"/>
23776                   </imageobject>
23777                 </mediaobject>
23778               </screenshot>
23779             </listitem>
23780
23781             <listitem>
23782               <para>From this form you can make edits to the holiday or delete the holiday
23783                 completely. <itemizedlist>
23784                   <listitem>
23785                     <para>All actions require that you click 'Save' before the change will be
23786                       made.</para>
23787                   </listitem>
23788                 </itemizedlist></para>
23789             </listitem>
23790
23791             <listitem>
23792               <para>Clicking on repeatable events will offer slightly
23793               different options</para>
23794
23795               <screenshot>
23796                 <screeninfo>Edit repeatable event</screeninfo>
23797
23798                 <mediaobject>
23799                   <imageobject>
23800                     <imagedata fileref="images/tools/calendar/calendarexception.png"/>
23801                   </imageobject>
23802                 </mediaobject>
23803               </screenshot>
23804
23805               <itemizedlist>
23806                 <listitem>
23807                   <para>In the form above you will note that there is now an option to 'Generate an
23808                     exception for this repeated holiday,' choosing this option will allow you to
23809                     make it so that this date is not closed even though the library is usually
23810                     closed on this date.<itemizedlist>
23811                       <listitem>
23812                         <para>All actions require that you click 'Save' before the change will be
23813                           made.</para>
23814                       </listitem>
23815                     </itemizedlist></para>
23816                 </listitem>
23817               </itemizedlist>
23818             </listitem>
23819           </itemizedlist>
23820         </section>
23821
23822         <section id="calendarhelp">
23823           <title>Additional Help</title>
23824
23825           <para>When adding or editing events you can get additional help by
23826           clicking on the question mark next to various different options on
23827           the form</para>
23828
23829           <screenshot>
23830             <screeninfo>Additional Calendar Help Buttons</screeninfo>
23831
23832             <mediaobject>
23833               <imageobject>
23834                 <imagedata fileref="images/tools/calendar/calendarhelp.png"/>
23835               </imageobject>
23836             </mediaobject>
23837           </screenshot>
23838         </section>
23839       </section>
23840
23841       <section id="csvprofiles">
23842         <title>CSV Profiles</title>
23843
23844         <itemizedlist>
23845           <listitem>
23846             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt;
23847             Additional Tools &gt; CSV Profiles</para>
23848           </listitem>
23849         </itemizedlist>
23850
23851         <para>CSV Profiles are created to define how you would like your cart
23852         or list to export.</para>
23853
23854         <section id="addcsvprofile">
23855           <title>Add CSV Profiles</title>
23856
23857           <para>To add a CSV Profile</para>
23858
23859           <itemizedlist>
23860             <listitem>
23861               <para>Click 'CSV Profiles' from the Tools menu</para>
23862             </listitem>
23863             <listitem>
23864               <para>The 'Profile type' determines what type of fields you plan to use (MARC or SQL)
23865                 to define your profile<itemizedlist>
23866                   <listitem>
23867                     <para>If tyou choose MARC then you will need to enter MARC fields</para>
23868                   </listitem>
23869                 </itemizedlist></para>
23870               <screenshot>
23871                 <screeninfo>MARC CSV Profile</screeninfo>
23872                 <mediaobject>
23873                   <imageobject>
23874                     <imagedata fileref="images/tools/csvprofiles/addcsv.png"/>
23875                   </imageobject>
23876                 </mediaobject>
23877               </screenshot>
23878               <itemizedlist>
23879                 <listitem>
23880                   <para>If tyou choose SQL then you will need to enter SQL database fields</para>
23881                   <screenshot>
23882                       <screeninfo>SQL CSV Profile</screeninfo>
23883                       <mediaobject>
23884                         <imageobject>
23885                           <imagedata fileref="images/tools/csvprofiles/addcsv-sql.png"/>
23886                         </imageobject>
23887                       </mediaobject>
23888                     </screenshot>
23889                 </listitem>
23890               </itemizedlist>
23891               <itemizedlist>
23892                 <listitem>
23893                   <para>The 'Profile name' will appear on the export pull down list when choosing
23894                     'Download' from your cart or list</para>
23895                   <screenshot>
23896                       <screeninfo>Download List</screeninfo>
23897                       <mediaobject>
23898                         <imageobject>
23899                           <imagedata fileref="images/tools/csvprofiles/downloadcsv.png"/>
23900                         </imageobject>
23901                       </mediaobject>
23902                     </screenshot>
23903                 </listitem>
23904                 <listitem>
23905                   <para>The 'Profile description' is for your own benefit, but will also appear in
23906                     the OPAC when patrons download content, so make sure it's clear to your patrons
23907                     as well</para>
23908                 </listitem>
23909                 <listitem>
23910                   <para>The 'CSV separator' is the character used to separate values and value groups<note>
23911                       <para>The most common option here is comma because most spreadsheet
23912                         applications know how to open files split by commas.</para>
23913                     </note></para>
23914                 </listitem>
23915                 <listitem>
23916                   <para>The 'Field separator' is the character used to separate duplicate
23917                     fields</para>
23918                   <itemizedlist>
23919                     <listitem>
23920                       <para>Example: You may have multiple 650 fields and this is the character that
23921                         will appear in between each one in the column</para>
23922                       <screenshot>
23923                           <screeninfo>Field separators in between multiple subjects</screeninfo>
23924                           <mediaobject>
23925                             <imageobject>
23926                               <imagedata fileref="images/tools/csvprofiles/csvfieldsep.png"/>
23927                             </imageobject>
23928                           </mediaobject>
23929                         </screenshot>
23930                     </listitem>
23931                   </itemizedlist>
23932                 </listitem>
23933                 <listitem>
23934                   <para>The 'Subfield separator' is the character used to separate duplicate
23935                     subfields</para>
23936                   <itemizedlist>
23937                     <listitem>
23938                       <para>Example: You may have multiple $a subfields in a field</para>
23939                     </listitem>
23940                   </itemizedlist>
23941                 </listitem>
23942                 <listitem>
23943                   <para>The 'Encoding' field lets you define the encoding used when saving the
23944                     file</para>
23945                 </listitem>
23946                 <listitem>
23947                   <para>Finally format your CSV file using the 'Profile MARC' or 'Profile SQL'
23948                     field</para>
23949                   <itemizedlist>
23950                     <listitem>
23951                       <para>Define which fields or subfields you want to export, separated by pipes.
23952                         Example : 200|210$a|301 for MARC and biblio.title|biblio.author for
23953                         SQL</para>
23954                     </listitem>
23955                     <listitem>
23956                       <note>
23957                         <para>You can also use your own headers (instead of the ones from Koha) by
23958                           prefixing the field number with an header, followed by the equal sign.
23959                           Example : Personal name=100|title=245$a|300</para>
23960                       </note>
23961                     </listitem>
23962                   </itemizedlist>
23963                 </listitem>
23964               </itemizedlist>
23965               <para>When you have entered in all of the information for you profile, simply click
23966                 'Submit' and you will be presented with a confirmation that your profile has been saved.</para>
23967               <screenshot>
23968                   <screeninfo>Confirmation of new CSV profile</screeninfo>
23969                   <mediaobject>
23970                     <imageobject>
23971                       <imagedata fileref="images/tools/csvprofiles/csvadded.png"/>
23972                     </imageobject>
23973                   </mediaobject>
23974                 </screenshot>
23975             </listitem>
23976           </itemizedlist>
23977         </section>
23978
23979         <section id="editcsvprofile">
23980           <title>Modify CSV Profiles</title>
23981
23982           <para>Once you have created at least one CSV Profile an 'Edit
23983           profile' tab will appear next to the 'New profile' button.</para>
23984
23985           <screenshot>
23986             <screeninfo>Modify CSV Profiles</screeninfo>
23987
23988             <mediaobject>
23989               <imageobject>
23990                 <imagedata fileref="images/tools/csvprofiles/modifycsv.png"/>
23991               </imageobject>
23992             </mediaobject>
23993           </screenshot>
23994
23995           <itemizedlist>
23996             <listitem>
23997               <para>Choose the profile you would like to edit and alter the necessary fields.</para>
23998             </listitem>
23999             <listitem>
24000               <para>After submitting your changes you will be presented with a confirmation message
24001                 at the top of the screen</para>
24002               <screenshot>
24003                   <screeninfo>Confirmation of CSV modification</screeninfo>
24004                   <mediaobject>
24005                     <imageobject>
24006                       <imagedata fileref="images/tools/csvprofiles/csvmodified.png"/>
24007                     </imageobject>
24008                   </mediaobject>
24009                 </screenshot>
24010             </listitem>
24011
24012             <listitem>
24013               <para>To delete a profile, check the 'Delete selected profile'
24014               option before clicking 'Submit Query'</para>
24015
24016               <screenshot>
24017                 <screeninfo>Delete an existing CSV Profile</screeninfo>
24018
24019                 <mediaobject>
24020                   <imageobject>
24021                     <imagedata fileref="images/tools/csvprofiles/deletecsv.png"/>
24022                   </imageobject>
24023                 </mediaobject>
24024               </screenshot>
24025             </listitem>
24026           </itemizedlist>
24027         </section>
24028
24029         <section id="usecsvprofiles">
24030           <title>Using CSV Profiles</title>
24031
24032           <para>Your CSV Profiles will appear on the export list or cart menu under the 'Download'
24033             button in both the staff client and the OPAC</para>
24034
24035           <screenshot>
24036             <screeninfo>CSV Profiles on Download Menu in the Staff Client</screeninfo>
24037
24038             <mediaobject>
24039               <imageobject>
24040                 <imagedata fileref="images/tools/csvprofiles/exportlist.png"/>
24041               </imageobject>
24042             </mediaobject>
24043           </screenshot>
24044         </section>
24045       </section>
24046
24047       <section id="logviewer">
24048         <title>Log Viewer</title>
24049
24050         <itemizedlist>
24051           <listitem>
24052             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt;
24053             Additional Tools &gt; Log Viewer</para>
24054           </listitem>
24055         </itemizedlist>
24056
24057         <para>Actions within the Koha system are tracked in log files. Your
24058         <link linkend="logs">system preferences</link> can be changed to
24059         prevent the logging of different actions. These logs can be viewed
24060         using the Log Viewer Tool.</para>
24061
24062         <screenshot>
24063           <screeninfo>Log Viewer</screeninfo>
24064
24065           <mediaobject>
24066             <imageobject>
24067               <imagedata fileref="images/tools/logs/logviewer.png"/>
24068             </imageobject>
24069           </mediaobject>
24070         </screenshot>
24071
24072         <para>Choosing different combinations of menu options will produce the
24073         log file for that query.</para>
24074
24075         <screenshot>
24076           <screeninfo>A query for all logs related to the Circulation module
24077           produces a result like this</screeninfo>
24078
24079           <mediaobject>
24080             <imageobject>
24081               <imagedata fileref="images/tools/logs/logresults.png"/>
24082             </imageobject>
24083           </mediaobject>
24084         </screenshot>
24085
24086         <para>You will note that real names do not appear on the log, only
24087         identifying numbers. You need to use the identifying numbers when
24088         searching the logs as well.</para>
24089       </section>
24090
24091       <section id="newstool">
24092         <title>News</title>
24093
24094         <itemizedlist>
24095           <listitem>
24096             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt;
24097             Additional Tools &gt; News</para>
24098           </listitem>
24099         </itemizedlist>
24100
24101         <para>Koha's news module allows librarians to post news to the OPAC,
24102         staff interface and circulation receipts.</para>
24103
24104         <screenshot>
24105           <screeninfo>Koha News Module</screeninfo>
24106
24107           <mediaobject>
24108             <imageobject>
24109               <imagedata fileref="images/tools/news/news.png"/>
24110             </imageobject>
24111           </mediaobject>
24112         </screenshot>
24113
24114         <para>To add news to either the OPAC, the Staff Client or a
24115         Circulation receipt:</para>
24116
24117         <itemizedlist>
24118           <listitem>
24119             <para>Click 'New Entry'</para>
24120
24121             <screenshot>
24122               <screeninfo>Add Koha News Form</screeninfo>
24123
24124               <mediaobject>
24125                 <imageobject>
24126                   <imagedata fileref="images/tools/news/addnews.png"/>
24127                 </imageobject>
24128               </mediaobject>
24129             </screenshot>
24130
24131             <itemizedlist>
24132               <listitem>
24133                 <para>Under 'Display Location' choose whether to put the news on the OPAC, Slip
24134                   (circulation receipt) or the Librarian (Staff) Interface.<screenshot>
24135                     <screeninfo>Display location</screeninfo>
24136                     <mediaobject>
24137                       <imageobject>
24138                         <imagedata fileref="images/tools/news/displaylocation.png"/>
24139                       </imageobject>
24140                     </mediaobject>
24141                   </screenshot></para>
24142               </listitem>
24143
24144               <listitem>
24145                 <para>Choose the library this news item will show for</para>
24146               </listitem>
24147               <listitem>
24148                 <para>Choose a title for your entry</para>
24149               </listitem>
24150
24151               <listitem>
24152                 <para>Using the publication and expiration date fields you can
24153                 control how long your item appears</para>
24154               </listitem>
24155
24156               <listitem>
24157                 <para>'Appear in position' lets you decide what order your
24158                 news items appear in</para>
24159               </listitem>
24160
24161               <listitem>
24162                 <para>The 'News' box allows for the use of HTML for formatting
24163                 of your news item</para>
24164               </listitem>
24165             </itemizedlist>
24166           </listitem>
24167
24168           <listitem>
24169             <para>After filling in all of the fields, click 'Submit'</para>
24170           </listitem>
24171
24172           <listitem>
24173             <para>News in the OPAC will appear above the <link linkend="OpacMainUserBlock">OpacMainUserBlock</link></para>
24174
24175             <screenshot>
24176               <screeninfo>News in the OPAC</screeninfo>
24177
24178               <mediaobject>
24179                 <imageobject>
24180                   <imagedata fileref="images/tools/news/opacnews.png"/>
24181                 </imageobject>
24182               </mediaobject>
24183             </screenshot>
24184           </listitem>
24185
24186           <listitem>
24187             <para>News in the Staff Client will appear on the far left of the
24188             screen</para>
24189
24190             <screenshot>
24191               <screeninfo>News in the Staff Client</screeninfo>
24192
24193               <mediaobject>
24194                 <imageobject>
24195                   <imagedata fileref="images/tools/news/librariannews.png"/>
24196                 </imageobject>
24197               </mediaobject>
24198             </screenshot>
24199           </listitem>
24200
24201           <listitem>
24202             <para>News on the circulation receipts will appear below the items
24203             that are checked out</para>
24204
24205             <screenshot>
24206               <screeninfo>News at the bottom of the circulation
24207               receipt</screeninfo>
24208
24209               <mediaobject>
24210                 <imageobject>
24211                   <imagedata fileref="images/tools/news/slipnews.png"/>
24212                 </imageobject>
24213               </mediaobject>
24214             </screenshot>
24215           </listitem>
24216         </itemizedlist>
24217       </section>
24218
24219       <section id="taskscheduler">
24220         <title>Task Scheduler</title>
24221
24222         <itemizedlist>
24223           <listitem>
24224             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt;
24225             Additional Tools &gt; Task Scheduler</para>
24226           </listitem>
24227         </itemizedlist>
24228
24229         <para>The task scheduler is a way to schedule reports to run whenever
24230         you want.</para>
24231
24232         <para>To schedule a task, visit the Task Scheduler and fill in the
24233         form</para>
24234
24235         <screenshot>
24236           <screeninfo>Task Scheduler</screeninfo>
24237
24238           <mediaobject>
24239             <imageobject>
24240               <imagedata fileref="images/tools/tasksched/taskscheduler.png"/>
24241             </imageobject>
24242           </mediaobject>
24243         </screenshot>
24244
24245         <itemizedlist>
24246           <listitem>
24247             <para>Current Server Time shows the time on your server (schedule
24248             all of your reports to run based on that time - not on your local
24249             time)</para>
24250           </listitem>
24251
24252           <listitem>
24253             <para>Time should be entered as hh:mm (2 digit hour, 2 digit
24254             minute)</para>
24255           </listitem>
24256
24257           <listitem>
24258             <para>Date should be entered using the calendar pop up</para>
24259           </listitem>
24260
24261           <listitem>
24262             <para>From Report choose the report you want to schedule</para>
24263           </listitem>
24264
24265           <listitem>
24266             <para>Choose whether to receive the text of or a link to the
24267             results</para>
24268           </listitem>
24269
24270           <listitem>
24271             <para>In the Email filed enter the email of the person you want to
24272             receive your report</para>
24273           </listitem>
24274         </itemizedlist>
24275
24276         <para>Below the task scheduler form, there is a list of scheduled
24277         reports</para>
24278
24279         <screenshot>
24280           <screeninfo>Scheduled Tasks</screeninfo>
24281
24282           <mediaobject>
24283             <imageobject>
24284               <imagedata fileref="images/tools/tasksched/scheduledreports.png"/>
24285             </imageobject>
24286           </mediaobject>
24287         </screenshot>
24288
24289         <para>You can also schedule reports directly from the list of saved
24290         reports by clicking the 'Schedule' link</para>
24291
24292         <screenshot>
24293           <screeninfo>Saved Reports List</screeninfo>
24294
24295           <mediaobject>
24296             <imageobject>
24297               <imagedata fileref="images/tools/tasksched/savedreports.png"/>
24298             </imageobject>
24299           </mediaobject>
24300         </screenshot>
24301
24302         <section id="taskscedtroubleshoot">
24303           <title>Troubleshooting</title>
24304
24305           <para>Task scheduler will not work if the user the web server runs
24306           as doesn't have the permission to use it. To find out if the right
24307           user has the permissions necessary, check /etc/at.allow to see what
24308           users are in it. If you don't have that file, check etc/at.deny. If
24309           at.deny exists but is blank, then every user can use it. Talk to
24310           your system admin about adding the user to the right place to make
24311           the task scheduler work.</para>
24312         </section>
24313       </section>
24314
24315       <section id="QOTDEditor">
24316         <title>Quote of the Day (QOTD) Editor</title>
24317         <itemizedlist>
24318           <listitem>
24319             <para><emphasis>Get there:</emphasis> More &gt; Tools &gt; Additional Tools &gt; Edit
24320               quotes for QOTD feature</para>
24321           </listitem>
24322         </itemizedlist>
24323
24324         <para>This tool will allow you to add and edit quotes to show on the
24325         OPAC if you're using the Quote of the Day (QOTD) feature.</para>
24326
24327         <para>To turn this feature on set the <link linkend="QuoteOfTheDay">QuoteOfTheDay</link> preference to 'Enable and
24328         add at least one quote via the Quote of the Day Editor. Once these
24329         steps are complete you will see your quotes above the <link linkend="OpacMainUserBlock">OpacMainUserBlock</link> in the
24330         OPAC:</para>
24331
24332         <screenshot>
24333           <screeninfo>Quote in the OPAC</screeninfo>
24334
24335           <mediaobject>
24336             <imageobject>
24337               <imagedata fileref="images/tools/qotd/quoteinopac.png"/>
24338             </imageobject>
24339           </mediaobject>
24340         </screenshot>
24341
24342         <section id="addquote">
24343           <title>Add a Quote</title>
24344
24345           <para>To add a quote:</para>
24346
24347           <itemizedlist>
24348             <listitem>
24349               <para>Click the 'Add quote' button in the toolbar and an empty
24350               quote entry will be added to the end of the current quote
24351               list.</para>
24352
24353               <screenshot>
24354                 <screeninfo>Add quote button</screeninfo>
24355
24356                 <mediaobject>
24357                   <imageobject>
24358                     <imagedata fileref="images/tools/qotd/quotebuttons.png"/>
24359                   </imageobject>
24360                 </mediaobject>
24361               </screenshot>
24362
24363               <itemizedlist>
24364                 <listitem>
24365                   <important>
24366                     <para>Both the 'Source' and the 'Text' fields must be
24367                     filled in in order to save the new quote.</para>
24368
24369                     <screenshot>
24370                       <screeninfo>Add quote</screeninfo>
24371
24372                       <mediaobject>
24373                         <imageobject>
24374                           <imagedata fileref="images/tools/qotd/addquote.png"/>
24375                         </imageobject>
24376                       </mediaobject>
24377                     </screenshot>
24378                   </important>
24379                 </listitem>
24380               </itemizedlist>
24381             </listitem>
24382
24383             <listitem>
24384               <para>When finished filling in both fields, press the
24385               &lt;Enter&gt; key on your keyboard to save the new quote.</para>
24386             </listitem>
24387
24388             <listitem>
24389               <para>The list will update and the new quote should now be
24390               visible in the list.</para>
24391             </listitem>
24392           </itemizedlist>
24393
24394           <note>
24395             <para>You may cancel the addition of a new quote any time prior to
24396             saving it simply by pressing the &lt;Esc&gt; key on your
24397             keyboard.</para>
24398           </note>
24399         </section>
24400
24401         <section id="editquote">
24402           <title>Edit/Delete a Quote</title>
24403
24404           <para>Once the current quote pool has been loaded into the editing
24405           table, you may edit the quote source and text.</para>
24406
24407           <itemizedlist>
24408             <listitem>
24409               <para>Edit either the 'Source' or 'Text' fields by clicking on
24410               the desired field.</para>
24411
24412               <screenshot>
24413                 <screeninfo>Edit quote</screeninfo>
24414
24415                 <mediaobject>
24416                   <imageobject>
24417                     <imagedata fileref="images/tools/qotd/editquote.png"/>
24418                   </imageobject>
24419                 </mediaobject>
24420               </screenshot>
24421             </listitem>
24422
24423             <listitem>
24424               <para>When you are finished editing a field, press the
24425               &lt;Enter&gt; key on your keyboard to save the changes.</para>
24426             </listitem>
24427           </itemizedlist>
24428
24429           <para>The list will be updated, the edits saved, and visible.</para>
24430
24431           <para>If you'd like you can also delete quote(s).</para>
24432
24433           <itemizedlist>
24434             <listitem>
24435               <para>Select the quote(s) you desire to delete by clicking on
24436               the corresponding quote id.</para>
24437             </listitem>
24438
24439             <listitem>
24440               <para>Once quote selection is finished, simply click the 'Delete
24441               quote(s)' button.</para>
24442             </listitem>
24443
24444             <listitem>
24445               <para>You will be prompted to confirm the deletion.</para>
24446             </listitem>
24447
24448             <listitem>
24449               <para>After confirming the deletion, the list will update and
24450               the quote(s) will no longer appear.</para>
24451             </listitem>
24452           </itemizedlist>
24453         </section>
24454
24455         <section id="importquote">
24456           <title>Import Quotes</title>
24457
24458           <para>If you'd like you can import a batch of quotes as a CSV file.
24459           Your file must contain two columns in the form: "source","text" with
24460           no header row.</para>
24461
24462           <note>
24463             <para>You will be prompted to confirm upload of files larger than
24464             512KB.</para>
24465           </note>
24466
24467           <itemizedlist>
24468             <listitem>
24469               <para>To start the import process click the 'Import quotes'
24470               button at the top of the screen</para>
24471
24472               <screenshot>
24473                 <screeninfo>Import quotes button</screeninfo>
24474
24475                 <mediaobject>
24476                   <imageobject>
24477                     <imagedata fileref="images/tools/qotd/quotebuttons.png"/>
24478                   </imageobject>
24479                 </mediaobject>
24480               </screenshot>
24481             </listitem>
24482
24483             <listitem>
24484               <para>Once on the import quotes screen you can browse your
24485               computer for the file you would like to import</para>
24486
24487               <screenshot>
24488                 <screeninfo>Import quotes</screeninfo>
24489
24490                 <mediaobject>
24491                   <imageobject>
24492                     <imagedata fileref="images/tools/qotd/importquotes.png"/>
24493                   </imageobject>
24494                 </mediaobject>
24495               </screenshot>
24496             </listitem>
24497
24498             <listitem>
24499               <para>After selecting the CSV file, click the 'Open' button and
24500               the file will be uploaded into a temporary editing table.</para>
24501
24502               <screenshot>
24503                 <screeninfo>Imported quotes</screeninfo>
24504
24505                 <mediaobject>
24506                   <imageobject>
24507                     <imagedata fileref="images/tools/qotd/importedsummary.png"/>
24508                   </imageobject>
24509                 </mediaobject>
24510               </screenshot>
24511             </listitem>
24512
24513             <listitem>
24514               <para>From the listing you can edit either the 'Source' or
24515               'Text' fields by clicking on the desired field. When you are
24516               finished editing a field, press the &lt;Enter&gt; key on your
24517               keyboard to save the changes.</para>
24518
24519               <screenshot>
24520                 <screeninfo>Edit imported quote</screeninfo>
24521
24522                 <mediaobject>
24523                   <imageobject>
24524                     <imagedata fileref="images/tools/qotd/editimported.png"/>
24525                   </imageobject>
24526                 </mediaobject>
24527               </screenshot>
24528             </listitem>
24529
24530             <listitem>
24531               <para>You can also delete quotes from this listing before
24532               completing the import.</para>
24533
24534               <itemizedlist>
24535                 <listitem>
24536                   <para>Select the quote(s) you desire to delete by clicking
24537                   on the corresponding quote id.</para>
24538
24539                   <screenshot>
24540                     <screeninfo>Selected for deletion</screeninfo>
24541
24542                     <mediaobject>
24543                       <imageobject>
24544                         <imagedata fileref="images/tools/qotd/selectfordelete.png"/>
24545                       </imageobject>
24546                     </mediaobject>
24547                   </screenshot>
24548                 </listitem>
24549
24550                 <listitem>
24551                   <para>Once quote selection is finished, simply click the
24552                   'Delete quote(s)' key.</para>
24553
24554                   <screenshot>
24555                     <screeninfo>Delete quote(s)</screeninfo>
24556
24557                     <mediaobject>
24558                       <imageobject>
24559                         <imagedata fileref="images/tools/qotd/importquotebuttons.png"/>
24560                       </imageobject>
24561                     </mediaobject>
24562                   </screenshot>
24563                 </listitem>
24564
24565                 <listitem>
24566                   <para>You will be prompted to confirm the deletion.</para>
24567
24568                   <screenshot>
24569                     <screeninfo>Confirm deletion</screeninfo>
24570
24571                     <mediaobject>
24572                       <imageobject>
24573                         <imagedata fileref="images/tools/qotd/confirmdelete.png"/>
24574                       </imageobject>
24575                     </mediaobject>
24576                   </screenshot>
24577                 </listitem>
24578
24579                 <listitem>
24580                   <para>After confirming the deletion, the list will update
24581                   and the quote(s) will no longer appear.</para>
24582                 </listitem>
24583               </itemizedlist>
24584             </listitem>
24585
24586             <listitem>
24587               <para>Once you are satisfied with the quotes, click the 'Save
24588               quotes' button in the toolbar at the top and the quotes will be
24589               saved.</para>
24590
24591               <screenshot>
24592                 <screeninfo>Save quotes button</screeninfo>
24593
24594                 <mediaobject>
24595                   <imageobject>
24596                     <imagedata fileref="images/tools/qotd/importquotebuttons.png"/>
24597                   </imageobject>
24598                 </mediaobject>
24599               </screenshot>
24600             </listitem>
24601           </itemizedlist>
24602         </section>
24603       </section>
24604     </section>
24605   </chapter>
24606
24607   <chapter id="patrons">
24608     <title>Patrons</title>
24609
24610     <para>Before importing and/or adding patrons be sure to set up your <link linkend="patcats">patron categories</link>.</para>
24611
24612     <section id="addnewpatron">
24613       <title>Add a new patron</title>
24614
24615       <para>Patrons are added by going to the 'Patrons' module.<itemizedlist>
24616           <listitem>
24617             <para><emphasis>Get there:</emphasis> Patrons</para>
24618           </listitem>
24619         </itemizedlist></para>
24620       <para>Once there you can add a new patron.</para>
24621
24622       <itemizedlist>
24623         <listitem>
24624           <para>Click 'New patron'</para>
24625
24626           <screenshot>
24627             <screeninfo>Choose patron type</screeninfo>
24628
24629             <mediaobject>
24630               <imageobject>
24631                 <imagedata fileref="images/patrons/newpatron.png"/>
24632               </imageobject>
24633             </mediaobject>
24634           </screenshot>
24635         </listitem>
24636
24637         <listitem>
24638           <para>The fields that appear on the patron add form can be
24639           controlled by editing the <link linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> system
24640           preference.</para>
24641         </listitem>
24642
24643         <listitem>
24644           <para>First enter the identifying information regarding your
24645           patron</para>
24646
24647           <screenshot>
24648             <screeninfo>Add Patron Form</screeninfo>
24649
24650             <mediaobject>
24651               <imageobject>
24652                 <imagedata fileref="images/patrons/addpatronform.png"/>
24653               </imageobject>
24654             </mediaobject>
24655           </screenshot>
24656
24657           <itemizedlist>
24658             <listitem>
24659               <para>Required fields are defined in the <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
24660               system preference</para>
24661             </listitem>
24662
24663             <listitem>
24664               <para>Salutation is populated by the <link linkend="BorrowersTitles">BorrowersTitles</link> system
24665               preference</para>
24666             </listitem>
24667           </itemizedlist>
24668         </listitem>
24669
24670         <listitem>
24671           <para>Next enter the contact information</para>
24672
24673           <screenshot>
24674             <screeninfo>Patron Contact Information</screeninfo>
24675
24676             <mediaobject>
24677               <imageobject>
24678                 <imagedata fileref="images/patrons/addcontact.png"/>
24679               </imageobject>
24680             </mediaobject>
24681           </screenshot>
24682
24683           <itemizedlist>
24684             <listitem>
24685               <para>For contact information, note that the primary phone and
24686               email addresses are the ones that appear on notices and slips
24687               printed during circulation (receipts, transfer slips and hold
24688               slips). The primary email is also the one that overdue notices
24689               and other messages go to.</para>
24690             </listitem>
24691           </itemizedlist>
24692         </listitem>
24693
24694         <listitem>
24695           <para>If this patron is a child, you will be asked to attach the
24696           child patron to an adult patron</para>
24697
24698           <screenshot>
24699             <screeninfo>Guarantor Linking</screeninfo>
24700
24701             <mediaobject>
24702               <imageobject>
24703                 <imagedata fileref="images/patrons/addGuarantor.png"/>
24704               </imageobject>
24705             </mediaobject>
24706           </screenshot>
24707
24708           <itemizedlist>
24709             <listitem>
24710               <para>Click 'Set to Patron' to search your system for an
24711               existing patron</para>
24712             </listitem>
24713
24714             <listitem>
24715               <para>If the Guarantor is not in the system, you can enter the
24716               first and last name in the fields available</para>
24717             </listitem>
24718
24719             <listitem>
24720               <para>The relationships are set using the <link linkend="borrowerRelationship">borrowerRelationship</link>
24721               system preference</para>
24722             </listitem>
24723           </itemizedlist>
24724         </listitem>
24725
24726         <listitem>
24727           <para>If this patron is a professional, you will be asked to attach
24728           the patron to an organizational patron</para>
24729
24730           <screenshot>
24731             <screeninfo>Organization Linking</screeninfo>
24732
24733             <mediaobject>
24734               <imageobject>
24735                 <imagedata fileref="images/patrons/addOrg.png"/>
24736               </imageobject>
24737             </mediaobject>
24738           </screenshot>
24739
24740           <itemizedlist>
24741             <listitem>
24742               <para>Click 'Set to Patron to search your system for an existing
24743               patron</para>
24744             </listitem>
24745           </itemizedlist>
24746         </listitem>
24747
24748         <listitem>
24749           <para>Each patron can have an alternate contact</para>
24750
24751           <screenshot>
24752             <screeninfo>Alternate Contact</screeninfo>
24753
24754             <mediaobject>
24755               <imageobject>
24756                 <imagedata fileref="images/patrons/addaltcontact.png"/>
24757               </imageobject>
24758             </mediaobject>
24759           </screenshot>
24760
24761           <itemizedlist>
24762             <listitem>
24763               <para>An alternate contact could be a parent or guardian. It can
24764               also be used in academic settings to store the patron's home
24765               address.</para>
24766             </listitem>
24767           </itemizedlist>
24768         </listitem>
24769
24770         <listitem>
24771           <para>The library management section includes values that are used
24772           within the library</para>
24773
24774           <screenshot>
24775             <screeninfo>Library Management</screeninfo>
24776
24777             <mediaobject>
24778               <imageobject>
24779                 <imagedata fileref="images/patrons/addlibmanagement.png"/>
24780               </imageobject>
24781             </mediaobject>
24782           </screenshot>
24783
24784           <itemizedlist>
24785             <listitem>
24786               <para>The card number field is automatically calculated if you
24787               have the <link linkend="autoMemberNum">autoMemberNum</link>
24788               system preference set that way</para>
24789
24790               <itemizedlist>
24791                 <listitem>
24792                   <note>
24793                     <para>For a newly installed system this preference will
24794                     start at 1 and increment by 1 each time after. To have it
24795                     start with the starting number of your barcodes, enter the
24796                     first barcode by hand in the patron record and save the
24797                     patron. After that the field will increment that number by
24798                     1.</para>
24799                   </note>
24800                 </listitem>
24801               </itemizedlist>
24802             </listitem>
24803
24804             <listitem>
24805               <para>If you accidentally chose the wrong patron category at the
24806               beginning you can fix that here</para>
24807             </listitem>
24808
24809             <listitem>
24810               <para>Sort 1 and 2 are used for statistical purposes within your
24811               library</para>
24812             </listitem>
24813           </itemizedlist>
24814         </listitem>
24815
24816         <listitem>
24817           <para>Next, the Library Setup section includes additional library
24818           settings</para>
24819
24820           <screenshot>
24821             <screeninfo>Library set-up options</screeninfo>
24822
24823             <mediaobject>
24824               <imageobject>
24825                 <imagedata fileref="images/patrons/addlibsetup.png"/>
24826               </imageobject>
24827             </mediaobject>
24828           </screenshot>
24829
24830           <itemizedlist>
24831             <listitem>
24832               <para>The registration date will automatically be filled in with
24833               today's date</para>
24834             </listitem>
24835
24836             <listitem>
24837               <para>If your patron cards expire (based on your <link linkend="patcats">patron category settings</link>) the Expiry
24838               date will automatically be calculated</para>
24839             </listitem>
24840
24841             <listitem>
24842               <para>The OPAC Note is a note for the patron - it will appear in
24843               the OPAC on the patron's record</para>
24844             </listitem>
24845
24846             <listitem>
24847               <para>The Circulation Note is meant solely for your library
24848               staff and will appear when the circulation staff goes to check
24849               an item out to the patron</para>
24850
24851               <screenshot>
24852                 <screeninfo>Sample Circulation Note</screeninfo>
24853
24854                 <mediaobject>
24855                   <imageobject>
24856                     <imagedata fileref="images/patrons/circnote.png"/>
24857                   </imageobject>
24858                 </mediaobject>
24859               </screenshot>
24860             </listitem>
24861
24862             <listitem>
24863               <para>The Staff/OPAC asks for the username and password to be
24864               used by the patron (and/or staff member) to log into their
24865               account in the OPAC and for staff to log in to the staff
24866               client.</para>
24867
24868               <itemizedlist>
24869                 <listitem>
24870                   <para>Staff will only be able to use this log in info to log
24871                   in to the staff client if they have the <link linkend="patronpermissions">necessary
24872                   permissions</link>.</para>
24873                 </listitem>
24874               </itemizedlist>
24875             </listitem>
24876           </itemizedlist>
24877         </listitem>
24878
24879         <listitem>
24880           <para>If you have set <link linkend="patronattributetypes">additional patron attributes</link>
24881           up, these will appear next</para>
24882
24883           <screenshot>
24884             <screeninfo>Additional Patron Attributes</screeninfo>
24885
24886             <mediaobject>
24887               <imageobject>
24888                 <imagedata fileref="images/patrons/addattributes.png"/>
24889               </imageobject>
24890             </mediaobject>
24891           </screenshot>
24892         </listitem>
24893
24894         <listitem>
24895           <para id="setpatronmessaging">Finally, if you have <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
24896           set to 'allow,' you can choose the messaging preferences for this
24897           patron.</para>
24898
24899           <screenshot>
24900             <screeninfo>Patron Messaging Settings</screeninfo>
24901
24902             <mediaobject>
24903               <imageobject>
24904                 <imagedata fileref="images/patrons/addpatronmsg.png"/>
24905               </imageobject>
24906             </mediaobject>
24907           </screenshot>
24908
24909           <itemizedlist>
24910             <listitem>
24911               <para>These notices are:</para>
24912               <itemizedlist>
24913                 <listitem>
24914                   <para>Advanced notice : A notice in advance of the patron's items being due (The
24915                     patron can choose the number of days in advance)</para>
24916                 </listitem>
24917                 <listitem>
24918                   <para>Item checkout : A notice that lists all the of the items the patron has just
24919                     checked out and/or renewed, this is an electronic form of the checkout
24920                     receipt</para>
24921                 </listitem>
24922                 <listitem>
24923                   <para>Hold filled : A notice when you have confirmed the hold is waiting for the
24924                     patron</para>
24925                 </listitem>
24926                 <listitem>
24927                   <para>Item due : A notice on the day and item is due back at the library</para>
24928                 </listitem>
24929                 <listitem>
24930                   <para>Item check-in : A notice that lists all the of the items the patron has just
24931                     checked in</para>
24932                 </listitem>
24933               </itemizedlist>
24934             </listitem>
24935             <listitem>
24936               <para>Patrons can choose to receive their notices as a digest by checking the 'Digest
24937                 only?' box along with the delivery method. A digest is a combination of all the
24938                 messages of that type (so all items due in 3 days in one email) in to one email
24939                 instead of multiple emails for each alert.</para>
24940             </listitem>
24941             <listitem>
24942               <important>
24943                 <para>These preferences will override any you set via the
24944                 <link linkend="addingpatroncat">patron
24945                 categories</link></para>
24946               </important>
24947             </listitem>
24948
24949             <listitem>
24950               <important>
24951                 <para>These preference can be altered by the patron via the
24952                 OPAC</para>
24953               </important>
24954             </listitem>
24955           </itemizedlist>
24956         </listitem>
24957
24958         <listitem>
24959           <para>Once finished, click 'Save'</para>
24960         </listitem>
24961       </itemizedlist>
24962
24963       <para>If the system suspects this patron is a duplicate of another it
24964       will warn you.</para>
24965
24966       <screenshot>
24967         <screeninfo>Patron Duplicate Suspected</screeninfo>
24968
24969         <mediaobject>
24970           <imageobject>
24971             <imagedata fileref="images/patrons/duplicatewarn.png"/>
24972           </imageobject>
24973         </mediaobject>
24974       </screenshot>
24975       <note>
24976         <para>A duplicate patron is detected if first and last names match and there is no date of
24977           birth populated or if first name, last name and date of birth fields are all populated. If
24978           two patrons have matching names, but one has a date of birth and the other does not they
24979           will not match as duplicates.</para>
24980       </note>
24981
24982       <para>If you have set a minimum or upper age limit on the patron
24983       category and are requiring that the birth date be filled in, Koha will
24984       warn you if the patron you're adding is too old or young for the patron
24985       category you have selected:</para>
24986
24987       <screenshot>
24988         <screeninfo>Patron age warning</screeninfo>
24989
24990         <mediaobject>
24991           <imageobject>
24992             <imagedata fileref="images/patrons/patronagelimit.png"/>
24993           </imageobject>
24994         </mediaobject>
24995       </screenshot>
24996     </section>
24997
24998     <section id="addstaffpatron">
24999       <title>Add a Staff Patron</title>
25000
25001       <para>All staff members must be entered into Koha as patrons of the
25002       'Staff' type. Follow the steps in <link linkend="addnewpatron">Add a
25003       Patron</link> to add a staff member. To give the staff member
25004       permissions to access the staff client, follow the steps in <link linkend="patronpermissions">Patron Permissions</link></para>
25005
25006       <important>
25007         <para>Remember to assign your staff secure usernames and passwords
25008         since these will be used to log into the staff client.</para>
25009       </important>
25010     </section>
25011
25012     <section id="addstatspatron">
25013       <title>Add a Statistical Patron</title>
25014
25015       <para>One way to track use of in house items is to "check out" the
25016       materials to a statistical patron. The "check out" process doesn's check
25017       the book out, but instead tracks an in house use of the item. To use
25018       this method for tracking in house use you first will need a <link linkend="patcats">patron category</link> set up for your Statistical
25019       patron.</para>
25020
25021       <screenshot>
25022         <screeninfo>In House Patron Category</screeninfo>
25023
25024         <mediaobject>
25025           <imageobject>
25026             <imagedata fileref="images/patrons/statspatcat.png"/>
25027           </imageobject>
25028         </mediaobject>
25029       </screenshot>
25030
25031       <para>Next, you will need to create a new patron of the statistical
25032       type</para>
25033
25034       <screenshot>
25035         <screeninfo>New In House Patron</screeninfo>
25036
25037         <mediaobject>
25038           <imageobject>
25039             <imagedata fileref="images/patrons/newinhouse.png"/>
25040           </imageobject>
25041         </mediaobject>
25042       </screenshot>
25043
25044       <para>Next, follow the steps put forth in the '<link linkend="addnewpatron">Add a new Patron</link>' section of this manual.
25045       Since this patron is not a real person, simply fill in the required
25046       fields, the correct library and nothing else.</para>
25047
25048       <para>To learn about other methods of tracking in house use visit the
25049       <link linkend="trackinhouse">Tracking inhouse use</link> section of this
25050       manual.</para>
25051     </section>
25052
25053     <section id="duplicatepatron">
25054       <title>Duplicate a Patron</title>
25055
25056       <para>Sometimes when you're adding a new family to your system you don't
25057       want to type the contact information over and over. Koha allows for you
25058       to duplicate a patron and change only the parts you want to (or need to)
25059       change.</para>
25060
25061       <itemizedlist>
25062         <listitem>
25063           <para>Open the patron you want to use as your base (the patron you
25064           want to duplicate information from)</para>
25065         </listitem>
25066
25067         <listitem>
25068           <para>Click the 'Duplicate' button at the top of their record</para>
25069
25070           <screenshot>
25071             <screeninfo>The Duplicate Button is the 3rd one in</screeninfo>
25072
25073             <mediaobject>
25074               <imageobject>
25075                 <imagedata fileref="images/patrons/patronedit.png"/>
25076               </imageobject>
25077             </mediaobject>
25078           </screenshot>
25079         </listitem>
25080
25081         <listitem>
25082           <para>All of the fields with the exception of first name, card
25083           number, username and password have been duplicated. Fill in the
25084           missing pieces and click 'Save'</para>
25085
25086           <screenshot>
25087             <screeninfo>Duplicating Patron Form</screeninfo>
25088
25089             <mediaobject>
25090               <imageobject>
25091                 <imagedata fileref="images/patrons/duplicatedpatron.png"/>
25092               </imageobject>
25093             </mediaobject>
25094           </screenshot>
25095
25096           <itemizedlist>
25097             <listitem>
25098               <note>
25099                 <para>Clicking in a field that is already populated with data
25100                 will clear that field of all information (making it easier for
25101                 you to type in something different)</para>
25102               </note>
25103             </listitem>
25104           </itemizedlist>
25105         </listitem>
25106
25107         <listitem>
25108           <para>You will be brought to your new patron</para>
25109
25110           <screenshot>
25111             <screeninfo>Newly created patron</screeninfo>
25112
25113             <mediaobject>
25114               <imageobject>
25115                 <imagedata fileref="images/patrons/duplicatedpatronfinal.png"/>
25116               </imageobject>
25117             </mediaobject>
25118           </screenshot>
25119         </listitem>
25120       </itemizedlist>
25121     </section>
25122     <section id="addpatronimages">
25123       <title>Add Patron Images</title>
25124       <para>If you would like you can add patron images to help identify patrons.  To enable this
25125         feature you must first set the <link linkend="patronimages">patronimages</link> preference
25126         to 'Allow'.</para>
25127       <para>If the preference is set to 'Allow' you will see a placeholder image under the patron's
25128         name and box to upload a patron image below the basic contact information.</para>
25129       <screenshot>
25130           <screeninfo>Add patron image</screeninfo>
25131           <mediaobject>
25132             <imageobject>
25133               <imagedata fileref="images/patrons/addpatronimage.png"/>
25134             </imageobject>
25135           </mediaobject>
25136         </screenshot>
25137       <para>In the 'Upload Patron Image' box click 'Browse' to find the image on your computer and
25138         'Upload' to load the image on to the patron record.</para>
25139       <screenshot>
25140           <screeninfo>Patron image</screeninfo>
25141           <mediaobject>
25142             <imageobject>
25143               <imagedata fileref="images/patrons/patronimage.png"/>
25144             </imageobject>
25145           </mediaobject>
25146         </screenshot>
25147       <para>
25148         <important>
25149           <para>There is a limit of 100K on the size of the picture uploaded and it is recommended
25150             that the image be 200x300 pixels, but smaller images will work as well.</para>
25151         </important>
25152       </para>
25153     </section>
25154
25155     <section id="editpatrons">
25156       <title>Editing Patrons</title>
25157
25158       <para>Patrons in Koha can be edited using one of many edit
25159       buttons.</para>
25160
25161       <itemizedlist>
25162         <listitem>
25163           <para>To edit the entire patron record simply click the 'Edit'
25164           button at the top of the patron record.</para>
25165
25166           <screenshot>
25167             <screeninfo>Main Patron Edit Menu</screeninfo>
25168
25169             <mediaobject>
25170               <imageobject>
25171                 <imagedata fileref="images/patrons/patronedit.png"/>
25172               </imageobject>
25173             </mediaobject>
25174           </screenshot>
25175         </listitem>
25176
25177         <listitem>
25178           <para>Patron passwords are not recoverable. The stars show on the
25179           patron detail next to the Password label are always there even if a
25180           password isn't set. If a patron forgets their password the only
25181           option is to reset their password. To change the patron's password,
25182           click the 'Change Password' button</para>
25183
25184           <screenshot>
25185             <screeninfo>Patron Password Change Form</screeninfo>
25186
25187             <mediaobject>
25188               <imageobject>
25189                 <imagedata fileref="images/patrons/patronpassword.png"/>
25190               </imageobject>
25191             </mediaobject>
25192           </screenshot>
25193
25194           <itemizedlist>
25195             <listitem>
25196               <para>Koha cannot display existing passwords. Leave the field
25197               blank to leave password unchanged.</para>
25198             </listitem>
25199
25200             <listitem>
25201               <para>This form can automatically generate a random password if
25202               you click the link labeled "Click to fill with a randomly
25203               generated suggestion. Passwords will be displayed as
25204               text."</para>
25205             </listitem>
25206           </itemizedlist>
25207         </listitem>
25208
25209         <listitem>
25210           <para>To edit a specific section of the patron record (for example
25211           the Library Use section) click the 'Edit' link below the
25212           section</para>
25213
25214           <screenshot>
25215             <screeninfo>Library Use Section of Patron Record</screeninfo>
25216
25217             <mediaobject>
25218               <imageobject>
25219                 <imagedata fileref="images/patrons/patroneditsection.png"/>
25220               </imageobject>
25221             </mediaobject>
25222           </screenshot>
25223         </listitem>
25224
25225         <listitem>
25226           <para>A patron image can be added by browsing for the image on your
25227           machine from the 'Manage Patron Image' section</para>
25228
25229           <screenshot>
25230             <screeninfo>Manage Patron Image Form</screeninfo>
25231
25232             <mediaobject>
25233               <imageobject>
25234                 <imagedata fileref="images/patrons/patronaddimage.png"/>
25235               </imageobject>
25236             </mediaobject>
25237           </screenshot>
25238
25239           <itemizedlist>
25240             <listitem>
25241               <para>This form will not appear if you have the <link linkend="patronimages">patronimages</link> system preference to
25242               not allow patron images</para>
25243             </listitem>
25244
25245             <listitem>
25246               <para>To add patron images in bulk, use the <link linkend="uploadpatronimages">Upload Patron Images</link>
25247               Tool</para>
25248             </listitem>
25249           </itemizedlist>
25250         </listitem>
25251
25252         <listitem>
25253           <para id="patronflags">Patrons can also be blocked from checking
25254           items out by setting Patron Flags</para>
25255
25256           <screenshot>
25257             <screeninfo>Patron Warning Flags</screeninfo>
25258
25259             <mediaobject>
25260               <imageobject>
25261                 <imagedata fileref="images/patrons/patronflags.png"/>
25262               </imageobject>
25263             </mediaobject>
25264           </screenshot>
25265
25266           <itemizedlist>
25267             <listitem>
25268               <para>If you would like your circulation staff to confirm a
25269               patron's address before checking items out to the patron, you
25270               can see the 'Gone no Address' flag</para>
25271
25272               <screenshot>
25273                 <screeninfo>Patron's address in doubt</screeninfo>
25274
25275                 <mediaobject>
25276                   <imageobject>
25277                     <imagedata fileref="images/patrons/patronaddress.png"/>
25278                   </imageobject>
25279                 </mediaobject>
25280               </screenshot>
25281             </listitem>
25282             <listitem>
25283               <para>If the patron reports that they have lost their card you can set the 'Lost Card'
25284                 flag to prevent someone else from using that card to check items out</para>
25285               <screenshot>
25286                 <screeninfo>Patron lost card</screeninfo>
25287                 <mediaobject>
25288                   <imageobject>
25289                     <imagedata fileref="images/patrons/patroncardlost.png"/>
25290                   </imageobject>
25291                 </mediaobject>
25292               </screenshot>
25293             </listitem>
25294
25295             <listitem>
25296               <para>If you would like to bar a patron from the library you can add a manual
25297                 restriction</para>
25298               <screenshot>
25299                 <screeninfo>Add manual restriction</screeninfo>
25300                 <mediaobject>
25301                   <imageobject>
25302                     <imagedata fileref="images/patrons/addpatronrestriction.png"/>
25303                   </imageobject>
25304                 </mediaobject>
25305               </screenshot>
25306
25307               <itemizedlist>
25308                 <listitem>
25309                   <note><para>This flag can automatically be set with the <link linkend="noticetriggers">Overdue/Notice Status
25310                   Triggers</link></para></note>
25311                 </listitem>
25312               </itemizedlist>
25313             </listitem>
25314
25315             <listitem>
25316               <para>If you enter in a date and/or note related to the
25317               restriction you will see that in the restricted message as
25318               well</para>
25319
25320               <screenshot>
25321                 <screeninfo>Restricted until message</screeninfo>
25322
25323                 <mediaobject>
25324                   <imageobject>
25325                     <imagedata fileref="images/patrons/restricteduntil.png"/>
25326                   </imageobject>
25327                 </mediaobject>
25328               </screenshot>
25329             </listitem>
25330           </itemizedlist>
25331         </listitem>
25332
25333         <listitem>
25334           <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
25335             to and adult patron category manually go to the 'More' menu and choose 'Update Child to
25336             Adult Patron'</para>
25337
25338           <screenshot>
25339             <screeninfo>Update Child to Adult Patron</screeninfo>
25340
25341             <mediaobject>
25342               <imageobject>
25343                 <imagedata fileref="images/patrons/updatetoadult.png"/>
25344               </imageobject>
25345             </mediaobject>
25346           </screenshot>
25347
25348           <itemizedlist>
25349             <listitem>
25350               <para>You will then be presented with a pop up window asking
25351               which one of your adult patron categories this Child should be
25352               updated to</para>
25353
25354               <screenshot>
25355                 <screeninfo>Choose Adult Category to Update To</screeninfo>
25356
25357                 <mediaobject>
25358                   <imageobject>
25359                     <imagedata fileref="images/patrons/choosadulttype.png"/>
25360                   </imageobject>
25361                 </mediaobject>
25362               </screenshot>
25363             </listitem>
25364           </itemizedlist>
25365         </listitem>
25366       </itemizedlist>
25367     </section>
25368     <section id="mangepatronedits">
25369       <title>Managing Patron Self Edits</title>
25370       <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
25371         approve all changes via the staff client before they're applied. If there are patron edits
25372         awaiting action they will appear on the staff client dashboard below the modules list (along
25373         with other items awaiting action).</para>
25374       <screenshot>
25375           <screeninfo>Patron requests waiting</screeninfo>
25376           <mediaobject>
25377             <imageobject>
25378               <imagedata fileref="images/patrons/pendingpatronrequest.png"/>
25379             </imageobject>
25380           </mediaobject>
25381         </screenshot>
25382       <para>When you click the 'Patrons requesting modifications' link you will be brought to a list
25383         of patrons with requested changes.</para>
25384       <screenshot>
25385           <screeninfo>Manage patron updates</screeninfo>
25386           <mediaobject>
25387             <imageobject>
25388               <imagedata fileref="images/patrons/managepatronupdates.png"/>
25389             </imageobject>
25390           </mediaobject>
25391         </screenshot>
25392       <para>From here you can 'Approve' and apply the changes to the patron record, 'Delete' and
25393         remove the changes or 'Ignore' and keep the changes pending to review later.</para>
25394     </section>
25395
25396     <section id="patronpermissions">
25397       <title>Patron Permissions</title>
25398
25399       <para>Patron Permissions are used to allow staff members access to the
25400       staff client.</para>
25401
25402       <important>
25403         <para>In order for a staff member to log into the staff interface they
25404         must have (at the very least) 'catalogue' permissions which allow them
25405         to view the staff interface.</para>
25406       </important>
25407
25408       <section id="setpatronperms">
25409         <title>Setting Patron Permissions</title>
25410
25411         <para>To set patron permissions, you must first <link linkend="addstaffpatron">have a patron of the 'Staff' type</link>
25412         open</para>
25413
25414         <itemizedlist>
25415           <listitem>
25416             <para>On the patron record click More and choose Set Permissions
25417             to alter patron permissions</para>
25418
25419             <screenshot>
25420               <screeninfo>Set Patron Permissions</screeninfo>
25421
25422               <mediaobject>
25423                 <imageobject>
25424                   <imagedata fileref="images/patrons/editpatronpermissions.png"/>
25425                 </imageobject>
25426               </mediaobject>
25427             </screenshot>
25428           </listitem>
25429
25430           <listitem>
25431             <para>You will be presented with a list of preferences, some of
25432             which can be expanded by clicking the plus sign to the left of the
25433             section title.</para>
25434
25435             <screenshot>
25436               <screeninfo>Patron Permissions</screeninfo>
25437
25438               <mediaobject>
25439                 <imageobject>
25440                   <imagedata fileref="images/patrons/GranularPermissions.png"/>
25441                 </imageobject>
25442               </mediaobject>
25443             </screenshot>
25444           </listitem>
25445         </itemizedlist>
25446       </section>
25447
25448       <section id="patronpermsdefined">
25449         <title>Patron Permissions Defined</title>
25450
25451         <para/>
25452
25453         <itemizedlist>
25454           <listitem>
25455             <para>superlibrarian</para>
25456
25457             <itemizedlist>
25458               <listitem>
25459                 <para>Access to all librarian functions</para>
25460
25461                 <itemizedlist>
25462                   <listitem>
25463                     <note>
25464                       <para>With this selected there is no need to choose any
25465                       other permissions</para>
25466                     </note>
25467                   </listitem>
25468                 </itemizedlist>
25469               </listitem>
25470             </itemizedlist>
25471           </listitem>
25472
25473           <listitem>
25474             <para>circulate</para>
25475
25476             <itemizedlist>
25477               <listitem>
25478                 <para>Check out and check in items</para>
25479               </listitem>
25480
25481               <listitem>
25482                 <para>This section can be expanded (<link linkend="circpermissions">Learn more</link>)</para>
25483               </listitem>
25484             </itemizedlist>
25485           </listitem>
25486
25487           <listitem>
25488             <para>catalogue</para>
25489
25490             <itemizedlist>
25491               <listitem>
25492                 <para><emphasis role="bold">Required for staff login.</emphasis> Staff access,
25493                   allows viewing the catalogue in staff client<itemizedlist>
25494                     <listitem>
25495                       <important>
25496                         <para>Must be given to all staff members to allow them to login to the staff
25497                           client</para>
25498                       </important>
25499                     </listitem>
25500                   </itemizedlist></para>
25501               </listitem>
25502             </itemizedlist>
25503           </listitem>
25504
25505           <listitem>
25506             <para>parameters</para>
25507
25508             <itemizedlist>
25509               <listitem>
25510                 <para>Manage Koha system systems (Administration panel)</para>
25511               </listitem>
25512
25513               <listitem>
25514                 <para>This section can be expanded (<link linkend="parameterpermissions">Learn
25515                     more</link>)</para>
25516               </listitem>
25517             </itemizedlist>
25518           </listitem>
25519
25520           <listitem>
25521             <para>borrowers</para>
25522
25523             <itemizedlist>
25524               <listitem>
25525                 <para>Add or modify patrons</para>
25526               </listitem>
25527             </itemizedlist>
25528           </listitem>
25529
25530           <listitem>
25531             <para>permissions</para>
25532
25533             <itemizedlist>
25534               <listitem>
25535                 <para>Set user permissions</para>
25536               </listitem>
25537             </itemizedlist>
25538           </listitem>
25539
25540           <listitem>
25541             <para>reserveforothers</para>
25542
25543             <itemizedlist>
25544               <listitem>
25545                 <para>Place and modify holds for patrons</para>
25546               </listitem>
25547
25548               <listitem>
25549                 <para>This section can be expanded (<link linkend="reservepermissions">Learn more</link>)</para>
25550               </listitem>
25551             </itemizedlist>
25552           </listitem>
25553
25554           <listitem>
25555             <para>borrow</para>
25556
25557             <itemizedlist>
25558               <listitem>
25559                 <para>Borrow books</para>
25560               </listitem>
25561             </itemizedlist>
25562           </listitem>
25563
25564           <listitem>
25565             <para>editcatalogue</para>
25566
25567             <itemizedlist>
25568               <listitem>
25569                 <para>Edit Catalog (Modify bibliographic/hodings data)</para>
25570               </listitem>
25571
25572               <listitem>
25573                 <para>This section can be expanded (<link linkend="catpermissions">Learn more</link>)</para>
25574               </listitem>
25575             </itemizedlist>
25576           </listitem>
25577
25578           <listitem>
25579             <para>updatecharges</para>
25580
25581             <itemizedlist>
25582               <listitem>
25583                 <para>Manage patrons fines and fees</para>
25584               </listitem>
25585               <listitem>
25586                 <para>This section can be expanded (<link linkend="updatechargespermissions">Learn
25587                     more</link>)</para>
25588               </listitem>
25589             </itemizedlist>
25590           </listitem>
25591
25592           <listitem>
25593             <para>acquisition</para>
25594
25595             <itemizedlist>
25596               <listitem>
25597                 <para>Acquisition and/or suggestion management</para>
25598               </listitem>
25599
25600               <listitem>
25601                 <para>This section can be expanded (<link linkend="acqpermissions">Learn more</link>)</para>
25602               </listitem>
25603             </itemizedlist>
25604           </listitem>
25605
25606           <listitem>
25607             <para>management</para>
25608
25609             <itemizedlist>
25610               <listitem>
25611                 <para>Set library management paraments (deprecated)<itemizedlist>
25612                     <listitem>
25613                       <important>
25614                         <para>This permission level no longer controls anything.</para>
25615                       </important>
25616                     </listitem>
25617                   </itemizedlist></para>
25618               </listitem>
25619             </itemizedlist>
25620           </listitem>
25621
25622           <listitem>
25623             <para>tools</para>
25624
25625             <itemizedlist>
25626               <listitem>
25627                 <para>Use all tools</para>
25628               </listitem>
25629
25630               <listitem>
25631                 <para>This section can be expanded (<link linkend="toolspermissions">Learn more</link>)</para>
25632               </listitem>
25633             </itemizedlist>
25634           </listitem>
25635
25636           <listitem>
25637             <para>editauthorities</para>
25638
25639             <itemizedlist>
25640               <listitem>
25641                 <para>Edit Authorities</para>
25642               </listitem>
25643             </itemizedlist>
25644           </listitem>
25645
25646           <listitem>
25647             <para>serials</para>
25648
25649             <itemizedlist>
25650               <listitem>
25651                 <para>Manage serial subscriptions</para>
25652               </listitem>
25653
25654               <listitem>
25655                 <para>This section can be expanded (<link linkend="serpermissions">Learn more</link>)</para>
25656               </listitem>
25657             </itemizedlist>
25658           </listitem>
25659
25660           <listitem>
25661             <para>reports</para>
25662
25663             <itemizedlist>
25664               <listitem>
25665                 <para>Allow access to the reports module</para>
25666               </listitem>
25667
25668               <listitem>
25669                 <para>Reports found on the Circulation page are not controlled
25670                 by this permission</para>
25671               </listitem>
25672
25673               <listitem>
25674                 <para>This section can be expanded (<link linkend="reportpermissions">Learn more</link>)</para>
25675               </listitem>
25676             </itemizedlist>
25677           </listitem>
25678
25679           <listitem>
25680             <para>staffaccess</para>
25681
25682             <itemizedlist>
25683               <listitem>
25684                 <para>Allow staff members to modify permissions for other staff members</para>
25685               </listitem>
25686
25687               <listitem>
25688                 <important>
25689                   <para>Requires the borrowers permission above</para>
25690                 </important>
25691               </listitem>
25692             </itemizedlist>
25693           </listitem>
25694           <listitem>
25695             <para>plugins<itemizedlist>
25696                 <listitem>
25697                   <para>Koha plugins</para>
25698                 </listitem>
25699                 <listitem>
25700                   <para>This section can be expanded (<link linkend="pluginpermissions">Learn
25701                       more</link>)</para>
25702                 </listitem>
25703               </itemizedlist></para>
25704           </listitem>
25705         </itemizedlist>
25706
25707         <section id="circpermissions">
25708           <title>Granular Circulate Permissions</title>
25709
25710           <para>If the staff member has 'circulate' permissions they have the
25711           ability to perform all of these actions. If you would like to
25712           control circulation permissions on a more granular level choose from
25713           these options:</para>
25714
25715           <itemizedlist>
25716             <listitem>
25717               <para>circulate_remaining_permissions</para>
25718
25719               <itemizedlist>
25720                 <listitem>
25721                   <para>Remaining circulation permissions</para>
25722                 </listitem>
25723                 <listitem>
25724                   <para>All circulation rights except those covered by permissions listed
25725                     below</para>
25726                 </listitem>
25727               </itemizedlist>
25728             </listitem>
25729             <listitem>
25730               <para>force_checkout<itemizedlist>
25731                   <listitem>
25732                     <para>Force checkout if a limitation exists</para>
25733                   </listitem>
25734                   <listitem>
25735                     <para>With this permission a librarian will be allowed to override a check out
25736                       restriction in the following cases: <itemizedlist>
25737                         <listitem>
25738                           <para>age restriction</para>
25739                         </listitem>
25740                         <listitem>
25741                           <para>the item is issued to another patron</para>
25742                         </listitem>
25743                         <listitem>
25744                           <para>the item is not for loan</para>
25745                         </listitem>
25746                         <listitem>
25747                           <para>the patron has overdue items</para>
25748                         </listitem>
25749                         <listitem>
25750                           <para>the item is lost </para>
25751                         </listitem>
25752                         <listitem>
25753                           <para>the item is a high demand item</para>
25754                         </listitem>
25755                         <listitem>
25756                           <para>the item is on hold</para>
25757                         </listitem>
25758                       </itemizedlist></para>
25759                   </listitem>
25760               </itemizedlist></para></listitem>
25761             <listitem><para>manage_restrictions<itemizedlist>
25762                   <listitem>
25763                     <para>Manage restrictions for accounts</para>
25764                   </listitem>
25765                   <listitem>
25766                     <para>Grants permission to the staff member to lift a restriction that might be
25767                       on the patron's record</para>
25768                   </listitem>
25769                 </itemizedlist></para>
25770             </listitem>
25771             <listitem>
25772               <para>overdues_report<itemizedlist>
25773                   <listitem>
25774                     <para> Execute overdue items report </para>
25775                   </listitem>
25776                   <listitem>
25777                     <para>The permission to run the overdues reports found under Circulation</para>
25778                   </listitem>
25779                 </itemizedlist></para>
25780             </listitem>
25781
25782             <listitem>
25783               <para>override_renewals</para>
25784
25785               <itemizedlist>
25786                 <listitem>
25787                   <para>Override blocked renewals</para>
25788                 </listitem>
25789
25790                 <listitem>
25791                   <para>Requires that the staff member also has
25792                   circulate_remaining_permissions</para>
25793                 </listitem>
25794               </itemizedlist>
25795             </listitem>
25796           </itemizedlist>
25797         </section>
25798
25799         <section id="parameterpermissions">
25800           <title>Granular Parameters Permissions</title>
25801
25802           <para>If the staff member has 'parameters' permissions they have the
25803           ability to perform all of these actions. If you would like to
25804           control parameter permissions on a more granular level choose from
25805           these options:</para>
25806
25807           <itemizedlist>
25808             <listitem>
25809               <para>manage_circ_rules</para>
25810
25811               <itemizedlist>
25812                 <listitem>
25813                   <para>Manage circulation rules</para>
25814                 </listitem>
25815                 <listitem>
25816                   <para>The ability to access the <link linkend="circfinerules">Circulation and
25817                       fines rules</link> in the administration area</para>
25818                 </listitem>
25819               </itemizedlist>
25820             </listitem>
25821
25822             <listitem>
25823               <para>parameters_remaining_permissions</para>
25824
25825               <itemizedlist>
25826                 <listitem>
25827                   <para>Remaining system parameters permissions</para>
25828                 </listitem>
25829                 <listitem>
25830                   <para>The ability to access all areas in Administration (other than the
25831                     Circulation and fine rules)</para>
25832                 </listitem>
25833               </itemizedlist>
25834             </listitem>
25835           </itemizedlist>
25836         </section>
25837
25838         <section id="reservepermissions">
25839           <title>Granular Holds Permissions</title>
25840
25841           <para>If the staff member has 'reserveforothers' permissions they
25842           have the ability to perform all of these actions. If you would like
25843           to control holds permissions on a more granular level choose from
25844           these options:</para>
25845
25846           <itemizedlist>
25847             <listitem>
25848               <para>modify_holds_priority</para>
25849
25850               <itemizedlist>
25851                 <listitem>
25852                   <para>Modify holds priority</para>
25853                 </listitem>
25854                 <listitem>
25855                   <para>Allow staff members to alter the holds priority (moving patrons up and down
25856                     the queue)</para>
25857                 </listitem>
25858               </itemizedlist>
25859             </listitem>
25860
25861             <listitem>
25862               <para>place_holds</para>
25863
25864               <itemizedlist>
25865                 <listitem>
25866                   <para>Place holds for patrons</para>
25867                 </listitem>
25868               </itemizedlist>
25869             </listitem>
25870           </itemizedlist>
25871         </section>
25872
25873         <section id="catpermissions">
25874           <title>Granular Cataloging Permissions</title>
25875
25876           <para>If the staff member has 'editcatalogue' permissions they have
25877           the ability to perform all of these actions. If you would like to
25878           control cataloging permissions on a more granular level choose from
25879           these options:</para>
25880
25881           <itemizedlist>
25882             <listitem>
25883               <para>delete_all_items<itemizedlist>
25884                   <listitem>
25885                     <para>Delete all items at once</para>
25886                   </listitem>
25887                   <listitem>
25888                     <para>Ability to use the 'Delete all items' option found under the 'Edit' menu
25889                       in cataloging</para>
25890                   </listitem>
25891                 </itemizedlist></para>
25892             </listitem>
25893             <listitem>
25894               <para>edit_catalogue</para>
25895
25896               <itemizedlist>
25897                 <listitem>
25898                   <para>Edit catalog (Modify bibliographic/holdings data)</para>
25899                 </listitem>
25900                 <listitem>
25901                   <para>Ability to access all cataloging functions via the <link linkend="cataloging">Cataloging</link> page</para>
25902                 </listitem>
25903               </itemizedlist>
25904             </listitem>
25905
25906             <listitem>
25907               <para>edit_items</para>
25908
25909               <itemizedlist>
25910                 <listitem>
25911                   <para>Edit items</para>
25912                 </listitem>
25913                 <listitem>
25914                   <para>Ability to make <link linkend="editingitems">edits to item/holdings
25915                       records</link>, but not bibliographic records</para>
25916                 </listitem>
25917               </itemizedlist>
25918             </listitem>
25919             <listitem id="edit_items_restricted">
25920               <para>edit_items_restricted<itemizedlist>
25921                   <listitem>
25922                     <para>Limit item modification to subfields defined in the <link
25923                         linkend="SubfieldsToAllowForRestrictedEditing"
25924                         >SubfieldsToAllowForRestrictedEditing</link> preference</para>
25925                   </listitem>
25926                   <listitem>
25927                     <para>
25928                       <note>
25929                         <para>Please note that edit_items permission is still required</para>
25930                       </note>
25931                     </para>
25932                   </listitem>
25933                 </itemizedlist></para>
25934             </listitem>
25935
25936             <listitem>
25937               <para id="fastaddpermissions">fast_cataloging</para>
25938
25939               <itemizedlist>
25940                 <listitem>
25941                   <para>Fast cataloging</para>
25942                 </listitem>
25943                 <listitem>
25944                   <para>The ability to catalog using only the <link linkend="fastaddcat">Fast Add
25945                       Framework</link> found on the <link linkend="circulation">Circulation</link>
25946                     page</para>
25947                 </listitem>
25948               </itemizedlist>
25949             </listitem>
25950           </itemizedlist>
25951         </section>
25952         <section id="updatechargespermissions">
25953           <title>Granular Fines and Charges Permissions</title>
25954           <para>If a staff member has 'updatecharges' permission they have the ability to perform
25955             all of these actions. If you would like to control fines and charges permissions on a
25956             more granular level choose from these options:<itemizedlist>
25957               <listitem>
25958                 <para>remaining_permissions<itemizedlist>
25959                     <listitem>
25960                       <para>Remaining permissions for managing fines and fees other than the ability
25961                         to write off charges</para>
25962                     </listitem>
25963                   </itemizedlist></para>
25964               </listitem>
25965               <listitem>
25966                 <para>writeoff<itemizedlist>
25967                     <listitem>
25968                       <para>Write off fines and fees</para>
25969                     </listitem>
25970                   </itemizedlist></para>
25971               </listitem>
25972             </itemizedlist></para>
25973         </section>
25974
25975         <section id="acqpermissions">
25976           <title>Granular Acquisitions Permissions</title>
25977
25978           <para>If the staff member has 'acquisition' permissions they have
25979           the ability to perform all of these actions. If you would like to
25980           control acquisitions permissions on a more granular level choose
25981           from these options:</para>
25982
25983           <itemizedlist>
25984             <listitem>
25985               <para>budget_add_del</para>
25986
25987               <itemizedlist>
25988                 <listitem>
25989                   <para>Add and delete budgets (but can't modify budgets)</para>
25990                 </listitem>
25991               </itemizedlist>
25992             </listitem>
25993
25994             <listitem>
25995               <para>budget_manage</para>
25996               <itemizedlist>
25997                 <listitem>
25998                   <para>Manage budgets</para>
25999                 </listitem>
26000               </itemizedlist>
26001             </listitem>
26002
26003             <listitem>
26004               <para>budget_manage_all <itemizedlist>
26005                   <listitem>
26006                     <para>Manage all budgets</para>
26007                   </listitem>
26008                 </itemizedlist></para>
26009               <para>budget_modify</para>
26010               <itemizedlist>
26011                 <listitem>
26012                   <para>Modify budget (can't create lines, but can modify existing ones)</para>
26013                 </listitem>
26014               </itemizedlist>
26015             </listitem>
26016
26017             <listitem>
26018               <para>contracts_manage</para>
26019
26020               <itemizedlist>
26021                 <listitem>
26022                   <para>Manage contracts</para>
26023                 </listitem>
26024               </itemizedlist>
26025             </listitem>
26026
26027             <listitem>
26028               <para>group_manage</para>
26029
26030               <itemizedlist>
26031                 <listitem>
26032                   <para>Manage orders and basket groups</para>
26033                 </listitem>
26034               </itemizedlist>
26035             </listitem>
26036
26037             <listitem>
26038               <para>order_manage</para>
26039
26040               <itemizedlist>
26041                 <listitem>
26042                   <para>Manage orders and baskets</para>
26043                 </listitem>
26044               </itemizedlist>
26045             </listitem>
26046             <listitem>
26047               <para>order_manage_all<itemizedlist>
26048                   <listitem>
26049                     <para>Manage all orders and baskets, regardless of restrictions on them</para>
26050                   </listitem>
26051                 </itemizedlist></para>
26052             </listitem>
26053
26054             <listitem>
26055               <para>order_receive</para>
26056
26057               <itemizedlist>
26058                 <listitem>
26059                   <para>Manage orders and baskets</para>
26060                 </listitem>
26061               </itemizedlist>
26062             </listitem>
26063
26064             <listitem>
26065               <para>period_manage</para>
26066
26067               <itemizedlist>
26068                 <listitem>
26069                   <para>Manage periods</para>
26070                 </listitem>
26071               </itemizedlist>
26072             </listitem>
26073
26074             <listitem>
26075               <para>planning_manage</para>
26076
26077               <itemizedlist>
26078                 <listitem>
26079                   <para>Manage budget planning</para>
26080                 </listitem>
26081               </itemizedlist>
26082             </listitem>
26083
26084             <listitem>
26085               <para>vendors_manage</para>
26086
26087               <itemizedlist>
26088                 <listitem>
26089                   <para>Manage vendors</para>
26090                 </listitem>
26091               </itemizedlist>
26092             </listitem>
26093           </itemizedlist>
26094         </section>
26095
26096         <section id="serpermissions">
26097           <title>Granular Serials Permissions</title>
26098
26099           <para>If the staff member has 'serials' permissions they have the
26100           ability to perform all of these actions. If you would like to
26101           control serials permissions on a more granular level choose from
26102           these options:</para>
26103
26104           <itemizedlist>
26105             <listitem>
26106               <para>check_expiration</para>
26107
26108               <itemizedlist>
26109                 <listitem>
26110                   <para>Check the <link linkend="serialexpiration">expiration of a
26111                     serial</link></para>
26112                 </listitem>
26113               </itemizedlist>
26114             </listitem>
26115
26116             <listitem>
26117               <para>claim_serials</para>
26118
26119               <itemizedlist>
26120                 <listitem>
26121                   <para>Claim missing serials via the <link linkend="serialclaims">Claims
26122                       section</link></para>
26123                 </listitem>
26124               </itemizedlist>
26125             </listitem>
26126
26127             <listitem>
26128               <para>create_subscription</para>
26129
26130               <itemizedlist>
26131                 <listitem>
26132                   <para>Create <link linkend="newsubscription">a new subscription</link></para>
26133                 </listitem>
26134               </itemizedlist>
26135             </listitem>
26136
26137             <listitem>
26138               <para>delete_subscription</para>
26139
26140               <itemizedlist>
26141                 <listitem>
26142                   <para>Delete an existing subscription</para>
26143                 </listitem>
26144               </itemizedlist>
26145             </listitem>
26146
26147             <listitem>
26148               <para>edit_subscription</para>
26149
26150               <itemizedlist>
26151                 <listitem>
26152                   <para>Edit an existing subscription</para>
26153                 </listitem>
26154                 <listitem>
26155                   <para>This permission does not include the ability to delete or create a
26156                     subscription</para>
26157                 </listitem>
26158               </itemizedlist>
26159             </listitem>
26160
26161             <listitem>
26162               <para>receive_serials</para>
26163
26164               <itemizedlist>
26165                 <listitem>
26166                   <para>Serials receiving</para>
26167                 </listitem>
26168                 <listitem>
26169                   <para>Receive serials on existing subscriptions</para>
26170                 </listitem>
26171               </itemizedlist>
26172             </listitem>
26173
26174             <listitem>
26175               <para>renew_subscription</para>
26176
26177               <itemizedlist>
26178                 <listitem>
26179                   <para>Renew a subscription</para>
26180                 </listitem>
26181               </itemizedlist>
26182             </listitem>
26183
26184             <listitem>
26185               <para>routing</para>
26186
26187               <itemizedlist>
26188                 <listitem>
26189                   <para>Routing</para>
26190                 </listitem>
26191                 <listitem>
26192                   <para>Manage <link linkend="routinglist">routing lists</link></para>
26193                 </listitem>
26194               </itemizedlist>
26195             </listitem>
26196             <listitem>
26197               <para>superserials<itemizedlist>
26198                   <listitem>
26199                     <para>Manage subscriptions from any branch (only applies when <link
26200                         linkend="IndependentBranches">IndependantBranches</link> is used)</para>
26201                   </listitem>
26202                 </itemizedlist></para>
26203             </listitem>
26204           </itemizedlist>
26205         </section>
26206
26207         <section id="toolspermissions">
26208           <title>Granular Tools Permissions</title>
26209
26210           <para>If the staff member has 'tools' permissions they have the
26211           ability to access and use all items under the Tools menu. If you
26212           would like to control which tools staff members have access to on a
26213           more granular level choose from these options:</para>
26214
26215           <itemizedlist>
26216             <listitem>
26217               <para>batch_upload_patron_images</para>
26218
26219               <itemizedlist>
26220                 <listitem>
26221                   <para>Upload patron images in batch or one at a time </para>
26222                 </listitem>
26223                 <listitem>
26224                   <para>Access to the <link linkend="uploadpatronimages">Image Upload
26225                     Tool</link></para>
26226                 </listitem>
26227               </itemizedlist>
26228             </listitem>
26229
26230             <listitem>
26231               <para>delete_anonymize_patrons</para>
26232
26233               <itemizedlist>
26234                 <listitem>
26235                   <para>Delete old borrowers and anonymize circulation/reading history (deletes
26236                     borrower reading history)</para>
26237                 </listitem>
26238                 <listitem>
26239                   <para>Access to the <link linkend="anonpatrons">Anonymize Patron
26240                     Tool</link></para>
26241                 </listitem>
26242               </itemizedlist>
26243             </listitem>
26244
26245             <listitem>
26246               <para>edit_calendar</para>
26247
26248               <itemizedlist>
26249                 <listitem>
26250                   <para>Define days when the library is closed </para>
26251                 </listitem>
26252                 <listitem>
26253                   <para>Access to the <link linkend="calholidays">Calendar/Holidays
26254                     Tool</link></para>
26255                 </listitem>
26256               </itemizedlist>
26257             </listitem>
26258
26259             <listitem>
26260               <para>edit_news</para>
26261
26262               <itemizedlist>
26263                 <listitem>
26264                   <para>Write news for the OPAC and staff interfaces </para>
26265                 </listitem>
26266                 <listitem>
26267                   <para>Access to the <link linkend="newstool">News Tool</link></para>
26268                 </listitem>
26269               </itemizedlist>
26270             </listitem>
26271
26272             <listitem>
26273               <para>edit_notice_status_triggers</para>
26274
26275               <itemizedlist>
26276                 <listitem>
26277                   <para>Set notice/status triggers for overdue items </para>
26278                 </listitem>
26279                 <listitem>
26280                   <para>Access to the <link linkend="noticetriggers">Overdue Notice Status/Triggers
26281                       Tool</link></para>
26282                 </listitem>
26283               </itemizedlist>
26284             </listitem>
26285
26286             <listitem>
26287               <para>edit_notices</para>
26288
26289               <itemizedlist>
26290                 <listitem>
26291                   <para>Define notices </para>
26292                 </listitem>
26293                 <listitem>
26294                   <para>Access to the <link linkend="notices">Notices Tool</link></para>
26295                 </listitem>
26296               </itemizedlist>
26297             </listitem>
26298
26299             <listitem>
26300               <para>export_catalog</para>
26301
26302               <itemizedlist>
26303                 <listitem>
26304                   <para>Export bibliographic, authorities and holdings data </para>
26305                 </listitem>
26306                 <listitem>
26307                   <para>Access to the <link linkend="exportbibs">Export Data Tool</link></para>
26308                 </listitem>
26309               </itemizedlist>
26310             </listitem>
26311
26312             <listitem>
26313               <para>import_patrons</para>
26314
26315               <itemizedlist>
26316                 <listitem>
26317                   <para>Import patron data </para>
26318                 </listitem>
26319                 <listitem>
26320                   <para>Access to the <link linkend="patronimport">Import Patrons Tool</link></para>
26321                 </listitem>
26322               </itemizedlist>
26323             </listitem>
26324
26325             <listitem>
26326               <para>inventory</para>
26327
26328               <itemizedlist>
26329                 <listitem>
26330                   <para>Perform inventory (stocktaking) of your catalog </para>
26331                 </listitem>
26332                 <listitem>
26333                   <para>Access to the <link linkend="inventory">Inventory Tool</link></para>
26334                 </listitem>
26335               </itemizedlist>
26336             </listitem>
26337
26338             <listitem>
26339               <para>items_batchdel</para>
26340
26341               <itemizedlist>
26342                 <listitem>
26343                   <para>Perform batch deletion of items </para>
26344                 </listitem>
26345                 <listitem>
26346                   <para>Access to the <link linkend="batchdeleteitems">Batch Item Deletion
26347                       Tool</link></para>
26348                 </listitem>
26349               </itemizedlist>
26350             </listitem>
26351
26352             <listitem>
26353               <para>items_batchmod</para>
26354
26355               <itemizedlist>
26356                 <listitem>
26357                   <para>Perform batch modification of items </para>
26358                 </listitem>
26359                 <listitem>
26360                   <para>Access to the <link linkend="batchmodifyitems">Batch Item Modification
26361                       Tool</link></para>
26362                 </listitem>
26363               </itemizedlist>
26364             </listitem>
26365             <listitem id="items_batchmod_restricted">
26366               <para>items_batchmod_restricted<itemizedlist>
26367                   <listitem>
26368                     <para>Limit <link linkend="batchmodifyitems">batch item modification</link> to
26369                       subfields defined in the <link linkend="SubfieldsToAllowForRestrictedBatchmod"
26370                         >SubfieldsToAllowForRestrictedBatchmod</link> preference</para>
26371                   </listitem>
26372                   <listitem>
26373                     <para>
26374                       <note>
26375                         <para>Please note that items_batchmod permission is still required</para>
26376                       </note>
26377                     </para>
26378                   </listitem>
26379                 </itemizedlist></para>
26380             </listitem>
26381
26382             <listitem>
26383               <para>label_creator</para>
26384
26385               <itemizedlist>
26386                 <listitem>
26387                   <para>Create printable labels and barcodes from catalog and patron data </para>
26388                 </listitem>
26389                 <listitem>
26390                   <para>Access to the <link linkend="labelcreator">Label Creator</link> and <link linkend="quicklabelcreator">Quick Label Creator</link> Tools</para>
26391                 </listitem>
26392               </itemizedlist>
26393             </listitem>
26394
26395             <listitem>
26396               <para>manage_csv_profiles</para>
26397
26398               <itemizedlist>
26399                 <listitem>
26400                   <para>Manage CSV export profiles</para>
26401                 </listitem>
26402                 <listitem>
26403                   <para>Access to the <link linkend="csvprofiles">CSV Profiles Tool</link></para>
26404                 </listitem>
26405               </itemizedlist>
26406             </listitem>
26407
26408             <listitem>
26409               <para>manage_staged_marc</para>
26410
26411               <itemizedlist>
26412                 <listitem>
26413                   <para>Managed staged MARC records, including completing and reversing imports
26414                   </para>
26415                 </listitem>
26416                 <listitem>
26417                   <para>Access to the <link linkend="managestaged">Manage Staged MARC Records
26418                       Tool</link></para>
26419                 </listitem>
26420               </itemizedlist>
26421             </listitem>
26422
26423             <listitem>
26424               <para>moderate_comments</para>
26425
26426               <itemizedlist>
26427                 <listitem>
26428                   <para>Moderate patron comments </para>
26429                 </listitem>
26430                 <listitem>
26431                   <para>Access to the <link linkend="comments">Comments Tool</link>
26432                   </para>
26433                 </listitem>
26434               </itemizedlist>
26435             </listitem>
26436
26437             <listitem>
26438               <para>moderate_tags<itemizedlist>
26439                   <listitem>
26440                     <para>Moderate patron tags</para>
26441                   </listitem>
26442                   <listitem>
26443                     <para>Access to the <link linkend="tagsmoderation">Tags Tool</link></para>
26444                   </listitem>
26445                 </itemizedlist></para>
26446             </listitem>
26447             <listitem>
26448               <para>records_batchdel<itemizedlist>
26449                   <listitem>
26450                     <para>Perform batch deletion of records (bibliographic or authority)</para>
26451                   </listitem>
26452                   <listitem>
26453                     <para>Access to the <link linkend="batchrecorddelete">Batch Record Deletion
26454                         Tool</link></para>
26455                   </listitem>
26456                 </itemizedlist></para>
26457             </listitem>
26458             <listitem>
26459               <para>rotating_collections<itemizedlist>
26460                   <listitem>
26461                     <para>Manage rotating collections</para>
26462                   </listitem>
26463                   <listitem>
26464                     <para>Access to the <link linkend="rotatingcollections">Rotating Collections
26465                         Tool</link></para>
26466                   </listitem>
26467                 </itemizedlist></para>
26468             </listitem>
26469             <listitem>
26470               <para>schedule_tasks</para>
26471               <itemizedlist>
26472                 <listitem>
26473                   <para>Schedule tasks to run </para>
26474                 </listitem>
26475                 <listitem>
26476                   <para>Access to the <link linkend="taskscheduler">Task Scheduler
26477                     Tool</link></para>
26478                 </listitem>
26479               </itemizedlist>
26480             </listitem>
26481
26482             <listitem>
26483               <para>stage_marc_import</para>
26484
26485               <itemizedlist>
26486                 <listitem>
26487                   <para>Stage MARC records into the reservoir </para>
26488                 </listitem>
26489                 <listitem>
26490                   <para>Access to the <link linkend="stagemarc">Stage MARC Records
26491                     Tool</link></para>
26492                 </listitem>
26493               </itemizedlist>
26494             </listitem>
26495
26496             <listitem>
26497               <para>upload_local_cover_images</para>
26498
26499               <itemizedlist>
26500                 <listitem>
26501                   <para>Upload local cover images </para>
26502                 </listitem>
26503                 <listitem>
26504                   <para>Access to the <link linkend="uploadlocalimages">Upload Local Cover Image
26505                       Tool</link> as well as permission to add and delete local cover images from
26506                     the bib detail page</para>
26507                 </listitem>
26508               </itemizedlist>
26509             </listitem>
26510
26511             <listitem>
26512               <para>view_system_logs</para>
26513
26514               <itemizedlist>
26515                 <listitem>
26516                   <para>Browse the system logs </para>
26517                 </listitem>
26518                 <listitem>
26519                   <para>Access to the <link linkend="logviewer">Log Viewer Tool</link></para>
26520                 </listitem>
26521               </itemizedlist>
26522             </listitem>
26523           </itemizedlist>
26524         </section>
26525
26526         <section id="reportpermissions">
26527           <title>Granular Reports Permissions</title>
26528
26529           <para>If the staff member has 'reports' permissions they have the
26530           ability to perform all of these actions. If you would like to
26531           control reports permissions on a more granular level choose from
26532           these options:</para>
26533
26534           <itemizedlist>
26535             <listitem>
26536               <para>create_reports</para>
26537
26538               <itemizedlist>
26539                 <listitem>
26540                   <para>Create SQL Reports</para>
26541                 </listitem>
26542                 <listitem>
26543                   <para>The ability to create and edit but not run SQL reports</para>
26544                 </listitem>
26545               </itemizedlist>
26546             </listitem>
26547
26548             <listitem>
26549               <para>execute_reports</para>
26550
26551               <itemizedlist>
26552                 <listitem>
26553                   <para>Execute SQL Reports</para>
26554                 </listitem>
26555                 <listitem>
26556                   <para>The ability to run but not create or edit SQL reports </para>
26557                 </listitem>
26558               </itemizedlist>
26559             </listitem>
26560           </itemizedlist>
26561         </section>
26562         <section id="pluginpermissions">
26563           <title>Granular Plugins Permissions</title>
26564           <para>If the staff member has 'plugins' permissions they have the ability to perform all
26565             of these actions. If you would like to control reports permissions on a more granular
26566             level choose from these options:<itemizedlist>
26567               <listitem>
26568                 <para>configure<itemizedlist>
26569                     <listitem>
26570                       <para>Configure plugins</para>
26571                     </listitem>
26572                     <listitem>
26573                       <para>The ability to run the 'configure' section of a plugin if it has
26574                         one</para>
26575                     </listitem>
26576                   </itemizedlist></para>
26577               </listitem>
26578               <listitem>
26579                 <para>manage<itemizedlist>
26580                     <listitem>
26581                       <para>Manage plugins </para>
26582                     </listitem>
26583                     <listitem>
26584                       <para>The ability to install or uninstall plugins</para>
26585                     </listitem>
26586                   </itemizedlist></para>
26587               </listitem>
26588               <listitem>
26589                 <para>report<itemizedlist>
26590                     <listitem>
26591                       <para>Use report plugins</para>
26592                     </listitem>
26593                     <listitem>
26594                       <para>The ability to use report plugins</para>
26595                     </listitem>
26596                   </itemizedlist></para>
26597               </listitem>
26598               <listitem>
26599                 <para>tool<itemizedlist>
26600                     <listitem>
26601                       <para>Use tool plugins</para>
26602                     </listitem>
26603                     <listitem>
26604                       <para>The ability to use tool plugins</para>
26605                     </listitem>
26606                   </itemizedlist></para>
26607               </listitem>
26608             </itemizedlist></para>
26609         </section>
26610       </section>
26611     </section>
26612
26613     <section id="patroninformation">
26614       <title>Patron Information</title>
26615
26616       <para>When viewing a patron record you have the option to view information from one of many
26617         tabs found on the left hand side of the record.<itemizedlist>
26618           <listitem>
26619             <para><emphasis role="italic">Get there:</emphasis> Patrons > Browse or search for
26620               patron > Click patron name</para>
26621           </listitem>
26622         </itemizedlist></para>
26623
26624       <section id="patcheckout">
26625         <title>Check Out</title>
26626
26627         <para>For instruction on checking items out, view the <link linkend="checkingout">Checking Out</link> section of this
26628         manual.</para>
26629         <para>Staff members can access their own check out screen by clicking their username in the
26630           top right of the staff client and choosing 'My checkouts'<screenshot>
26631             <screeninfo>My checkouts</screeninfo>
26632             <mediaobject>
26633               <imageobject>
26634                 <imagedata fileref="images/patrons/mycheckouts.png"/>
26635               </imageobject>
26636             </mediaobject>
26637           </screenshot></para>
26638       </section>
26639
26640       <section id="patrondetails">
26641         <title>Details</title>
26642         <para>Staff members can access their own account details by clicking their username in the
26643           top right of the staff client and choosing 'My account'</para>
26644         <screenshot>
26645           <screeninfo>My account</screeninfo>
26646           <mediaobject>
26647             <imageobject>
26648               <imagedata fileref="images/patrons/myaccount.png"/>
26649             </imageobject>
26650           </mediaobject>
26651         </screenshot>
26652
26653         <para>All patron information will appear on the Details tab. This
26654         includes all the contact information, notes, custom patron attributes,
26655         messaging preferences, etc entered when adding the patron.</para>
26656
26657         <para>In the case of patrons who are marked as 'Child' or
26658         'Professional' and their Guarantors additional information will appear
26659         on their record.</para>
26660
26661         <itemizedlist>
26662           <listitem>
26663             <para>A child patron will list their Guarantor</para>
26664
26665             <screenshot>
26666               <screeninfo>Guarantor listed and linked from the child
26667               record</screeninfo>
26668
26669               <mediaobject>
26670                 <imageobject>
26671                   <imagedata fileref="images/patrons/child.png"/>
26672                 </imageobject>
26673               </mediaobject>
26674             </screenshot>
26675           </listitem>
26676
26677           <listitem>
26678             <para>On the Guarantor's record, all children and/or professionals
26679             will be listed</para>
26680
26681             <screenshot>
26682               <screeninfo>Guarantees listed on the Guarantor's
26683               profile</screeninfo>
26684
26685               <mediaobject>
26686                 <imageobject>
26687                   <imagedata fileref="images/patrons/parent.png"/>
26688                 </imageobject>
26689               </mediaobject>
26690             </screenshot>
26691           </listitem>
26692         </itemizedlist>
26693
26694         <section id="patcircsummary">
26695           <title>Circulation Summary</title>
26696
26697           <para>Below the patron's information on the details screen is a
26698           tabbed display of the items they have checked out, overdue, and on
26699           hold.</para>
26700
26701           <screenshot>
26702             <screeninfo>Checkout summary</screeninfo>
26703
26704             <mediaobject>
26705               <imageobject>
26706                 <imagedata fileref="images/patrons/checkoutsummary.png"/>
26707               </imageobject>
26708             </mediaobject>
26709           </screenshot>
26710
26711           <para>If they have family at the library staff can see what the
26712           other family members have checked out.</para>
26713
26714           <screenshot>
26715             <screeninfo>Relative checkouts</screeninfo>
26716
26717             <mediaobject>
26718               <imageobject>
26719                 <imagedata fileref="images/patrons/relativecheckouts.png"/>
26720               </imageobject>
26721             </mediaobject>
26722           </screenshot>
26723           <para>The Restrictions tab will show for all patrons. If the patron has no restrictions
26724             you will see that on the tab.</para>
26725           <screenshot>
26726             <screeninfo>Patron restrictions</screeninfo>
26727             <mediaobject>
26728               <imageobject>
26729                 <imagedata fileref="images/patrons/patronrestrictions-none.png"/>
26730               </imageobject>
26731             </mediaobject>
26732           </screenshot>
26733           <para>If the patron has restrictions on their account the tab will show the number and the
26734             description.</para>
26735           <screenshot>
26736             <screeninfo>Patron restrictions</screeninfo>
26737             <mediaobject>
26738               <imageobject>
26739                 <imagedata fileref="images/patrons/patronrestrictions.png"/>
26740               </imageobject>
26741             </mediaobject>
26742           </screenshot>
26743           <para>Using the 'Add manual restriction' button you can add a restriction to the patron
26744             record from here.</para>
26745           <screenshot>
26746             <screeninfo>Add restriction</screeninfo>
26747             <mediaobject>
26748               <imageobject>
26749                 <imagedata fileref="images/patrons/addrestriction.png"/>
26750               </imageobject>
26751             </mediaobject>
26752           </screenshot>
26753         </section>
26754       </section>
26755
26756       <section id="patronfines">
26757         <title>Fines</title>
26758
26759         <para>The patron's complete accounting history will appear on the
26760         Fines tab. Contrary to its name, the Fines tab does not just show fine
26761         data, it also shows membership fees, rental fees, reserve fees and any
26762         other charge you may have for patrons.</para>
26763
26764         <screenshot>
26765           <screeninfo>Patron Accounting Summary</screeninfo>
26766
26767           <mediaobject>
26768             <imageobject>
26769               <imagedata fileref="images/patrons/patronaccount.png"/>
26770             </imageobject>
26771           </mediaobject>
26772         </screenshot>
26773
26774         <para>The table will show you the following columns:</para>
26775
26776         <itemizedlist>
26777           <listitem>
26778             <para>Date: the date the charge/payment was posted</para>
26779
26780             <itemizedlist>
26781               <listitem>
26782                 <para>In the case of fines this will be the last day that the
26783                 fine was accrued</para>
26784               </listitem>
26785             </itemizedlist>
26786           </listitem>
26787
26788           <listitem>
26789             <para>Description: a description of the charges including the due
26790             date for overdue items and a link to the item record where one is
26791             available</para>
26792           </listitem>
26793
26794           <listitem>
26795             <para>Note: any notes about this charge/payment</para>
26796           </listitem>
26797
26798           <listitem>
26799             <para>Amount: the total amount of the payment or charge</para>
26800           </listitem>
26801
26802           <listitem>
26803             <para>Outstanding: the amount still due on charge</para>
26804           </listitem>
26805         </itemizedlist>
26806
26807         <section id="chargefines">
26808           <title>Charging Fines/Fees</title>
26809
26810           <para>Most fees and fines will be charged automatically if the <link linkend="finescronjob">fines cron job</link> is running:</para>
26811
26812           <itemizedlist>
26813             <listitem>
26814               <para>Fines will be charged based on your <link linkend="circfinerules">Circulation &amp; Fines
26815               Rules</link></para>
26816             </listitem>
26817
26818             <listitem>
26819               <para>Hold fees will be charged based on the rules you set in
26820               the <link linkend="patcats">Patron Types &amp; Categories</link>
26821               administration area</para>
26822             </listitem>
26823
26824             <listitem>
26825               <para>Rental fees will be charged based on the settings in your
26826               <link linkend="itemtypeadmin">Item Types</link> administration
26827               area</para>
26828             </listitem>
26829
26830             <listitem>
26831               <para>Marking an item 'Lost' via the cataloging module will
26832               automatically charge the patron the replacement cost for that
26833               item</para>
26834             </listitem>
26835           </itemizedlist>
26836         </section>
26837
26838         <section id="payfines">
26839           <title>Pay/Reverse Fines</title>
26840
26841           <para>Each line item can be paid in full (or written off) using the
26842           'Pay Fines' tab.</para>
26843
26844           <screenshot>
26845             <screeninfo>Paying Fines</screeninfo>
26846
26847             <mediaobject>
26848               <imageobject>
26849                 <imagedata fileref="images/patrons/makepayment.png"/>
26850               </imageobject>
26851             </mediaobject>
26852           </screenshot>
26853
26854           <itemizedlist>
26855             <listitem>
26856               <para>Each line item can be paid in full, partially paid, or
26857               written off.</para>
26858             </listitem>
26859
26860             <listitem>
26861               <para>Pay a fine in full</para>
26862
26863               <itemizedlist>
26864                 <listitem>
26865                   <para>Click "Pay" next to the fine you want to pay in
26866                   full</para>
26867                 </listitem>
26868
26869                 <listitem>
26870                   <para>The full amount of the fine will be populated for you
26871                   in the "Collect From Patron" box</para>
26872
26873                   <screenshot>
26874                     <screeninfo>Pay fine</screeninfo>
26875
26876                     <mediaobject>
26877                       <imageobject>
26878                         <imagedata fileref="images/patrons/payfine.png"/>
26879                       </imageobject>
26880                     </mediaobject>
26881                   </screenshot>
26882                 </listitem>
26883
26884                 <listitem>
26885                   <para>Click "Confirm"</para>
26886                 </listitem>
26887
26888                 <listitem>
26889                   <para>The fine will be removed from outstanding fines, and
26890                   displayed as fully paid.</para>
26891                 </listitem>
26892               </itemizedlist>
26893             </listitem>
26894
26895             <listitem>
26896               <para>Pay a partial fine</para>
26897
26898               <itemizedlist>
26899                 <listitem>
26900                   <para>Click "Pay" next to the fine you want to partially
26901                   pay</para>
26902                 </listitem>
26903
26904                 <listitem>
26905                   <para>Enter the amount you are collecting from the patron in
26906                   the "Collect From Patron" box</para>
26907
26908                   <screenshot>
26909                     <screeninfo>Pay partial fine</screeninfo>
26910
26911                     <mediaobject>
26912                       <imageobject>
26913                         <imagedata fileref="images/patrons/paypartial.png"/>
26914                       </imageobject>
26915                     </mediaobject>
26916                   </screenshot>
26917                 </listitem>
26918
26919                 <listitem>
26920                   <para>Click "Confirm"</para>
26921                 </listitem>
26922
26923                 <listitem>
26924                   <para>The fine will be updated to show the original Amount,
26925                   and the current Amount Outstanding</para>
26926                 </listitem>
26927               </itemizedlist>
26928             </listitem>
26929
26930             <listitem>
26931               <para>Pay an amount towards all fines</para>
26932
26933               <itemizedlist>
26934                 <listitem>
26935                   <para>Click the "Pay Amount" button</para>
26936                 </listitem>
26937
26938                 <listitem>
26939                   <para>Enter the amount you are collecting from the patron in
26940                   "Collect from Patron." The sum of all fines is shown in
26941                   "Total Amount Outstanding"</para>
26942
26943                   <screenshot>
26944                     <screeninfo>Pay Amount</screeninfo>
26945
26946                     <mediaobject>
26947                       <imageobject>
26948                         <imagedata fileref="images/patrons/payamount.png"/>
26949                       </imageobject>
26950                     </mediaobject>
26951                   </screenshot>
26952                 </listitem>
26953
26954                 <listitem>
26955                   <para>Click "Confirm"</para>
26956                 </listitem>
26957
26958                 <listitem>
26959                   <para>The fine totals will be updated with the payment
26960                   applied to oldest fines first.</para>
26961                 </listitem>
26962               </itemizedlist>
26963             </listitem>
26964
26965             <listitem>
26966               <para>Pay Selected fines</para>
26967
26968               <itemizedlist>
26969                 <listitem>
26970                   <para>Check the selection boxes next to the fines you wish
26971                   to pay, click "Pay Selected"</para>
26972
26973                   <screenshot>
26974                     <screeninfo>Select lines to pay</screeninfo>
26975
26976                     <mediaobject>
26977                       <imageobject>
26978                         <imagedata fileref="images/patrons/payselected-select.png"/>
26979                       </imageobject>
26980                     </mediaobject>
26981                   </screenshot>
26982                 </listitem>
26983
26984                 <listitem>
26985                   <para>Enter an amount to pay towards the fines.</para>
26986
26987                   <screenshot>
26988                     <screeninfo>Pay Selected</screeninfo>
26989
26990                     <mediaobject>
26991                       <imageobject>
26992                         <imagedata fileref="images/patrons/payselected.png"/>
26993                       </imageobject>
26994                     </mediaobject>
26995                   </screenshot>
26996                 </listitem>
26997
26998                 <listitem>
26999                   <para>Click "Confirm"</para>
27000                 </listitem>
27001
27002                 <listitem>
27003                   <para>The fine totals will be updated with the payment
27004                   applied to the oldest selected fines first.</para>
27005                 </listitem>
27006               </itemizedlist>
27007             </listitem>
27008
27009             <listitem>
27010               <para>Writeoff a single fine</para>
27011
27012               <itemizedlist>
27013                 <listitem>
27014                   <para>Click "Writeoff" next to the fine you wish to
27015                   writeoff.</para>
27016                 </listitem>
27017
27018                 <listitem>
27019                   <para>The fine will be removed from outstanding fines, and
27020                   displayed as written off.</para>
27021                 </listitem>
27022               </itemizedlist>
27023             </listitem>
27024
27025             <listitem>
27026               <para>Writeoff All fines</para>
27027
27028               <itemizedlist>
27029                 <listitem>
27030                   <para>Click the "Writeoff All" button</para>
27031                 </listitem>
27032
27033                 <listitem>
27034                   <para>All fines will be removed from outstanding fines, and
27035                   displayed as written off.</para>
27036                 </listitem>
27037               </itemizedlist>
27038             </listitem>
27039
27040             <listitem>
27041               <para>If you accidentally mark and item as paid, you can reverse
27042               that line item by clicking 'Reverse' to the right of the
27043               line</para>
27044
27045               <screenshot>
27046                 <screeninfo>Reverse Link</screeninfo>
27047
27048                 <mediaobject>
27049                   <imageobject>
27050                     <imagedata fileref="images/patrons/reverselink.png"/>
27051                   </imageobject>
27052                 </mediaobject>
27053               </screenshot>
27054
27055               <itemizedlist>
27056                 <listitem>
27057                   <para>Once clicked a new line item will be added to the
27058                   account, showing the payment as reversed</para>
27059
27060                   <screenshot>
27061                     <screeninfo>Reversed Payment</screeninfo>
27062
27063                     <mediaobject>
27064                       <imageobject>
27065                         <imagedata fileref="images/patrons/reversed.png"/>
27066                       </imageobject>
27067                     </mediaobject>
27068                   </screenshot>
27069                 </listitem>
27070               </itemizedlist>
27071             </listitem>
27072           </itemizedlist>
27073         </section>
27074
27075         <section id="manualinvoice">
27076           <title>Creating Manual Invoices</title>
27077
27078           <para>For fees that are not automatically charged, librarians can
27079           create a manual invoice</para>
27080
27081           <screenshot>
27082             <screeninfo>Create Manual Invoice</screeninfo>
27083
27084             <mediaobject>
27085               <imageobject>
27086                 <imagedata fileref="images/patrons/manualinvoice.png"/>
27087               </imageobject>
27088             </mediaobject>
27089           </screenshot>
27090
27091           <itemizedlist>
27092             <listitem>
27093               <para>First choose the type of invoice you would like to
27094               create</para>
27095
27096               <itemizedlist>
27097                 <listitem>
27098                   <para>To add additional values to the manual invoice type pull down menu, add them
27099                     to the <link linkend="manualinvvals">MANUAL_INV</link> Authorized Value</para>
27100                 </listitem>
27101                 <listitem>
27102                   <para>
27103                     <important>
27104                       <para>The value set as the Authorized Value for the MANUAL_INV authorized
27105                         value category will appear as the Description and the Authorized Value
27106                         Description will be used as the amount.</para>
27107                     </important>
27108                   </para>
27109                 </listitem>
27110               </itemizedlist>
27111             </listitem>
27112
27113             <listitem>
27114               <para>If the fee is associated with an item you can enter its
27115               barcode so that the line item shows a link to that item</para>
27116             </listitem>
27117
27118             <listitem>
27119               <para>The description field is where you will enter the
27120               description of the charge</para>
27121             </listitem>
27122
27123             <listitem>
27124               <para>In the amount field, do not enter currency symbols, only
27125               numbers and decimals</para>
27126             </listitem>
27127           </itemizedlist>
27128         </section>
27129
27130         <section id="manualcredit">
27131           <title>Creating Manual Credits</title>
27132
27133           <para>Manual credits can be used to pay off parts of fines, or to
27134           forgive a fine amount.</para>
27135
27136           <screenshot>
27137             <screeninfo>Create Manual Credit</screeninfo>
27138
27139             <mediaobject>
27140               <imageobject>
27141                 <imagedata fileref="images/patrons/manualcredit.png"/>
27142               </imageobject>
27143             </mediaobject>
27144           </screenshot>
27145
27146           <itemizedlist>
27147             <listitem>
27148               <para>First choose the type of credit you'd like to apply</para>
27149             </listitem>
27150
27151             <listitem>
27152               <para>If this credit is associated with an item you can enter
27153               that item's barcode so that the line item links to the right
27154               item</para>
27155             </listitem>
27156
27157             <listitem>
27158               <para>The description field is where you will enter the
27159               description of the credit</para>
27160             </listitem>
27161
27162             <listitem>
27163               <para>In the amount field, do not enter currency symbols, only
27164               numbers and decimals</para>
27165             </listitem>
27166           </itemizedlist>
27167         </section>
27168
27169         <section id="printinglineitems">
27170           <title>Printing Invoices</title>
27171
27172           <para>To the right of each account line there is a print link.
27173           Clicking that link will print an invoice for the line item that
27174           includes the date and description of the line item along with the
27175           total outstanding on the account.</para>
27176
27177           <screenshot>
27178             <screeninfo>Sample Invoice</screeninfo>
27179
27180             <mediaobject>
27181               <imageobject>
27182                 <imagedata fileref="images/patrons/patroninvoice.png"/>
27183               </imageobject>
27184             </mediaobject>
27185           </screenshot>
27186         </section>
27187       </section>
27188
27189       <section id="patronroutingtab">
27190         <title>Routing Lists</title>
27191
27192         <para>A list of all of the serial routing lists the patron belongs to
27193         will be accessible via the 'Routing Lists' tab on the patron
27194         record.</para>
27195
27196         <screenshot>
27197           <screeninfo>Routing Lists</screeninfo>
27198
27199           <mediaobject>
27200             <imageobject>
27201               <imagedata fileref="images/patrons/routinglisttab.png"/>
27202             </imageobject>
27203           </mediaobject>
27204         </screenshot>
27205
27206         <para>On this tab you will be able to see and edit all of the routing
27207         lists that this patron is on.</para>
27208
27209         <screenshot>
27210           <screeninfo>Patron's routing lists</screeninfo>
27211
27212           <mediaobject>
27213             <imageobject>
27214               <imagedata fileref="images/patrons/patronroutinglists.png"/>
27215             </imageobject>
27216           </mediaobject>
27217         </screenshot>
27218       </section>
27219
27220       <section id="circhistory">
27221         <title>Circulation History</title>
27222
27223         <para>The circulation history tab will appear if you have set the
27224         <link linkend="intranetreadinghistory">intranetreadinghistory</link>
27225         preference to allow it to appear. If you have the <link linkend="OPACPrivacy">OPACPrivacy</link> system preference set to
27226         'Allow' and the patron has decided that the library cannot keep this
27227         information this tab will only show currently checked out
27228         items.</para>
27229
27230         <screenshot>
27231           <screeninfo>Patron Circulation History</screeninfo>
27232
27233           <mediaobject>
27234             <imageobject>
27235               <imagedata fileref="images/patrons/readinghistory.png"/>
27236             </imageobject>
27237           </mediaobject>
27238         </screenshot>
27239
27240         <para>If you would like to export a list of barcodes for the items
27241         checked in today you can find that option under the More menu on the
27242         top right of the page.</para>
27243
27244         <screenshot>
27245           <screeninfo>Export today's checkins</screeninfo>
27246
27247           <mediaobject>
27248             <imageobject>
27249               <imagedata fileref="images/patrons/readinghistory-export.png"/>
27250             </imageobject>
27251           </mediaobject>
27252         </screenshot>
27253
27254         <para>This will generate a text file with one barcode per line.</para>
27255       </section>
27256
27257       <section id="patmodlog">
27258         <title>Modification Log</title>
27259
27260         <para>If you have set your <link linkend="BorrowersLog">BorrowersLog</link> to track changes to patron
27261         records, then this tab will appear. The Modification Log will show
27262         when changes were made to the patron record. If you also have turned
27263         on the <link linkend="IssueLog">IssueLog</link> and <link linkend="ReturnLog">ReturnLog</link> you will see checkins and outs on
27264         this screen as well.</para>
27265
27266         <screenshot>
27267           <screeninfo>Changes to Patron</screeninfo>
27268
27269           <mediaobject>
27270             <imageobject>
27271               <imagedata fileref="images/patrons/borrowerlog.png"/>
27272             </imageobject>
27273           </mediaobject>
27274         </screenshot>
27275
27276         <itemizedlist>
27277           <listitem>
27278             <para>The Librarian field shows the patron number for the
27279             librarian who made the changes</para>
27280           </listitem>
27281
27282           <listitem>
27283             <para>The module lists 'MEMBERS' for the patron module</para>
27284           </listitem>
27285
27286           <listitem>
27287             <para>The action will tell you what action was being logged</para>
27288           </listitem>
27289
27290           <listitem>
27291             <para>The Object field lists the borrowernumber that is being
27292             modified (in the example above, it was my changing my own
27293             record)</para>
27294           </listitem>
27295         </itemizedlist>
27296       </section>
27297
27298       <section id="patnotices">
27299         <title>Notices</title>
27300
27301         <para>The <link linkend="setpatronmessaging">patron's messaging
27302         preferences</link> are set when <link linkend="addnewpatron">adding</link> or <link linkend="editpatrons">editing</link> the patron. This tab will show
27303         the messages that have been sent and those that are queued to be
27304         sent:</para>
27305
27306         <screenshot>
27307           <screeninfo>Patron Notices Tab</screeninfo>
27308
27309           <mediaobject>
27310             <imageobject>
27311               <imagedata fileref="images/patrons/patnoticestab.png"/>
27312             </imageobject>
27313           </mediaobject>
27314         </screenshot>
27315
27316         <para>Clicking on the message title will expand the view to show you
27317         the full text of the message that was sent.</para>
27318
27319         <screenshot>
27320           <screeninfo>Full message text</screeninfo>
27321
27322           <mediaobject>
27323             <imageobject>
27324               <imagedata fileref="images/patrons/patnoticestab-full.png"/>
27325             </imageobject>
27326           </mediaobject>
27327         </screenshot>
27328       </section>
27329
27330       <section id="patronstatstab">
27331         <title>Statistics</title>
27332
27333         <para>Depending on what you set for the values of your <link linkend="StatisticsFields">StatisticsFields</link> system preference,
27334         you can see statistics for one patron's circulation actions.</para>
27335
27336         <screenshot>
27337           <screeninfo>Patron's Statistics</screeninfo>
27338
27339           <mediaobject>
27340             <imageobject>
27341               <imagedata fileref="images/patrons/patronstats.png"/>
27342             </imageobject>
27343           </mediaobject>
27344         </screenshot>
27345       </section>
27346
27347       <section id="patronfiles">
27348         <title>Files</title>
27349
27350         <para>If you set the <link linkend="EnableBorrowerFiles">EnableBorrowerFiles</link> preference to
27351         'Do' the Files tab will be visible on the patron information
27352         page.</para>
27353
27354         <screenshot>
27355           <screeninfo>Patron Files Tab</screeninfo>
27356
27357           <mediaobject>
27358             <imageobject>
27359               <imagedata fileref="images/patrons/patronfilestab.png"/>
27360             </imageobject>
27361           </mediaobject>
27362         </screenshot>
27363
27364         <para>From here you can upload files to attach to the patron
27365         record.</para>
27366
27367         <screenshot>
27368           <screeninfo>Upload patron files</screeninfo>
27369
27370           <mediaobject>
27371             <imageobject>
27372               <imagedata fileref="images/patrons/nopatronfiles.png"/>
27373             </imageobject>
27374           </mediaobject>
27375         </screenshot>
27376
27377         <para>All files that are uploaded will appear above a form where
27378         additional files can be uploaded from.</para>
27379
27380         <screenshot>
27381           <screeninfo>List of files on the patron record</screeninfo>
27382
27383           <mediaobject>
27384             <imageobject>
27385               <imagedata fileref="images/patrons/patronfileslist.png"/>
27386             </imageobject>
27387           </mediaobject>
27388         </screenshot>
27389       </section>
27390       <section id="patronsuggestions">
27391         <title>Purchase Suggestions</title>
27392         <para>If the patron has made any purchase suggestions you will see a purchase suggestions
27393           tab on the patron record.<screenshot>
27394             <screeninfo>Patron purchase suggestions</screeninfo>
27395             <mediaobject>
27396               <imageobject>
27397                 <imagedata fileref="images/patrons/purchasesuggestions.png"/>
27398               </imageobject>
27399             </mediaobject>
27400           </screenshot></para>
27401         <para>From here you can see all suggestions made by the patron and their status, you can
27402           also create a purchase suggestion on the patron's behalf by clicking the 'New purchase
27403           suggestion' button at the top.</para>
27404         <para>Learn more about <link linkend="purchasesuggest">Purchase suggestions</link> in the
27405             <link linkend="acqmodule">Acquisitions</link> chapter of this manual.</para>
27406       </section>
27407     </section>
27408
27409     <section id="patronsearch">
27410       <title>Patron Search</title>
27411
27412       <para>Clicking on the link to the Patron module will bring you to a search/browse screen for
27413         patrons. From here you can search for a patron by any part of their name or their card
27414         number.</para>
27415
27416       <screenshot>
27417         <screeninfo>Patron Search</screeninfo>
27418
27419         <mediaobject>
27420           <imageobject>
27421             <imagedata fileref="images/patrons/patronsearch.png"/>
27422           </imageobject>
27423         </mediaobject>
27424       </screenshot>
27425       <para>Clicking the small plus sign [+] to the right of the search box will open up an advanced
27426         patron search with more filters including the ability to limit to a specific category and/or library.</para>
27427       <screenshot>
27428           <screeninfo>Expanded patron search</screeninfo>
27429           <mediaobject>
27430             <imageobject>
27431               <imagedata fileref="images/patrons/patronsearchexpand.png"/>
27432             </imageobject>
27433           </mediaobject>
27434         </screenshot>
27435       <para>You can also filter your patron results using the search options on the left hand side
27436         of the page.<screenshot>
27437           <screeninfo>Patron search filters</screeninfo>
27438           <mediaobject>
27439             <imageobject>
27440               <imagedata fileref="images/patrons/patronsearchfilters.png"/>
27441             </imageobject>
27442           </mediaobject>
27443         </screenshot></para>
27444
27445       <para>Depending on what you have chosen for the 'Search fields' you can
27446       search for patrons in various different ways.</para>
27447
27448       <screenshot>
27449         <screeninfo>Patron Search Fields</screeninfo>
27450
27451         <mediaobject>
27452           <imageobject>
27453             <imagedata fileref="images/patrons/patronfieldsearch.png"/>
27454           </imageobject>
27455         </mediaobject>
27456       </screenshot>
27457
27458       <itemizedlist>
27459         <listitem>
27460           <para>Standard:</para>
27461
27462           <itemizedlist>
27463             <listitem>
27464               <para>Enter any part of their name, username, email address or
27465               barcode</para>
27466             </listitem>
27467           </itemizedlist>
27468         </listitem>
27469
27470         <listitem>
27471           <para>Email:</para>
27472
27473           <itemizedlist>
27474             <listitem>
27475               <para>Enter any part of their email address and choose 'Contains' instead of 'Starts
27476                 with'</para>
27477             </listitem>
27478           </itemizedlist>
27479         </listitem>
27480
27481         <listitem>
27482           <para>Borrower number:</para>
27483
27484           <itemizedlist>
27485             <listitem>
27486               <para>Enter the Koha borrower number</para>
27487             </listitem>
27488           </itemizedlist>
27489         </listitem>
27490
27491         <listitem>
27492           <para>Phone number:</para>
27493
27494           <itemizedlist>
27495             <listitem>
27496               <para>Enter the phone number exactly as it is in the system or
27497               by using spaces between each batch of numbers.</para>
27498             </listitem>
27499
27500             <listitem>
27501               <para>Example: To find (212) 555-1212 you can search for it
27502               exactly as it was entered or by searching for 212 555
27503               1212</para>
27504             </listitem>
27505           </itemizedlist>
27506         </listitem>
27507
27508         <listitem>
27509           <para>Street address:</para>
27510
27511           <itemizedlist>
27512             <listitem>
27513               <para>Enter any part of the patron's address (includes all address fields) and choose
27514                 'Contains' instead of 'Starts with' to find the string anywhere in the
27515                 address</para>
27516             </listitem>
27517           </itemizedlist>
27518         </listitem>
27519         <listitem>
27520           <para>Date of birth<itemizedlist>
27521               <listitem>
27522                 <para>Birthdates should be entered using the format set forth in the <link
27523                     linkend="dateformat">dateformat</link> preference. </para>
27524               </listitem>
27525             </itemizedlist></para>
27526         </listitem>
27527         <listitem>
27528           <para>Sort field 1<itemizedlist>
27529               <listitem>
27530                 <para>This is a custom field that libraries can use for any type of data about the
27531                   patron.</para>
27532               </listitem>
27533             </itemizedlist></para>
27534         </listitem>
27535         <listitem>
27536           <para>Sort field 2<itemizedlist>
27537               <listitem>
27538                 <para>This is a custom field that libraries can use for any type of data about the
27539                   patron.</para>
27540               </listitem>
27541             </itemizedlist></para>
27542         </listitem>
27543       </itemizedlist>
27544       <para>You can also choose to either search for fields that start with the string you entered
27545         or contain the string.  Choosing 'Contains' will work like a wildcard search.</para>
27546       <screenshot>
27547           <screeninfo>Contains or Starts with Search</screeninfo>
27548           <mediaobject>
27549             <imageobject>
27550               <imagedata fileref="images/patrons/patronsearchcontains.png"/>
27551             </imageobject>
27552           </mediaobject>
27553         </screenshot>
27554
27555       <para>You can also browse through the patron records by clicking on the
27556       linked letters across the top.</para>
27557
27558       <screenshot>
27559         <screeninfo>Patron Browse</screeninfo>
27560
27561         <mediaobject>
27562           <imageobject>
27563             <imagedata fileref="images/patrons/patronbrowse.png"/>
27564           </imageobject>
27565         </mediaobject>
27566       </screenshot>
27567     </section>
27568   </chapter>
27569
27570   <chapter id="circulation">
27571     <title>Circulation</title>
27572
27573     <para>Circulation functions can be accessed in several different ways. On
27574     the main page of the staff client there are some quick links in the center
27575     of the page to check items out, in or transfer them. For a complete
27576     listing of Circulation functions you can visit the Circulation page which
27577     is linked from the top left of every page or from the center of the main
27578     page.</para>
27579
27580     <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 &amp; Circulation Rules</link>.</para>
27581
27582     <para>While in Circulation you can jump between the tabs on the quick
27583     search box at the top of the screen by using the following hot
27584     keys:</para>
27585
27586     <itemizedlist>
27587       <listitem>
27588         <para>jump to the catalog search with Alt+Q</para>
27589       </listitem>
27590
27591       <listitem>
27592         <para>jump to the checkout with Alt+U</para>
27593
27594         <itemizedlist>
27595           <listitem>
27596             <para>this will not work for Mac users</para>
27597           </listitem>
27598         </itemizedlist>
27599       </listitem>
27600
27601       <listitem>
27602         <para>jump to the checkin with Alt+R</para>
27603       </listitem>
27604     </itemizedlist>
27605
27606     <para><note>
27607         <para>Mac users use the OPTION button in place of ALT</para>
27608       </note></para>
27609
27610     <section id="checkingout">
27611       <title>Check Out (Issuing)</title>
27612
27613       <para>To begin the checkout process you must enter the patron barcode or
27614       part of their name. The checkout option appears in three main
27615       places:</para>
27616
27617       <itemizedlist>
27618         <listitem>
27619           <para>Check out option on the top of the main staff client</para>
27620
27621           <screenshot>
27622             <screeninfo>Check out box on main Koha Staff Client
27623             page</screeninfo>
27624
27625             <mediaobject>
27626               <imageobject>
27627                 <imagedata fileref="images/circ/checkoutmain.png"/>
27628               </imageobject>
27629             </mediaobject>
27630           </screenshot>
27631         </listitem>
27632
27633         <listitem>
27634           <para>Check out option on the patron record</para>
27635
27636           <screenshot>
27637             <screeninfo>Check out tab on a patron record</screeninfo>
27638
27639             <mediaobject>
27640               <imageobject>
27641                 <imagedata fileref="images/circ/checkoutpatron.png"/>
27642               </imageobject>
27643             </mediaobject>
27644           </screenshot>
27645         </listitem>
27646
27647         <listitem>
27648           <para>Check out option on the quick search bar on the circulation
27649           page</para>
27650
27651           <screenshot>
27652             <screeninfo>Check out tab on quick search bar</screeninfo>
27653
27654             <mediaobject>
27655               <imageobject>
27656                 <imagedata fileref="images/circ/circquickbox.png"/>
27657               </imageobject>
27658             </mediaobject>
27659           </screenshot>
27660         </listitem>
27661       </itemizedlist>
27662
27663       <section id="checkitemout">
27664         <title>Checking Items Out</title>
27665
27666         <para>To check an item out to a patron, first search for that patron using one of the many
27667           options listed above. You will then be presented with the checkout screen.</para>
27668         <screenshot>
27669           <screeninfo>Check Out Screen</screeninfo>
27670           <mediaobject>
27671             <imageobject>
27672               <imagedata fileref="images/circ/checkingout-noshow.png"/>
27673             </imageobject>
27674           </mediaobject>
27675         </screenshot>
27676         <para>If you have chosen to 'Always show checkouts immediately' then you will see the list
27677           of checkouts below the check out box.</para>
27678
27679         <screenshot>
27680           <screeninfo>Check Out Screen</screeninfo>
27681
27682           <mediaobject>
27683             <imageobject>
27684               <imagedata fileref="images/circ/checkingout.png"/>
27685             </imageobject>
27686           </mediaobject>
27687         </screenshot>
27688
27689         <para>At the top of the Check Out screen is a box for you to type or
27690         scan the item's barcode into.</para>
27691
27692         <itemizedlist>
27693           <listitem>
27694             <important>
27695               <para>Many modern barcode scanners will send a 'return' to the
27696               browser, making it so that the 'Check Out' button is
27697               automatically clicked</para>
27698             </important>
27699           </listitem>
27700
27701           <listitem>
27702             <para>If the barcode is not found you will be prompted to use fast cataloging to add the
27703               item. Learn more about <link linkend="fastaddcat">fast cataloging</link> later in this
27704               manual.</para>
27705           </listitem>
27706           <listitem>
27707             <para>If you have <link linkend="itemBarcodeFallbackSearch"
27708                 >itemBarcodeFallbackSearch</link> set to 'Enable' then you can enter a keyword
27709               search in this box instead of just a barcode (this will make it possible to check out
27710               using title and/or call number).</para>
27711           </listitem>
27712         </itemizedlist>
27713         <para>Below the box for the barcode you will see a checkbox for 'Automatic renewal'.  This
27714           will allow this item to automatically renew if the <link linkend="autorenewcron"
27715             >appropriate cron job</link> is running and there are no holds on the item.</para>
27716
27717         <para>Below the box for the barcode there may be options for you to
27718         override the default due date for the item.</para>
27719
27720         <itemizedlist>
27721           <listitem>
27722             <para>This option will only appear if you have set the <link linkend="SpecifyDueDate">SpecifyDueDate</link> system preference
27723             to allow staff to override the due date</para>
27724           </listitem>
27725         </itemizedlist>
27726         <para>If you're allowing the <link linkend="OnSiteCheckouts">checkout of items on
27727             site</link> to patrons (these are usually items that are not for loan that you would
27728           like to check for in library use) then you will see the 'On-site checkout' checkbox.<screenshot>
27729             <screeninfo>On-site checkout</screeninfo>
27730             <mediaobject>
27731               <imageobject>
27732                 <imagedata fileref="images/circ/allowonsitecheckout.png"/>
27733               </imageobject>
27734             </mediaobject>
27735           </screenshot></para>
27736
27737         <para>At the bottom of the page there is a summary of the patron's
27738         current checked out items along with the due date (and time if the
27739         item is an hourly loan), items checked out today will appear at the
27740         top.</para>
27741
27742         <note>
27743           <para>Items that are hourly loan items will include the time with the due date.</para>
27744         </note>
27745
27746         <screenshot>
27747           <screeninfo>Patron's checkout summary</screeninfo>
27748
27749           <mediaobject>
27750             <imageobject>
27751               <imagedata fileref="images/circ/checkoutsummary.png"/>
27752             </imageobject>
27753           </mediaobject>
27754         </screenshot>
27755         <para>If you checked out an item for on site use you will see that highlighted in red in the
27756           checkout summary.</para>
27757         <screenshot>
27758           <screeninfo>Patron's on-site checkout </screeninfo>
27759           <mediaobject>
27760             <imageobject>
27761               <imagedata fileref="images/circ/onsitecheckout.png"/>
27762             </imageobject>
27763           </mediaobject>
27764         </screenshot>
27765         <para>If you have set your <link linkend="ExportWithCsvProfile">ExportWithCsvProfile</link>
27766           preference, you will also see the option to export the patron's current checkout
27767           information using a CSV Profile or ISO2709 (MARC21) format.</para>
27768         <screenshot>
27769           <screeninfo>Export patron's checkout information</screeninfo>
27770           <mediaobject>
27771             <imageobject>
27772               <imagedata fileref="images/circ/exportcheckouts.png"/>
27773             </imageobject>
27774           </mediaobject>
27775         </screenshot>
27776
27777         <para>Also at the bottom of the page is the list of items the patron
27778         has on hold</para>
27779
27780         <screenshot>
27781           <screeninfo>Holds summary on check out screen</screeninfo>
27782
27783           <mediaobject>
27784             <imageobject>
27785               <imagedata fileref="images/circ/holdssummary.png"/>
27786             </imageobject>
27787           </mediaobject>
27788         </screenshot>
27789
27790         <para>From the holds list you can suspend or resume patrons holds
27791         using the options at the bottom of the list if you have the <link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link> preference
27792         set to 'allow.'</para>
27793
27794         <note>
27795           <para>If you have your <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
27796           preference set to "Don't allow" then you will not have the option to
27797           put an end date on the hold suspension</para>
27798         </note>
27799
27800         <para>If there are notes on the patron record these will appear to the
27801         right of the checkout box</para>
27802
27803         <screenshot>
27804           <screeninfo>Patron notes on check out screen</screeninfo>
27805
27806           <mediaobject>
27807             <imageobject>
27808               <imagedata fileref="images/circ/patronnotes.png"/>
27809             </imageobject>
27810           </mediaobject>
27811         </screenshot>
27812
27813         <para>If the patron has a hold waiting at the library that too will
27814         appear to the right of the check out box making it easy for the
27815         circulation librarian to see that there is another item to give the
27816         patron</para>
27817
27818         <screenshot>
27819           <screeninfo>Hold waiting message on check out screen</screeninfo>
27820
27821           <mediaobject>
27822             <imageobject>
27823               <imagedata fileref="images/circ/holdwaiting.png"/>
27824             </imageobject>
27825           </mediaobject>
27826         </screenshot>
27827         <para>The details of the checkouts will appear on the bib detail page in the staff client as
27828           well.</para>
27829         <screenshot>
27830           <screeninfo>Circulation information on holdings tab</screeninfo>
27831           <mediaobject>
27832             <imageobject>
27833               <imagedata fileref="images/circ/circonholdings.png"/>
27834             </imageobject>
27835           </mediaobject>
27836         </screenshot>
27837
27838         <section id="printcircreceipt">
27839           <title>Printing Receipts</title>
27840
27841           <para>Once you have checked out all of the items for the patron you
27842           can print them a receipt by choosing one of two methods.</para>
27843
27844           <para>If you have the <link linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
27845           preference set to 'open a print quick slip window' you can simply
27846           hit enter on your keyboard or scan a blank piece of paper with your
27847           barcode scanner. The idea being that you're "checking out" a blank
27848           barcode which triggers Koha to print the 'Quick slip.'</para>
27849
27850           <para>You can also click the Print button at the top of the screen
27851           and choose 'Print slip' or 'Print quick slip'.</para>
27852
27853           <screenshot>
27854             <screeninfo>Print receipt to slip printer</screeninfo>
27855
27856             <mediaobject>
27857               <imageobject>
27858                 <imagedata fileref="images/circ/printslip.png"/>
27859               </imageobject>
27860             </mediaobject>
27861           </screenshot>
27862
27863           <para>If you choose 'Print slip' it will print all of the items the
27864           patron has checked out, including those they checked out at an
27865           earlier date. Choosing 'Print quick slip' will print only the items
27866           that were checked out today.</para>
27867
27868           <para>What prints on the slips can be customized by altering the
27869           slip templates under the <link linkend="notices">Notices &amp;
27870           Slips</link> tool.</para>
27871         </section>
27872
27873         <section id="clearpatroninfo">
27874           <title>Clear Patron Information</title>
27875
27876           <para>When you're done checking an item out if you have the <link linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
27877           preference set to 'Show' you can clear the current patron by
27878           clicking the X in the top right of the patron's info to remove the
27879           current patron from the screen and start over.</para>
27880
27881           <screenshot>
27882             <screeninfo>Clear Screen Button</screeninfo>
27883
27884             <mediaobject>
27885               <imageobject>
27886                 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
27887               </imageobject>
27888             </mediaobject>
27889           </screenshot>
27890
27891           <para>If you have the <link linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
27892           preference set to 'clear the screen' then you simply need to hit
27893           enter or scan a blank barcode and the screen will be cleared of the
27894           current patron.</para>
27895         </section>
27896       </section>
27897
27898       <section id="checkoutmsg">
27899         <title>Check Out Messages</title>
27900
27901         <para>If you check out an item that has multiple pieces and you have
27902         cataloged that information in subfield 3 of the item record (in
27903         MARC21) a message will pop up when you check out that item telling you
27904         how many pieces should be there.</para>
27905
27906         <screenshot>
27907           <screeninfo>Materials in the checked out item</screeninfo>
27908
27909           <mediaobject>
27910             <imageobject>
27911               <imagedata fileref="images/circ/materialspecified.png"/>
27912             </imageobject>
27913           </mediaobject>
27914         </screenshot>
27915
27916         <para>There are times when Koha will prevent the librarian from being
27917         able to check out items to a patron. When this happens a warning will
27918         appear notifying the librarian of why the patron cannot check items
27919         out.</para>
27920
27921         <itemizedlist>
27922           <listitem>
27923             <para>Patron owes too much in fines</para>
27924
27925             <screenshot>
27926               <screeninfo>Patron owes too much in fines</screeninfo>
27927
27928               <mediaobject>
27929                 <imageobject>
27930                   <imagedata fileref="images/circ/fineswarning.png"/>
27931                 </imageobject>
27932               </mediaobject>
27933             </screenshot>
27934
27935             <itemizedlist>
27936               <listitem>
27937                 <para>You can set the amount at which patron checkouts are
27938                 blocked with the <link linkend="noissuescharge">noissuescharge</link> system
27939                 preference</para>
27940               </listitem>
27941             </itemizedlist>
27942           </listitem>
27943
27944           <listitem>
27945             <para>Patron has a restriction on their account</para>
27946
27947             <screenshot>
27948               <screeninfo>Patron account restricted</screeninfo>
27949
27950               <mediaobject>
27951                 <imageobject>
27952                   <imagedata fileref="images/circ/debarwarning.png"/>
27953                 </imageobject>
27954               </mediaobject>
27955             </screenshot>
27956
27957             <itemizedlist>
27958               <listitem>
27959                 <para>This can be set by the librarian editing a patron record and adding a <link
27960                     linkend="patronflags">restriction</link> or by the <link
27961                     linkend="noticetriggers">Overdue/Notice Status Triggers</link></para>
27962               </listitem>
27963               <listitem>
27964                 <para>If the staff member has the right permission they can override the restriction
27965                   temporarily</para>
27966                 <screenshot>
27967                   <screeninfo>Patron account restricted</screeninfo>
27968                   <mediaobject>
27969                     <imageobject>
27970                       <imagedata fileref="images/circ/overridetemporarily.png"/>
27971                     </imageobject>
27972                   </mediaobject>
27973                 </screenshot>
27974               </listitem>
27975             </itemizedlist>
27976           </listitem>
27977
27978           <listitem>
27979             <para>Patron needs to confirm their address</para>
27980
27981             <screenshot>
27982               <screeninfo>Patron's address warning</screeninfo>
27983
27984               <mediaobject>
27985                 <imageobject>
27986                   <imagedata fileref="images/circ/addresswarning.png"/>
27987                 </imageobject>
27988               </mediaobject>
27989             </screenshot>
27990
27991             <itemizedlist>
27992               <listitem>
27993                 <para>This can be set by the librarian editing a patron record
27994                 and adding a <link linkend="patronflags">flag</link></para>
27995               </listitem>
27996             </itemizedlist>
27997           </listitem>
27998
27999           <listitem>
28000             <para>Patrons has lost their library card</para>
28001
28002             <screenshot>
28003               <screeninfo>Lost patron card warning</screeninfo>
28004
28005               <mediaobject>
28006                 <imageobject>
28007                   <imagedata fileref="images/circ/lostcardwarning.png"/>
28008                 </imageobject>
28009               </mediaobject>
28010             </screenshot>
28011
28012             <itemizedlist>
28013               <listitem>
28014                 <para>This can be set by the librarian editing a patron record
28015                 and adding a <link linkend="patronflags">flag</link></para>
28016               </listitem>
28017             </itemizedlist>
28018           </listitem>
28019         </itemizedlist>
28020       </section>
28021
28022       <section id="checkoutwarn">
28023         <title>Check Out Warnings</title>
28024
28025         <para>Sometimes checkouts will trigger warning messages that will
28026         appear in a yellow box above the check out field. These warnings need
28027         to be acknowledged before you will be able to continue checking items
28028         out.</para>
28029
28030         <itemizedlist>
28031           <listitem>
28032             <para>Patron has outstanding fines</para>
28033
28034             <screenshot>
28035               <screeninfo>Patron has a debt</screeninfo>
28036
28037               <mediaobject>
28038                 <imageobject>
28039                   <imagedata fileref="images/circ/warnings/patrondebt.png"/>
28040                 </imageobject>
28041               </mediaobject>
28042             </screenshot>
28043           </listitem>
28044
28045           <listitem>
28046             <para>Item on hold for someone else</para>
28047
28048             <screenshot>
28049               <screeninfo>Item is on hold for someone else</screeninfo>
28050
28051               <mediaobject>
28052                 <imageobject>
28053                   <imagedata fileref="images/circ/warnings/onhold.png"/>
28054                 </imageobject>
28055               </mediaobject>
28056             </screenshot>
28057           </listitem>
28058
28059           <listitem>
28060             <para>Item should be on the hold shelf waiting for someone
28061             else</para>
28062
28063             <screenshot>
28064               <screeninfo>Item is on hold shelf waiting for someone
28065               else</screeninfo>
28066
28067               <mediaobject>
28068                 <imageobject>
28069                   <imagedata fileref="images/circ/warnings/holdwaiting.png"/>
28070                 </imageobject>
28071               </mediaobject>
28072             </screenshot>
28073           </listitem>
28074
28075           <listitem>
28076             <para>Item already checked out to this patron</para>
28077
28078             <screenshot>
28079               <screeninfo>Item is currently checked out to this
28080               patron</screeninfo>
28081
28082               <mediaobject>
28083                 <imageobject>
28084                   <imagedata fileref="images/circ/warnings/alreadycheckedout.png"/>
28085                 </imageobject>
28086               </mediaobject>
28087             </screenshot>
28088           </listitem>
28089
28090           <listitem>
28091             <para>Item checked out to another patron</para>
28092
28093             <screenshot>
28094               <screeninfo>Item checked out to another patron</screeninfo>
28095
28096               <mediaobject>
28097                 <imageobject>
28098                   <imagedata fileref="images/circ/warnings/checkedoutelse.png"/>
28099                 </imageobject>
28100               </mediaobject>
28101             </screenshot>
28102           </listitem>
28103
28104           <listitem>
28105             <para>Item not for loan</para>
28106
28107             <screenshot>
28108               <screeninfo>Item is not normally for loan</screeninfo>
28109
28110               <mediaobject>
28111                 <imageobject>
28112                   <imagedata fileref="images/circ/warnings/notforloan.png"/>
28113                 </imageobject>
28114               </mediaobject>
28115             </screenshot>
28116           </listitem>
28117
28118           <listitem>
28119             <para>Patron has too many things checked out and <link linkend="AllowTooManyOverride"
28120                 >AllowTooManyOverride</link> is set to 'Allow'</para>
28121
28122             <screenshot>
28123               <screeninfo>Too many checkouts</screeninfo>
28124
28125               <mediaobject>
28126                 <imageobject>
28127                   <imagedata fileref="images/circ/warnings/toomanycheckouts.png"/>
28128                 </imageobject>
28129               </mediaobject>
28130             </screenshot>
28131           </listitem>
28132           <listitem>
28133             <para>Patron has too many things checked out and <link linkend="AllowTooManyOverride"
28134                 >AllowTooManyOverride</link> is set to "Don't allow"</para>
28135             <screenshot>
28136               <screeninfo>Too many checkouts</screeninfo>
28137               <mediaobject>
28138                 <imageobject>
28139                   <imagedata fileref="images/circ/warnings/toomanycheckouts-no.png"/>
28140                 </imageobject>
28141               </mediaobject>
28142             </screenshot>
28143           </listitem>
28144
28145           <listitem>
28146             <para>Item cannot be renewed</para>
28147
28148             <screenshot>
28149               <screeninfo>No more renewals</screeninfo>
28150
28151               <mediaobject>
28152                 <imageobject>
28153                   <imagedata fileref="images/circ/warnings/norenewals.png"/>
28154                 </imageobject>
28155               </mediaobject>
28156             </screenshot>
28157
28158             <itemizedlist>
28159               <listitem>
28160                 <para>This can be overridden with the <link linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
28161                 system preference</para>
28162               </listitem>
28163             </itemizedlist>
28164           </listitem>
28165
28166           <listitem>
28167             <para>Barcode not found</para>
28168
28169             <screenshot>
28170               <screeninfo>Barcode not found</screeninfo>
28171
28172               <mediaobject>
28173                 <imageobject>
28174                   <imagedata fileref="images/circ/barcodefastadd.png"/>
28175                 </imageobject>
28176               </mediaobject>
28177             </screenshot>
28178
28179             <itemizedlist>
28180               <listitem>
28181                 <para>Learn more about <link linkend="fastaddcat">fast
28182                 cataloging</link> later in this manual.</para>
28183               </listitem>
28184             </itemizedlist>
28185           </listitem>
28186
28187           <listitem>
28188             <para>Item being checked out is marked as 'lost'</para>
28189
28190             <itemizedlist>
28191               <listitem>
28192                 <para>Depending on the value in your <link linkend="IssueLostItem">IssueLostItem</link> preference, you
28193                 may just see a warning</para>
28194
28195                 <screenshot>
28196                   <screeninfo>Warning that item is lost</screeninfo>
28197
28198                   <mediaobject>
28199                     <imageobject>
28200                       <imagedata fileref="images/circ/lostitemmsg.png"/>
28201                     </imageobject>
28202                   </mediaobject>
28203                 </screenshot>
28204
28205                 <para>or a confirmation box</para>
28206
28207                 <screenshot>
28208                   <screeninfo>Confirm checkout of lost item</screeninfo>
28209
28210                   <mediaobject>
28211                     <imageobject>
28212                       <imagedata fileref="images/circ/lostitemconfirm.png"/>
28213                     </imageobject>
28214                   </mediaobject>
28215                 </screenshot>
28216               </listitem>
28217             </itemizedlist>
28218           </listitem>
28219
28220           <listitem>
28221             <para>Item being checked out is not recommended for a patron of
28222             this age</para>
28223
28224             <screenshot>
28225               <screeninfo>Age warning</screeninfo>
28226
28227               <mediaobject>
28228                 <imageobject>
28229                   <imagedata fileref="images/circ/warnings/agewarning.png"/>
28230                 </imageobject>
28231               </mediaobject>
28232             </screenshot>
28233           </listitem>
28234           <listitem>
28235             <para>Item being checked out meets the <link linkend="decreaseLoanHighHolds">decreaseLoanHighHolds</link> system preference criteria</para>
28236             <screenshot>
28237               <screeninfo>Too many holds</screeninfo>
28238               <mediaobject>
28239                 <imageobject>
28240                   <imagedata fileref="images/circ/warnings/decreaseLoanHighHoldsDuration.png"/>
28241                 </imageobject>
28242               </mediaobject>
28243             </screenshot>
28244           </listitem>
28245         </itemizedlist>
28246       </section>
28247     </section>
28248
28249     <section id="circrenew">
28250       <title>Renewing</title>
28251
28252       <para>Checked out items can be renewed (checked out for another period of time) based on your
28253           <link linkend="circfinerules">circulation rules</link> and <link
28254           linkend="RenewalPeriodBase">renewal preferences</link>. </para>
28255       <para>If <link linkend="OpacRenewalAllowed">you allow it</link>, patrons can renew their own
28256         items via the OPAC, but sometimes you'll need to help them by renewing their items via the
28257         staff client. </para>
28258       <para>To renew items checked out to a patron, you can do one of two things. </para>
28259       <para>The first is to visit their details page or checkout page and review their checkout
28260         summary at the bottom.</para>
28261
28262       <screenshot>
28263         <screeninfo>Circulation Summary</screeninfo>
28264
28265         <mediaobject>
28266           <imageobject>
28267             <imagedata fileref="images/circ/circsummary.png"/>
28268           </imageobject>
28269         </mediaobject>
28270       </screenshot>
28271
28272       <para>In the Renew column you will see how many times each item has been
28273       renewed and a checkbox to renew the item for the patron. Check the boxed
28274       of the items you would like to renew and click the 'Renew or Return
28275       checked items' button, or to renew all items checked out to the patron
28276       simply click the 'Renew all' button.</para>
28277
28278       <screenshot>
28279         <screeninfo>Renew buttons</screeninfo>
28280
28281         <mediaobject>
28282           <imageobject>
28283             <imagedata fileref="images/circ/renewbutton.png"/>
28284           </imageobject>
28285         </mediaobject>
28286       </screenshot>
28287
28288       <para>Sometimes renewals will be blocked based on your circulation
28289       rules, to override this block you must have your <link linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
28290       preference set to 'Allow'. If you allow renewal limit overrides, you
28291       will see a checkbox at the bottom left of the circulation summary. Check
28292       that box and then choose the items you would like to renew.</para>
28293
28294       <screenshot>
28295         <screeninfo>Override renewal limit</screeninfo>
28296
28297         <mediaobject>
28298           <imageobject>
28299             <imagedata fileref="images/circ/overriderenew.png"/>
28300           </imageobject>
28301         </mediaobject>
28302       </screenshot>
28303
28304       <para>Checking that box will add checkboxes in the renew column above
28305       where before the item was not renewable.</para>
28306       <para>The second option is to visit the 'Renew' page found under the Circulation menu.</para>
28307       <screenshot>
28308         <screeninfo>Renew</screeninfo>
28309         <mediaobject>
28310           <imageobject>
28311             <imagedata fileref="images/circ/renewcirc.png"/>
28312           </imageobject>
28313         </mediaobject>
28314       </screenshot>
28315       <para>And scan the barcodes of the items you would like to renew.</para>
28316       <screenshot>
28317         <screeninfo>Barcode to renew</screeninfo>
28318         <mediaobject>
28319           <imageobject>
28320             <imagedata fileref="images/circ/renewbarcode.png"/>
28321           </imageobject>
28322         </mediaobject>
28323       </screenshot>
28324       <para>If the item is renewed you will receive a confirmation message.</para>
28325       <screenshot>
28326         <screeninfo>Item renewed</screeninfo>
28327         <mediaobject>
28328           <imageobject>
28329             <imagedata fileref="images/circ/renewed.png"/>
28330           </imageobject>
28331         </mediaobject>
28332       </screenshot>
28333       <para>If the barcode is not found you will be presented with an error.</para>
28334       <screenshot>
28335         <screeninfo>No barcode found</screeninfo>
28336         <mediaobject>
28337           <imageobject>
28338             <imagedata fileref="images/circ/renewnomatch.png"/>
28339           </imageobject>
28340         </mediaobject>
28341       </screenshot>
28342       <para>If the item is not actually checked out you will also receive an error.</para>
28343       <screenshot>
28344         <screeninfo>Item not checked out</screeninfo>
28345         <mediaobject>
28346           <imageobject>
28347             <imagedata fileref="images/circ/renewnotchecked.png"/>
28348           </imageobject>
28349         </mediaobject>
28350       </screenshot>
28351     </section>
28352
28353     <section id="checkingin">
28354       <title>Check In (Returning)</title>
28355
28356       <para>Checking in items can be performed from various different
28357       locations</para>
28358
28359       <itemizedlist>
28360         <listitem>
28361           <para>The check in box on the top of the main staff client</para>
28362
28363           <screenshot>
28364             <screeninfo>Check out box on main Koha Staff Client
28365             page</screeninfo>
28366
28367             <mediaobject>
28368               <imageobject>
28369                 <imagedata fileref="images/circ/checkinmain.png"/>
28370               </imageobject>
28371             </mediaobject>
28372           </screenshot>
28373         </listitem>
28374
28375         <listitem>
28376           <para>The check in option on the quick search bar on the Circulation
28377             page</para>
28378           <screenshot>
28379               <screeninfo>Check in tab on quick search bar</screeninfo>
28380
28381               <mediaobject>
28382                 <imageobject>
28383                   <imagedata fileref="images/circ/checkinquickbox.png"/>
28384                 </imageobject>
28385               </mediaobject>
28386             </screenshot>
28387         </listitem>
28388
28389         <listitem>
28390           <para>The check in link on the patron's checkout summary (and on the
28391           checkout summary page)</para>
28392
28393           <screenshot>
28394             <screeninfo>Patron checkout summary includes 'Check In'
28395             link</screeninfo>
28396
28397             <mediaobject>
28398               <imageobject>
28399                 <imagedata fileref="images/circ/checkinlink.png"/>
28400               </imageobject>
28401             </mediaobject>
28402           </screenshot>
28403         </listitem>
28404
28405         <listitem>
28406           <para>The Check in page under the Circulation menu</para>
28407
28408           <screenshot>
28409             <screeninfo>Check in link on Circulation Module</screeninfo>
28410
28411             <mediaobject>
28412               <imageobject>
28413                 <imagedata fileref="images/circ/checkincirc.png"/>
28414               </imageobject>
28415             </mediaobject>
28416           </screenshot>
28417         </listitem>
28418       </itemizedlist>
28419
28420       <section id="checkitemin">
28421         <title>Checking Items In</title>
28422
28423         <para>To check an item in scan the barcode for the item into the box
28424         provided. A summary of all items checked in will appear below the
28425         checkin box</para>
28426
28427         <screenshot>
28428           <screeninfo>Check In Summary</screeninfo>
28429
28430           <mediaobject>
28431             <imageobject>
28432               <imagedata fileref="images/circ/checkin.png"/>
28433             </imageobject>
28434           </mediaobject>
28435         </screenshot>
28436
28437         <para>If you are checking items in that were put in the book drop while the library was
28438           closed you can check the 'Book drop mode' box before scanning items. This will effectively
28439           roll back the returned date to the last date the library was open.</para>
28440
28441         <itemizedlist>
28442           <listitem>
28443             <para>This requires that you have your closings added to the <link linkend="calholidays">Holidays &amp; Calendar Tool </link></para>
28444           </listitem>
28445         </itemizedlist>
28446
28447         <para>You can also choose to forgive all overdue charges for items you
28448         are checking in by checking the 'Forgive overdue charges' box before
28449         scanning items.</para>
28450         <para>If you have the <link linkend="SpecifyReturnDate">SpecifyReturnDate</link> preference
28451           set to 'Allow' you will be able to arbitrarily set the return date from below the check in box.<screenshot>
28452             <screeninfo>Specify check in date</screeninfo>
28453             <mediaobject>
28454               <imageobject>
28455                 <imagedata fileref="images/circ/SpecifyReturnDate.png"/>
28456               </imageobject>
28457             </mediaobject>
28458           </screenshot></para>
28459       </section>
28460
28461       <section id="checkinmsg">
28462         <title>Check In Messages</title>
28463
28464         <para>There are several messages that can appear when checking items
28465         in:</para>
28466
28467         <itemizedlist>
28468           <listitem>
28469             <para>If you are checking an item in at a library other than the
28470             home branch, a message will appear asking you to transfer the book
28471             to the home library</para>
28472
28473             <screenshot>
28474               <screeninfo>Check in Transfer Message</screeninfo>
28475
28476               <mediaobject>
28477                 <imageobject>
28478                   <imagedata fileref="images/circ/checkintransfer.png"/>
28479                 </imageobject>
28480               </mediaobject>
28481             </screenshot>
28482
28483             <itemizedlist>
28484               <listitem>
28485                 <para>After this item is checked in the status of the item
28486                 will be changed in the catalog to 'in transit'</para>
28487
28488                 <screenshot>
28489                   <screeninfo>In Transit Status</screeninfo>
28490
28491                   <mediaobject>
28492                     <imageobject>
28493                       <imagedata fileref="images/circ/transferstatus.png"/>
28494                     </imageobject>
28495                   </mediaobject>
28496                 </screenshot>
28497               </listitem>
28498
28499               <listitem>
28500                 <para>To mark an item as back at the home branch, check the
28501                 item in at the home branch</para>
28502
28503                 <screenshot>
28504                   <screeninfo>Check In Transferred Item</screeninfo>
28505
28506                   <mediaobject>
28507                     <imageobject>
28508                       <imagedata fileref="images/circ/transfercheckin.png"/>
28509                     </imageobject>
28510                   </mediaobject>
28511                 </screenshot>
28512
28513                 <itemizedlist>
28514                   <listitem>
28515                     <para>A message will appear tell you that the item is not
28516                     checked out, but the status will now say available in the
28517                     catalog. This step is necessary to mark items as received
28518                     by the home branch.</para>
28519                   </listitem>
28520                 </itemizedlist>
28521               </listitem>
28522             </itemizedlist>
28523           </listitem>
28524
28525           <listitem>
28526             <para>If you are checking in an item that should have multiple
28527             parts or pieces a message will appear warning you about the number
28528             of pieces you should have in your hand</para>
28529
28530             <screenshot>
28531               <screeninfo>Materials Specified</screeninfo>
28532
28533               <mediaobject>
28534                 <imageobject>
28535                   <imagedata fileref="images/circ/materialspecified.png"/>
28536                 </imageobject>
28537               </mediaobject>
28538             </screenshot>
28539           </listitem>
28540
28541           <listitem>
28542             <para>If you're checking an item in that has a hold on it, you
28543             will be prompted to confirm the hold</para>
28544
28545             <screenshot>
28546               <screeninfo>Hold Found Check In Message</screeninfo>
28547
28548               <mediaobject>
28549                 <imageobject>
28550                   <imagedata fileref="images/circ/holdfound.png"/>
28551                 </imageobject>
28552               </mediaobject>
28553             </screenshot>
28554
28555             <itemizedlist>
28556               <listitem>
28557                 <para>Clicking the Confirm hold button will mark the item as
28558                 waiting for pickup from the library</para>
28559
28560                 <screenshot>
28561                   <screeninfo>Hold waiting at the library</screeninfo>
28562
28563                   <mediaobject>
28564                     <imageobject>
28565                       <imagedata fileref="images/circ/waitingstatus.png"/>
28566                     </imageobject>
28567                   </mediaobject>
28568                 </screenshot>
28569               </listitem>
28570
28571               <listitem>
28572                 <para>Clicking the Print Slip and Confirm button will mark the
28573                 item as waiting for pickup at the library and present the
28574                 library with a receipt to print and place on the book with the
28575                 patron's information</para>
28576               </listitem>
28577
28578               <listitem>
28579                 <para>Ignoring the hold will leave the item on hold, but leave
28580                 its status as Available (it will not cancel the hold)</para>
28581               </listitem>
28582             </itemizedlist>
28583           </listitem>
28584
28585           <listitem>
28586             <para>If you're checking in an item that has a hold on it at
28587             another branch you will be prompted to confirm and transfer the
28588             item</para>
28589
28590             <screenshot>
28591               <screeninfo>Hold found for another branch</screeninfo>
28592
28593               <mediaobject>
28594                 <imageobject>
28595                   <imagedata fileref="images/circ/holdconfirmtransfer.png"/>
28596                 </imageobject>
28597               </mediaobject>
28598             </screenshot>
28599
28600             <itemizedlist>
28601               <listitem>
28602                 <para>Clicking the Confirm hold and Transfer button will mark
28603                 the item as in transit to the library where the hold was
28604                 placed</para>
28605
28606                 <screenshot>
28607                   <screeninfo>In transit hold status</screeninfo>
28608
28609                   <mediaobject>
28610                     <imageobject>
28611                       <imagedata fileref="images/circ/intransithold.png"/>
28612                     </imageobject>
28613                   </mediaobject>
28614                 </screenshot>
28615               </listitem>
28616
28617               <listitem>
28618                 <para>Clicking the Print Slip, Transfer and Confirm button
28619                 will mark the item as in transit to the library where the hold
28620                 was placed and present the library with a receipt to print and
28621                 place on the book with the patron's information</para>
28622               </listitem>
28623
28624               <listitem>
28625                 <para>Ignoring the hold will leave the item on hold, but leave
28626                 its status as Available (it will not cancel the hold)</para>
28627               </listitem>
28628             </itemizedlist>
28629           </listitem>
28630
28631           <listitem>
28632             <para>If you have the system showing you fines at the time of
28633             checkin (<link linkend="FineNotifyAtCheckin">FineNotifyAtCheckin</link>) you will
28634             see a message telling you about the fine and providing you a link
28635             to the payment page for that patron</para>
28636
28637             <screenshot>
28638               <screeninfo>FineNotifyAtCheckin</screeninfo>
28639
28640               <mediaobject>
28641                 <imageobject>
28642                   <imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
28643                 </imageobject>
28644               </mediaobject>
28645             </screenshot>
28646           </listitem>
28647         </itemizedlist>
28648       </section>
28649     </section>
28650
28651     <section id="circmessages">
28652       <title>Circulation Messages</title>
28653
28654       <para>Circulation messages are short messages that librarians can leave
28655       for their patrons or their colleagues that will appear at the time of
28656       circulation.</para>
28657
28658       <section id="setcircmsg">
28659         <title>Setting up Messages</title>
28660
28661         <para>Circulation messages are set up as <link linkend="authorizedvalues">Authorized Values</link>. To add or edit
28662         Circulation Messages you want to work with the <link linkend="bornotes">BOR_NOTES</link> value.</para>
28663
28664         <screenshot>
28665           <screeninfo>BOR_NOTES Authorized Values</screeninfo>
28666
28667           <mediaobject>
28668             <imageobject>
28669               <imagedata fileref="images/circ/bor_notes.png"/>
28670             </imageobject>
28671           </mediaobject>
28672         </screenshot>
28673
28674         <para>The 'Description' field can hold a canned message that you would
28675         like to appear on the patron's record. <important>
28676             <para>The 'Description' field is limited to 80 characters, but the
28677             patron message field can hold more than that. Enter 80 characters
28678             in the 'Description' field and then type the rest on the patron
28679             record.</para>
28680           </important></para>
28681       </section>
28682
28683       <section id="addcircmsg">
28684         <title>Adding a Message</title>
28685
28686         <para>When on the patron's check out tab you will see a link to 'Add a
28687         new message' to the right of the check out box.</para>
28688
28689         <screenshot>
28690           <screeninfo>Circulation Message in Staff Client</screeninfo>
28691
28692           <mediaobject>
28693             <imageobject>
28694               <imagedata fileref="images/circ/staffmessages.png"/>
28695             </imageobject>
28696           </mediaobject>
28697         </screenshot>
28698
28699         <para>When you click 'Add a new message' you will be asked to choose
28700         if the message is for the librarians or the patron and the message you
28701         would like to leave.</para>
28702
28703         <screenshot>
28704           <screeninfo>Leave a Circulation Message</screeninfo>
28705
28706           <mediaobject>
28707             <imageobject>
28708               <imagedata fileref="images/circ/leavecircmsg.png"/>
28709             </imageobject>
28710           </mediaobject>
28711         </screenshot>
28712
28713         <note>
28714           <para>A message for the patron will also show to the library
28715           staff.</para>
28716         </note>
28717       </section>
28718
28719       <section id="viewcircmsg">
28720         <title>Viewing Messages</title>
28721
28722         <para>Circulation messages meant for the staff and/or the patron will
28723         appear on the patron's checkout screen to the right of the checkout
28724         box. Messages in bold and red are meant for the library staff only,
28725         whereas messages in regular italics font are meant for the patron and
28726         the librarian.</para>
28727
28728         <screenshot>
28729           <screeninfo>Circulation Message in Staff Client</screeninfo>
28730
28731           <mediaobject>
28732             <imageobject>
28733               <imagedata fileref="images/circ/staffmessages.png"/>
28734             </imageobject>
28735           </mediaobject>
28736         </screenshot>
28737
28738         <para>Circulation messages meant for the patron will also appear when
28739         they log into the OPAC.</para>
28740
28741         <screenshot>
28742           <screeninfo>Circulation Message in OPAC</screeninfo>
28743
28744           <mediaobject>
28745             <imageobject>
28746               <imagedata fileref="images/circ/opacmsg.png"/>
28747             </imageobject>
28748           </mediaobject>
28749         </screenshot>
28750       </section>
28751     </section>
28752
28753     <section id="holds">
28754       <title>Holds</title>
28755
28756       <para>Koha allows patrons to put things on hold.  A 'Hold' is a way to reserve an item.
28757         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
28758         items on hold for pickup at the library at a later date/time.</para>
28759
28760       <section id="holdsinstaff">
28761         <title>Placing Holds in Staff Client</title>
28762
28763         <para>There are several ways to place holds from the staff client. The
28764         most obvious is using the 'Place Hold' button at the top of any
28765         bibliographic record.</para>
28766
28767         <screenshot>
28768           <screeninfo>Place Hold Button on Bib Record</screeninfo>
28769
28770           <mediaobject>
28771             <imageobject>
28772               <imagedata fileref="images/circ/placeholdbib.png"/>
28773             </imageobject>
28774           </mediaobject>
28775         </screenshot>
28776
28777         <para>You can also click the smaller 'Place Hold' link found at the
28778         top of your catalog search results, or the 'Holds' link found below
28779         each result.</para>
28780
28781         <screenshot>
28782           <screeninfo>Hold options on search results</screeninfo>
28783
28784           <mediaobject>
28785             <imageobject>
28786               <imagedata fileref="images/circ/placeholdsearch.png"/>
28787             </imageobject>
28788           </mediaobject>
28789         </screenshot>
28790
28791         <para>You will be asked to search for a patron by barcode or any part
28792         of their name to start the hold process.</para>
28793
28794         <screenshot>
28795           <screeninfo>Find Patron For Hold</screeninfo>
28796
28797           <mediaobject>
28798             <imageobject>
28799               <imagedata fileref="images/circ/placeholdfindpatron.png"/>
28800             </imageobject>
28801           </mediaobject>
28802         </screenshot>
28803
28804         <para>If you'd like to search for the patron first and then the bib
28805         record for the hold, you can open the patron record and click on the
28806         'Search to Hold' button at the top of the patron record.</para>
28807
28808         <screenshot>
28809           <screeninfo>Search to Hold on Patron Record</screeninfo>
28810
28811           <mediaobject>
28812             <imageobject>
28813               <imagedata fileref="images/circ/searchtohold.png"/>
28814             </imageobject>
28815           </mediaobject>
28816         </screenshot>
28817
28818         <para>After clicking the button you will be brought to the catalog
28819         search page where you can find the book(s) you want to place a hold
28820         on. Under each title on the results you'll see an option to 'Hold for
28821         Patron Name.'</para>
28822
28823         <screenshot>
28824           <screeninfo>Hold for Patron links on Search Results</screeninfo>
28825
28826           <mediaobject>
28827             <imageobject>
28828               <imagedata fileref="images/circ/holdresults.png"/>
28829             </imageobject>
28830           </mediaobject>
28831         </screenshot>
28832
28833         <para>If you want to place a hold on multiple items, simply check the
28834         boxes to the left of them and click the arrow to the right of the
28835         'Place Hold' button.</para>
28836
28837         <screenshot>
28838           <screeninfo>Hold Multiple Items for Patron</screeninfo>
28839
28840           <mediaobject>
28841             <imageobject>
28842               <imagedata fileref="images/circ/holdmultiresults.png"/>
28843             </imageobject>
28844           </mediaobject>
28845         </screenshot>
28846
28847         <para>Depending on how many items you choose to place a hold on at
28848         once you will see a different place hold form. If you are placing a
28849         hold on one bibliographic record you will see a list of all of the
28850         items you can place a hold on.</para>
28851
28852         <screenshot>
28853           <screeninfo>Place Hold Form</screeninfo>
28854
28855           <mediaobject>
28856             <imageobject>
28857               <imagedata fileref="images/circ/placeholdsingle.png"/>
28858             </imageobject>
28859           </mediaobject>
28860         </screenshot>
28861
28862         <itemizedlist>
28863           <listitem>
28864             <para>Enter any notes that might apply to this hold</para>
28865           </listitem>
28866
28867           <listitem>
28868             <para>Choose the library where the patron will pick up the
28869             item</para>
28870           </listitem>
28871
28872           <listitem>
28873             <para>If the patron wants the hold to start on a date other than
28874             today, enter that in the 'Hold starts on date' field</para>
28875
28876             <itemizedlist>
28877               <listitem>
28878                 <para>This option will only appear if the <link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
28879                 system preference is set to 'Allow'</para>
28880               </listitem>
28881             </itemizedlist>
28882           </listitem>
28883
28884           <listitem>
28885             <para>If the patron has specified that they don't want the item
28886             after a certain date, or if you have limits on hold lengths, you
28887             can enter an expiration date for the hold in the 'Hold expires on
28888             date'</para>
28889
28890             <itemizedlist>
28891               <listitem>
28892                 <para>To have expired holds canceled automatically you will
28893                 need to have the <link linkend="expiredholdscron">Expired
28894                 Holds</link> cron job set to run on a regular basis.</para>
28895               </listitem>
28896             </itemizedlist>
28897           </listitem>
28898
28899           <listitem>
28900             <para>Next choose if you want to place a hold on the next
28901             available item or a specific item by clicking the radio button
28902             next to an individual item.</para>
28903           </listitem>
28904         </itemizedlist>
28905
28906         <para>If you're placing a hold on multiple items you will be presented
28907         with the next available option for all titles. If no items are
28908         available for hold it will say so on the confirmation screen.</para>
28909
28910         <screenshot>
28911           <screeninfo>Place multiple items on hold</screeninfo>
28912
28913           <mediaobject>
28914             <imageobject>
28915               <imagedata fileref="images/circ/placeholdmultiple.png"/>
28916             </imageobject>
28917           </mediaobject>
28918         </screenshot>
28919
28920         <para>Once your hold is placed, if you'd like to have Koha forget that
28921         you used the 'Search to Hold' function, you can choose to have Koha
28922         'forget' the patron's name by clicking the arrow to the right of the
28923         'Place Hold' button on the search results and choosing the 'Forget'
28924         option.</para>
28925
28926         <screenshot>
28927           <screeninfo>Forget Search to Hold Option</screeninfo>
28928
28929           <mediaobject>
28930             <imageobject>
28931               <imagedata fileref="images/circ/forgethold.png"/>
28932             </imageobject>
28933           </mediaobject>
28934         </screenshot>
28935       </section>
28936
28937       <section id="manageholds">
28938         <title>Managing Holds</title>
28939
28940         <para>Holds can be altered and canceled from the Holds tab found on
28941         the left of the bibliographic record.</para>
28942
28943         <screenshot>
28944           <screeninfo>Bibliographic Record Tabs</screeninfo>
28945
28946           <mediaobject>
28947             <imageobject>
28948               <imagedata fileref="images/circ/holdtab.png"/>
28949             </imageobject>
28950           </mediaobject>
28951         </screenshot>
28952
28953         <para>From the list of holds you can change the order of the holds,
28954         the pickup location, suspend and/or cancel the hold.</para>
28955
28956         <screenshot>
28957           <screeninfo>Lists of Holds</screeninfo>
28958
28959           <mediaobject>
28960             <imageobject>
28961               <imagedata fileref="images/circ/holdslist.png"/>
28962             </imageobject>
28963           </mediaobject>
28964         </screenshot>
28965
28966         <note>
28967           <para>If you have your <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
28968           preference set to "Don't allow" then you will not have the option to
28969           put an end date on the hold suspension</para>
28970         </note>
28971
28972         <note>
28973           <para>Depending on how you have your <link linkend="HidePatronName">HidePatronName</link> system preference set
28974           the list may show card numbers instead of names in the Patron column
28975           like in the image above.</para>
28976         </note>
28977
28978         <para>To rearrange or delete holds, simply make a selection from the
28979         'Priority' pull down or click the arrows to the right of the priority
28980         pull down.</para>
28981
28982         <screenshot>
28983           <screeninfo>Hold Priority Menu</screeninfo>
28984
28985           <mediaobject>
28986             <imageobject>
28987               <imagedata fileref="images/circ/holdpriority.png"/>
28988             </imageobject>
28989           </mediaobject>
28990         </screenshot>
28991
28992         <para>If you use the priority pull down to rearrange or delete holds
28993         you will need to click the 'Update hold(s)' button to save your
28994         changes.</para>
28995
28996         <para>Clicking the down arrow to the right of the hold will stick the
28997         hold at the bottom of the list even if more requests are made.</para>
28998
28999         <para>For example, your library has home-bound patrons that are
29000         allowed to keep books out for months at a time. It would not be fair
29001         to other patrons if a home-bound patron were able to check out a brand
29002         new book and keep it for months. For this reason, the home-bound
29003         patron's hold request would stay at the bottom of the queue until
29004         everyone else who wanted to read that book has already done so.</para>
29005
29006         <screenshot>
29007           <screeninfo>Lowest Priority &amp; Delete Options for
29008           Holds</screeninfo>
29009
29010           <mediaobject>
29011             <imageobject>
29012               <imagedata fileref="images/circ/lowestpriority.png"/>
29013             </imageobject>
29014           </mediaobject>
29015         </screenshot>
29016
29017         <para>If a patron asks to have their hold suspended and you have the
29018         <link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
29019         system preference set to 'allow' you can do so by clicking the Suspend
29020         button to far right. If the patron gives you a date for the items to
29021         become unsuspended you can enter that in the date box and click the
29022         'Update hold(s)' button to save your changes.</para>
29023
29024         <screenshot>
29025           <screeninfo>Hold suspension column</screeninfo>
29026
29027           <mediaobject>
29028             <imageobject>
29029               <imagedata fileref="images/circ/suspendholds.png"/>
29030             </imageobject>
29031           </mediaobject>
29032         </screenshot>
29033
29034         <para>To delete or cancel a hold click the red 'X' to the right of the
29035         hold line. To delete/cancel a bunch of holds you can choose 'del' from
29036         pull down to the left of each line and then click 'Update hold(s)' at
29037         the bottom of the list.</para>
29038
29039         <screenshot>
29040           <screeninfo>Cancel Holds</screeninfo>
29041
29042           <mediaobject>
29043             <imageobject>
29044               <imagedata fileref="images/circ/cancelholds.png"/>
29045             </imageobject>
29046           </mediaobject>
29047         </screenshot>
29048       </section>
29049
29050       <section id="receiveholds">
29051         <title>Receiving Holds</title>
29052
29053         <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
29054           the item is on hold and offer them options for managing the hold.</para>
29055
29056         <para>When you check in an item that has a hold on it the system will
29057         ask you to either confirm and transfer the item</para>
29058
29059         <screenshot>
29060           <screeninfo>Confirm Hold &amp; Transfer</screeninfo>
29061
29062           <mediaobject>
29063             <imageobject>
29064               <imagedata fileref="images/circ/holdconfirmtransfer.png"/>
29065             </imageobject>
29066           </mediaobject>
29067         </screenshot>
29068
29069         <para>or just confirm the hold</para>
29070
29071         <screenshot>
29072           <screeninfo>Confirm Hold</screeninfo>
29073
29074           <mediaobject>
29075             <imageobject>
29076               <imagedata fileref="images/circ/holdconfirm.png"/>
29077             </imageobject>
29078           </mediaobject>
29079         </screenshot>
29080
29081         <para>Clicking the Confirm button will mark the item as on hold for
29082         the patron. If the item needs to be transferred the item will also be
29083         marked as in transit to the proper branch. Clicking 'Ignore' will
29084         retain the hold, but allow you to check the item out to another
29085         patron. Choosing to confirm and print will present you with a
29086         printable page that you can slip inside the book with the necessary
29087         hold and/or transfer information.</para>
29088
29089         <para>Once confirmed the hold will show on the patron record and on
29090         the checkout screen under the 'Hold' tab.</para>
29091
29092         <screenshot>
29093           <screeninfo>Hold on Patron Record</screeninfo>
29094
29095           <mediaobject>
29096             <imageobject>
29097               <imagedata fileref="images/circ/holdpatronrec.png"/>
29098             </imageobject>
29099           </mediaobject>
29100         </screenshot>
29101
29102         <para>The item record will also show that the item is on hold.</para>
29103
29104         <screenshot>
29105           <screeninfo>Hold on Item Record</screeninfo>
29106
29107           <mediaobject>
29108             <imageobject>
29109               <imagedata fileref="images/circ/holditem.png"/>
29110             </imageobject>
29111           </mediaobject>
29112         </screenshot>
29113
29114         <para>In some cases a patron may come in to pick up a hold for their
29115         partner (or someone else in their household). In this case you want to
29116         make sure that the hold is cancelled when you check the item out to
29117         someone else. When trying to check out an item that is already waiting
29118         for someone else you will be presented with a warning message.</para>
29119
29120         <screenshot>
29121           <screeninfo>Hold waiting for someone else</screeninfo>
29122
29123           <mediaobject>
29124             <imageobject>
29125               <imagedata fileref="images/circ/holdwaitingwarn.png"/>
29126             </imageobject>
29127           </mediaobject>
29128         </screenshot>
29129
29130         <para>From here you can check the item out to the patron at the desk
29131         and cancel the hold for the patron.</para>
29132       </section>
29133     </section>
29134
29135     <section id="transfers">
29136       <title>Transfers</title>
29137
29138       <para>If you work in a multi-branch system you can transfer items from one library to another
29139         by using the Transfer tool.<itemizedlist>
29140           <listitem>
29141             <para><emphasis role="italic">Get there</emphasis>: Circulation > Transfer</para>
29142           </listitem>
29143         </itemizedlist></para>
29144       <para>To transfer an item</para>
29145
29146       <itemizedlist>
29147         <listitem>
29148           <para>Click 'Transfer' on the Circulation page</para>
29149
29150           <screenshot>
29151             <screeninfo>Transfer Tool</screeninfo>
29152
29153             <mediaobject>
29154               <imageobject>
29155                 <imagedata fileref="images/circ/transfer.png"/>
29156               </imageobject>
29157             </mediaobject>
29158           </screenshot>
29159
29160           <itemizedlist>
29161             <listitem>
29162               <para>Enter the library you would like to transfer the item
29163               to</para>
29164             </listitem>
29165
29166             <listitem>
29167               <para>Scan or type the barcode on the item you would like to
29168               transfer</para>
29169             </listitem>
29170           </itemizedlist>
29171         </listitem>
29172
29173         <listitem>
29174           <para>Click 'Submit'</para>
29175
29176           <screenshot>
29177             <screeninfo>Transfer Summary</screeninfo>
29178
29179             <mediaobject>
29180               <imageobject>
29181                 <imagedata fileref="images/circ/itemtransferred.png"/>
29182               </imageobject>
29183             </mediaobject>
29184           </screenshot>
29185         </listitem>
29186
29187         <listitem>
29188           <para>The item will now say that it is in transit</para>
29189
29190           <screenshot>
29191             <screeninfo>Item in Transit</screeninfo>
29192
29193             <mediaobject>
29194               <imageobject>
29195                 <imagedata fileref="images/circ/itemintransit.png"/>
29196               </imageobject>
29197             </mediaobject>
29198           </screenshot>
29199         </listitem>
29200
29201         <listitem>
29202           <para>When the item arrives at the other branch the librarian must
29203           check the item in to acknowledge that it is no longer in
29204           transit</para>
29205         </listitem>
29206
29207         <listitem>
29208           <para>The item will not be permanently moved to the new
29209           library</para>
29210
29211           <screenshot>
29212             <screeninfo>Item record</screeninfo>
29213
29214             <mediaobject>
29215               <imageobject>
29216                 <imagedata fileref="images/circ/itemlocations.png"/>
29217               </imageobject>
29218             </mediaobject>
29219           </screenshot>
29220
29221           <itemizedlist>
29222             <listitem>
29223               <para>The item shows the same 'Home Library' but has updated the
29224               'Current Location' to note where it resides at this time</para>
29225             </listitem>
29226           </itemizedlist>
29227         </listitem>
29228       </itemizedlist>
29229     </section>
29230
29231     <section id="setlibrary">
29232       <title>Set Library</title>
29233
29234       <para>By default you will enter the staff client as if you are at your
29235       home library. This library will appear in the top right of the Staff
29236       Client.</para>
29237
29238       <screenshot>
29239         <screeninfo>My Library</screeninfo>
29240
29241         <mediaobject>
29242           <imageobject>
29243             <imagedata fileref="images/circ/mylibrary.png"/>
29244           </imageobject>
29245         </mediaobject>
29246       </screenshot>
29247
29248       <para>This is the library that all circulation transactions will take
29249       place at. If you are at another library (or on a bookmobile) you will
29250       want to set your library before you start circulating items. To do this
29251       you can click 'Set' at the top right or on the Circulation page.</para>
29252
29253       <screenshot>
29254         <screeninfo>Set Library Form</screeninfo>
29255
29256         <mediaobject>
29257           <imageobject>
29258             <imagedata fileref="images/circ/setlibrary.png"/>
29259           </imageobject>
29260         </mediaobject>
29261       </screenshot>
29262
29263       <para>Once you have saved your changes you new library will appear in
29264       the top right.</para>
29265     </section>
29266
29267     <section id="fastaddcat">
29268       <title>Fast Add Cataloging</title>
29269
29270       <para>Sometimes circulation librarians need to quickly add a record to
29271       the system for an item they are about to check out. This is called 'Fast
29272       Add.' To allow circulation librarians access to the Fast Add Cataloging
29273       tool, simply make sure they have the <link linkend="fastaddpermissions">fast_cataloging</link> permissions. There
29274       are two ways to add titles via fast add. If you know that you're about
29275       to check out an item that isn't in you catalog you can go to the
29276       Circulation module and click 'Fast cataloging.'</para>
29277
29278       <screenshot>
29279         <screeninfo>Circulation Menu</screeninfo>
29280
29281         <mediaobject>
29282           <imageobject>
29283             <imagedata fileref="images/circ/circmenu.png"/>
29284           </imageobject>
29285         </mediaobject>
29286       </screenshot>
29287
29288       <para>The cataloging interface will open up with the short cataloging
29289       record:</para>
29290
29291       <screenshot>
29292         <screeninfo>Fast Add Framework</screeninfo>
29293
29294         <mediaobject>
29295           <imageobject>
29296             <imagedata fileref="images/circ/fastadd.png"/>
29297           </imageobject>
29298         </mediaobject>
29299       </screenshot>
29300
29301       <para>After adding your cataloging data you will be asked to enter item
29302       data. Enter the items barcode, collection code, etc and save the item
29303       before checking it out.</para>
29304
29305       <para>The other way to fast catalog is from the checkout screen. When
29306       you enter a barcode at checkout that Koha can't find, it will prompt you
29307       to use fast cataloging to add the item to Koha and check it out.</para>
29308
29309       <screenshot>
29310         <screeninfo>Barcode not found</screeninfo>
29311
29312         <mediaobject>
29313           <imageobject>
29314             <imagedata fileref="images/circ/barcodefastadd.png"/>
29315           </imageobject>
29316         </mediaobject>
29317       </screenshot>
29318
29319       <para>Clicking 'Fast cataloging' will bring you to the fast cataloging
29320       form where you can enter the title information</para>
29321
29322       <screenshot>
29323         <screeninfo>Fast cataloging</screeninfo>
29324
29325         <mediaobject>
29326           <imageobject>
29327             <imagedata fileref="images/circ/fastaddbarcode.png"/>
29328           </imageobject>
29329         </mediaobject>
29330       </screenshot>
29331
29332       <para>After clicking 'Save' you will be brought to the item record where
29333       the barcode will already be filled in with the barcode you're trying to
29334       check out.</para>
29335
29336       <screenshot>
29337         <screeninfo>Fast cataloging item record</screeninfo>
29338
29339         <mediaobject>
29340           <imageobject>
29341             <imagedata fileref="images/circ/fastadditem.png"/>
29342           </imageobject>
29343         </mediaobject>
29344       </screenshot>
29345
29346       <para>After clicking the 'Add item' button the item will automatically
29347       be checked out the patron you were trying to check the book out to
29348       originally.</para>
29349
29350       <screenshot>
29351         <screeninfo>Checked out item</screeninfo>
29352
29353         <mediaobject>
29354           <imageobject>
29355             <imagedata fileref="images/circ/fastaddcheckedout.png"/>
29356           </imageobject>
29357         </mediaobject>
29358       </screenshot>
29359     </section>
29360
29361     <section id="circreports">
29362       <title>Circulation Reports</title>
29363
29364       <para>Most reports can be found vai the Reports module, but some of the more common
29365         circulation reports are available right from the Circulation module.<itemizedlist>
29366           <listitem>
29367             <para><emphasis role="italic">Get there</emphasis>: Circulation > Circulation
29368               reports</para>
29369           </listitem>
29370         </itemizedlist></para>
29371
29372       <section id="holdsqueue">
29373         <title>Holds Queue</title>
29374
29375         <para>This report will show you all of the holds at your
29376         library.</para>
29377
29378         <screenshot>
29379           <screeninfo>Sample Holds Queue</screeninfo>
29380
29381           <mediaobject>
29382             <imageobject>
29383               <imagedata fileref="images/circ/holdsqueue.png"/>
29384             </imageobject>
29385           </mediaobject>
29386         </screenshot>
29387
29388         <para>To generate this report, you must have the <link linkend="buildholdscron">Build Holds Queue cron job</link> running.
29389         This cron job is a script that should be run periodically if your
29390         library system allows borrowers to place on-shelf holds. This script
29391         decides which library should be responsible for fulfilling a given
29392         hold request.</para>
29393
29394         <para>It's behavior is controlled by the system preferences <link linkend="holdqueueweight">StaticHoldsQueueWeight</link> and <link linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
29395
29396         <para>If you do not want all of your libraries to participate in the
29397         on-shelf holds fulfillment process, you should list the the libraries
29398         that *do* participate in the process here by inputting all the
29399         participating library's branchcodes, separated by commas ( e.g.
29400         "MPL,CPL,SPL,BML" etc. ).</para>
29401
29402         <para>By default, the holds queue will be generated such that the
29403         system will first attempt to hold fulfillment using items already at
29404         the pickup library if possible. If there are no items available at the
29405         pickup library to fill a hold, build_holds_queue.pl will then use the
29406         list of libraries defined in StaticHoldsQueueWeight. If
29407         RandomizeHoldsQueueWeight is disabled ( which it is by default ), the
29408         script will assign fulfillment requests in the order the branches are
29409         placed in the StaticHoldsQueueWeight system preference.</para>
29410
29411         <para>For example, if your system has three libraries, of varying
29412         sizes ( small, medium and large ) and you want the burden of holds
29413         fulfillment to be on larger libraries before smaller libraries, you
29414         would want StaticHoldsQueueWeight to look something like
29415         "LRG,MED,SML".</para>
29416
29417         <para>If you want the burden of holds fulfillment to be spread out
29418         equally throughout your library system, simply enable
29419         RandomizeHoldsQueueWeight. When this system preference is enabled, the
29420         order in which libraries will be requested to fulfill an on-shelf hold
29421         will be randomized each time the list is regenerated.</para>
29422
29423         <para>Leaving StaticHoldsQueueWeight empty is contraindicated at this
29424         time. Doing so will cause the build_holds_queue script to ignore
29425         RandomizeHoldsQueueWeight, causing the script to request hold
29426         fulfillment not randomly, but by alphabetical order.</para>
29427       </section>
29428
29429       <section id="holdspull">
29430         <title>Holds to pull</title>
29431
29432         <para>This report will show you all of the items that have holds on
29433         them that are available at the library for pulling. If the items are
29434         available at multiple branches then all branches with that item
29435         available will see the hold to pull until one library triggers the
29436         hold.</para>
29437
29438         <screenshot>
29439           <screeninfo>Holds to Pull</screeninfo>
29440
29441           <mediaobject>
29442             <imageobject>
29443               <imagedata fileref="images/circ/holdstopull.png"/>
29444             </imageobject>
29445           </mediaobject>
29446         </screenshot>
29447
29448         <para>You can limit the results you see by using the Refine box on the
29449         left side of the page:</para>
29450
29451         <screenshot>
29452           <screeninfo>Refine Holds to Pull Report</screeninfo>
29453
29454           <mediaobject>
29455             <imageobject>
29456               <imagedata fileref="images/circ/refineholdstopull.png"/>
29457             </imageobject>
29458           </mediaobject>
29459         </screenshot>
29460       </section>
29461
29462       <section id="holdspickup">
29463         <title>Holds awaiting pickup</title>
29464
29465         <para>This report will show all of the holds that are waiting for
29466         patrons to pick them up.</para>
29467
29468         <screenshot>
29469           <screeninfo>Holds Awaiting Pickup</screeninfo>
29470
29471           <mediaobject>
29472             <imageobject>
29473               <imagedata fileref="images/circ/holdspickup.png"/>
29474             </imageobject>
29475           </mediaobject>
29476         </screenshot>
29477
29478         <para>Items that have been on the hold shelf longer than you normally
29479         allow (based on the <link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
29480         preference value) will appear on the 'Holds Over' tab, they will not
29481         automatically be cancelled unless you have set the <link linkend="expiredholdscron">cron job</link> to do that for you, but you
29482         can cancel all holds using the button at the top of the list.</para>
29483
29484         <screenshot>
29485           <screeninfo>Items waiting on the hold shelf too long</screeninfo>
29486
29487           <mediaobject>
29488             <imageobject>
29489               <imagedata fileref="images/circ/holdspickupover.png"/>
29490             </imageobject>
29491           </mediaobject>
29492         </screenshot>
29493       </section>
29494
29495       <section id="holdratios">
29496         <title>Hold ratios</title>
29497
29498         <para>Hold ratios help with collection development. Using this report
29499         you will be able to see how many of your patrons have holds on items
29500         and whether you should buy more. By default it will be set to the
29501         library needing 3 items per hold that has been placed. The report will
29502         tell you how many additional items need to be purchased to meet this
29503         quota.</para>
29504
29505         <screenshot>
29506           <screeninfo>Hold Ratios</screeninfo>
29507
29508           <mediaobject>
29509             <imageobject>
29510               <imagedata fileref="images/circ/holdratio.png"/>
29511             </imageobject>
29512           </mediaobject>
29513         </screenshot>
29514       </section>
29515
29516       <section id="transferstoreceive">
29517         <title>Transfers to receive</title>
29518
29519         <para>This report will list all of the items that Koha thinks are in
29520         transit to your library.</para>
29521
29522         <screenshot>
29523           <screeninfo>Transfers to Receive</screeninfo>
29524
29525           <mediaobject>
29526             <imageobject>
29527               <imagedata fileref="images/circ/transitreceive.png"/>
29528             </imageobject>
29529           </mediaobject>
29530         </screenshot>
29531
29532         <para>If your transfers are late in arriving at your library you will
29533         see a message stating how late your items are.</para>
29534
29535         <screenshot>
29536           <screeninfo>Late transfers include warning messages</screeninfo>
29537
29538           <mediaobject>
29539             <imageobject>
29540               <imagedata fileref="images/circ/transferlate.png"/>
29541             </imageobject>
29542           </mediaobject>
29543         </screenshot>
29544
29545         <important>
29546           <para>An item is considered late based on the number of days you
29547           have entered in the <link linkend="TransfersMaxDaysWarning">TransfersMaxDaysWarning</link>
29548           system preference.</para>
29549         </important>
29550       </section>
29551
29552       <section id="overduesreport">
29553         <title>Overdues</title>
29554
29555         <important>
29556           <para>For libraries with a large patron base, this report may take a
29557           significant amount of time to run.</para>
29558         </important>
29559
29560         <note>
29561           <para>Large libraries can choose to filter the report before it runs
29562           by setting the <link linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
29563           system preference to 'Require'.</para>
29564         </note>
29565
29566         <para>This report will list all items that are overdue at your
29567         library.</para>
29568
29569         <screenshot>
29570           <screeninfo>Overdues List</screeninfo>
29571
29572           <mediaobject>
29573             <imageobject>
29574               <imagedata fileref="images/circ/overdues.png"/>
29575             </imageobject>
29576           </mediaobject>
29577         </screenshot>
29578
29579         <para>The report can be filtered using the menu options found on the left of the report.<note>
29580             <para>The 'Show any items currently checked out' checkbox basically switches this from a
29581               report of overdues to a report of checkouts.  It will show all titles checked out
29582               regardless of due date.</para>
29583           </note></para>
29584       </section>
29585
29586       <section id="overduesfines">
29587         <title>Overdues with fines</title>
29588
29589         <para>This report will show you any overdues at your library that have
29590         accrued fines on them.</para>
29591
29592         <screenshot>
29593           <screeninfo>Overdues with fines</screeninfo>
29594
29595           <mediaobject>
29596             <imageobject>
29597               <imagedata fileref="images/circ/overduewfines.png"/>
29598             </imageobject>
29599           </mediaobject>
29600         </screenshot>
29601
29602         <para>If you would like to limit the report you can use the pull down
29603         menu at the top to limit to a specific shelving location at your
29604         branch. To see overdues with fines at other branches you will have to
29605         <link linkend="setlibrary">change your branch</link> or log in at that
29606         branch.<important>
29607             <para>If you do not charge fines and/or don't have the <link linkend="finescronjob">fines cron job</link> running you will see
29608             no data on this report.</para>
29609           </important></para>
29610       </section>
29611       <section id="pendingonsite">
29612         <title>Pending on-site checkouts</title>
29613         <para>If you are using the on site checkouts functionality (<link linkend="OnSiteCheckouts"
29614             >OnSiteCheckouts</link>) then you'll have a report to view all items that are currently
29615           checked out on site.<screenshot>
29616             <screeninfo>Pending onsite checkouts</screeninfo>
29617             <mediaobject>
29618               <imageobject>
29619                 <imagedata fileref="images/circ/pendingonsite.png"/>
29620               </imageobject>
29621             </mediaobject>
29622           </screenshot></para>
29623         <para>This will list the due date (overdues in red), who has the item, item information and
29624           what library the item is at.</para>
29625       </section>
29626     </section>
29627
29628     <section id="trackinhouse">
29629       <title>Tracking In house Use</title>
29630
29631       <para>Many libraries track the use of items within the library. <note>
29632           <para>This is different from tracking on site usage.  In house use is the use of items in
29633             the library by patrons without them having to check them out.  On site use is the use of
29634             items on site that must first be checked out. To learn more about on site usage please
29635             review the <link linkend="OnSiteCheckouts">OnSiteCheckouts</link> preference.</para>
29636         </note></para>
29637       <para>Tracking the use of items in the library without checking them out can be done in Koha
29638         one of two ways. The first is to create one or more <link linkend="addstatspatron"
29639           >Statistical Patrons</link>. When collecting items that have been used within the library,
29640         you will want to check them out to your statistical patron:</para>
29641
29642       <screenshot>
29643         <screeninfo>Check Out Items to Stats Patron</screeninfo>
29644
29645         <mediaobject>
29646           <imageobject>
29647             <imagedata fileref="images/circ/checkoutinhouse.png"/>
29648           </imageobject>
29649         </mediaobject>
29650       </screenshot>
29651
29652       <para>Instead of marking the item as 'checked out' the system will
29653       record that the item was used in house:</para>
29654
29655       <screenshot>
29656         <screeninfo>Local Use Recorded</screeninfo>
29657
29658         <mediaobject>
29659           <imageobject>
29660             <imagedata fileref="images/circ/localuserecorded.png"/>
29661           </imageobject>
29662         </mediaobject>
29663       </screenshot>
29664
29665       <para>Repeat these steps for all items that have been used within the
29666       library to keep accurate statistics for item use.</para>
29667
29668       <para>The other way to record local use of items is to set your <link linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link>
29669       preference to 'Record.' Then whenever you check an item in that is not
29670       checked out and not on hold a local use will be recorded.</para>
29671
29672       <screenshot>
29673         <screeninfo>Local Use Recorded</screeninfo>
29674
29675         <mediaobject>
29676           <imageobject>
29677             <imagedata fileref="images/circ/localusecheckin.png"/>
29678           </imageobject>
29679         </mediaobject>
29680       </screenshot>
29681
29682       <note>
29683         <para>If you have <link linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link> set to
29684         'Record' you can still use your statistical patrons to record local
29685         use as well.</para>
29686       </note>
29687     </section>
29688
29689     <section id="processinglocations">
29690       <title>In Processing / Book Cart Locations</title>
29691
29692       <para>Koha allows for handling temporary locations like the processing
29693       center and/or book carts throughout the library. For this feature to
29694       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)
29695       and CART (Book Cart).</para>
29696
29697       <screenshot>
29698         <screeninfo>CART &amp; PROC values in LOC</screeninfo>
29699
29700         <mediaobject>
29701           <imageobject>
29702             <imagedata fileref="images/circ/LOCvalues.png"/>
29703           </imageobject>
29704         </mediaobject>
29705       </screenshot>
29706
29707       <para>Next you need to set the <link linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link> system
29708       preference to PROC. This will set the new items to the Processing Center
29709       as their default location.</para>
29710
29711       <para>When creating items you enter in their desired final shelving location and Koha will
29712         temporarily change that to PROC.  If <link linkend="InProcessingToShelvingCart"
29713           >InProcessingToShelvingCart</link> is set to "Don't move" then when an item with a
29714         location of PROC is checked in it will either automatically update the item to use the
29715         permanent location. If <link linkend="InProcessingToShelvingCart"
29716           >InProcessingToShelvingCart</link> is set to "Move" then when an item is checked in the
29717         location is changed from PROC to CART.</para>
29718
29719               <para>A <link linkend="proccartcron">cron job</link> is then set to run at specified
29720         intervals to age items from CART to the permanent shelving location. (For example, an hourly
29721         cron entry of cart_to_shelf.pl --hours 3 where --hours is the amount of time an item should
29722         spend on the cart before aging to its permanent location.)</para>
29723               <itemizedlist>
29724                 <listitem>
29725                   <note>
29726                     <para>If the <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
29727               system preference is set to "Move", any newly checked-in item is also automatically
29728               put into the shelving cart, to be covered by the same script run.</para>
29729                   </note>
29730                 </listitem>
29731                 <listitem>
29732                   <important>
29733                     <para>Checkins with confirmed holds will not go into the shelving cart. If items
29734                       on the shelving cart are checked out, the cart location will be
29735                       cleared.</para>
29736                   </important>
29737                 </listitem>
29738               </itemizedlist>
29739     </section>
29740
29741     <section id="selfcheckout">
29742       <title>Self Checkout</title>
29743
29744       <para>Koha comes with a very basic self checkout module. To enable this
29745       module you need to set the <link linkend="WebBasedSelfCheck">WebBasedSelfCheck</link> preference to
29746       '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>
29747
29748       <note>
29749         <para>Create a <link linkend="addstaffpatron">staff patron</link>
29750         specifically for this action so that you don't leave a real staff
29751         client logged into a computer all day</para>
29752       </note>
29753
29754       <para>There is no link to the Self Checkout module, but a simple
29755       addition to the <link linkend="intranetuserjs">intranetuserjs</link>
29756       system preference can add one.</para>
29757
29758       <programlisting>$(document).ready(function(){ $("#login
29759       #submit").parent().after("&lt;p&gt;&lt;a
29760       href=\"http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl\"
29761       target=\"_blank\"&gt;Self-Checkout&lt;/a&gt;&lt;/p&gt;"); }); </programlisting>
29762
29763       <important>
29764         <para>The code above has line breaks added to make it more readable,
29765         please be sure to enter the above as one line in when putting it in
29766         the system preference.</para>
29767       </important>
29768
29769       <para>The link will then appear at the bottom of the log in page:</para>
29770
29771       <screenshot>
29772         <screeninfo>Self Checkout Link on Staff Login</screeninfo>
29773
29774         <mediaobject>
29775           <imageobject>
29776             <imagedata fileref="images/circ/selfcheckoutlink.png"/>
29777           </imageobject>
29778         </mediaobject>
29779       </screenshot>
29780
29781       <para>You can also access this module by going to :
29782       http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl</para>
29783
29784       <para>When on the self checkout page depending on your value in the
29785       <link linkend="SelfCheckoutByLogin">SelfCheckoutByLogin</link>
29786       preference you will be asked to enter you cardnumber</para>
29787
29788       <screenshot>
29789         <screeninfo>Self Checkout Patron Card Number</screeninfo>
29790
29791         <mediaobject>
29792           <imageobject>
29793             <imagedata fileref="images/circ/selfcheckout.png"/>
29794           </imageobject>
29795         </mediaobject>
29796       </screenshot>
29797
29798       <para>or your username and password:</para>
29799
29800       <screenshot>
29801         <screeninfo>Shelf checkout by login</screeninfo>
29802
29803         <mediaobject>
29804           <imageobject>
29805             <imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
29806           </imageobject>
29807         </mediaobject>
29808       </screenshot>
29809
29810       <para>Once you're logged in to the self check module you will be asked
29811       to scan the items you are checking out</para>
29812
29813       <screenshot>
29814         <screeninfo>Self Checkout</screeninfo>
29815
29816         <mediaobject>
29817           <imageobject>
29818             <imagedata fileref="images/circ/selfcheckoutuser.png"/>
29819           </imageobject>
29820         </mediaobject>
29821       </screenshot>
29822
29823       <para>As you scan items they will appear below the barcode box</para>
29824
29825       <screenshot>
29826         <screeninfo>Self Checkout Summary</screeninfo>
29827
29828         <mediaobject>
29829           <imageobject>
29830             <imagedata fileref="images/circ/selfcheckoutsummary.png"/>
29831           </imageobject>
29832         </mediaobject>
29833       </screenshot>
29834
29835       <para>When you are finished scanning items it is important to click the 'Finish' button. This
29836         will prompt you to print a receipt and log you out of the self check module.</para>
29837       <screenshot>
29838           <screeninfo>Self Checkout Receipt</screeninfo>
29839           <mediaobject>
29840             <imageobject>
29841               <imagedata fileref="images/circ/selfreceiptprint.png"/>
29842             </imageobject>
29843           </mediaobject>
29844         </screenshot>
29845
29846       <para>When attempting to check items out there are some instances where
29847       error messages will appear and the patron will be directed to the
29848       librarian. This will happen even if you are allowing overrides on
29849       circulation functions. Only a librarian can override a circulation block
29850       and so patrons must go to the librarian for help in these
29851       situations.</para>
29852
29853       <screenshot>
29854         <screeninfo>Self Checkout Error Message</screeninfo>
29855
29856         <mediaobject>
29857           <imageobject>
29858             <imagedata fileref="images/circ/selfcheckoutfines.png"/>
29859           </imageobject>
29860         </mediaobject>
29861       </screenshot>
29862     </section>
29863
29864     <section id="offlinecirc">
29865       <title>Offline Circulation Utilities</title>
29866       <para>Koha allows for you to continue circulation actions while offline by using any one of
29867         three utilities.</para>
29868       <section id="kohaofflinecirc">
29869         <title>Offline Circulation in Koha</title>
29870         <para>If the <link linkend="AllowOfflineCirculation">AllowOfflineCirculation</link>
29871           preference is set to 'Enable' the library staff can continue to perform circulation
29872           actions within Koha when the system is offline.  You will want to visit
29873           http://your-koha-staff-client-url/cgi-bin/koha/circ/offline.pl at least once while online
29874           and bookmark that page. That is the page you will go to when you are offline.</para>
29875         <important>
29876           <para>The offline interface uses HTML LocalStorage, which depending on the browser and
29877             user setting, is limited to 2.5MB or 5MB per domain. This means that larger systems will
29878             not be able to syncronize their data and are recommended to use either the <link
29879               linkend="firefoxofflinecirc">Firefox</link> or <link linkend="windowsofflinecirc"
29880               >Windows</link> application for offline circulation.</para>
29881         </important>
29882         <section id="kohaofflinesetup">
29883           <title id="offlinesetup">Setup</title>
29884           <para>Before the first time the system goes offline go to Circulation and choose 'Built-in
29885             offline circulation interface'</para>
29886           <screenshot>
29887               <screeninfo>Built-in offline circulation interface</screeninfo>
29888               <mediaobject>
29889                 <imageobject>
29890                   <imagedata fileref="images/circ/offlinecirc.png"/>
29891                 </imageobject>
29892               </mediaobject>
29893             </screenshot>
29894           <para>And synchronize your data on every circulation computer by clicking the
29895             'Synchronize' link on the right of the screen.</para>
29896           <screenshot>
29897               <screeninfo>Synchronize data</screeninfo>
29898               <mediaobject>
29899                 <imageobject>
29900                   <imagedata fileref="images/circ/syncoffline.png"/>
29901                 </imageobject>
29902               </mediaobject>
29903             </screenshot>
29904           <important>
29905             <para>The offline interface uses HTML LocalStorage, which depending on the browser and
29906               user setting, is limited to 2.5MB or 5MB per domain. This means that larger systems
29907               will not be able to syncronize their data and are recommended to use either the <link
29908                 linkend="firefoxofflinecirc">Firefox</link> or <link linkend="windowsofflinecirc"
29909                 >Windows</link> application for offline circulation.</para>
29910           </important>
29911           <para>This will allow you download a local copy of your patrons and circulation data.
29912             Click the 'Download records' link at the top of the page to synchronize your data.</para>
29913           <screenshot>
29914               <screeninfo>Download records for offline use</screeninfo>
29915               <mediaobject>
29916                 <imageobject>
29917                   <imagedata fileref="images/circ/downloadoffline.png"/>
29918                 </imageobject>
29919               </mediaobject>
29920             </screenshot>
29921           <para>Once your data is downloaded you will see the dates your data was last synced to the
29922             right of each data set.<screenshot>
29923               <screeninfo>Synced offline data</screeninfo>
29924               <mediaobject>
29925                 <imageobject>
29926                   <imagedata fileref="images/circ/syncedoffline.png"/>
29927                 </imageobject>
29928               </mediaobject>
29929             </screenshot>This should be done regularly in preparation for any unexpected connection
29930             losses.</para>
29931         </section>
29932         <section id="kohaofflinecirculating">
29933           <title id="offlinecirculating">Circulating</title>
29934           <para>When your system goes offline visit the Offline Circulation page
29935             (http://your-koha-staff-client-url/cgi-bin/koha/circ/offline.pl) in Koha and click
29936             'Check out' or 'Check in' to perform offline actions.</para>
29937           <para>Checking out is done by searching for the patron by barcode or name at the top of
29938             the 'Check out' screen. After selecting a patron you will be presented with the synced
29939             patron info, including fines and check outs.</para>
29940           <screenshot>
29941               <screeninfo>Check out offline</screeninfo>
29942               <mediaobject>
29943                 <imageobject>
29944                   <imagedata fileref="images/circ/offlinecheckout.png"/>
29945                 </imageobject>
29946               </mediaobject>
29947             </screenshot>
29948           <para>Scan the barcode of the item you would like to check out and enter a due date. If
29949             you don't enter a due date Koha will prompt you for one.</para>
29950           <screenshot>
29951               <screeninfo>Offline due date</screeninfo>
29952               <mediaobject>
29953                 <imageobject>
29954                   <imagedata fileref="images/circ/offlineduedate.png"/>
29955                 </imageobject>
29956               </mediaobject>
29957             </screenshot>
29958           <para>Once the item is checked out it will appear below the patron's info.</para>
29959           <screenshot>
29960               <screeninfo>Offline checkouts</screeninfo>
29961               <mediaobject>
29962                 <imageobject>
29963                   <imagedata fileref="images/circ/offlinecheckouts.png"/>
29964                 </imageobject>
29965               </mediaobject>
29966             </screenshot>
29967           <para/>
29968         </section>
29969         <section id="kohaofflineupload">
29970           <title>Koha Offline Uploading</title>
29971           <para>Once the system is back online visit the Synchronize page on the Offline Circulation
29972             module and click 'Upload transactions'</para>
29973           <screenshot>
29974               <screeninfo>Upload transactions</screeninfo>
29975               <mediaobject>
29976                 <imageobject>
29977                   <imagedata fileref="images/circ/offlineupload.png"/>
29978                 </imageobject>
29979               </mediaobject>
29980             </screenshot>
29981           <para>After the files are uploaded you can click 'View pending offline circulation
29982             actions' on the right.</para>
29983           <screenshot>
29984               <screeninfo>View pending offline circulation actions</screeninfo>
29985               <mediaobject>
29986                 <imageobject>
29987                   <imagedata fileref="images/circ/viewkohaoffline.png"/>
29988                 </imageobject>
29989               </mediaobject>
29990             </screenshot>
29991           <para>After clicking 'View pending offline circulation actions' you will be brought to a
29992             summary of all of the actions you loaded in to Koha in your *.koc file.</para>
29993           <screenshot>
29994             <screeninfo>Offline Circulation</screeninfo>
29995             <mediaobject>
29996               <imageobject>
29997                 <imagedata fileref="images/circ/offlinecirclog.png"/>
29998               </imageobject>
29999             </mediaobject>
30000           </screenshot>
30001           <itemizedlist>
30002             <listitem>
30003               <para>Once all of the logs from all of the circulation computers are loaded you will
30004                 be able to check them all or select just those you want to process into Koha.</para>
30005             </listitem>
30006             <listitem>
30007               <para>Click on the Process button and Koha will record every stored transaction one by
30008                 one. For each transaction, the status will change to:<itemizedlist>
30009                   <listitem>
30010                     <para>"Success." if the transaction was processed correctly</para>
30011                   </listitem>
30012                   <listitem>
30013                     <para>"Borrower not found." if the borrower card number is incorrect</para>
30014                   </listitem>
30015                   <listitem>
30016                     <para>"Item not found." if the item barcode is wrong</para>
30017                   </listitem>
30018                   <listitem>
30019                     <para>"Item not issued." if you checked in an available item</para>
30020                   </listitem>
30021                 </itemizedlist></para>
30022             </listitem>
30023           </itemizedlist>
30024           <para>Once finished you will have a summary of all of your transactions</para>
30025           <screenshot>
30026             <screeninfo>Offline Circulation Summary</screeninfo>
30027             <mediaobject>
30028               <imageobject>
30029                 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
30030               </imageobject>
30031             </mediaobject>
30032           </screenshot>
30033         </section>
30034       </section>
30035
30036       <section id="firefoxofflinecirc">
30037         <sectioninfo>
30038           <authorgroup>
30039             <author>
30040               <firstname>Franois</firstname>
30041               <surname>Charbonnier</surname>
30042               <affiliation>
30043                 <orgname>BibLibre</orgname>
30044               </affiliation>
30045             </author>
30046
30047             <editor>
30048               <firstname>Nicole C.</firstname>
30049               <surname>Engard</surname>
30050               <contrib>Changed/edited content where necessary.</contrib>
30051             </editor>
30052           </authorgroup>
30053
30054           <pubdate>2012</pubdate>
30055         </sectioninfo>
30056         <title>Firefox Plugin</title>
30057
30058         <para>There is an offline circulation tool that you can add to your Firefox browser as an
30059           addon. To do so, just go to <ulink url="https://addons.mozilla.org/en/firefox/addon/koct/"
30060             >https://addons.mozilla.org/en/firefox/addon/koct/</ulink> page and click on the
30061           "install now" button. You may have to confirm the installation, just click on "install
30062           now" and then restart Firefox to complete the installation.</para>
30063
30064         <para>Once you have installed the plugins and restarted Firefox, you will see the Koha logo
30065           in the download bar at the bottom right of Firefox.</para>
30066
30067         <screenshot>
30068           <screeninfo>Koha Icon on Add-on Bar</screeninfo>
30069
30070           <mediaobject>
30071             <imageobject>
30072               <imagedata fileref="images/circ/koctstatusbar.png"/>
30073             </imageobject>
30074           </mediaobject>
30075         </screenshot>
30076
30077         <para>A click on the logo will open the tool in its own window.</para>
30078
30079         <screenshot>
30080           <screeninfo>Koha Offline Circ Tool</screeninfo>
30081
30082           <mediaobject>
30083             <imageobject>
30084               <imagedata fileref="images/circ/koct.png"/>
30085             </imageobject>
30086           </mediaobject>
30087         </screenshot>
30088
30089         <para>The plugin consists of four tabs:</para>
30090
30091         <itemizedlist>
30092           <listitem>
30093             <para>The Check Out tab is where you check out items</para>
30094           </listitem>
30095
30096           <listitem>
30097             <para>The Check In tab is where you check in items</para>
30098           </listitem>
30099
30100           <listitem>
30101             <para>The Log tab keeps track of every transaction done while in
30102             offline mode</para>
30103
30104             <itemizedlist>
30105               <listitem>
30106                 <para>The log will keep information until you empty it. Each
30107                 time you open the plugin and it contains data in the log it
30108                 will warn you</para>
30109
30110                 <screenshot>
30111                   <screeninfo>Koha Offline Circ Warning</screeninfo>
30112
30113                   <mediaobject>
30114                     <imageobject>
30115                       <imagedata fileref="images/circ/koctwarn.png"/>
30116                     </imageobject>
30117                   </mediaobject>
30118                 </screenshot>
30119
30120                 <para>If you'd like to clear the log, check the 'I want to
30121                 delete rows' box before hitting the 'OK' button. Otherwise
30122                 clicking 'OK' will keep the items in the log and let you
30123                 continue working with the tool.</para>
30124               </listitem>
30125             </itemizedlist>
30126           </listitem>
30127
30128           <listitem>
30129             <para>The Param tab is to set up the plugin</para>
30130           </listitem>
30131         </itemizedlist>
30132
30133         <para>The first thing you want to do then is to set up the plugin. Go
30134         to the Param tab to set up the plugin</para>
30135
30136         <screenshot>
30137           <screeninfo>Koha Offline CIrc Params</screeninfo>
30138
30139           <mediaobject>
30140             <imageobject>
30141               <imagedata fileref="images/circ/koctparam.png"/>
30142             </imageobject>
30143           </mediaobject>
30144         </screenshot>
30145
30146         <para>Answer the 4 questions presented:</para>
30147
30148         <itemizedlist>
30149           <listitem>
30150             <para>Server = the URL of the librarian interface</para>
30151           </listitem>
30152
30153           <listitem>
30154             <para>Branch Code = the code for the branch where you are
30155             located</para>
30156           </listitem>
30157
30158           <listitem>
30159             <para>Username = your staff account login</para>
30160           </listitem>
30161
30162           <listitem>
30163             <para>Password = your staff account password</para>
30164           </listitem>
30165         </itemizedlist>
30166
30167         <para><important>
30168             <para>To save the settings, you will have to close the plugin
30169             window and re-open it by clicking again on the Koha logo in the
30170             add-on bar.</para>
30171           </important><note>
30172             <para>You can create a staff account dedicated to the offline
30173             circulation. So that, no matter who is at the circulation desk,
30174             they can all use the same login. Along those lines, you can use a
30175             group login that you already have in place for circulation as
30176             well.</para>
30177           </note>Once you have everything set up you can start checking items
30178         in and out.</para>
30179
30180         <para>Checking out:</para>
30181
30182         <screenshot>
30183           <screeninfo>Koha Offline Circulation Check Out</screeninfo>
30184
30185           <mediaobject>
30186             <imageobject>
30187               <imagedata fileref="images/circ/koct.png"/>
30188             </imageobject>
30189           </mediaobject>
30190         </screenshot>
30191
30192         <itemizedlist>
30193           <listitem>
30194             <para>Go to the Check Out tab</para>
30195           </listitem>
30196
30197           <listitem>
30198             <para>Scan the patron barcode</para>
30199           </listitem>
30200
30201           <listitem>
30202             <para>Scan the item barcode</para>
30203           </listitem>
30204
30205           <listitem>
30206             <para>Click 'Save'</para>
30207           </listitem>
30208         </itemizedlist>
30209
30210         <para>Checking in:</para>
30211
30212         <screenshot>
30213           <screeninfo>Koha Offline Circulation Check In</screeninfo>
30214
30215           <mediaobject>
30216             <imageobject>
30217               <imagedata fileref="images/circ/koctcheckin.png"/>
30218             </imageobject>
30219           </mediaobject>
30220         </screenshot>
30221
30222         <itemizedlist>
30223           <listitem>
30224             <para>Go to the Check In tab</para>
30225           </listitem>
30226
30227           <listitem>
30228             <para>Scan the item barcode</para>
30229           </listitem>
30230
30231           <listitem>
30232             <para>Click Save</para>
30233           </listitem>
30234         </itemizedlist>
30235
30236         <para>Each time, you check out or check in an item, a new transaction
30237         is recorded in the local plugin database and you will see, at the
30238         bottom of the plugin how many transactions has been made during the
30239         offline circulation. For example, "10 Row(s) Added" means you did 10
30240         transactions.</para>
30241
30242         <screenshot>
30243           <screeninfo>Koha Offline Circulation Tool Count</screeninfo>
30244
30245           <mediaobject>
30246             <imageobject>
30247               <imagedata fileref="images/circ/koctcount.png"/>
30248             </imageobject>
30249           </mediaobject>
30250         </screenshot>
30251
30252         <para>Then, if you want an overview of every transaction, go to the
30253         Log tab. This tab will show you the transactions in the plugin
30254         database</para>
30255
30256         <screenshot>
30257           <screeninfo>Koha Offline Circulation Log</screeninfo>
30258
30259           <mediaobject>
30260             <imageobject>
30261               <imagedata fileref="images/circ/koctlog.png"/>
30262             </imageobject>
30263           </mediaobject>
30264         </screenshot>
30265
30266         <para><note>
30267             <para>The status will be "Local." as long as you are offline and
30268             don't process the transactions into Koha.</para>
30269           </note>When your Internet connection comes back up you will want to
30270         get these transactions in to Koha. Before processing these
30271         transactions you should be aware of a few issues.</para>
30272
30273         <para>Because you are not connected to your Koha database when using
30274         this plugin holds will need additional processing. If an item you
30275         check in while offline has a hold, the hold is kept on the item.
30276         Since, you can't confirm holds found during the processing of every
30277         check in, the holds stay on the item and will need to be managed
30278         later. If you only checked in a few items you can just keep a record
30279         of them all. If you checked in a lot of items you can use the Holds
30280         Queue once it rebuilds to see what holds made it to the shelf
30281         erroneously.</para>
30282
30283         <para>Similarly, if an patron card was expired, the offline
30284         circulation tool won't know about it, so the checkout will be recorded
30285         regardless of the patron's account being blocked normally.</para>
30286
30287         <para>You have two options for adding this data to Koha</para>
30288
30289         <itemizedlist>
30290           <listitem>
30291             <para>Commit to Koha</para>
30292
30293             <itemizedlist>
30294               <listitem>
30295                 <para>If you checked in/out on more than one computer at the
30296                 same time, what you want is to process every transaction
30297                 consistently. Let's say for instance that one patron checked a
30298                 book out on one computer and then checked the same book in on
30299                 another computer. To be consistent, you need to record the
30300                 check out first and then the check in. Not the opposite! To do
30301                 so, you need to group every transaction in one place, sort
30302                 them all and then, process everything. So, you need to use the
30303                 "Commit to Koha" option from every plugin/computer you worked
30304                 with. This way, the log will go to Koha and be accessible from
30305                 the Offline Circulation page.</para>
30306
30307                 <screenshot>
30308                   <screeninfo>Circulation Menu</screeninfo>
30309
30310                   <mediaobject>
30311                     <imageobject>
30312                       <imagedata fileref="images/circ/offlinecirclink.png"/>
30313                     </imageobject>
30314                   </mediaobject>
30315                 </screenshot>
30316               </listitem>
30317
30318               <listitem>
30319                 <para><emphasis>Get there:</emphasis> Circulation &gt; Pending offline circulation
30320                   actions</para>
30321
30322                 <screenshot>
30323                   <screeninfo>Offline Circulation</screeninfo>
30324
30325                   <mediaobject>
30326                     <imageobject>
30327                       <imagedata fileref="images/circ/offlinecirclog.png"/>
30328                     </imageobject>
30329                   </mediaobject>
30330                 </screenshot>
30331               </listitem>
30332
30333               <listitem>
30334                 <para>Once all of the logs from all of the circulation
30335                 computers are loaded you will be able to check them all or
30336                 select just those you want to process into Koha.</para>
30337               </listitem>
30338
30339               <listitem>
30340                 <para>Click on the Process button and Koha will record every stored transaction one
30341                   by one. For each transaction, the status will change to:</para>
30342
30343                 <itemizedlist>
30344                   <listitem>
30345                     <para>"Success." if the transaction was processed
30346                     correctly</para>
30347                   </listitem>
30348
30349                   <listitem>
30350                     <para>"Borrower not found." if the borrower card number is
30351                     incorrect</para>
30352                   </listitem>
30353
30354                   <listitem>
30355                     <para>"Item not found." if the item barcode is
30356                     wrong</para>
30357                   </listitem>
30358
30359                   <listitem>
30360                     <para>"Item not issued." if you checked in an available
30361                     item</para>
30362                   </listitem>
30363                 </itemizedlist>
30364               </listitem>
30365
30366               <listitem>
30367                 <para>Once finished you will have a summary of all of your
30368                 transactions</para>
30369
30370                 <screenshot>
30371                   <screeninfo>Offline Circulation Summary</screeninfo>
30372
30373                   <mediaobject>
30374                     <imageobject>
30375                       <imagedata fileref="images/circ/offlinecircsuccess.png"/>
30376                     </imageobject>
30377                   </mediaobject>
30378                 </screenshot>
30379               </listitem>
30380             </itemizedlist>
30381           </listitem>
30382
30383           <listitem>
30384             <para>Apply directly</para>
30385
30386             <itemizedlist>
30387               <listitem>
30388                 <para>If you performed all of the circulation actions on one
30389                 computer then everything is sorted already so you can choose
30390                 to "Apply directly"</para>
30391               </listitem>
30392
30393               <listitem>
30394                 <para>The status column will be updated to let you know if the
30395                 transactions were applied</para>
30396
30397                 <itemizedlist>
30398                   <listitem>
30399                     <para>"Success." if the transaction was processed
30400                     correctly</para>
30401                   </listitem>
30402
30403                   <listitem>
30404                     <para>"Borrower not found." if the borrower card number is
30405                     incorrect</para>
30406                   </listitem>
30407
30408                   <listitem>
30409                     <para>"Item not found." if the item barcode is
30410                     wrong</para>
30411                   </listitem>
30412
30413                   <listitem>
30414                     <para>"Item not issued." if you checked in an available
30415                     item</para>
30416                   </listitem>
30417                 </itemizedlist>
30418               </listitem>
30419
30420               <listitem>
30421                 <para>Once you're finished you can review all of the items
30422                 right in the Log tab</para>
30423
30424                 <screenshot>
30425                   <screeninfo>Koha Offline Circulation Apply
30426                   Directly</screeninfo>
30427
30428                   <mediaobject>
30429                     <imageobject>
30430                       <imagedata fileref="images/circ/koctdirectly.png"/>
30431                     </imageobject>
30432                   </mediaobject>
30433                 </screenshot>
30434               </listitem>
30435             </itemizedlist>
30436           </listitem>
30437         </itemizedlist>
30438
30439         <para>Once you are done you can clear the log by clicking Clear. If
30440         you don't you will be warned the next time you open the Offline
30441         Circulation tool.</para>
30442
30443         <screenshot>
30444           <screeninfo>Koha Offline Circulation Tool Warning</screeninfo>
30445
30446           <mediaobject>
30447             <imageobject>
30448               <imagedata fileref="images/circ/koctwarn.png"/>
30449             </imageobject>
30450           </mediaobject>
30451         </screenshot>
30452       </section>
30453
30454       <section id="windowsofflinecirc">
30455         <title>Offline Circ Tool for Windows</title>
30456
30457         <para>The Offline Circulation Utility can be downloaded at: <ulink url="http://kylehall.info/index.php/projects/koha/koha-offline-circulation/">http://kylehall.info/index.php/projects/koha/koha-offline-circulation/</ulink></para>
30458         <para>To generate a borrowers.db file for loading in to the Windows tool you will need to
30459           run the <link linkend="offlinecirccron">file generator via a cron job</link>.</para>
30460         <section id="uploadofflinecirc">
30461           <title>Upload Offline Circ File</title>
30462           <para>The <link linkend="windowsofflinecirc">offline circulation tool for Windows</link>
30463             will generate a KOC file that you can upload into Koha once your system comes back
30464             up.</para>
30465           <para>On the Circulation menu click 'Upload offline circulation file (.koc)'</para>
30466           <screenshot>
30467             <screeninfo>Circulation menu</screeninfo>
30468             <mediaobject>
30469               <imageobject>
30470                 <imagedata fileref="images/circ/offlinecirclink.png"/>
30471               </imageobject>
30472             </mediaobject>
30473           </screenshot>
30474           <para>Browse your computer for the *.koc file</para>
30475           <screenshot>
30476             <screeninfo>Upload KOC File</screeninfo>
30477             <mediaobject>
30478               <imageobject>
30479                 <imagedata fileref="images/circ/uploadofflinecirc.png"/>
30480               </imageobject>
30481             </mediaobject>
30482           </screenshot>
30483           <para>Once the file is uploaded, click the process the file</para>
30484           <screenshot>
30485             <screeninfo>Process offline circulation file</screeninfo>
30486             <mediaobject>
30487               <imageobject>
30488                 <imagedata fileref="images/circ/processoffline.png"/>
30489               </imageobject>
30490             </mediaobject>
30491           </screenshot>
30492           <para>When this is complete you'll be able to upload another file or tend to pending
30493             offline circulation actions.</para>
30494           <screenshot>
30495             <screeninfo>Summary of offline actions</screeninfo>
30496             <mediaobject>
30497               <imageobject>
30498                 <imagedata fileref="images/circ/offlinesummary.png"/>
30499               </imageobject>
30500             </mediaobject>
30501           </screenshot>
30502           <para>After clicking 'View pending offline circulation actions' you will be brought to a
30503             summary of all of the actions you loaded in to Koha in your *.koc file.</para>
30504           <screenshot>
30505             <screeninfo>Offline Circulation</screeninfo>
30506             <mediaobject>
30507               <imageobject>
30508                 <imagedata fileref="images/circ/offlinecirclog.png"/>
30509               </imageobject>
30510             </mediaobject>
30511           </screenshot>
30512           <itemizedlist>
30513             <listitem>
30514               <para>Once all of the logs from all of the circulation computers are loaded you will
30515                 be able to check them all or select just those you want to process into Koha.</para>
30516             </listitem>
30517             <listitem>
30518               <para>Click on the Process button and Koha will record every stored transaction one by
30519                 one. For each transaction, the status will change to:<itemizedlist>
30520                   <listitem>
30521                     <para>"Success." if the transaction was processed correctly</para>
30522                   </listitem>
30523                   <listitem>
30524                     <para>"Borrower not found." if the borrower card number is incorrect</para>
30525                   </listitem>
30526                   <listitem>
30527                     <para>"Item not found." if the item barcode is wrong</para>
30528                   </listitem>
30529                   <listitem>
30530                     <para>"Item not issued." if you checked in an available item</para>
30531                   </listitem>
30532                 </itemizedlist></para>
30533             </listitem>
30534           </itemizedlist>
30535           <para>Once finished you will have a summary of all of your transactions</para>
30536           <screenshot>
30537             <screeninfo>Offline Circulation Summary</screeninfo>
30538             <mediaobject>
30539               <imageobject>
30540                 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
30541               </imageobject>
30542             </mediaobject>
30543           </screenshot>
30544         </section>
30545       </section>
30546     </section>
30547   </chapter>
30548
30549   <chapter id="cataloging">
30550     <title>Cataloging</title>
30551
30552     <para>Before you start cataloging in Koha you're going to want to do some
30553     basic setup. Refer to the <link linkend="implementation">Implementation
30554     Checklist</link> for a full list of these things. Most importantly you're
30555     going to want to make sure that your <link linkend="marcbibframeworks">Frameworks</link> are all defined the way you
30556     want. Once in the cataloging module you will not be able to add or remove
30557     fields and subfields so your frameworks must be ready before you start
30558     cataloging.</para>
30559     <para>You can also use OCLC Connexion to send records directly in to Koha.  For more information
30560       on that please review the <link linkend="oclcappendix">OCLC Connexion Setup
30561       appendix</link>.</para>
30562
30563     <itemizedlist>
30564       <listitem>
30565         <para><emphasis>Get there:</emphasis> More &gt; Cataloging</para>
30566       </listitem>
30567     </itemizedlist>
30568
30569     <section id="catbibs">
30570       <title>Bibliographic Records</title>
30571
30572       <para>In Koha the bibliographic record contains the main information
30573       related to the material. This includes things like the title, author,
30574       ISBN, etc. This information is stored in Koha in Marc (different flavors
30575       of Marc are supported in Koha). Once this information is saved, <link linkend="catitems">items or holdings</link> can be attached.</para>
30576
30577       <section id="addbibrec">
30578         <title>Adding Records</title>
30579
30580         <para>Records can be added to Koha via original or copy cataloging. If
30581         you would like to catalog a record using a blank template</para>
30582
30583         <itemizedlist>
30584           <listitem>
30585             <para>Click 'New Record'</para>
30586
30587             <screenshot>
30588               <screeninfo>New Record Menu</screeninfo>
30589
30590               <mediaobject>
30591                 <imageobject>
30592                   <imagedata fileref="images/cataloging/newfromframework.png"/>
30593                 </imageobject>
30594               </mediaobject>
30595             </screenshot>
30596
30597             <itemizedlist>
30598               <listitem>
30599                 <para>Choose the framework you would like to base your record
30600                 off of</para>
30601               </listitem>
30602             </itemizedlist>
30603           </listitem>
30604         </itemizedlist>
30605
30606         <para>If you want to catalog a record based on an existing record at
30607         another library</para>
30608
30609         <itemizedlist>
30610           <listitem>
30611             <para>Click 'New from Z39.50/SRU'</para>
30612
30613             <screenshot>
30614               <screeninfo>Z39.50 Search</screeninfo>
30615
30616               <mediaobject>
30617                 <imageobject>
30618                   <imagedata fileref="images/cataloging/zsearch.png"/>
30619                 </imageobject>
30620               </mediaobject>
30621             </screenshot>
30622
30623             <itemizedlist>
30624               <listitem>
30625                 <para>Search for the item you would like to catalog</para>
30626
30627                 <itemizedlist>
30628                   <listitem>
30629                     <note>
30630                       <para>If no results are found, try searching for fewer
30631                       fields, not all Z39.50 targets can search all of the
30632                       fields above.</para>
30633                     </note>
30634                   </listitem>
30635                 </itemizedlist>
30636               </listitem>
30637
30638               <listitem>
30639                 <para>Search targets can be altered by using the <link linkend="z3950admin">Z39.50 Admin</link> area.</para>
30640               </listitem>
30641
30642               <listitem>
30643                 <para>From the results you can view the MARC or Card view for
30644                 the records or choose to Import them into Koha</para>
30645
30646                 <screenshot>
30647                   <screeninfo>Z39.50 Search Results</screeninfo>
30648
30649                   <mediaobject>
30650                     <imageobject>
30651                       <imagedata fileref="images/cataloging/zsearchresults.png"/>
30652                     </imageobject>
30653                   </mediaobject>
30654                 </screenshot>
30655
30656                 <itemizedlist>
30657                   <listitem>
30658                     <para>In addition to the Import link to the right of each
30659                     title, you can click on the title you're interested in and
30660                     a menu will pop up with links to preview the record and
30661                     import it</para>
30662
30663                     <screenshot>
30664                       <screeninfo>Import Link Popup on Z39.50 Search
30665                       Results</screeninfo>
30666
30667                       <mediaobject>
30668                         <imageobject>
30669                           <imagedata fileref="images/cataloging/importz39.png"/>
30670                         </imageobject>
30671                       </mediaobject>
30672                     </screenshot>
30673                   </listitem>
30674
30675                   <listitem>
30676                     <para>If you don't find the title you need in your Z39.50
30677                     search results you can click the 'Try Another Search'
30678                     button at the bottom left of your results</para>
30679
30680                     <screenshot>
30681                       <screeninfo>Try another search</screeninfo>
30682
30683                       <mediaobject>
30684                         <imageobject>
30685                           <imagedata fileref="images/cataloging/tryanotherzsearch.png"/>
30686                         </imageobject>
30687                       </mediaobject>
30688                     </screenshot>
30689                   </listitem>
30690                 </itemizedlist>
30691               </listitem>
30692             </itemizedlist>
30693           </listitem>
30694         </itemizedlist>
30695
30696         <para>Once you've opened a blank framework or imported a record via
30697         Z39.50 you will be presented with the form to continue
30698         cataloging</para>
30699
30700         <screenshot>
30701           <screeninfo>Add MARC Record</screeninfo>
30702
30703           <mediaobject>
30704             <imageobject>
30705               <imagedata fileref="images/cataloging/addmarc.png"/>
30706             </imageobject>
30707           </mediaobject>
30708         </screenshot>
30709
30710         <itemizedlist>
30711           <listitem>
30712             <para>If you would rather not see the MARC tag numbers you can change the value in your
30713                 <link linkend="hide_marc">hide_marc</link> system preference or each user can check
30714               the box next to 'Show tags' at the top of the editor.</para>
30715           </listitem>
30716           <listitem>
30717             <para>To expand a collapsed tag click on the tag description</para>
30718           </listitem>
30719
30720           <listitem>
30721             <para>To get help from the Library of Congress on a Marc tag click
30722             the question mark (?) to the right of each field number</para>
30723
30724             <itemizedlist>
30725               <listitem>
30726                 <para>If you feel that this clutters the screen you can hide
30727                 the question marks by unchecking the box next to the 'Show
30728                 MARC tag documentation links' note at the top right of the
30729                 editor</para>
30730
30731                 <screenshot>
30732                   <screeninfo>Show MARC tag documentation links
30733                   checkbox</screeninfo>
30734
30735                   <mediaobject>
30736                     <imageobject>
30737                       <imagedata fileref="images/cataloging/marcdoclinks.png"/>
30738                     </imageobject>
30739                   </mediaobject>
30740                 </screenshot>
30741               </listitem>
30742             </itemizedlist>
30743           </listitem>
30744
30745           <listitem>
30746             <para>Sometimes fields may not be editable due to the value in
30747             your <link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
30748             system preference. If you have this preference set to not allow
30749             catalogers to type in fields controlled by authorities you may see
30750             a lock symbol to the left of the field.</para>
30751
30752             <screenshot>
30753               <screeninfo>Authority fields locked against editing</screeninfo>
30754
30755               <mediaobject>
30756                 <imageobject>
30757                   <imagedata fileref="images/cataloging/lockedauthority.png"/>
30758                 </imageobject>
30759               </mediaobject>
30760             </screenshot>
30761
30762             <itemizedlist>
30763               <listitem>
30764                 <para>If this icon appears you must click the icon to the
30765                 right of the field to search for an existing authority.</para>
30766
30767                 <screenshot>
30768                   <screeninfo>Search for authority</screeninfo>
30769
30770                   <mediaobject>
30771                     <imageobject>
30772                       <imagedata fileref="images/cataloging/catauthoritysearch.png"/>
30773                     </imageobject>
30774                   </mediaobject>
30775                 </screenshot>
30776               </listitem>
30777
30778               <listitem>
30779                 <para>From the results list click 'Choose authority' to bring
30780                 that into your catalog record</para>
30781
30782                 <screenshot>
30783                   <screeninfo>Authority search results</screeninfo>
30784
30785                   <mediaobject>
30786                     <imageobject>
30787                       <imagedata fileref="images/cataloging/catauthoritysearchresults.png"/>
30788                     </imageobject>
30789                   </mediaobject>
30790                 </screenshot>
30791               </listitem>
30792             </itemizedlist>
30793           </listitem>
30794
30795           <listitem>
30796             <para>To duplicate a field click on the 'repeat this tag' icon to
30797             the right of the tag</para>
30798
30799             <screenshot>
30800               <screeninfo>Duplicate a Field</screeninfo>
30801
30802               <mediaobject>
30803                 <imageobject>
30804                   <imagedata fileref="images/cataloging/dupfield.png"/>
30805                 </imageobject>
30806               </mediaobject>
30807             </screenshot>
30808
30809             <itemizedlist>
30810               <listitem>
30811                 <para>To move subfields in to the right order, click the up
30812                 arrow to the left of the field</para>
30813               </listitem>
30814
30815               <listitem>
30816                 <para>To duplicate a subfield click on the clone icon (to
30817                 remove a copied field, click the delete clone icon) to the
30818                 right of the field</para>
30819
30820                 <screenshot>
30821                   <screeninfo>Clone Subfield</screeninfo>
30822
30823                   <mediaobject>
30824                     <imageobject>
30825                       <imagedata fileref="images/cataloging/clonesubfield.png"/>
30826                     </imageobject>
30827                   </mediaobject>
30828                 </screenshot>
30829               </listitem>
30830
30831               <listitem>
30832                 <para>To remove a subfield (if there is more than one of the
30833                 same type), click the - (minus sign) to the right of the
30834                 field</para>
30835               </listitem>
30836             </itemizedlist>
30837           </listitem>
30838
30839           <listitem>
30840             <para>To use a plugin click on the icon to the right of the
30841             filed</para>
30842
30843             <screenshot>
30844               <screeninfo>Leader Builder Plugin</screeninfo>
30845
30846               <mediaobject>
30847                 <imageobject>
30848                   <imagedata fileref="images/cataloging/leaderbuilder.png"/>
30849                 </imageobject>
30850               </mediaobject>
30851             </screenshot>
30852
30853             <itemizedlist>
30854               <listitem>
30855                 <para>Some fixed fields have editors that will change based on
30856                 the material type you're cataloging (for example the 006 and
30857                 the 008 fields)</para>
30858
30859                 <screenshot>
30860                   <screeninfo>008 Plugin</screeninfo>
30861
30862                   <mediaobject>
30863                     <imageobject>
30864                       <imagedata fileref="images/cataloging/008plugin.png"/>
30865                     </imageobject>
30866                   </mediaobject>
30867                 </screenshot>
30868               </listitem>
30869             </itemizedlist>
30870           </listitem>
30871
30872           <listitem>
30873             <para>Once you've finished, click the 'Save' button at the top and
30874             choose whether you want to save and view the bib record you have
30875             created or continue on to add/edit items attached to the
30876             record</para>
30877
30878             <screenshot>
30879               <screeninfo>Record save options</screeninfo>
30880
30881               <mediaobject>
30882                 <imageobject>
30883                   <imagedata fileref="images/cataloging/savecataloging.png"/>
30884                 </imageobject>
30885               </mediaobject>
30886             </screenshot>
30887             <itemizedlist>
30888               <listitem>
30889                 <para>Choosing 'Save and view record' will bring you right to the record you just
30890                   cataloged</para>
30891               </listitem>
30892               <listitem>
30893                 <para>Choosing 'Save and edit items' will bring you to the add/edit item form after
30894                   saving the bib record so that you can attach holdings</para>
30895               </listitem>
30896               <listitem>
30897                 <para>Choosing 'Save and continute editing' will allow you to save your work so far
30898                   and keep you in the editor to continue working</para>
30899               </listitem>
30900             </itemizedlist>
30901           </listitem>
30902           <listitem>
30903             <para>If you are about to add a duplicate record to the system you will be warned before
30904               saving</para>
30905             <screenshot>
30906               <screeninfo>Duplicate Record Warning</screeninfo>
30907               <mediaobject>
30908                 <imageobject>
30909                   <imagedata fileref="images/cataloging/duprecordwarn.png"/>
30910                 </imageobject>
30911               </mediaobject>
30912             </screenshot>
30913           </listitem>
30914         </itemizedlist>
30915       </section>
30916
30917       <section id="cataloganalytics">
30918         <title>Adding Analytic Records</title>
30919
30920         <para>Libraries sometimes make journal articles and articles within
30921         monographs and serials accessible to library patrons through analytics
30922         cataloging. Analytics cataloging creates separate bibliographic
30923         records for these articles, chapters, sections, etc. found within a
30924         larger resource such as a book, an article within a journal, newspaper
30925         or serial. In analytics cataloging, although a separate bib record is
30926         created for the title, it is not physically separated from the host
30927         item.  Learn more about Analytics in Chapter 13 of AACR2.</para>
30928
30929         <para>If you would like to catalog analytic records there are two options. One is to use the
30930             <link linkend="catalogeasyanalytics">Easy Analytics</link> funtion; the other is the
30931             <link linkend="catalogenhanceanalytics">Analytics Enhanced Workflow</link>.</para>
30932         <section id="catalogeasyanalytics">
30933           <title>Easy Analytics</title>
30934           <para>The Easy Analytics feature makes linking analytic records together easier.  The
30935             first thing you need to do is set the <link linkend="EasyAnalyticalRecords"
30936               >EasyAnalyticalRecords</link> preference to 'Display' and the <link
30937               linkend="UseControlNumber">UseControlNumber</link> preference to 'Don't use.' </para>
30938           <para>After cataloging your analytic record (see <link linkend="addbibrec">Adding
30939               Records</link> for more on creating records) click 'Edit' from the normal view and
30940             choose to 'Link to Host Item'</para>
30941           <screenshot>
30942             <screeninfo>Link to Host Item</screeninfo>
30943             <mediaobject>
30944               <imageobject>
30945                 <imagedata fileref="images/cataloging/analyticslink.png"/>
30946               </imageobject>
30947             </mediaobject>
30948           </screenshot>
30949           <para>This will prompt you to enter the barcode for the item this record should be linked
30950             to.</para>
30951           <screenshot>
30952             <screeninfo>Barcode for Analytic Linking</screeninfo>
30953             <mediaobject>
30954               <imageobject>
30955                 <imagedata fileref="images/cataloging/analyticsbarcode.png"/>
30956               </imageobject>
30957             </mediaobject>
30958           </screenshot>
30959           <para>After entering the item's barcode and clicking 'Select' you will receive a
30960             confirmation message.</para>
30961           <screenshot>
30962             <screeninfo>Analytic Link Success</screeninfo>
30963             <mediaobject>
30964               <imageobject>
30965                 <imagedata fileref="images/cataloging/analyticlinksuccess.png"/>
30966               </imageobject>
30967             </mediaobject>
30968           </screenshot>
30969           <para>The record will now have the 773 field filled in properly to complete the
30970             link.</para>
30971           <screenshot>
30972             <screeninfo>773</screeninfo>
30973             <mediaobject>
30974               <imageobject>
30975                 <imagedata fileref="images/cataloging/analytics773.png"/>
30976               </imageobject>
30977             </mediaobject>
30978           </screenshot>
30979           <para>To view all of the items tied to the host record, do a search for the record, click
30980             the Analytics tab on the left and the analytics tied to each barcode will be shown under
30981             the "Used in" column.</para>
30982           <screenshot>
30983             <screeninfo>Analytics Tab</screeninfo>
30984             <mediaobject>
30985               <imageobject>
30986                 <imagedata fileref="images/cataloging/analyticstab.png"/>
30987               </imageobject>
30988             </mediaobject>
30989           </screenshot>
30990           <note>
30991             <para>It is also possible to create analytic records from this screen by clicking on
30992               "Create Analytics"</para>
30993           </note>
30994           <para>You can also see the analytics attached to this record by clicking the 'Show
30995             Analytic' link towards the top of the record in the normal view.</para>
30996           <screenshot>
30997             <screeninfo>Show Analytics on Bib Record</screeninfo>
30998             <mediaobject>
30999               <imageobject>
31000                 <imagedata fileref="images/cataloging/anayticbib.png"/>
31001               </imageobject>
31002             </mediaobject>
31003           </screenshot>
31004           <para>When looking at the anaytic record you will also see a link to the host item under
31005             the 'Host records' column in the holdings table when viewing the 'Analtyics' tab.</para>
31006           <screenshot>
31007               <screeninfo>Host Record</screeninfo>
31008               <mediaobject>
31009                 <imageobject>
31010                   <imagedata fileref="images/cataloging/hostrecords.png"/>
31011                 </imageobject>
31012               </mediaobject>
31013             </screenshot>
31014         </section>
31015         <section id="catalogenhanceanalytics">
31016           <title>Analytics Enhanced Workflow </title>
31017           <para>To use the Enhanced Workflow method of adding analytics, the first thing you need to
31018             do is set the <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link>
31019             preference to 'Don't display' and the <link linkend="UseControlNumber"
31020               >UseControlNumber</link> preference to 'Use.' </para>
31021           <para>After cataloging your original record (see <link linkend="addbibrec">Adding
31022               Records</link> for more on creating records) click 'New' from the normal view and
31023             choose to 'New child record.'</para>
31024           <screenshot>
31025               <screeninfo>New child record</screeninfo>
31026               <mediaobject>
31027                 <imageobject>
31028                   <imagedata fileref="images/cataloging/analyticschildlink.png"/>
31029                 </imageobject>
31030               </mediaobject>
31031             </screenshot>
31032           <para>This will open a new blank record for cataloging. The blank record will only have
31033             the 773 field filled in properly to complete the link once the record is saved.</para>
31034           <screenshot>
31035             <screeninfo>773</screeninfo>
31036             <mediaobject>
31037               <imageobject>
31038                 <imagedata fileref="images/cataloging/analytics773child.png"/>
31039               </imageobject>
31040             </mediaobject>
31041           </screenshot>
31042           <para>To view all of the items tied to the host record, do a search for the record, click
31043             the Analytics tab on the left and the analytics tied to each barcode will be shown under
31044             the "Used in" column.</para>
31045           <screenshot>
31046             <screeninfo>Analytics Tab</screeninfo>
31047             <mediaobject>
31048               <imageobject>
31049                 <imagedata fileref="images/cataloging/analyticstab.png"/>
31050               </imageobject>
31051             </mediaobject>
31052           </screenshot>
31053           <para>You can also see the analytics attached to this record by clicking the 'Show
31054             Analytic' link towards the top of the record in the normal view.</para>
31055           <screenshot>
31056             <screeninfo>Show Analytics on Bib Record</screeninfo>
31057             <mediaobject>
31058               <imageobject>
31059                 <imagedata fileref="images/cataloging/anayticbib.png"/>
31060               </imageobject>
31061             </mediaobject>
31062           </screenshot>
31063           <para>When looking at the anaytic record you will also see a link to the host item under
31064             the 'Host records' column in the holdings table when viewing the 'Analtyics' tab.</para>
31065           <screenshot>
31066               <screeninfo>Host Record</screeninfo>
31067               <mediaobject>
31068                 <imageobject>
31069                   <imagedata fileref="images/cataloging/hostrecords.png"/>
31070                 </imageobject>
31071               </mediaobject>
31072             </screenshot>
31073         </section>
31074         <section id="analyticediting">
31075           <title>Editing Analytics</title>
31076           <para>If you have linked an analytic record incorrectly you can remove that link by
31077             editing the item on the analytic record (not the host record). To do this, go to the
31078             analytic record and click the 'Edit' button and choose to 'Edit items'. To the left of
31079             each item you will see two options.</para>
31080           <screenshot>
31081             <screeninfo>Edit Analytic Item Record</screeninfo>
31082             <mediaobject>
31083               <imageobject>
31084                 <imagedata fileref="images/cataloging/analyticdelink.png"/>
31085               </imageobject>
31086             </mediaobject>
31087           </screenshot>
31088           <itemizedlist>
31089             <listitem>
31090               <para>Clicking 'Edit in Host' will allow you to edit the item on the host
31091                 record.</para>
31092             </listitem>
31093             <listitem>
31094               <para>Clicking 'Delink' will remove the 773 field and the link between the analytic
31095                 and the host.</para>
31096             </listitem>
31097           </itemizedlist>
31098         </section>
31099       </section>
31100
31101       <section id="editbibrec">
31102         <title>Editing Records</title>
31103
31104         <para>To edit a record you can click 'Edit Biblio' from the search
31105         results on the cataloging page</para>
31106
31107         <screenshot>
31108           <screeninfo>Edit Biblio Option on Search Results</screeninfo>
31109
31110           <mediaobject>
31111             <imageobject>
31112               <imagedata fileref="images/cataloging/catalogsearch.png"/>
31113             </imageobject>
31114           </mediaobject>
31115         </screenshot>
31116
31117         <para>or by clicking the Edit button on the Bibliographic Record and
31118         choosing 'Edit Record'</para>
31119
31120         <screenshot>
31121           <screeninfo>Edit Record Option on Bibliographic Record</screeninfo>
31122
31123           <mediaobject>
31124             <imageobject>
31125               <imagedata fileref="images/cataloging/editrecord.png"/>
31126             </imageobject>
31127           </mediaobject>
31128         </screenshot>
31129
31130         <para>The record will open in the MARC editor</para>
31131
31132         <screenshot>
31133           <screeninfo>Editing MARC Record</screeninfo>
31134
31135           <mediaobject>
31136             <imageobject>
31137               <imagedata fileref="images/cataloging/editingrecord.png"/>
31138             </imageobject>
31139           </mediaobject>
31140         </screenshot>
31141
31142         <para>The alternative is to search via Z39.50 to overlay your record
31143         with a fuller record found at another library. You can do this by
31144         choosing 'Replace Record via Z39.50' from the Edit menu.</para>
31145
31146         <screenshot>
31147           <screeninfo>Replace via Z39.50</screeninfo>
31148
31149           <mediaobject>
31150             <imageobject>
31151               <imagedata fileref="images/cataloging/replaceviaz39.png"/>
31152             </imageobject>
31153           </mediaobject>
31154         </screenshot>
31155
31156         <para>Once you choose that you will be brought to a Z39.50 search
31157         window to search other libraries for the record in question.</para>
31158
31159         <para>Once you have made your edits (via either method) you can click
31160         'Save' at the top left of the editor.</para>
31161
31162         <para>You can also use the edit menu to add your own custom cover
31163         image if you have either <link linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> and/or
31164         <link linkend="LocalCoverImages">LocalCoverImages</link> set to
31165         'Display' by choosing 'Upload Image' from the menu.</para>
31166
31167         <screenshot>
31168           <screeninfo>Upload Image</screeninfo>
31169
31170           <mediaobject>
31171             <imageobject>
31172               <imagedata fileref="images/cataloging/uploadimage.png"/>
31173             </imageobject>
31174           </mediaobject>
31175         </screenshot>
31176
31177         <para>Choosing to 'Upload Image' will take you to the <link linkend="uploadlocalimages">Upload Local Cover Image
31178         Tool</link>.</para>
31179       </section>
31180
31181       <section id="dupbibrec">
31182         <title>Duplicating Records</title>
31183
31184         <para>Sometimes a copy of the record you need to catalog can't be
31185         found via Z39.50. In these cases you can create a duplicate of similar
31186         record and edit the necessary pieces to create a new record. To
31187         duplicate an existing record click 'Edit as New (Duplicate)' from the
31188         Edit menu on the Bibliographic Record</para>
31189
31190         <screenshot>
31191           <screeninfo>Edit as New (Duplicate) Bibliographic
31192           Record</screeninfo>
31193
31194           <mediaobject>
31195             <imageobject>
31196               <imagedata fileref="images/cataloging/createduplicate.png"/>
31197             </imageobject>
31198           </mediaobject>
31199         </screenshot>
31200
31201         <para>This will open a new MARC record with the fields filled in with
31202         the values from the original Bibliographic Record.</para>
31203
31204         <screenshot>
31205           <screeninfo>New Duplicate Record</screeninfo>
31206
31207           <mediaobject>
31208             <imageobject>
31209               <imagedata fileref="images/cataloging/newduprecord.png"/>
31210             </imageobject>
31211           </mediaobject>
31212         </screenshot>
31213       </section>
31214
31215       <section id="mergebibs">
31216         <title>Merging Records</title>
31217
31218         <para>If you would like to merge together multiple records you can do
31219         that via the <link linkend="lists">Lists</link> tool. <link linkend="mergebibrecs">Learn more here</link>.</para>
31220       </section>
31221       <section id="deleterecord">
31222         <title>Deleting Records</title>
31223         <para>To delete a bibliographic record simply choose the 'Edit' button and select 'Delete record'</para>
31224         <screenshot>
31225             <screeninfo>Delete record</screeninfo>
31226             <mediaobject>
31227               <imageobject>
31228                 <imagedata fileref="images/cataloging/deleterecord.png"/>
31229               </imageobject>
31230             </mediaobject>
31231           </screenshot>
31232         <para>Bibliographic records can only be deleted one all items have been deleted. If you try
31233           to delete a bibliographic record with items still attached you will see that the delete
31234           option is grayed out.</para>
31235         <screenshot>
31236             <screeninfo>Record with items still attached</screeninfo>
31237             <mediaobject>
31238               <imageobject>
31239                 <imagedata fileref="images/cataloging/nodeleterecord.png"/>
31240               </imageobject>
31241             </mediaobject>
31242           </screenshot>
31243       </section>
31244     </section>
31245
31246     <section id="catitems">
31247       <title>Item Records</title>
31248
31249       <para>In Koha each bibliographic record can have one or more items
31250       attached. These items are sometimes referred to as holdings. Each item
31251       includes information to the physical copy the library has.</para>
31252
31253       <section id="addingitems">
31254         <title>Adding Items</title>
31255
31256         <para>After saving a new bibliographic record, you will be redirected
31257         to a blank item record so that you can attach an item to the
31258         bibliographic record. You can also click 'Add/Edit Items' from the
31259         cataloging search results</para>
31260
31261         <screenshot>
31262           <screeninfo>Add/Edit Items Option on Search Results</screeninfo>
31263
31264           <mediaobject>
31265             <imageobject>
31266               <imagedata fileref="images/cataloging/catalogsearch.png"/>
31267             </imageobject>
31268           </mediaobject>
31269         </screenshot>
31270
31271         <para>or you can add new item at any time by clicking 'New' on the
31272         bibliographic record and choosing 'New Item'</para>
31273
31274         <screenshot>
31275           <screeninfo>New Item Button</screeninfo>
31276
31277           <mediaobject>
31278             <imageobject>
31279               <imagedata fileref="images/cataloging/newitem.png"/>
31280             </imageobject>
31281           </mediaobject>
31282         </screenshot>
31283
31284         <para>The item edit form will appear:</para>
31285
31286         <screenshot>
31287           <screeninfo>Add item form</screeninfo>
31288
31289           <mediaobject>
31290             <imageobject>
31291               <imagedata fileref="images/cataloging/additem.png"/>
31292             </imageobject>
31293           </mediaobject>
31294         </screenshot>
31295
31296         <para>At the very least, if you plan on circulating the item, the
31297         following fields should be entered for new items:</para>
31298
31299         <itemizedlist>
31300           <listitem>
31301             <para>2 - Source of classification</para>
31302           </listitem>
31303
31304           <listitem>
31305             <para>a - Permanent location</para>
31306           </listitem>
31307
31308           <listitem>
31309             <para>b - Current location</para>
31310           </listitem>
31311
31312           <listitem>
31313             <para>o - Full call number<itemizedlist>
31314                 <listitem>
31315                   <para>If you'd like you can use the <link linkend="cnbrowseplugin">call number
31316                       browser plugin</link> for this field. If it's enabled you'll see a ... to the
31317                     right of the field. When clicked that will open a call number browser window.<screenshot>
31318                       <screeninfo>Call number browser</screeninfo>
31319                       <mediaobject>
31320                         <imageobject>
31321                           <imagedata fileref="images/cataloging/cnbrowser.png"/>
31322                         </imageobject>
31323                       </mediaobject>
31324                     </screenshot></para>
31325                 </listitem>
31326               </itemizedlist></para>
31327           </listitem>
31328
31329           <listitem>
31330             <para>p - Barcode</para>
31331           </listitem>
31332
31333           <listitem>
31334             <para>v - Cost, replacement price</para>
31335
31336             <itemizedlist>
31337               <listitem>
31338                 <para>This value will be charged to patrons when you mark an
31339                 item they have checked out as 'Lost'</para>
31340               </listitem>
31341             </itemizedlist>
31342           </listitem>
31343
31344           <listitem>
31345             <para>y - Koha item type</para>
31346           </listitem>
31347         </itemizedlist>
31348
31349         <para>To make sure that these values are filled in you can mark them
31350         as mandatory in the <link linkend="marcbibframeworks">framework</link>
31351         you're using and then they will appear in red with a 'required' label.
31352         The item will not save until the required fields are filled in.</para>
31353
31354         <screenshot>
31355           <screeninfo>Required Item Subfield</screeninfo>
31356
31357           <mediaobject>
31358             <imageobject>
31359               <imagedata fileref="images/cataloging/requireditemfields.png"/>
31360             </imageobject>
31361           </mediaobject>
31362         </screenshot>
31363
31364         <itemizedlist>
31365           <listitem>
31366             <note>
31367               <para>To make item subfields required in a framework you'll want
31368               to edit the 952 field in the <link linkend="marcbibframeworks">framework editor</link>.</para>
31369             </note>
31370           </listitem>
31371         </itemizedlist>
31372
31373         <para>Below the add form there are 3 buttons for adding the
31374         item</para>
31375
31376         <screenshot>
31377           <screeninfo>Add Item Buttons</screeninfo>
31378
31379           <mediaobject>
31380             <imageobject>
31381               <imagedata fileref="images/cataloging/additembuttons.png"/>
31382             </imageobject>
31383           </mediaobject>
31384         </screenshot>
31385
31386         <itemizedlist>
31387           <listitem>
31388             <para>Add Item will add just the one item</para>
31389           </listitem>
31390
31391           <listitem>
31392             <para>Add &amp; Duplicate will add the item and fill in a new form
31393             with the same values for your to alter</para>
31394           </listitem>
31395
31396           <listitem>
31397             <para>Add Multiple items will ask how many items and will then add that number of items
31398               adding +1 to the barcode so each barcode is unique</para>
31399           </listitem>
31400         </itemizedlist>
31401
31402         <para>Your added items will appear above the add form once
31403         submitted</para>
31404
31405         <screenshot>
31406           <screeninfo>Items</screeninfo>
31407
31408           <mediaobject>
31409             <imageobject>
31410               <imagedata fileref="images/cataloging/items.png"/>
31411             </imageobject>
31412           </mediaobject>
31413         </screenshot>
31414
31415         <para>Your items will also appear below the bibliographic details on
31416         the bib record display.</para>
31417
31418         <screenshot>
31419           <screeninfo>List of Items on the Bib Record</screeninfo>
31420
31421           <mediaobject>
31422             <imageobject>
31423               <imagedata fileref="images/cataloging/items-withoutlabelprint.png"/>
31424             </imageobject>
31425           </mediaobject>
31426         </screenshot>
31427
31428         <para>If you have <link linkend="SpineLabelShowPrintOnBibDetails">SpineLabelShowPrintOnBibDetails</link>
31429         set to 'Display' then there will also be a link to print a quick spine
31430         label next to each item.</para>
31431
31432         <screenshot>
31433           <screeninfo>List of Items on the Bib Record with a Print Label
31434           link</screeninfo>
31435
31436           <mediaobject>
31437             <imageobject>
31438               <imagedata fileref="images/cataloging/items-withlabelprint.png"/>
31439             </imageobject>
31440           </mediaobject>
31441         </screenshot>
31442         <para>You can also filter the contents of your holdings table by clicking the 'Activate
31443           filters' links.  This will show a row at the top where you can type in any column to
31444           filter the results in the table.</para>
31445         <screenshot>
31446             <screeninfo>Filter holdings</screeninfo>
31447             <mediaobject>
31448               <imageobject>
31449                 <imagedata fileref="images/cataloging/items-activatefilters.png"/>
31450               </imageobject>
31451             </mediaobject>
31452           </screenshot>
31453       </section>
31454
31455       <section id="editingitems">
31456         <title>Editing Items</title>
31457
31458         <para>Items can be edited in several ways.</para>
31459
31460         <itemizedlist>
31461           <listitem>
31462             <para>Clicking 'Edit' and 'Edit Items' from the bibliographic
31463             record</para>
31464
31465             <screenshot>
31466               <screeninfo>Edit Items Menu Option</screeninfo>
31467
31468               <mediaobject>
31469                 <imageobject>
31470                   <imagedata fileref="images/cataloging/edititem.png"/>
31471                 </imageobject>
31472               </mediaobject>
31473             </screenshot>
31474
31475             <para>Which will open up a list of items where you can click
31476             'Edit' to the left of the specific item you would like to
31477             edit.</para>
31478
31479             <screenshot>
31480               <screeninfo>Edit individual items</screeninfo>
31481
31482               <mediaobject>
31483                 <imageobject>
31484                   <imagedata fileref="images/cataloging/edititemlink.png"/>
31485                 </imageobject>
31486               </mediaobject>
31487             </screenshot>
31488           </listitem>
31489
31490           <listitem>
31491             <para>Clicking 'Edit Items' beside the item on the 'Items'
31492             tab</para>
31493
31494             <screenshot>
31495               <screeninfo>Items Tab</screeninfo>
31496
31497               <mediaobject>
31498                 <imageobject>
31499                   <imagedata fileref="images/cataloging/itemstab.png"/>
31500                 </imageobject>
31501               </mediaobject>
31502             </screenshot>
31503
31504             <para>Which will open up the editor on the item you'd like to edit</para>
31505
31506             <screenshot>
31507               <screeninfo>Edit individual items</screeninfo>
31508
31509               <mediaobject>
31510                 <imageobject>
31511                   <imagedata fileref="images/cataloging/edititemlinkfromtab.png"/>
31512                 </imageobject>
31513               </mediaobject>
31514             </screenshot>
31515           </listitem>
31516
31517           <listitem>
31518             <para>Clicking 'Edit' and then 'Edit items in batch'</para>
31519
31520             <screenshot>
31521               <screeninfo>Edit items in a batch</screeninfo>
31522
31523               <mediaobject>
31524                 <imageobject>
31525                   <imagedata fileref="images/cataloging/editinbatch.png"/>
31526                 </imageobject>
31527               </mediaobject>
31528             </screenshot>
31529
31530             <para>This will open up the <link linkend="batchmodifyitems">batch
31531             item modification tool</link> where you can edit all of the items
31532             on this record as a batch.</para></listitem>
31533             <listitem><para>You can also enable <link linkend="StaffDetailItemSelection">StaffDetailItemSelection
31534             </link> to have checkboxes appear to the left of each item
31535               on the detail display. You can then check off the items you would like to edit and
31536               click 'Modify selected items' at the top of the list.</para>
31537               <screenshot>
31538                 <screeninfo>Editing selected items</screeninfo>
31539                 <mediaobject>
31540                   <imageobject>
31541                     <imagedata fileref="images/cataloging/editwithitemchecks.png"/>
31542                   </imageobject>
31543                 </mediaobject>
31544               </screenshot>
31545           </listitem>
31546           <listitem>
31547             <para>You can click 'Edit' to the right of each item in the Holdings tab<screenshot>
31548                 <screeninfo>Edit individual items</screeninfo>
31549                 <mediaobject>
31550                   <imageobject>
31551                     <imagedata fileref="images/cataloging/editindividual.png"/>
31552                   </imageobject>
31553                 </mediaobject>
31554               </screenshot></para>
31555           </listitem>
31556           <listitem>
31557             <para>Finally you can use the <link linkend="batchmodifyitems">Batch Item
31558                 Modification</link> tool</para>
31559           </listitem>
31560         </itemizedlist>
31561
31562         <section id="itemquickedit">
31563           <title>Quick Item Status Updates</title>
31564
31565           <para>Often circulation staff need to change the status of an item
31566           to Lost or Damaged. This doesn't require you to edit the entire item
31567           record. Instead clicking on the item barcode on the checkout summary
31568           or checkin history will bring you to an item summary. You can also
31569           get to the item summary by clicking on the Items tab to the left of
31570           the bib detail page.</para>
31571
31572           <screenshot>
31573             <screeninfo>Item Edit</screeninfo>
31574
31575             <mediaobject>
31576               <imageobject>
31577                 <imagedata fileref="images/cataloging/quickitemedit.png"/>
31578               </imageobject>
31579             </mediaobject>
31580           </screenshot>
31581
31582           <para>From this view you can mark an item lost by choosing a lost
31583           status from the pull down and clicking the 'Set Status'
31584           button.</para>
31585
31586           <screenshot>
31587             <screeninfo>Edit Lost Status</screeninfo>
31588
31589             <mediaobject>
31590               <imageobject>
31591                 <imagedata fileref="images/cataloging/editloststatus.png"/>
31592               </imageobject>
31593             </mediaobject>
31594           </screenshot>
31595
31596           <para>You can also mark an item as damaged by choosing a damaged
31597           status from the pull down and clicking the 'Set Status'
31598           button.</para>
31599
31600           <screenshot>
31601             <screeninfo>Edit Damaged Status</screeninfo>
31602
31603             <mediaobject>
31604               <imageobject>
31605                 <imagedata fileref="images/cataloging/editdamagedstatus.png"/>
31606               </imageobject>
31607             </mediaobject>
31608           </screenshot>
31609         </section>
31610       </section>
31611
31612       <section id="iteminfo">
31613         <title>Item Information</title>
31614
31615         <para>To the left of every bibliographic record there is a tab to view
31616         the items.</para>
31617
31618         <screenshot>
31619           <screeninfo>Items Tab</screeninfo>
31620
31621           <mediaobject>
31622             <imageobject>
31623               <imagedata fileref="images/cataloging/quickitemedit.png"/>
31624             </imageobject>
31625           </mediaobject>
31626         </screenshot>
31627
31628         <para>Clicking that tab will give you basic information about the items. From here you can
31629           see basic information about the item such as the home library, item type, collection code,
31630           call number and replacement price. You can also see and edit the status information.  If
31631           an item is marked lost or withdrawn you will also see the date that status was applied.<screenshot>
31632             <screeninfo/>
31633             <mediaobject>
31634               <imageobject>
31635                 <imagedata fileref="images/cataloging/itemstatuses.png"/>
31636               </imageobject>
31637             </mediaobject>
31638           </screenshot></para>
31639         <para>In the History section you will see infomration about the check out history of the
31640           item and if you ordered the item via the acquisitions module then this section will
31641           include information about the order.</para>
31642
31643         <screenshot>
31644           <screeninfo>History with order info</screeninfo>
31645
31646           <mediaobject>
31647             <imageobject>
31648               <imagedata fileref="images/cataloging/itemorderinfo.png"/>
31649             </imageobject>
31650           </mediaobject>
31651         </screenshot>
31652
31653         <para>If the Order or Accession date is linked, clicking it will bring
31654         you to the acquisitions information for that item.</para>
31655       </section>
31656
31657       <section id="moveitemrec">
31658         <title>Moving Items</title>
31659
31660         <para>Items can be moved from one bibliographic record to another
31661         using the Attach Item option</para>
31662
31663         <screenshot>
31664           <screeninfo>Attach Item Option</screeninfo>
31665
31666           <mediaobject>
31667             <imageobject>
31668               <imagedata fileref="images/cataloging/attachitem.png"/>
31669             </imageobject>
31670           </mediaobject>
31671         </screenshot>
31672
31673         <para>Visit the bibliographic record you want to attach the item to
31674         and choose 'Attach Item' from the 'Edit' menu.</para>
31675
31676         <screenshot>
31677           <screeninfo>Attach Item Form</screeninfo>
31678
31679           <mediaobject>
31680             <imageobject>
31681               <imagedata fileref="images/cataloging/attachitemform.png"/>
31682             </imageobject>
31683           </mediaobject>
31684         </screenshot>
31685
31686         <para>Simply enter the barcode for the item you want to move and click
31687         'Select'</para>
31688
31689         <para>If you want to move all items to a new record creating only one
31690         bibliographic record you can use the <link linkend="mergebibrecs">Merge Records tool</link> instead.</para>
31691       </section>
31692
31693       <section id="deleteitems">
31694         <title>Deleting Items</title>
31695
31696         <para>There are many ways to delete item records. If you only need to
31697         delete one item you can do this by opening up the detail page for the
31698         bib record and clicking the 'Edit' button at the top. From there you
31699         can choose to 'Edit items'.</para>
31700
31701         <screenshot>
31702           <screeninfo>'Edit Items' menu option</screeninfo>
31703
31704           <mediaobject>
31705             <imageobject>
31706               <imagedata fileref="images/cataloging/edititemstodelete.png"/>
31707             </imageobject>
31708           </mediaobject>
31709         </screenshot>
31710
31711         <para>You will be presented with a list of items and next to each one
31712         will be a link labeled 'Delete'. Click that link and if the item is
31713         not checked out it will delete that item.</para>
31714
31715         <screenshot>
31716           <screeninfo>Delete link on the left</screeninfo>
31717
31718           <mediaobject>
31719             <imageobject>
31720               <imagedata fileref="images/cataloging/deleteitemlink.png"/>
31721             </imageobject>
31722           </mediaobject>
31723         </screenshot>
31724
31725         <para>If you know that all of the items attached to your record are
31726         not currently checked out you can use the 'Delete all items' option
31727         under the 'Edit menu' and it will remove all items from the
31728         record.</para>
31729         <para>You can also enable <link linkend="StaffDetailItemSelection">StaffDetailItemSelection</link>
31730           to have checkboxes appear to the left of each item on
31731           the detail display. You can then check off the items you would like to delete and click
31732           'Delete selected items' at the top of the list.</para>
31733         <screenshot>
31734             <screeninfo>Deleting selected items</screeninfo>
31735             <mediaobject>
31736               <imageobject>
31737                 <imagedata fileref="images/cataloging/editwithitemchecks.png"/>
31738               </imageobject>
31739             </mediaobject>
31740           </screenshot>
31741
31742         <para>Finally you can use the <link linkend="batchdeleteitems">batch
31743         delete tool</link> to delete a batch of items.</para>
31744       </section>
31745
31746       <section id="itemcirchistory">
31747         <title>Item Specific Circulation History</title>
31748
31749         <para>Each bibliographic record keeps a circulation history (with or
31750         without the patron information depending on your settings), but each
31751         item also has its own circulation history page. To see this, click on
31752         the 'Items' tab to the left of the record you are viewing.</para>
31753
31754         <screenshot>
31755           <screeninfo>Items tab</screeninfo>
31756
31757           <mediaobject>
31758             <imageobject>
31759               <imagedata fileref="images/cataloging/itemstab-long.png"/>
31760             </imageobject>
31761           </mediaobject>
31762         </screenshot>
31763
31764         <para>Below the 'History' heading is a link to 'View item's checkout
31765         history,' clicking that will open up the item's history which will
31766         look slightly different from the bibliographic record's history
31767         page.</para>
31768
31769         <screenshot>
31770           <screeninfo>Item Specific Circulation History</screeninfo>
31771
31772           <mediaobject>
31773             <imageobject>
31774               <imagedata fileref="images/cataloging/itemspecifichistory.png"/>
31775             </imageobject>
31776           </mediaobject>
31777         </screenshot>
31778       </section>
31779     </section>
31780
31781     <section id="catauthorities">
31782       <title>Authorities</title>
31783
31784       <para>Authority records are a way of controlling fields in your MARC
31785       records. Using authority records will provide you with control over
31786       subject headings, personal names and places.</para>
31787
31788       <section id="addauthorities">
31789         <title>Adding Authorities</title>
31790
31791         <para>To add a new authority record you can either choose the authority type from the 'New
31792           Authority' button or search another library by clicking the 'New from Z39.50'
31793           button.</para>
31794
31795         <screenshot>
31796           <screeninfo>New Authority Record Options</screeninfo>
31797
31798           <mediaobject>
31799             <imageobject>
31800               <imagedata fileref="images/cataloging/newauthtypes.png"/>
31801             </imageobject>
31802           </mediaobject>
31803         </screenshot>
31804
31805         <para>If you choose to enter a new authority from scratch, the form that appears will allow
31806           you to enter all of the necessary details regarding your authority record.</para>
31807
31808         <screenshot>
31809           <screeninfo>New Authority Record</screeninfo>
31810
31811           <mediaobject>
31812             <imageobject>
31813               <imagedata fileref="images/cataloging/newauthrec.png"/>
31814             </imageobject>
31815           </mediaobject>
31816         </screenshot>
31817
31818         <para>To expand collapsed values simply click on the title and the
31819         subfields will appear. To duplicate a field or subfield just click the
31820         plus sign (+) to the right of the label. To use field helper plugins
31821         simply click the ellipsis (...) to the right of the field.</para>
31822
31823         <para>When linking authorities to other headings, you can use the
31824         authority finder plugin by clicking the ellipsis (...) to the right of
31825         the field.</para>
31826
31827         <screenshot>
31828           <screeninfo>Authority search plugin</screeninfo>
31829
31830           <mediaobject>
31831             <imageobject>
31832               <imagedata fileref="images/cataloging/creatnewauthfromlink.png"/>
31833             </imageobject>
31834           </mediaobject>
31835         </screenshot>
31836
31837         <para>From there you can search your authority file for the authority
31838         to link. If you can't find the authority to link, you can click the
31839         'Create new' button and add the necessary authority for the link. This
31840         plugin also allows for you to choose the link relationship between the
31841         authorities.</para>
31842
31843         <screenshot>
31844           <screeninfo>Authority relationships</screeninfo>
31845
31846           <mediaobject>
31847             <imageobject>
31848               <imagedata fileref="images/cataloging/authrelationships.png"/>
31849             </imageobject>
31850           </mediaobject>
31851         </screenshot>
31852         <para>If you choose to search another library for the authority record you will be presented
31853           with a search box</para>
31854         <screenshot>
31855             <screeninfo>Authority Z39.50 Search</screeninfo>
31856             <mediaobject>
31857               <imageobject>
31858                 <imagedata fileref="images/cataloging/authzsearch.png"/>
31859               </imageobject>
31860             </mediaobject>
31861           </screenshot>
31862         <para>From the results you can choose the 'Import' link to the right of the record you would
31863           like to add to Koha</para>
31864         <screenshot>
31865             <screeninfo>Authority Z39.50 Results</screeninfo>
31866             <mediaobject>
31867               <imageobject>
31868                 <imagedata fileref="images/cataloging/authimport.png"/>
31869               </imageobject>
31870             </mediaobject>
31871           </screenshot>
31872         <para>You will then be presented with the form to edit the authority before saving it to
31873           your system</para>
31874         <screenshot>
31875             <screeninfo>Imported Authority</screeninfo>
31876             <mediaobject>
31877               <imageobject>
31878                 <imagedata fileref="images/cataloging/authorityimported.png"/>
31879               </imageobject>
31880             </mediaobject>
31881           </screenshot>
31882       </section>
31883
31884       <section id="searchauthorities">
31885         <title>Searching Authorities</title>
31886
31887         <para>From the authorities page you can search for existing terms and
31888         the bibliographic records they are attached to.</para>
31889
31890         <screenshot>
31891           <screeninfo>Authority Search</screeninfo>
31892
31893           <mediaobject>
31894             <imageobject>
31895               <imagedata fileref="images/cataloging/authoritysearch.png"/>
31896             </imageobject>
31897           </mediaobject>
31898         </screenshot>
31899
31900         <para>From the results you will see the authority record, how many bibliographic records it
31901           is attached to, an <link linkend="editauthorities">edit</link> link, a <link
31902             linkend="authoritymerge">merge</link> link and a <link linkend="editauthorities"
31903             >delete</link> link (if there are no bibliographic records attached).</para>
31904
31905         <screenshot>
31906           <screeninfo>Authority Search Results</screeninfo>
31907
31908           <mediaobject>
31909             <imageobject>
31910               <imagedata fileref="images/cataloging/authorityresults.png"/>
31911             </imageobject>
31912           </mediaobject>
31913         </screenshot>
31914
31915         <para>Clicking on the Details link to the right of the authority
31916         record summary will open the full record and the option to edit the
31917         record.</para>
31918
31919         <screenshot>
31920           <screeninfo>Authority Record</screeninfo>
31921
31922           <mediaobject>
31923             <imageobject>
31924               <imagedata fileref="images/cataloging/authrecord.png"/>
31925             </imageobject>
31926           </mediaobject>
31927         </screenshot>
31928
31929         <para>If the authority has See Alsos in it you will see those broken
31930         out on the search results, clicking the linked headings will run a
31931         search for that heading instead.</para>
31932
31933         <screenshot>
31934           <screeninfo>See Also in Authorities</screeninfo>
31935
31936           <mediaobject>
31937             <imageobject>
31938               <imagedata fileref="images/cataloging/authoritiesseealso.png"/>
31939             </imageobject>
31940           </mediaobject>
31941         </screenshot>
31942       </section>
31943
31944       <section id="editauthorities">
31945         <title>Editing Authorities</title>
31946
31947         <para>Authorities can be edited by clicking on the authority summary from the search results
31948           and then clicking the 'Edit' button above the record. Or by clicking on the 'Edit' link to
31949           the left of the authority on the search results.</para>
31950
31951         <screenshot>
31952           <screeninfo>Edit Authority Record</screeninfo>
31953
31954           <mediaobject>
31955             <imageobject>
31956               <imagedata fileref="images/cataloging/editauthority.png"/>
31957             </imageobject>
31958           </mediaobject>
31959         </screenshot>
31960
31961         <para>Once you've made the necessary edits, simply click 'Save' and <link
31962             linkend="dontmerge">dontmerge</link> is set to 'Do', Koha will immediately update all of
31963           the bib records linked to the authority with the new authority record's data. If dontmerge
31964           is set to "Don't" then Koha won't edit bib records when changes are made to authorities,
31965           rather, this is done later by the <link linkend="mergeauthcron">merge_authority.pl
31966             cronjob</link>.</para>
31967
31968         <para>To delete an authority record you first must make sure it's not
31969         linked to any bibliographic records. If it is not used by any
31970         bibliographic records a 'Delete' link will appear to the right of the
31971         record on the search results and as a button that appears after
31972         clicking on the summary of the authority record.</para>
31973       </section>
31974       <section id="authoritymerge">
31975         <title>Merging Authorities</title>
31976         <para>If you have duplicate authority records you can merge them together by clicking the
31977           'Merge' link next to two results on an authority search.  After clicking 'Merge' on the
31978           first result you will see that authority listed at the top of the results.</para>
31979         <screenshot>
31980             <screeninfo>Merging authorities results</screeninfo>
31981             <mediaobject>
31982               <imageobject>
31983                 <imagedata fileref="images/cataloging/authmergesearch.png"/>
31984               </imageobject>
31985             </mediaobject>
31986           </screenshot>
31987         <para>You will be asked which of the two records you would like to keep as your primary
31988           record and which will be deleted after the merge.</para>
31989         <screenshot>
31990           <screeninfo>Merging authorities</screeninfo>
31991           <mediaobject>
31992             <imageobject>
31993               <imagedata fileref="images/cataloging/authmergechoice.png"/>
31994             </imageobject>
31995           </mediaobject>
31996         </screenshot>
31997         <para>You will be presented with the MARC for both of the records (each accessible by tabs
31998           labeled with the authority numbers for those records). By default the entire first record
31999           will be selected, uncheck the fields you don't want in the final (destination) record and
32000           then move on to the second tab to choose which fields should be in the final (destination)
32001           record.</para>
32002         <screenshot>
32003           <screeninfo>Authorities to merge</screeninfo>
32004           <mediaobject>
32005             <imageobject>
32006               <imagedata fileref="images/cataloging/authmerging.png"/>
32007             </imageobject>
32008           </mediaobject>
32009         </screenshot>
32010         <para>Once you have completed your selections click the 'Merge' button. The primary record
32011           will now contain the data you chose for it and the second record will be deleted.</para>
32012         <screenshot>
32013           <screeninfo>Merged authority</screeninfo>
32014           <mediaobject>
32015             <imageobject>
32016               <imagedata fileref="images/cataloging/authmerged.png"/>
32017             </imageobject>
32018           </mediaobject>
32019         </screenshot>
32020       </section>
32021     </section>
32022
32023     <section id="catguides">
32024       <title>Cataloging Guides</title>
32025
32026       <para/>
32027
32028       <section id="bibcatcheatsheet">
32029         <sectioninfo>
32030           <authorgroup>
32031             <author>
32032               <firstname>Jared</firstname>
32033               <surname>Camins-Esakov</surname>
32034               <affiliation>
32035                 <orgname>American Numismatic Society</orgname>
32036               </affiliation>
32037             </author>
32038
32039             <editor>
32040               <firstname>Nicole C.</firstname>
32041               <surname>Engard</surname>
32042               <contrib>Changed/edited content where necessary.</contrib>
32043             </editor>
32044           </authorgroup>
32045
32046           <pubdate>2010</pubdate>
32047         </sectioninfo>
32048         <title>Bibliographic Record Cataloging Cheat Sheet</title>
32049
32050         <table cellpadding="4" cellspacing="4" frame="all">
32051           <title>Cataloging Guide</title>
32052
32053           <tgroup align="left" cols="4" colsep="1" rowsep="1">
32054             <thead>
32055               <row>
32056                 <entry><para>Tag</para></entry>
32057
32058                 <entry><para>Label</para></entry>
32059
32060                 <entry><para>Description</para></entry>
32061
32062                 <entry><para>Instructions</para></entry>
32063               </row>
32064             </thead>
32065
32066             <tbody>
32067               <row>
32068                 <entry><para>000</para></entry>
32069
32070                 <entry><para>LEADER</para></entry>
32071
32072                 <entry><para>Describes the record(i.e. surrogate) -- is it a
32073                 record for a monograph? A serial?</para></entry>
32074
32075                 <entry><para>Click in this field to fill it in. Then set
32076                 "Bibliographic level" to 'a' for articles or 's' for serials.
32077                 Otherwise, leave everything as is.</para></entry>
32078               </row>
32079
32080               <row>
32081                 <entry><para>001</para></entry>
32082
32083                 <entry><para>CONTROL NUMBER</para></entry>
32084
32085                 <entry><para>Accession number.</para></entry>
32086
32087                 <entry><para>Enter the accession number written inside the
32088                 item here. For articles and items which do not have accession
32089                 numbers, leave blank.</para></entry>
32090               </row>
32091
32092               <row>
32093                 <entry><para>003</para></entry>
32094
32095                 <entry><para>CONTROL NUMBER IDENTIFIER</para></entry>
32096
32097                 <entry><para>Your MARC Organizational Code</para></entry>
32098
32099                 <entry><para>Click in this field to fill it in (will auto fill
32100                 if you have your <link linkend="MARCOrgCode">MARCOrgCode</link> preference
32101                 set).</para></entry>
32102               </row>
32103
32104               <row>
32105                 <entry><para>005</para></entry>
32106
32107                 <entry><para>D &amp; T LATEST TRANSACTION</para></entry>
32108
32109                 <entry><para>Current date and time.</para></entry>
32110
32111                 <entry><para>Click in this field to fill it in.</para></entry>
32112               </row>
32113
32114               <row>
32115                 <entry><para>008</para></entry>
32116
32117                 <entry><para>FIXED-LENGTH DATA ELEMENTS</para></entry>
32118
32119                 <entry><para>Field containing computer-readable
32120                 representations of a number of things.</para></entry>
32121
32122                 <entry><para>Generally you will only use 's' (single) or 'm'
32123                 (multiple) options for position 06- use the former when the
32124                 item was published in a single year, the latter when it was
32125                 published over the course of several. If there is a single
32126                 date, only enter a date in the first date field (positions
32127                 07-10). Enter the three-digit country code in positions 15-17,
32128                 being sure to add spaces if the country code is fewer than
32129                 three characters long. If there is an index, note that fact in
32130                 position 31. Enter the three-letter language code in positions
32131                 35-37.</para></entry>
32132               </row>
32133
32134               <row>
32135                 <entry><para>010</para></entry>
32136
32137                 <entry><para>LCCN</para></entry>
32138
32139                 <entry><para>A number assigned by the Library of Congress to
32140                 uniquely identify the work.</para></entry>
32141
32142                 <entry><para>Check on the copyright page of the book (if it
32143                 was published in the US) or the LC catalog for this number. If
32144                 you can't find it, don't worry about it.</para></entry>
32145               </row>
32146
32147               <row>
32148                 <entry><para>020</para></entry>
32149
32150                 <entry><para>ISBN</para></entry>
32151
32152                 <entry><para>Unique number used by publishers to identify
32153                 books.</para></entry>
32154
32155                 <entry><para>If this number isn't listed on the book, there
32156                 probably isn't one.</para></entry>
32157               </row>
32158
32159               <row>
32160                 <entry><para>022</para></entry>
32161
32162                 <entry><para>ISSN</para></entry>
32163
32164                 <entry><para>Unique number used by publishers to identify
32165                 serials.</para></entry>
32166
32167                 <entry><para>If this number isn't listed on the book, there
32168                 probably isn't one.</para></entry>
32169               </row>
32170
32171               <row>
32172                 <entry><para>033</para></entry>
32173
32174                 <entry><para>DATE/TIME OF EVENT</para></entry>
32175
32176                 <entry><para>Used for auction dates. Required for auction
32177                 catalogs.</para></entry>
32178
32179                 <entry><para>For auctions that took place on only one day,
32180                 enter the date of the auction in the format YYYYMMDD in the
32181                 subfield 'a' and a '0' in the first indicator. For auctions
32182                 that took place over two consecutive days or any number of
32183                 non-consecutive days, create a subfield 'a' for each day with
32184                 the date in the format YYYYMMDD, and put a '1' in the first
32185                 indicator. For auctions that took place over more than two
32186                 consecutive days, create a subfield 'a' (in format YYYYMMDD)
32187                 for the first day and a subfield 'a' (also in format YYYYMMDD)
32188                 for the last day, and put a '2' in the first
32189                 indicator.</para></entry>
32190               </row>
32191
32192               <row>
32193                 <entry><para>040</para></entry>
32194
32195                 <entry><para>CATALOGING SOURCE</para></entry>
32196
32197                 <entry><para>Identifies which libraries created and modified
32198                 the record.</para></entry>
32199
32200                 <entry><para>For imported records, add a subfield 'd' with
32201                 your OCLC code as the value. For new records, make sure that
32202                 the subfield 'c' with your OCLC code as the
32203                 value.</para></entry>
32204               </row>
32205
32206               <row>
32207                 <entry><para>041</para></entry>
32208
32209                 <entry><para>LANGUAGE CODE</para></entry>
32210
32211                 <entry><para>Identifies all the languages used in an item,
32212                 when two or more languages are present.</para></entry>
32213
32214                 <entry><para>For significant portions of a text in a given
32215                 language, there should be a subfield 'a' with that language
32216                 code. If there are only summaries or abstracts in a specific
32217                 language, create a subfield 'b' with that language
32218                 code.</para></entry>
32219               </row>
32220
32221               <row>
32222                 <entry><para>100</para></entry>
32223
32224                 <entry><para>MAIN ENTRY--PERSONAL</para></entry>
32225
32226                 <entry><para>Authorized form of the main author's
32227                 name</para></entry>
32228
32229                 <entry><para>See Authorized headings sheet and AACR2. The
32230                 first indicator should generally be a '1', to indicate that
32231                 the entry is surname first. If the name consists only of a
32232                 forename, however, the first indicator should be
32233                 '0'.</para></entry>
32234               </row>
32235
32236               <row>
32237                 <entry><para>110</para></entry>
32238
32239                 <entry><para>MAIN ENTRY--CORPORATE</para></entry>
32240
32241                 <entry><para>Authorized form of the name of the main corporate
32242                 author. Required for auction catalogs.</para></entry>
32243
32244                 <entry><para>Auction catalogs should use a 110 field rather
32245                 than a 100 field. See Authorized headings sheet and AACR2. Set
32246                 the first indicator to '2'.</para></entry>
32247               </row>
32248
32249               <row>
32250                 <entry><para>111</para></entry>
32251
32252                 <entry><para>MAIN ENTRY--MEETING</para></entry>
32253
32254                 <entry><para>Authorized form of the name of a meeting which
32255                 acted as a main offer (e.g. conference
32256                 proceedings)</para></entry>
32257
32258                 <entry><para>See Authorized headings sheet and AACR2. Set the
32259                 first indicator to '2'.</para></entry>
32260               </row>
32261
32262               <row>
32263                 <entry><para>245</para></entry>
32264
32265                 <entry><para>TITLE STATEMENT</para></entry>
32266
32267                 <entry><para>Transcription of the title statement from the
32268                 title page (or chief source of information)</para></entry>
32269
32270                 <entry><para>Enter the title in subfield 'a', the subtitle in
32271                 subfield 'b', and the statement of responsibility in subfield
32272                 'c'. If you are creating a record for a single volume or part
32273                 of a multi-part item, you should put the part number in
32274                 subfield 'n' and the part title in subfield 'p.' For auction
32275                 catalogs, the date (in 'MM/DD/YYYY' format) should be listed
32276                 in square brackets in subfield 'f'. See ISBD punctuation
32277                 sheet. Set the first indicator to '0' if there is no author,
32278                 otherwise set it to '1'. Set the second indicator to the
32279                 number of non-filing characters (i.e. characters in an initial
32280                 articles plus the space... for "The " set the second indicator
32281                 to '4').</para></entry>
32282               </row>
32283
32284               <row>
32285                 <entry><para>246</para></entry>
32286
32287                 <entry><para>VARYING FORM OF TITLE</para></entry>
32288
32289                 <entry><para>Alternate form of title for searching and filing
32290                 purposes</para></entry>
32291
32292                 <entry><para>If the patron might look for the work under a
32293                 different title, enter it here. Do not include initial
32294                 articles. The first indicator should be '3', unless the title
32295                 is merely a variant spelling, in which case the first
32296                 indicator should be '1'.</para></entry>
32297               </row>
32298
32299               <row>
32300                 <entry><para>250</para></entry>
32301
32302                 <entry><para>EDITION STATEMENT</para></entry>
32303
32304                 <entry><para>Transcription of the edition statement from the
32305                 title page (or chief source of information)</para></entry>
32306
32307                 <entry><para>Transcribe the edition statement exactly as it
32308                 appears on the title-page. You may abbreviate if the edition
32309                 statement is very long.</para></entry>
32310               </row>
32311
32312               <row>
32313                 <entry><para>260</para></entry>
32314
32315                 <entry><para>PUBLICATION (IMPRINT)</para></entry>
32316
32317                 <entry><para>Publication information.</para></entry>
32318
32319                 <entry><para>Put the location of publication in subfield 'a',
32320                 the publisher in subfield 'b', and the year (or probable year)
32321                 in subfield 'c'. See ISBD punctuation sheet.</para></entry>
32322               </row>
32323
32324               <row>
32325                 <entry><para>300</para></entry>
32326
32327                 <entry><para>PHYSICAL DESCRIPTION</para></entry>
32328
32329                 <entry><para>Physical description</para></entry>
32330
32331                 <entry><para>Enter the pagination statement in subfield 'a', a
32332                 brief description of "special" contents such as illustrations
32333                 or maps in subfield 'b' (see AACR2), and the size of the item
32334                 in subfield 'c'. See ISBD punctuation sheet.</para></entry>
32335               </row>
32336
32337               <row>
32338                 <entry><para>490</para></entry>
32339
32340                 <entry><para>SERIES STATEMENT</para></entry>
32341
32342                 <entry><para>Shows the series statement exactly as it appears
32343                 on the item.</para></entry>
32344
32345                 <entry><para>Transcribe the series statement into subfield 'a'
32346                 with the volume number in subfield 'v'. See ISBD punctuation
32347                 sheet. Set the first indicator to '1' if you are using an 830.
32348                 As a general rule, you should do so.</para></entry>
32349               </row>
32350
32351               <row>
32352                 <entry><para>500</para></entry>
32353
32354                 <entry><para>GENERAL NOTE</para></entry>
32355
32356                 <entry><para>Notes that don't fit anywhere
32357                 else.</para></entry>
32358
32359                 <entry><para>Enter notes as full sentences, with a separate
32360                 500 field for each distinct topic.</para></entry>
32361               </row>
32362
32363               <row>
32364                 <entry><para>501</para></entry>
32365
32366                 <entry><para>WITH NOTE</para></entry>
32367
32368                 <entry><para>Notes whether the work is bound with the works
32369                 described by other records.</para></entry>
32370
32371                 <entry><para>Put description of relationship in subfield
32372                 'a'.</para></entry>
32373               </row>
32374
32375               <row>
32376                 <entry><para>504</para></entry>
32377
32378                 <entry><para>BIBLIOGRAPHY, ETC. NOTE</para></entry>
32379
32380                 <entry><para>Indicates whether the work includes a
32381                 bibliography.</para></entry>
32382
32383                 <entry><para>If the work includes a bibliography and index,
32384                 put the text "Includes bibliographical references (p. XXX-XXX)
32385                 and index." in subfield 'a'. If the work does not include an
32386                 index, remove that part of the sentence. If the references are
32387                 scattered throughout the work and not gathered into a distinct
32388                 sentence, remove the parenthetical statement.</para></entry>
32389               </row>
32390
32391               <row>
32392                 <entry><para>505</para></entry>
32393
32394                 <entry><para>FORMATTED CONTENTS</para></entry>
32395
32396                 <entry><para>List of contents in a standard format.
32397                 Unformatted contents can be listed in a 500 (General Note)
32398                 field.</para></entry>
32399
32400                 <entry><para>See ISBD punctuation sheet. Set the first
32401                 indicator to '0'. If you are separately coding authors and
32402                 titles, set the second indicator to '0'. Otherwise, leave the
32403                 second indicator blank.</para></entry>
32404               </row>
32405
32406               <row>
32407                 <entry><para>518</para></entry>
32408
32409                 <entry><para>DATE/TIME OF EVENT NOTE</para></entry>
32410
32411                 <entry><para>Used for auction dates.</para></entry>
32412
32413                 <entry><para>For auction catalogs, enter the date of the
32414                 auction in the format 'January 2, 1984' in the subfield
32415                 'a'</para></entry>
32416               </row>
32417
32418               <row>
32419                 <entry><para>520</para></entry>
32420
32421                 <entry><para>SUMMARY, ETC.</para></entry>
32422
32423                 <entry><para>A brief summary or abstract of the book or
32424                 article.</para></entry>
32425
32426                 <entry><para>In general you do not need to write a summary. A
32427                 summary might be called for, however, with items that cannot
32428                 be easily reviewed by a patron, such as books with highly
32429                 acidic paper or CD-ROMs.</para></entry>
32430               </row>
32431
32432               <row>
32433                 <entry><para>546</para></entry>
32434
32435                 <entry><para>LANGUAGE NOTE</para></entry>
32436
32437                 <entry><para>Note describing the languages used in the
32438                 work</para></entry>
32439
32440                 <entry><para>Only needed for works in multiple languages. See
32441                 ISBD punctuation sheet.</para></entry>
32442               </row>
32443
32444               <row>
32445                 <entry><para>561</para></entry>
32446
32447                 <entry><para>PROVENANCE INFORMATION</para></entry>
32448
32449                 <entry><para>Describes the previous ownership of the
32450                 item.</para></entry>
32451
32452                 <entry><para>Used only for rare books.</para></entry>
32453               </row>
32454
32455               <row>
32456                 <entry><para>563</para></entry>
32457
32458                 <entry><para>BINDING INFORMATION</para></entry>
32459
32460                 <entry><para>Describes the binding of the item.</para></entry>
32461
32462                 <entry><para>Used only for rare books.</para></entry>
32463               </row>
32464
32465               <row>
32466                 <entry><para>590</para></entry>
32467
32468                 <entry><para>LOCAL NOTE</para></entry>
32469
32470                 <entry><para>Local notes. Required for auction
32471                 catalogs.</para></entry>
32472
32473                 <entry><para>Used for auction catalogs to indicate what types
32474                 of coins are sold in the auction- Roman, Greek,
32475                 etc.</para></entry>
32476               </row>
32477
32478               <row>
32479                 <entry><para>600</para></entry>
32480
32481                 <entry><para>SUBJECT ADDED--PERSONAL</para></entry>
32482
32483                 <entry><para>Authorized form of personal names for people
32484                 discussed in the work</para></entry>
32485
32486                 <entry><para>See Authorized headings sheet and AACR2. The
32487                 first indicator should generally be a '1', to indicate that
32488                 the entry is surname first. If the name consists only of a
32489                 forename, however, the first indicator should be '0'. If you
32490                 found the name in the LC authority file, set the second
32491                 indicator to '0'. Otherwise set the second indicator to
32492                 '4'.</para></entry>
32493               </row>
32494
32495               <row>
32496                 <entry><para>610</para></entry>
32497
32498                 <entry><para>SUBJECT ADDED--CORPORATE</para></entry>
32499
32500                 <entry><para>Authorized form of corporate names for
32501                 organizations discussed in the work</para></entry>
32502
32503                 <entry><para>See Authorized headings sheet and AACR2. Set the
32504                 first indicator to '2'. If you found the name in the LC
32505                 authority file, set the second indicator to '0'. Otherwise set
32506                 the second indicator to '4'.</para></entry>
32507               </row>
32508
32509               <row>
32510                 <entry><para>611</para></entry>
32511
32512                 <entry><para>SUBJECT ADDED--MEETING</para></entry>
32513
32514                 <entry><para>Authorized form of meeting names for meetings
32515                 discussed in the work</para></entry>
32516
32517                 <entry><para>See Authorized headings sheet and AACR2. Set the
32518                 first indicator to '2'. If you found the name in the LC
32519                 authority file, set the second indicator to '0'. Otherwise set
32520                 the second indicator to '4'.</para></entry>
32521               </row>
32522
32523               <row>
32524                 <entry><para>630</para></entry>
32525
32526                 <entry><para>SUBJECT ADDED--UNIFORM TITLE</para></entry>
32527
32528                 <entry><para>Authorized form of titles for other works
32529                 discussed in the work</para></entry>
32530
32531                 <entry><para>See Authorized headings sheet and AACR2. Set the
32532                 first indicator to the number of non-filing characters (i.e.
32533                 characters in an initial articles plus the space... for "The "
32534                 set the first indicator to '4'). If you found the name in the
32535                 LC authority file, set the second indicator to '0'. Otherwise
32536                 set the second indicator to '4'.</para></entry>
32537               </row>
32538
32539               <row>
32540                 <entry><para>650</para></entry>
32541
32542                 <entry><para>SUBJECT ADDED--TOPICAL</para></entry>
32543
32544                 <entry><para>Library of Congress Subject Heading terms
32545                 describing the subject of the work</para></entry>
32546
32547                 <entry><para>See Authorized headings sheet and AACR2. If you
32548                 found the name in the LC authority file, set the second
32549                 indicator to '0'. Otherwise set the second indicator to
32550                 '4'.</para></entry>
32551               </row>
32552
32553               <row>
32554                 <entry><para>651</para></entry>
32555
32556                 <entry><para>SUBJECT ADDED--GEOGRAPHICAL</para></entry>
32557
32558                 <entry><para>Library of Congress Subject Heading geographical
32559                 terms describing the subject of the work</para></entry>
32560
32561                 <entry><para>See Authorized headings sheet and AACR2. If you
32562                 found the name in the LC authority file, set the second
32563                 indicator to '0'. Otherwise set the second indicator to
32564                 '4'.</para></entry>
32565               </row>
32566
32567               <row>
32568                 <entry><para>655</para></entry>
32569
32570                 <entry><para>INDEX TERM--GENRE/FORM</para></entry>
32571
32572                 <entry><para>Describes what an item is as opposed to what the
32573                 item is about.</para></entry>
32574
32575                 <entry><para>Generally used only for auction catalogs, which
32576                 should have the genre heading "Auction catalogs." (make sure
32577                 to find the authorized heading!) If you found the name in the
32578                 LC authority file, set the second indicator to '0'. If you are
32579                 using a term from a specific thesaurus, set the second
32580                 indicator to '7' and put the code for the thesaurus in
32581                 subfield '2'. Otherwise set the second indicator to
32582                 '4'.</para></entry>
32583               </row>
32584
32585               <row>
32586                 <entry><para>690</para></entry>
32587
32588                 <entry><para>LOCAL SUBJECT ADDED--TOPICAL</para></entry>
32589
32590                 <entry><para>Used for headings from any custom subject
32591                 authority file.</para></entry>
32592
32593                 <entry><para>If there is no appropriate LCSH term, you can use
32594                 a 690 with subject headings you find on other items in the
32595                 catalog.</para></entry>
32596               </row>
32597
32598               <row>
32599                 <entry><para>691</para></entry>
32600
32601                 <entry><para>LOCAL SUBJECT ADDED--GEOGRAPHICAL</para></entry>
32602
32603                 <entry><para>Used for headings from any custom subject
32604                 authority file.</para></entry>
32605
32606                 <entry><para>If there is no appropriate LCSH term, you can use
32607                 a 691 with subject headings you find on other items in the
32608                 catalog.</para></entry>
32609               </row>
32610
32611               <row>
32612                 <entry><para>700</para></entry>
32613
32614                 <entry><para>ADDED ENTRY--PERSONAL</para></entry>
32615
32616                 <entry><para>Used for second authors and other persons related
32617                 to the production of the work.</para></entry>
32618
32619                 <entry><para>See Authorized headings sheet and AACR2. The
32620                 first indicator should generally be a '1', to indicate that
32621                 the entry is surname first. If the name consists only of a
32622                 forename, however, the first indicator should be
32623                 '0'.</para></entry>
32624               </row>
32625
32626               <row>
32627                 <entry><para>710</para></entry>
32628
32629                 <entry><para>ADDED ENTRY--CORPORATE</para></entry>
32630
32631                 <entry><para>Used for corporate bodies related to the
32632                 production of the work (e.g. publishers).</para></entry>
32633
32634                 <entry><para>See Authorized headings sheet and AACR2. Set the
32635                 first indicator to '2'.</para></entry>
32636               </row>
32637
32638               <row>
32639                 <entry><para>711</para></entry>
32640
32641                 <entry><para>ADDED ENTRY--MEETING</para></entry>
32642
32643                 <entry><para>Used for meetings related to the production of
32644                 the work (e.g. symposia that contributed to the
32645                 work).</para></entry>
32646
32647                 <entry><para>See Authorized headings sheet and AACR2. Set the
32648                 first indicator to '2'.</para></entry>
32649               </row>
32650
32651               <row>
32652                 <entry><para>730</para></entry>
32653
32654                 <entry><para>ADDED ENTRY--UNIFORM TITLE</para></entry>
32655
32656                 <entry><para>Used for uniform titles related to the production
32657                 of the work (e.g. a work that inspired the present
32658                 work)</para></entry>
32659
32660                 <entry><para>See Authorized headings sheet and AACR2. Set the
32661                 first indicator to the number of non-filing characters (i.e.
32662                 characters in an initial articles plus the space... for "The "
32663                 set the first indicator to '4').</para></entry>
32664               </row>
32665
32666               <row>
32667                 <entry><para>773</para></entry>
32668
32669                 <entry><para>HOST ITEM ENTRY</para></entry>
32670
32671                 <entry><para>Describes the larger bibliographic unit that
32672                 contains the work (e.g. book or journal containing the article
32673                 being described in the current record)</para></entry>
32674
32675                 <entry><para>If the host publication is author main entry,
32676                 enter the authorized form of the author's name in subfield
32677                 'a'. Put the title in subfield 't'. If the host publication is
32678                 an independent work, put publication information in subfield
32679                 'd'. When available, ISSN and ISBN should always be used in,
32680                 in subfields 'x' and 'z' respectively. Relationship
32681                 information (e.g. volume number, page number, etc.) goes in
32682                 subfield 'g'. Subfield 'q' contains an encoded representation
32683                 of the location of the item: volume, issue, and section
32684                 numbers are separated by colons, and the first page is entered
32685                 following a '&lt;' at the end of the subfield. See ISBD
32686                 punctuation sheet. Set the first indicator to '0'. If you want
32687                 the label "In:" to be generated, leave the second indicator
32688                 blank. If you want something else displayed before the 773
32689                 text, set the second indicator to '8' and add a subfield 'i'
32690                 with the label you want at the beginning of the field (e.g.
32691                 "$iOffprint from:").</para></entry>
32692               </row>
32693
32694               <row>
32695                 <entry><para>830</para></entry>
32696
32697                 <entry><para>SERIES ENTRY--UNIFORM TITLE</para></entry>
32698
32699                 <entry><para>Authorized form of the series name transcribed in
32700                 the 490 field. Often this will just be the same as the
32701                 490.</para></entry>
32702
32703                 <entry><para>See Authorized headings sheet and AACR2. Set the
32704                 second indicator to the number of non-filing characters (i.e.
32705                 characters in an initial articles plus the space... for "The "
32706                 set the second indicator to '4').</para></entry>
32707               </row>
32708
32709               <row>
32710                 <entry><para>852</para></entry>
32711
32712                 <entry><para>LOCATION/CALL NUMBER</para></entry>
32713
32714                 <entry><para>Provides the section name for pre-barcode books,
32715                 pamphlets, and some articles and serials.</para></entry>
32716
32717                 <entry><para>Do not put anything in this field if you are
32718                 cataloging a volume which gets only one record and a barcode.
32719                 If the item does not get a barcode, or you are currently
32720                 creating a record for an article in a volume, put the section
32721                 in subfield 'a' (see ANS cataloging documentation), and the
32722                 call number in subfield 'i'. Set the first indicator to
32723                 '8'.</para></entry>
32724               </row>
32725
32726               <row>
32727                 <entry><para>856</para></entry>
32728
32729                 <entry><para>ELECTRONIC ACCESS</para></entry>
32730
32731                 <entry><para>Links to material available
32732                 online.</para></entry>
32733
32734                 <entry><para>Put the URL of any electronic copies or
32735                 summaries, etc. in subfield 'u' and a link title in subfield
32736                 'y'. Set the first indicator to '4'.</para></entry>
32737               </row>
32738
32739               <row>
32740                 <entry><para>942</para></entry>
32741
32742                 <entry><para>ADDED ENTRY ELEMENTS (KOHA)</para></entry>
32743
32744                 <entry><para>Used for Koha-specific data.</para></entry>
32745
32746                 <entry><para>Set the subfield 'c' to the appropriate item
32747                 type.</para></entry>
32748               </row>
32749             </tbody>
32750           </tgroup>
32751         </table>
32752       </section>
32753
32754       <section id="itemcatguide">
32755         <title>Item/Holdings Record Cataloging Guide</title>
32756
32757         <para>This table represents the default embedded holdings data in Koha. This information can
32758           be used for migration or importing data purposes</para>
32759
32760         <table cellpadding="4" cellspacing="4" frame="all">
32761           <title>Koha Embedded Holdings Data</title>
32762
32763           <tgroup align="left" cols="4" colsep="1" rowsep="1">
32764             <colspec colname="tag" colnum="1"/>
32765
32766             <colspec colname="data" colnum="2"/>
32767
32768             <colspec colname="desc" colnum="3"/>
32769
32770             <colspec colname="note" colnum="4"/>
32771
32772             <thead>
32773               <row>
32774                 <entry><para>MARC21 Tag/subfield</para></entry>
32775
32776                 <entry><para>Data Element</para></entry>
32777
32778                 <entry><para>Description</para></entry>
32779
32780                 <entry><para>Notes</para></entry>
32781               </row>
32782             </thead>
32783
32784             <tbody>
32785               <row>
32786                 <entry><para>952$0</para></entry>
32787
32788                 <entry><para>Withdrawn status</para></entry>
32789
32790                 <entry><para>Default values: </para> <itemizedlist>
32791                     <listitem>
32792                       <para>0 = Not withdrawn</para>
32793                     </listitem>
32794
32795                     <listitem>
32796                       <para>1 = Withdrawn</para>
32797                     </listitem>
32798                   </itemizedlist></entry>
32799
32800                 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
32801                 ('WITHDRAWN' in default installation)</para></entry>
32802               </row>
32803
32804               <row>
32805                 <entry><para>952$1</para></entry>
32806
32807                 <entry><para>Lost status</para></entry>
32808
32809                 <entry><para>Default values:</para> <itemizedlist>
32810                     <listitem>
32811                       <para>0 = Available</para>
32812                     </listitem>
32813
32814                     <listitem>
32815                       <para>1 = Lost</para>
32816                     </listitem>
32817
32818                     <listitem>
32819                       <para>2 = Long Overdue (Lost)</para>
32820                     </listitem>
32821
32822                     <listitem>
32823                       <para>3 = Lost and Paid For</para>
32824                     </listitem>
32825
32826                     <listitem>
32827                       <para>4 = Missing in Inventory</para>
32828                     </listitem>
32829
32830                     <listitem>
32831                       <para>5 = Missing in Hold Queue</para>
32832                     </listitem>
32833                   </itemizedlist></entry>
32834
32835                 <entry><para>It's possible to configure OPAC so that lost
32836                 items don't display with the <link linkend="hidelostitems">hidelostitems</link> system
32837                 preference. </para> <para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
32838                 ('LOST' in default installation)</para></entry>
32839               </row>
32840
32841               <row>
32842                 <entry><para>952$2</para></entry>
32843
32844                 <entry><para>Classification</para></entry>
32845
32846                 <entry><para>Classification scheme that defines filing rules
32847                 used for sorting call numbers.</para></entry>
32848
32849                 <entry><para>A choice of <link linkend="classificationsources">classification sources</link>
32850                 as they are defined in administration. If no classification
32851                 scheme is entered, the system will use the value entered in
32852                 the <link linkend="DefaultClassificationSource">DefaultClassificationSource</link>
32853                 preference.</para></entry>
32854               </row>
32855
32856               <row>
32857                 <entry><para>952$3</para></entry>
32858
32859                 <entry><para>Materials specified</para></entry>
32860
32861                 <entry><para>Specific issues of serials or multi-part
32862                 items.</para></entry>
32863
32864                 <entry><para>Displayed when items are checked out and in to
32865                 tell the staff how many pieces the item has. Copy/volume data
32866                 is stored in 952$h and $t for display in Normal
32867                 views.</para></entry>
32868               </row>
32869
32870               <row>
32871                 <entry><para>952$4</para></entry>
32872
32873                 <entry><para>Damaged status</para></entry>
32874
32875                 <entry><para>Default values: </para> <itemizedlist>
32876                     <listitem>
32877                       <para>0 = Not damaged</para>
32878                     </listitem>
32879
32880                     <listitem>
32881                       <para>1 = Damaged</para>
32882                     </listitem>
32883                   </itemizedlist></entry>
32884
32885                 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
32886                 ('DAMAGE' in default installation)</para></entry>
32887               </row>
32888
32889               <row>
32890                 <entry><para>952$5</para></entry>
32891
32892                 <entry><para>Use restrictions</para></entry>
32893
32894                 <entry><para>Default values:</para> <itemizedlist>
32895                     <listitem>
32896                       <para>0 = No use restrictions</para>
32897                     </listitem>
32898
32899                     <listitem>
32900                       <para>1 = Restricted Access</para>
32901                     </listitem>
32902                   </itemizedlist></entry>
32903
32904                 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
32905                 ('RESTRICT' in default installation). This value has no effect
32906                 on circulation.</para></entry>
32907               </row>
32908
32909               <row>
32910                 <entry><para>952$7</para></entry>
32911
32912                 <entry><para>Not for loan</para></entry>
32913
32914                 <entry><para>Default values:</para> <itemizedlist>
32915                     <listitem>
32916                       <para>-1 = Ordered</para>
32917                     </listitem>
32918
32919                     <listitem>
32920                       <para>0 = Available for loans</para>
32921                     </listitem>
32922
32923                     <listitem>
32924                       <para>1 = Not for Loan</para>
32925                     </listitem>
32926
32927                     <listitem>
32928                       <para>2 = Staff Collection</para>
32929                     </listitem>
32930                   </itemizedlist></entry>
32931
32932                 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
32933                 ('NOT_LOAN' in default installation). Negative number values
32934                 can still be placed on hold.</para></entry>
32935               </row>
32936
32937               <row>
32938                 <entry><para>952$8</para></entry>
32939
32940                 <entry><para>Collection code</para></entry>
32941
32942                 <entry><para>Coded value</para></entry>
32943
32944                 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
32945                 ('CCODE' in default installation)</para></entry>
32946               </row>
32947
32948               <row>
32949                 <entry><para>952$9</para></entry>
32950
32951                 <entry><para>Item number</para></entry>
32952
32953                 <entry><para>System-generated item number.</para></entry>
32954
32955                 <entry><para>Does not display in the item
32956                 record.</para></entry>
32957               </row>
32958
32959               <row>
32960                 <entry><para>952$a</para></entry>
32961
32962                 <entry><para>Owning Library **</para></entry>
32963
32964                 <entry><para>Branch code</para></entry>
32965
32966                 <entry><para><emphasis role="bold">Required</emphasis>. Code
32967                 must be defined in <link linkend="libsgroups">Libraries,
32968                 Branches and Groups</link></para></entry>
32969               </row>
32970
32971               <row>
32972                 <entry><para>952$b</para></entry>
32973
32974                 <entry><para>Holding library ** (usually the same as 952$a
32975                 )</para></entry>
32976
32977                 <entry><para>Branch code</para></entry>
32978
32979                 <entry><para><emphasis role="bold">Required</emphasis>. Code
32980                 must be defined in <link linkend="libsgroups">Libraries,
32981                 Branches and Groups</link></para></entry>
32982               </row>
32983
32984               <row>
32985                 <entry><para>952$c</para></entry>
32986
32987                 <entry><para>Shelving location code</para></entry>
32988
32989                 <entry><para/></entry>
32990
32991                 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
32992                 ('LOC' in default installation)</para></entry>
32993               </row>
32994
32995               <row>
32996                 <entry><para>952$d</para></entry>
32997
32998                 <entry><para>Date acquired</para></entry>
32999
33000                 <entry><para>YYYY-MM-DD</para></entry>
33001
33002                 <entry><para>Date formats in the 952 subfields are required to
33003                 be in the system internal format for data loading and
33004                 subsequent item editing: YYYY-MM-DD</para></entry>
33005               </row>
33006
33007               <row>
33008                 <entry><para>952$e</para></entry>
33009
33010                 <entry><para>Source of acquisition</para></entry>
33011
33012                 <entry><para>Coded value or vendor string</para></entry>
33013
33014                 <entry><para>Filled in automatically with the Koha assigned
33015                 vendor id by Acquisitions when an item is
33016                 received.</para></entry>
33017               </row>
33018
33019               <row>
33020                 <entry><para>952$g</para></entry>
33021
33022                 <entry><para>Purchase price</para></entry>
33023
33024                 <entry><para>Decimal number, no currency symbol (ex.
33025                 10.00)</para></entry>
33026
33027                 <entry><para>Filled in automatically by Acquisitions when an
33028                 item is received.</para></entry>
33029               </row>
33030
33031               <row>
33032                 <entry><para>952$h</para></entry>
33033
33034                 <entry><para>Serial enumeration</para></entry>
33035
33036                 <entry><para/></entry>
33037
33038                 <entry><para>Filled in automatically by Serials if the issue
33039                 is received there.</para></entry>
33040               </row>
33041
33042               <row>
33043                 <entry><para>952$o</para></entry>
33044
33045                 <entry><para>Koha full call number</para></entry>
33046
33047                 <entry><para/></entry>
33048
33049                 <entry><para>Can be filled in automatically based on the <link linkend="itemcallnumber">itemcallnumber</link> system
33050                 preference.</para></entry>
33051               </row>
33052
33053               <row>
33054                 <entry><para>952$p</para></entry>
33055
33056                 <entry><para>Barcode *</para></entry>
33057
33058                 <entry><para>Max 20 characters</para></entry>
33059
33060                 <entry><para/></entry>
33061               </row>
33062
33063               <row>
33064                 <entry><para>952$t</para></entry>
33065
33066                 <entry><para>Copy number</para></entry>
33067
33068                 <entry><para>Max 32 characters</para></entry>
33069
33070                 <entry><para/></entry>
33071               </row>
33072               <row>
33073                 <entry>
33074                   <para>952$u</para>
33075                 </entry>
33076                 <entry>
33077                   <para>Uniform Resource Identifier </para>
33078                 </entry>
33079                 <entry>
33080                   <para>Item specific URL</para>
33081                 </entry>
33082                 <entry>
33083                   <para>Full URL starting with http:// Only needed if your item has its own URL, not
33084                     necessary if the bib record has a 856$u that applies to all items on the record.
33085                   </para>
33086                 </entry>
33087               </row>
33088               <row>
33089                 <entry>
33090                   <para>952$v</para>
33091                 </entry>
33092                 <entry>
33093                   <para>Replacement price</para>
33094                 </entry>
33095                 <entry>
33096                   <para>Decimal number, no currency symbol (ex. 10.00)</para>
33097                 </entry>
33098                 <entry>
33099                   <para>Filled in automatically by Acquisitions when an item is received.</para>
33100                 </entry>
33101               </row>
33102
33103               <row>
33104                 <entry><para>952$w</para></entry>
33105
33106                 <entry><para>Price effective from</para></entry>
33107
33108                 <entry><para>YYYY-MM-DD</para></entry>
33109
33110                 <entry>Date formats in the 952 subfields are required to be in
33111                 the system internal format for data loading and subsequent
33112                 item editing: YYYY-MM-DD. Filled in automatically by
33113                 Acquisitions when an item is received.</entry>
33114               </row>
33115               <row>
33116                 <entry>
33117                   <para>952$x</para>
33118                 </entry>
33119                 <entry>
33120                   <para>Nonpublic note</para>
33121                 </entry>
33122                 <entry>
33123                   <para/>
33124                 </entry>
33125                 <entry>This is a note field for notes that will not appear in the OPAC. Right now
33126                   this note does not appear anywhere but in the item edit screen in the staff
33127                   client.</entry>
33128               </row>
33129
33130               <row>
33131                 <entry><para>952$y</para></entry>
33132
33133                 <entry><para>Koha item type **</para></entry>
33134
33135                 <entry><para>Coded value, required field for
33136                 circulation</para></entry>
33137
33138                 <entry><para><emphasis role="bold">Required</emphasis>. Coded
33139                 value, must be defined in <link linkend="itemtypeadmin">Item
33140                 types</link></para></entry>
33141               </row>
33142
33143               <row>
33144                 <entry><para>952$z</para></entry>
33145
33146                 <entry><para>Public note</para></entry>
33147
33148                 <entry><para/></entry>
33149
33150                 <entry><para/></entry>
33151               </row>
33152             </tbody>
33153           </tgroup>
33154         </table>
33155
33156         <para>* - required for circulation</para>
33157
33158         <para>** - required by Koha</para>
33159       </section>
33160
33161       <section id="onorderitemholds">
33162         <sectioninfo>
33163           <corpauthor>VOKAL</corpauthor>
33164
33165           <editor>
33166             <firstname>Nicole C.</firstname>
33167
33168             <surname>Engard</surname>
33169           </editor>
33170
33171           <pubdate>2010</pubdate>
33172
33173           <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>
33174         </sectioninfo>
33175
33176         <title>Handling On Order Items and Holds</title>
33177
33178         <para>If you tend to import your MARC records when you have ordered
33179         the book (as opposed to when you receive the books), and allow patrons
33180         to place holds on those books, you may need to add item records to the
33181         *.mrc file before importing.</para>
33182
33183         <para>The easiest way to import your latest order is to first run your records through
33184             <ulink url="http://marcedit.reeset.net/">MARCEdit</ulink>. Download your MARC records,
33185           saving them to your desktop or some other location you use/will remember. If you have
33186           MARCEdit already installed you should simply have to double click on your MARC records,
33187           and they will automatically open in MARCEdit.<important>
33188             <para>This tutorial was written with MARCEdit version 5.2.3769.41641 on Windows XP,
33189               instructions may be different if your version or operating system is different.</para>
33190           </important></para>
33191
33192         <itemizedlist>
33193           <listitem>
33194             <para>Your original file will automatically be in the input;
33195             ensure MarcBreaker is chosen, and then click "Execute"</para>
33196
33197             <screenshot>
33198               <screeninfo>MarcBreaker</screeninfo>
33199
33200               <mediaobject>
33201                 <imageobject>
33202                   <imagedata fileref="images/appendix-onorder/marcbreaker.png"/>
33203                 </imageobject>
33204               </mediaobject>
33205             </screenshot>
33206           </listitem>
33207
33208           <listitem>
33209             <para>You will be presented with a summary of the records
33210             processed at the bottom of the screen</para>
33211
33212             <screenshot>
33213               <screeninfo>MarcBreaker Summary</screeninfo>
33214
33215               <mediaobject>
33216                 <imageobject>
33217                   <imagedata fileref="images/appendix-onorder/marcbreaker-summary.png"/>
33218                 </imageobject>
33219               </mediaobject>
33220             </screenshot>
33221           </listitem>
33222
33223           <listitem>
33224             <para>Click 'Edit Records' to continue on to adding item
33225             records</para>
33226           </listitem>
33227
33228           <listitem>
33229             <para>Your screen will be replaced with a larger screen containing
33230             the MARC records</para>
33231
33232             <screenshot>
33233               <screeninfo>MARC file for editing</screeninfo>
33234
33235               <mediaobject>
33236                 <imageobject>
33237                   <imagedata fileref="images/appendix-onorder/editrecords.png"/>
33238                 </imageobject>
33239               </mediaobject>
33240             </screenshot>
33241           </listitem>
33242
33243           <listitem>
33244             <para>Click on Tools &gt; Add/Edit Field</para>
33245
33246             <screenshot>
33247               <screeninfo>Add/Delete Field</screeninfo>
33248
33249               <mediaobject>
33250                 <imageobject>
33251                   <imagedata fileref="images/appendix-onorder/addfield.png"/>
33252                 </imageobject>
33253               </mediaobject>
33254             </screenshot>
33255           </listitem>
33256
33257           <listitem>
33258             <para>Enter in the Koha specific item info</para>
33259
33260             <screenshot>
33261               <screeninfo>Add 942 Field</screeninfo>
33262
33263               <mediaobject>
33264                 <imageobject>
33265                   <imagedata fileref="images/appendix-onorder/add942.png"/>
33266                 </imageobject>
33267               </mediaobject>
33268             </screenshot>
33269
33270             <itemizedlist>
33271               <listitem>
33272                 <para>In the Field box, type 942</para>
33273               </listitem>
33274
33275               <listitem>
33276                 <para>In the Field Data box, type \\$c and the item type code
33277                 (\\$cBOOK in this example)</para>
33278               </listitem>
33279
33280               <listitem>
33281                 <para>Check the 'Insert last' option</para>
33282               </listitem>
33283
33284               <listitem>
33285                 <para>Click 'Add Field'</para>
33286               </listitem>
33287             </itemizedlist>
33288           </listitem>
33289
33290           <listitem>
33291             <para>Enter in the item record data</para>
33292
33293             <screenshot>
33294               <screeninfo>Add 952 Field</screeninfo>
33295
33296               <mediaobject>
33297                 <imageobject>
33298                   <imagedata fileref="images/appendix-onorder/add952.png"/>
33299                 </imageobject>
33300               </mediaobject>
33301             </screenshot>
33302
33303             <itemizedlist>
33304               <listitem>
33305                 <para>In the Field box, type 952</para>
33306               </listitem>
33307
33308               <listitem>
33309                 <para>In the Field Data box, type
33310                 $7ORDERED_STATUS$aPERM_LOC$bCURR_LOC$cSHELVING_LOCATION$eSOURCE_OF_ACQ$yITEM_TYPE</para>
33311
33312                 <itemizedlist>
33313                   <listitem>
33314                     <para>ex. $7-1$aCPL$bCPL$cNEW$eBrodart$yBOOK</para>
33315
33316                     <itemizedlist>
33317                       <listitem>
33318                         <para>In a default install of Koha -1 is the value for
33319                         the Ordered status</para>
33320                       </listitem>
33321                     </itemizedlist>
33322                   </listitem>
33323
33324                   <listitem>
33325                     <para>You may want to look at other subfields you would
33326                     like data in -- for example, changing the collection code
33327                     to put all the items in the same collection (8),
33328                     automatically fill in the acquisition date (d), or put in
33329                     a public note (z).</para>
33330                   </listitem>
33331
33332                   <listitem>
33333                     <para>Be sure you use the $ to separate subfields; adding
33334                     each subfield on a separate line will cause that many
33335                     items to be imported with your MARC record (in the example
33336                     above, four items, each with one of those subfields
33337                     corrected)</para>
33338                   </listitem>
33339
33340                   <listitem>
33341                     <para>Make sure you look at the Administration &gt;
33342                     Authorized Values in Koha to put the correct code into the
33343                     field</para>
33344                   </listitem>
33345                 </itemizedlist>
33346               </listitem>
33347
33348               <listitem>
33349                 <para>Check the 'Insert last' option</para>
33350               </listitem>
33351
33352               <listitem>
33353                 <para>Click 'Add Field'</para>
33354               </listitem>
33355             </itemizedlist>
33356           </listitem>
33357
33358           <listitem>
33359             <para>Close the field editor window</para>
33360           </listitem>
33361
33362           <listitem>
33363             <para>Click on File &gt; Compile into MARC</para>
33364
33365             <screenshot>
33366               <screeninfo>Compile into MARC</screeninfo>
33367
33368               <mediaobject>
33369                 <imageobject>
33370                   <imagedata fileref="images/appendix-onorder/compile.png"/>
33371                 </imageobject>
33372               </mediaobject>
33373             </screenshot>
33374           </listitem>
33375
33376           <listitem>
33377             <para>Choose where to save your file</para>
33378           </listitem>
33379         </itemizedlist>
33380
33381         <para>Now you want to go into your Koha system and follow the
33382         instructions for <link linkend="stagemarc">importing MARC
33383         records</link>.</para>
33384
33385         <para>Once the item has come in, you will need to go to the item
33386         record and individually change the item to have the correct barcode,
33387         and manually change the status from Ordered to the blank line in the
33388         Not for Loan field.</para>
33389
33390         <note>
33391           <para>If you purchase your cataloged item records, you may want to
33392           request your vendor put in the information you need into the MARC
33393           records for you; that way, you could import the edited-by-the-vendor
33394           file, overwriting the current record, automatically replacing the
33395           data with what you need.</para>
33396         </note>
33397       </section>
33398     </section>
33399   </chapter>
33400   <chapter id="coursereserves">
33401     <title>Course Reserves</title>
33402     <para>The course reserves module in Koha allows you to temporarily move items to 'reserve' and
33403       assign different circulation rules to these items while they are being used for a specific
33404       course.</para>
33405     <section id="coursesetup">
33406       <title>Course Reserves Setup</title>
33407       <para>Before using Course Reserves you will need to do some set up.  </para>
33408       <para>First you will need to enable course reserves by setting the <link
33409           linkend="UseCourseReserves">UseCourseReserves</link> preference to 'Use'.</para>
33410       <para>Next you will need to have all of your course instructors <link linkend="addnewpatron"
33411           >added as patrons</link>.</para>
33412       <para>Next you will want to add a couple of new <link linkend="newauthval">authorized
33413           values</link> for Departments and Terms. </para>
33414       <para>You may also want to create new <link linkend="additemtype">item types</link>, <link
33415           linkend="ccode">collection codes</link> and/or <link linkend="shelvelocvals">shelving
33416           locations</link> to make it clear that the items are on reserve to your patrons. You will
33417         also want to be sure to confirm that your <link linkend="circfinerules">circulation and fine
33418           rules</link> are right for your new item types (whether they be hourly or daily
33419         loans).</para>
33420     </section>
33421     <section id="addingcourses">
33422       <title>Adding Courses</title>
33423       <para>Once you have completed your set up for Course Reserves you can start creating courses
33424         and adding titles to the reserve list.</para>
33425       <screenshot>
33426           <screeninfo>Course Reserves Admin</screeninfo>
33427           <mediaobject>
33428             <imageobject>
33429               <imagedata fileref="images/coursereserves/coursesblank.png"/>
33430             </imageobject>
33431           </mediaobject>
33432         </screenshot>
33433       <para>From the main course reserves page you can add a new course by clicking the 'New course'
33434         button at the top left.</para>
33435       <screenshot>
33436           <screeninfo>Add a new course</screeninfo>
33437           <mediaobject>
33438             <imageobject>
33439               <imagedata fileref="images/coursereserves/newcourse.png"/>
33440             </imageobject>
33441           </mediaobject>
33442         </screenshot>
33443       <para>Your new course will need a Department, Number and Name at the bare minimum. You can
33444         also add in additional details like course section number and term. To link an instructor to
33445         this course simply start typing their name and Koha will search your patron database to find
33446         you the right person.</para>
33447       <screenshot>
33448           <screeninfo>Instrcutor search</screeninfo>
33449           <mediaobject>
33450             <imageobject>
33451               <imagedata fileref="images/coursereserves/instructorsearch.png"/>
33452             </imageobject>
33453           </mediaobject>
33454         </screenshot>
33455       <para>Once the instructor you want appears just click their name and they will be added. You
33456         can repeat this for all instructors on this course. Each instructor will appear above the
33457         search box and can be removed by clicking the 'Remove' link to the right of their name.</para>
33458       <screenshot>
33459           <screeninfo>Instructors</screeninfo>
33460           <mediaobject>
33461             <imageobject>
33462               <imagedata fileref="images/coursereserves/instructorremove.png"/>
33463             </imageobject>
33464           </mediaobject>
33465         </screenshot>
33466       <para>If you would like your course to show publicly you'll want to be sure to check the
33467         'Enabled?' box before saving your new course.</para>
33468       <para>Once your course is saved it will show on the main course reserves page and be
33469         searchable by any field in the course.</para>
33470       <screenshot>
33471           <screeninfo>Courses</screeninfo>
33472           <mediaobject>
33473             <imageobject>
33474               <imagedata fileref="images/coursereserves/courses.png"/>
33475             </imageobject>
33476           </mediaobject>
33477         </screenshot>
33478     </section>
33479     <section id="addreserves">
33480       <title>Adding Reserve Materials </title>
33481       <para>Before adding reserve materials you will need at least one course to add them to.  To
33482         add materials visit the Course Reserves module.</para>
33483       <screenshot>
33484         <screeninfo>Courses</screeninfo>
33485         <mediaobject>
33486           <imageobject>
33487             <imagedata fileref="images/coursereserves/courses.png"/>
33488           </imageobject>
33489         </mediaobject>
33490       </screenshot>
33491       <para>Click on the title of the course you would like to add materials to.</para>
33492       <screenshot>
33493           <screeninfo>Course administration</screeninfo>
33494           <mediaobject>
33495             <imageobject>
33496               <imagedata fileref="images/coursereserves/courseadmin.png"/>
33497             </imageobject>
33498           </mediaobject>
33499         </screenshot>
33500       <para>At the top of the course description click the 'Add reserves' button to add titles to
33501         this reserve list. You will be asked to enter the barcode for the reserve item.</para>
33502       <screenshot>
33503         <screeninfo>Add item to reserve</screeninfo>
33504         <mediaobject>
33505           <imageobject>
33506             <imagedata fileref="images/coursereserves/addbarcode.png"/>
33507           </imageobject>
33508         </mediaobject>
33509       </screenshot>
33510       <para>After you are done scanning the barcodes to add to the course you can see them on the
33511         course page</para>
33512       <screenshot>
33513         <screeninfo>Course with reserves</screeninfo>
33514         <mediaobject>
33515           <imageobject>
33516             <imagedata fileref="images/coursereserves/coursewithreserves.png"/>
33517           </imageobject>
33518         </mediaobject>
33519       </screenshot>
33520     </section>
33521     <section id="opaccoursereserves">
33522       <title>Course Reserves in the OPAC</title>
33523       <para>Once you have enabled Course Reserves and added courses you will see a link to Course
33524         Reserves below your search box in the OPAC.</para>
33525       <screenshot>
33526           <screeninfo>Course Reserves Link</screeninfo>
33527           <mediaobject>
33528             <imageobject>
33529               <imagedata fileref="images/coursereserves/courselinkopac.png"/>
33530             </imageobject>
33531           </mediaobject>
33532         </screenshot>
33533       <para>Clicking that link will show you your list of enabled courses (if you have only one
33534         course you will just see the contents of that one course).</para>
33535       <screenshot>
33536           <screeninfo>Course list in the OPAC</screeninfo>
33537           <mediaobject>
33538             <imageobject>
33539               <imagedata fileref="images/coursereserves/coursesopac.png"/>
33540             </imageobject>
33541           </mediaobject>
33542         </screenshot>
33543       <para>You can search course reserves by any field (course number, course name, instructor
33544         name, department) that is visible in the list of courses. Clicking a course name will show
33545         you the details and reserve items.</para>
33546       <screenshot>
33547           <screeninfo>Course listing</screeninfo>
33548           <mediaobject>
33549             <imageobject>
33550               <imagedata fileref="images/coursereserves/courseopac.png"/>
33551             </imageobject>
33552           </mediaobject>
33553         </screenshot>
33554     </section>
33555   </chapter>
33556
33557   <chapter id="serials">
33558     <title>Serials</title>
33559
33560     <para>Serials actions can be accessed by going to the More menu at the top
33561     of your screen and choosing Serials or by clicking Serials on the main
33562     Koha staff client page. The Serials module in Koha is used for keeping
33563     track of journals, newspapers and other items that come on a regular
33564     schedule. As with all modules, make sure you go through the related <link linkend="impserials">Implementation Checklist</link> before using the
33565     Serials module.</para>
33566
33567     <itemizedlist>
33568       <listitem>
33569         <para><emphasis>Get there:</emphasis> More &gt; Serials</para>
33570       </listitem>
33571     </itemizedlist>
33572     <section id="serialfreq">
33573       <title>Manage Serial Frequencies</title>
33574       <para>Koha keeps a record of publication frequencies for easy management and
33575         duplication.</para>
33576       <itemizedlist>
33577         <listitem>
33578           <para><emphasis>Get there:</emphasis> More &gt; Serials > Manage frequencies</para>
33579         </listitem>
33580       </itemizedlist>
33581       <para>From this page you can view all of the existing frequencies in your system</para>
33582       <screenshot>
33583         <screeninfo>Frequencies</screeninfo>
33584         <mediaobject>
33585           <imageobject>
33586             <imagedata fileref="images/serials/frequencies.png"/>
33587           </imageobject>
33588         </mediaobject>
33589       </screenshot>
33590       <para>and create new ones.</para>
33591       <screenshot>
33592         <screeninfo>New frequency</screeninfo>
33593         <mediaobject>
33594           <imageobject>
33595             <imagedata fileref="images/serials/newfrequency.png"/>
33596           </imageobject>
33597         </mediaobject>
33598       </screenshot>
33599     </section>
33600     <section id="serialpatterns">
33601       <title>Manage Serial Numbering Patterns</title>
33602       <para>Everytime you create a new numbering pattern in serials you can save it for later use.
33603         These patters are accessible via the Manage numbering patterns page.</para>
33604       <itemizedlist>
33605         <listitem>
33606           <para><emphasis>Get there:</emphasis> More &gt; Serials > Manage numbering patterns</para>
33607         </listitem>
33608       </itemizedlist>
33609       <para>This page will list for you the numbering patterns you have saved in the past as well as
33610         a few canned patterns.</para>
33611       <screenshot>
33612         <screeninfo>Number patterns</screeninfo>
33613         <mediaobject>
33614           <imageobject>
33615             <imagedata fileref="images/serials/numpatterns.png"/>
33616           </imageobject>
33617         </mediaobject>
33618       </screenshot>
33619       <para><note>
33620           <para>If you have upgraded from a previous version of Koha you will see 'Backup patterns'
33621             listed for patterns used in version before Koha 3.14. This is how Koha saved your old
33622             numbering patterns. You can edit these to give them more meaningful names from
33623             here.</para>
33624         </note>It will also allow you to create a new numbering pattern without first adding a
33625         subscription. To add new new pattern click 'New numbering pattern' at the top of the list of
33626         patterns.</para>
33627       <screenshot>
33628         <screeninfo>New number pattern</screeninfo>
33629         <mediaobject>
33630           <imageobject>
33631             <imagedata fileref="images/serials/newnumpattern.png"/>
33632           </imageobject>
33633         </mediaobject>
33634       </screenshot>
33635     </section>
33636
33637     <section id="newsubscription">
33638       <title>Add a subscription</title>
33639
33640       <para>Subscriptions can be added by clicking the 'New' button on any
33641       bibliographic record</para>
33642
33643       <screenshot>
33644         <screeninfo>New Subscription Button</screeninfo>
33645
33646         <mediaobject>
33647           <imageobject>
33648             <imagedata fileref="images/serials/newsubfrombib.png"/>
33649           </imageobject>
33650         </mediaobject>
33651       </screenshot>
33652
33653       <para>Or by visiting the Serials module and clicking 'New
33654       Subscription'</para>
33655
33656       <screenshot>
33657         <screeninfo>New Subscription Button</screeninfo>
33658
33659         <mediaobject>
33660           <imageobject>
33661             <imagedata fileref="images/serials/newsubbutton.png"/>
33662           </imageobject>
33663         </mediaobject>
33664       </screenshot>
33665
33666       <para>If you are entering a new subscription from the Serials module you
33667       will be presented with a blank form (if creating new from a
33668       bibliographic record the form will include the bib info).</para>
33669
33670       <screenshot>
33671         <screeninfo>Add a new subscription (1/2)</screeninfo>
33672
33673         <mediaobject>
33674           <imageobject>
33675             <imagedata fileref="images/serials/addsub.png"/>
33676           </imageobject>
33677         </mediaobject>
33678       </screenshot>
33679
33680       <itemizedlist>
33681         <listitem>
33682           <para>'Librarian' field will show the logged in librarian's
33683           username</para>
33684         </listitem>
33685
33686         <listitem>
33687           <para>'Vendor' can be found by either searching vendors entered via
33688           the <link linkend="acqmodule">Acquisitions module</link> or entering
33689           the vendor ID number</para>
33690
33691           <itemizedlist>
33692             <listitem>
33693               <para>Vendor information is not required</para>
33694             </listitem>
33695
33696             <listitem>
33697               <para>In order to claim missing and late issues you need to
33698               enter vendor information</para>
33699
33700               <screenshot>
33701                 <screeninfo>Vendor Missing Warning</screeninfo>
33702
33703                 <mediaobject>
33704                   <imageobject>
33705                     <imagedata fileref="images/serials/vendorwarning.png"/>
33706                   </imageobject>
33707                 </mediaobject>
33708               </screenshot>
33709             </listitem>
33710           </itemizedlist>
33711         </listitem>
33712
33713         <listitem>
33714           <para>'Biblio' is the MARC record you'd like to link this
33715           subscription to</para>
33716
33717           <itemizedlist>
33718             <listitem>
33719               <para>This can be done by searching for an existing record by
33720               clicking on the 'Search for Biblio' link below the boxes or by
33721               entering the bib number for a record in the first box. Only if
33722               you search with the field between the parenthesis.</para>
33723             </listitem>
33724           </itemizedlist>
33725         </listitem>
33726
33727         <listitem>
33728           <para>Next you can choose whether a new item is created when receiving an issue (if you
33729             barcode issues you'll want to create an item at this time)</para>
33730         </listitem>
33731         <listitem>
33732           <para>In order to determine how to handle irregularities in your subscription answer 'When
33733             there is an irregular issue', if the numbers are always sequential you'll want to pick
33734             'Keep issue number'</para>
33735         </listitem>
33736         <listitem>
33737           <para>Checking the 'Manual history' box will allow you to enter serials outside the
33738             prediction pattern once the subscription is saved by going to the 'Planning' tab on the
33739             subscription detail page.<screenshot>
33740               <screeninfo>Manual History</screeninfo>
33741               <mediaobject>
33742                 <imageobject>
33743                   <imagedata fileref="images/serials/manualhistory.png"/>
33744                 </imageobject>
33745               </mediaobject>
33746             </screenshot></para>
33747         </listitem>
33748         <listitem>
33749           <para>'Call Number' is for your item's call number or call number prefix</para>
33750         </listitem>
33751         <listitem>
33752           <para>'Library' is the branch that owns this subscription.</para>
33753           <itemizedlist>
33754             <listitem>
33755               <para>If more than one library subscribes to this serial you will need to create a
33756                 subscription for each library</para>
33757             </listitem>
33758             <listitem>
33759               <para>This can be done easily by using the 'Edit as New (Duplicate)' option found on
33760                 the subscription information page and changing only the 'Library' field</para>
33761               <screenshot>
33762                 <screeninfo>New Duplicate Subscription</screeninfo>
33763                 <mediaobject>
33764                   <imageobject>
33765                     <imagedata fileref="images/serials/newasdup.png"/>
33766                   </imageobject>
33767                 </mediaobject>
33768               </screenshot>
33769             </listitem>
33770           </itemizedlist>
33771         </listitem>
33772         <listitem>
33773           <para>Use the 'Public Note' for any notes you would like to appear in the OPAC for the
33774             patrons</para>
33775         </listitem>
33776         <listitem>
33777           <para>'Nonpublic Note' should be used for notes that are only visible to the librarians
33778             via the staff client</para>
33779         </listitem>
33780         <listitem>
33781           <para>The 'Patron notification' option lets you pick a notice to send to patrons who
33782             subscribe to updates on this serial via the OPAC.</para>
33783           <itemizedlist>
33784             <listitem>
33785               <para>For this option to appear you need to make sure that you have a Routing List
33786                 notice set up in the <link linkend="notices">Notices Tool</link></para>
33787             </listitem>
33788           </itemizedlist>
33789         </listitem>
33790
33791         <listitem>
33792           <para>'Location' is for the shelving location</para>
33793         </listitem>
33794
33795         <listitem>
33796           <para>The 'Grace period' is the number of days before an issue is automatically moved from
33797             'Expected' status to 'Waiting' and how many days before an issue is automatically moved
33798             from 'Waiting' status to 'Late'</para>
33799         </listitem>
33800
33801         <listitem>
33802           <para>The Staff and OPAC Display options allow you to control how
33803           many issues appear by default on bibliographic records in the Staff
33804           Client and the OPAC</para>
33805
33806           <itemizedlist>
33807             <listitem>
33808               <para>If no values are entered in these fields, they will use
33809               the <link linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
33810               and <link linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
33811               system preference values</para>
33812             </listitem>
33813           </itemizedlist>
33814         </listitem>
33815         </itemizedlist>
33816       <para>Once that data is filled in you can click 'Next' to enter the prediction pattern information.</para>
33817       <screenshot>
33818           <screeninfo>Add a new subscription (2/2)</screeninfo>
33819           <mediaobject>
33820             <imageobject>
33821               <imagedata fileref="images/serials/addsub2.png"/>
33822             </imageobject>
33823           </mediaobject>
33824         </screenshot>
33825 <itemizedlist>
33826         <listitem>
33827           <para>In 'First issue publication date' you want to enter the date
33828           of the issue you have in your hand, the date from which the
33829           prediction pattern will start</para>
33830         </listitem>
33831
33832         <listitem>
33833           <para>There are several pre-defined options for the 'Frequency' of publication all of
33834             which are visible alongside your own custom frequencies by visiting '<link
33835               linkend="serialfreq">Manage frequencies</link>'</para>
33836
33837           <itemizedlist>
33838             <listitem>
33839               <para>Without periodicy: some very specific (usually high level
33840               science journals) don't have a true periodicity. When you
33841               subscribe to the title, you subscribe for 6 issues, which can
33842               arrive in 1 year... or 2... There is no regularity or known
33843               schedule.</para>
33844             </listitem>
33845
33846             <listitem>
33847               <para>Unknown select this if none of the other choices are
33848               relevant</para>
33849             </listitem>
33850
33851             <listitem>
33852               <para>Irregular: The journal is not "regular" but has a
33853               periodicity. You know that it comes out on January, then in
33854               October and December, it is irregular, but you know when it's
33855               going to arrive.</para>
33856             </listitem>
33857
33858             <listitem>
33859               <para>2/day: Twice daily</para>
33860             </listitem>
33861
33862             <listitem>
33863               <para>1/day: Daily</para>
33864             </listitem>
33865
33866             <listitem>
33867               <para>3/week: Three times a week</para>
33868             </listitem>
33869
33870             <listitem>
33871               <para>1/week: Weekly</para>
33872             </listitem>
33873
33874             <listitem>
33875               <para>1/ 2 weeks: Twice monthly (fortnightly)</para>
33876             </listitem>
33877
33878             <listitem>
33879               <para>1/ 3 weeks: Tri-weekly</para>
33880             </listitem>
33881
33882             <listitem>
33883               <para>1/month: Monthly</para>
33884             </listitem>
33885
33886             <listitem>
33887               <para>1/ 2 months (6/year): Bi-monthly</para>
33888             </listitem>
33889
33890             <listitem>
33891               <para>1/ 3 months (1/quarter): Quarterly</para>
33892             </listitem>
33893
33894             <listitem>
33895               <para>1/quarter (seasonal) : Quarterly related to seasons (ie.
33896               Summer, Autumn, Winter, Spring)</para>
33897             </listitem>
33898
33899             <listitem>
33900               <para>2/year: Half yearly</para>
33901             </listitem>
33902
33903             <listitem>
33904               <para>1/year: Annual</para>
33905             </listitem>
33906
33907             <listitem>
33908               <para>1/ 2 years: Bi-annual</para>
33909             </listitem>
33910           </itemizedlist>
33911         </listitem>
33912         <listitem>
33913           <para>'Subscription length' is the number of issues or months in the subscription. This is
33914             also used for setting up renewal alerts</para>
33915         </listitem>
33916         <listitem>
33917           <para>'Subscription start date' is the date at which the subscription begins. This is used
33918             for setting up renewal alerts</para>
33919         </listitem>
33920         <listitem>
33921           <para>'Subscription end date' should only be entered for subscriptions that have ended (if
33922             you're entering in a backlog of serials)</para>
33923         </listitem>
33924
33925         <listitem>
33926           <para>'Numbering pattern' will help you determine how the numbers are printed for each
33927             issue. Patterns entered here are saved and editable at any time by visiting '<link
33928               linkend="serialpatterns">Manage numbering patterns</link>'</para>
33929
33930           <itemizedlist>
33931             <listitem>
33932               <para>Start with the numbering on the issue you have in hand,
33933               the numbering that matches the date you entered in the 'First
33934               issue publication' field</para>
33935             </listitem>
33936
33937             <listitem>
33938               <para>You can choose to create your own numbering pattern by choosing 'None of the
33939                 above' and clicking the 'Show/Hide Advanced Pattern' button at the bottom of the form</para>
33940               <screenshot>
33941                   <screeninfo>Advanced prediction pattern</screeninfo>
33942                   <mediaobject>
33943                     <imageobject>
33944                       <imagedata fileref="images/serials/advancedpattern.png"/>
33945                     </imageobject>
33946                   </mediaobject>
33947                 </screenshot>
33948             </listitem>
33949           </itemizedlist>
33950         </listitem>
33951         <listitem>
33952           <para>The 'Locale' option is useful when you want to display days, month or season. For
33953             example, if you have a German serial, you can use the German locale option to display
33954             days, etc. in German.</para>
33955         </listitem>
33956
33957         <listitem>
33958           <para>Once a 'Numbering pattern' is chosen the number formula will appear.<screenshot>
33959               <screeninfo>Numbering Forumla</screeninfo>
33960               <mediaobject>
33961                 <imageobject>
33962                   <imagedata fileref="images/serials/numberonly.png"/>
33963                 </imageobject>
33964               </mediaobject>
33965             </screenshot><itemizedlist>
33966               <listitem>
33967                 <para>The 'Begins with' number is the number of the issue you're holding in your
33968                   hand.</para>
33969               </listitem>
33970               <listitem>
33971                 <para>The 'Inner counter' is used to tell Koha where the "receiving cycle" starts<itemizedlist>
33972                     <listitem>
33973                       <para>For example: If the first issue to receive is "vol. 4, no. 1, iss. 796",
33974                         you need to set up "inner counter = 0" But if it's "vol. 4, no. 2, iss.
33975                         797", the inner counter should be "1".</para>
33976                     </listitem>
33977                   </itemizedlist></para>
33978               </listitem>
33979               <listitem>
33980                 <para>After filling in this data click the 'Test prediction pattern' button to see
33981                   what issues the system will generate, if there are irregularities you can choose
33982                   which issues don't exist from the list presented.</para>
33983                 <screenshot>
33984                     <screeninfo>Prediction pattern</screeninfo>
33985                     <mediaobject>
33986                       <imageobject>
33987                         <imagedata fileref="images/serials/predictionpattern.png"/>
33988                       </imageobject>
33989                     </mediaobject>
33990                   </screenshot>
33991               </listitem>
33992             </itemizedlist></para>
33993         </listitem>
33994       </itemizedlist>
33995
33996       <para>Click 'Save Subscription' to save the information you have
33997       entered. <link linkend="sampleserialsapp">Find sample serial examples in
33998       the appendix</link>.</para>
33999     </section>
34000
34001     <section id="receiveissues">
34002       <title>Receive Issues</title>
34003
34004       <para>Issues can be marked as received from several locations. To find a
34005       subscription, use the search box at the top of the Serials page to
34006       search for the serial you'd like to receive issues for:</para>
34007
34008       <screenshot>
34009         <screeninfo>Subscription Search</screeninfo>
34010
34011         <mediaobject>
34012           <imageobject>
34013             <imagedata fileref="images/serials/subsearch.png"/>
34014           </imageobject>
34015         </mediaobject>
34016       </screenshot>
34017
34018       <para>From the search results you can click the 'Serial Receive' link or
34019       you can click on the subscription title and then click the 'Receive'
34020       button.</para>
34021
34022       <screenshot>
34023         <screeninfo>Subscription Buttons</screeninfo>
34024
34025         <mediaobject>
34026           <imageobject>
34027             <imagedata fileref="images/serials/subbuttons.png"/>
34028           </imageobject>
34029         </mediaobject>
34030       </screenshot>
34031
34032       <para>The final way to receive serials is from the 'Serial Collection'
34033       page. To the left of the Subscription summary page there is a menu with
34034       a link to 'Serial Collection'</para>
34035
34036       <screenshot>
34037         <screeninfo>Serial Subscription Menu</screeninfo>
34038
34039         <mediaobject>
34040           <imageobject>
34041             <imagedata fileref="images/serials/serialcolllink.png"/>
34042           </imageobject>
34043         </mediaobject>
34044       </screenshot>
34045
34046       <para>From the page that opens up you can click 'Edit Serial' with the
34047       issue you want to receive checked.</para>
34048
34049       <screenshot>
34050         <screeninfo>Edit Issues</screeninfo>
34051
34052         <mediaobject>
34053           <imageobject>
34054             <imagedata fileref="images/serials/editissue.png"/>
34055           </imageobject>
34056         </mediaobject>
34057       </screenshot>
34058
34059       <para>All three of these options will open up the issue receive
34060       form:</para>
34061
34062       <screenshot>
34063         <screeninfo>Receive Serials</screeninfo>
34064
34065         <mediaobject>
34066           <imageobject>
34067             <imagedata fileref="images/serials/receiveissue.png"/>
34068           </imageobject>
34069         </mediaobject>
34070       </screenshot>
34071
34072       <itemizedlist>
34073         <listitem>
34074           <para>Choose 'Arrived' from the status pull down to mark a serial as
34075           received.</para>
34076         </listitem>
34077
34078         <listitem>
34079           <para>If you have decided to have an item record created for each issue an <link linkend="addingitems">item add form</link>
34080             will appear after choosing 'Arrived'</para>
34081           <screenshot>
34082               <screeninfo>Serial item record</screeninfo>
34083               <mediaobject>
34084                 <imageobject>
34085                   <imagedata fileref="images/serials/serialitem.png"/>
34086                 </imageobject>
34087               </mediaobject>
34088             </screenshot>
34089         </listitem>
34090
34091         <listitem>
34092           <para>If your issue has a supplemental issue with it, fill in the Supplemental Issue information.<itemizedlist>
34093               <listitem>
34094                 <para>Key the entire numbering in the box after "Supplemental issue" no numbering
34095                   will be inherited/auto-filled from the main issue, and exactly what you key in the
34096                   box after "Supplemental issue" will be auto-filled in the item record's Serial
34097                   enumeration/chronology [MARC21 952$h] (if you create item records). <itemizedlist>
34098                     <listitem>
34099                       <para>E.g., key this in its entirety if it's what you would like displayed:
34100                         "v.69 no.3 (Mar. 2015) suppl." </para>
34101                     </listitem>
34102                   </itemizedlist></para>
34103               </listitem>
34104             </itemizedlist></para>
34105         </listitem>
34106
34107         <listitem>
34108           <para>If you have decided to have an item record created for each
34109           issue an <link linkend="addingitems">item add form</link> will
34110           appear for your supplement and for the issue itself</para>
34111         </listitem>
34112
34113         <listitem>
34114           <para>Once you have entered your info you can click 'Save'</para>
34115         </listitem>
34116       </itemizedlist>
34117
34118       <para>If you are receiving multiple issues at once, or have marked an
34119       issue as 'Late' or 'Missing' there you can click the 'Generate Next'
34120       button below the list of issues.</para>
34121
34122       <screenshot>
34123         <screeninfo>Generate Next Button</screeninfo>
34124
34125         <mediaobject>
34126           <imageobject>
34127             <imagedata fileref="images/serials/editissue.png"/>
34128           </imageobject>
34129         </mediaobject>
34130       </screenshot>
34131
34132       <para>Clicking this button will generate the next issue for you and mark
34133       the previously expected issue as 'Late' automatically. You can then
34134       check the 'Edit' box to the right of each issue and edit the status on
34135       multiple issues at once.</para>
34136     </section>
34137
34138     <section id="routinglist">
34139       <title>Create a Routing List</title>
34140
34141       <para>A routing list is a list of people who receive the serial before it goes to the shelf.
34142         To enable routing lists you want to set your <link linkend="RoutingSerials"
34143           >RoutingSerials</link> preference to 'Add'.</para>
34144
34145       <para>When on the subscription page you will see a link to the left that
34146       reads 'Create Routing List' or 'Edit Routing List'</para>
34147
34148       <screenshot>
34149         <screeninfo>Subscription Routing List Link</screeninfo>
34150
34151         <mediaobject>
34152           <imageobject>
34153             <imagedata fileref="images/serials/createroutinglink.png"/>
34154           </imageobject>
34155         </mediaobject>
34156       </screenshot>
34157
34158       <para>Clicking that link will bring you to the menu to add a new routing
34159       list.</para>
34160
34161       <screenshot>
34162         <screeninfo>Routing List Creation</screeninfo>
34163
34164         <mediaobject>
34165           <imageobject>
34166             <imagedata fileref="images/serials/createroutinglist.png"/>
34167           </imageobject>
34168         </mediaobject>
34169       </screenshot>
34170
34171       <para>From here you want to click 'Add recipients' in order to add
34172       people to the routing list. In the menu that appears you can filter
34173       patrons by part of their name, their library and/or patron
34174       category.</para>
34175
34176       <screenshot>
34177         <screeninfo>Add Members to Routing List</screeninfo>
34178
34179         <mediaobject>
34180           <imageobject>
34181             <imagedata fileref="images/serials/addtorouting.png"/>
34182           </imageobject>
34183         </mediaobject>
34184       </screenshot>
34185
34186       <para>Clicking 'Add' to the right of each name will add them to the
34187       routing list. When you have chosen all of the people for the list, click
34188       the 'Close' link to be redirected to the routing list.</para>
34189
34190       <screenshot>
34191         <screeninfo>Routing List</screeninfo>
34192
34193         <mediaobject>
34194           <imageobject>
34195             <imagedata fileref="images/serials/editroutinglist.png"/>
34196           </imageobject>
34197         </mediaobject>
34198       </screenshot>
34199
34200       <para>If the list looks the way you expect it to, then click 'Save'.
34201       Next you will be brought to a preview of the routing list. To print the
34202       list click 'Save and preview routing slip.' This will open a printable
34203       version of the list.</para>
34204
34205       <screenshot>
34206         <screeninfo>Preview Routing List</screeninfo>
34207
34208         <mediaobject>
34209           <imageobject>
34210             <imagedata fileref="images/serials/previewroutinglist.png"/>
34211           </imageobject>
34212         </mediaobject>
34213       </screenshot>
34214
34215       <para>If <link linkend="RoutingListAddReserves">RoutingListAddReserves</link> is set to
34216       on then patrons listed in the routing list will automatically be added
34217       to the holds list for the issue.</para>
34218
34219       <para>To see a list of all of the routing lists a specific patron is on visit the <link
34220           linkend="patronroutingtab">Routing Lists tab</link> on their patron record.</para>
34221     </section>
34222
34223     <section id="serialsubinstaff">
34224       <title>Subscriptions in Staff Client</title>
34225
34226       <para>Subscription information will appear on bibliographic records
34227       under the 'Subscriptions' tab</para>
34228
34229       <screenshot>
34230         <screeninfo>Subscription Tab on Bibliographic Record</screeninfo>
34231
34232         <mediaobject>
34233           <imageobject>
34234             <imagedata fileref="images/serials/subinfoonbib.png"/>
34235           </imageobject>
34236         </mediaobject>
34237       </screenshot>
34238
34239       <para>Clicking the 'Subscription Details' link will take you to the
34240       Subscription summary page in the staff client.</para>
34241
34242       <screenshot>
34243         <screeninfo>Subscription Detail</screeninfo>
34244
34245         <mediaobject>
34246           <imageobject>
34247             <imagedata fileref="images/serials/subscriptiondetail.png"/>
34248           </imageobject>
34249         </mediaobject>
34250       </screenshot>
34251       <para>If you are using the <link linkend="acqmodule">Acquisitions</link> module to keep <link
34252           linkend="ordersubscription">track of serial subscriptions</link> you will see that info
34253         before your subscription details.</para>
34254       <screenshot>
34255           <screeninfo>Acquisitions information for subscription</screeninfo>
34256           <mediaobject>
34257             <imageobject>
34258               <imagedata fileref="images/acquisitions/subdetails.png"/>
34259             </imageobject>
34260           </mediaobject>
34261         </screenshot>
34262     </section>
34263
34264     <section id="serialsubinopac">
34265       <title>Subscriptions in OPAC</title>
34266
34267       <para>When viewing the subscription in the OPAC there will be several
34268       options.</para>
34269
34270       <para>Like in the staff client, there will be a Subscriptions tab on the
34271       bibliographic record.</para>
34272
34273       <screenshot>
34274         <screeninfo>Subscriptions Tab in OPAC</screeninfo>
34275
34276         <mediaobject>
34277           <imageobject>
34278             <imagedata fileref="images/serials/subopac.png"/>
34279           </imageobject>
34280         </mediaobject>
34281       </screenshot>
34282
34283       <para>Under this tab will appear the number of issues you chose when
34284       setting up the subscription or in your <link linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
34285       system preference. Clicking the 'More details' link will provide you
34286       with additional information about the serial history. You can set the
34287       default view of a serial in the OPAC with the <link linkend="SubscriptionHistory">SubscriptionHistory</link> system
34288       preference.</para>
34289
34290       <para>There are two views, compact and full. The compact serial
34291       subscription will show basic information regarding the
34292       subscription</para>
34293
34294       <screenshot>
34295         <screeninfo>Compact Serial View</screeninfo>
34296
34297         <mediaobject>
34298           <imageobject>
34299             <imagedata fileref="images/serials/compactopac.png"/>
34300           </imageobject>
34301         </mediaobject>
34302       </screenshot>
34303
34304       <para>From this compact display patrons can subscribe to be notified of new issues as they are
34305         released by clicking the 'Subscribe to email notifications of new issues' button. For this
34306         link to appear you will want to have chosen to notify patrons <link
34307           linkend="newsubscription">on the subscription</link> itself.</para>
34308
34309       <screenshot>
34310         <screeninfo>Subscribe link in the OPAC</screeninfo>
34311
34312         <mediaobject>
34313           <imageobject>
34314             <imagedata fileref="images/serials/opacroutingsubscribe.png"/>
34315           </imageobject>
34316         </mediaobject>
34317       </screenshot>
34318       <para>You can see thos who subscribe to new issue alerts by going to the subscription page in
34319         the staff client and looking on the right of the 'Information' tab.<screenshot>
34320           <screeninfo>Serial notification subscribers</screeninfo>
34321           <mediaobject>
34322             <imageobject>
34323               <imagedata fileref="images/serials/subscribers.png"/>
34324             </imageobject>
34325           </mediaobject>
34326         </screenshot></para>
34327
34328       <para>Whereas the full view shows extensive details, broken out by year,
34329       regarding the subscription</para>
34330
34331       <screenshot>
34332         <screeninfo>Full Serial View</screeninfo>
34333
34334         <mediaobject>
34335           <imageobject>
34336             <imagedata fileref="images/serials/fullopac.png"/>
34337           </imageobject>
34338         </mediaobject>
34339       </screenshot>
34340     </section>
34341
34342     <section id="serialclaims">
34343       <title>Claim Late Serials</title>
34344
34345       <para>Koha can send email messages to your serial vendors if you have
34346       late issues. To the left of the main serials page there is a link to
34347       'Claims'</para>
34348
34349       <screenshot>
34350         <screeninfo>Link to Claims on Serials Menu</screeninfo>
34351
34352         <mediaobject>
34353           <imageobject>
34354             <imagedata fileref="images/serials/serialclaimmenu.png"/>
34355           </imageobject>
34356         </mediaobject>
34357       </screenshot>
34358
34359       <para>The links to claims also appears to the left of the subscription
34360       detail page</para>
34361
34362       <screenshot>
34363         <screeninfo>Link to Claims on the Serials Menu</screeninfo>
34364
34365         <mediaobject>
34366           <imageobject>
34367             <imagedata fileref="images/serials/serialclaimmenu1.png"/>
34368           </imageobject>
34369         </mediaobject>
34370       </screenshot>
34371
34372       <para>If you don't have a claim notice defined yet you will see a
34373       warning message that you need to first define a notice.</para>
34374
34375       <screenshot>
34376         <screeninfo>Missing Claims Notice Warning</screeninfo>
34377
34378         <mediaobject>
34379           <imageobject>
34380             <imagedata fileref="images/serials/noserialclaim.png"/>
34381           </imageobject>
34382         </mediaobject>
34383       </screenshot>
34384
34385       <para>Clicking 'Claims' will open a report that will ask you to choose
34386       from your various serial vendors to generate claims for late
34387       issues.</para>
34388
34389       <screenshot>
34390         <screeninfo>Serial Claims</screeninfo>
34391
34392         <mediaobject>
34393           <imageobject>
34394             <imagedata fileref="images/serials/serialclaims.png"/>
34395           </imageobject>
34396         </mediaobject>
34397       </screenshot>
34398
34399       <para>From the list of late issues you can choose which ones you want to
34400       send a claim email to by clicking the checkbox to the left of late
34401       issue, choosing the notice template to use and clicking the 'Send
34402       notification' button.</para>
34403     </section>
34404
34405     <section id="serialexpiration">
34406       <title>Check Serial Expiration</title>
34407
34408       <para>When adding serials you enter a subscription length, using the
34409       check expiration tool you can see when your subscriptions are about to
34410       expire. To use the tool click the link to 'Check expiration' on the
34411       serials menu.</para>
34412
34413       <screenshot>
34414         <screeninfo>Check Serial Expiration</screeninfo>
34415
34416         <mediaobject>
34417           <imageobject>
34418             <imagedata fileref="images/serials/serialexpiresearch.png"/>
34419           </imageobject>
34420         </mediaobject>
34421       </screenshot>
34422
34423       <para>In the form that appears you need to enter at least a date to
34424       search by.</para>
34425
34426       <para>In your results you will see all subscriptions that will expire
34427       before the date you entered. From there you can choose to view the
34428       subscription further or renew it in one click.</para>
34429
34430       <screenshot>
34431         <screeninfo>Serial Expiration Search Results</screeninfo>
34432
34433         <mediaobject>
34434           <imageobject>
34435             <imagedata fileref="images/serials/serialexpire.png"/>
34436           </imageobject>
34437         </mediaobject>
34438       </screenshot>
34439     </section>
34440
34441     <section id="serialrenew">
34442       <title>Renewing Serials</title>
34443
34444       <para>If your serial subscription has expired you won't be able to
34445       receive issues. To renew your subscription you can click the 'Renew'
34446       button at the top of your subscription detail page.</para>
34447
34448       <screenshot>
34449         <screeninfo>Renew option on subscription detail</screeninfo>
34450
34451         <mediaobject>
34452           <imageobject>
34453             <imagedata fileref="images/serials/renewsubscription.png"/>
34454           </imageobject>
34455         </mediaobject>
34456       </screenshot>
34457
34458       <para>Another option is to click the 'Renew' link to the right of the
34459       subscription on the Serial Collection page.</para>
34460
34461       <screenshot>
34462         <screeninfo>Renew option on serial collection</screeninfo>
34463
34464         <mediaobject>
34465           <imageobject>
34466             <imagedata fileref="images/serials/collectionrenew.png"/>
34467           </imageobject>
34468         </mediaobject>
34469       </screenshot>
34470
34471       <para>Once you click the 'Renew' link or button you will be presenting
34472       with renewal options.</para>
34473
34474       <screenshot>
34475         <screeninfo>Subscription renewal form</screeninfo>
34476
34477         <mediaobject>
34478           <imageobject>
34479             <imagedata fileref="images/serials/serialrenew.png"/>
34480           </imageobject>
34481         </mediaobject>
34482       </screenshot>
34483
34484       <itemizedlist>
34485         <listitem>
34486           <para>The start date should be the date your subscription period
34487           starts.</para>
34488         </listitem>
34489
34490         <listitem>
34491           <para>For the subscription length you'll want to fill in one of the
34492           three fields presented: Number of num (issues), Number of months or
34493           Number of weeks.</para>
34494         </listitem>
34495
34496         <listitem>
34497           <para>Finally enter any notes you might have about this
34498           renewal.</para>
34499         </listitem>
34500       </itemizedlist>
34501     </section>
34502
34503     <section id="serialsearch">
34504       <title>Searching Serials</title>
34505
34506       <para>Once in the Serials module there is basic search box at the top
34507       that you can use to find subscriptions using any part of the ISSN and/or
34508       title.</para>
34509
34510       <screenshot>
34511         <screeninfo>Basic Serials Search</screeninfo>
34512
34513         <mediaobject>
34514           <imageobject>
34515             <imagedata fileref="images/serials/serialsearch.png"/>
34516           </imageobject>
34517         </mediaobject>
34518       </screenshot>
34519
34520       <para>You can also click the 'Advanced Search' link to the right of the
34521       'Submit' button to do a more thorough search of your serials.</para>
34522
34523       <screenshot>
34524         <screeninfo>Advanced Serials Search</screeninfo>
34525
34526         <mediaobject>
34527           <imageobject>
34528             <imagedata fileref="images/serials/advanceserialsearch.png"/>
34529           </imageobject>
34530         </mediaobject>
34531       </screenshot>
34532
34533       <para>From your results you can filter by using the search boxes at the
34534       bottom of each column and adjust the number of resutls using the toolbar
34535       at the top of the results set.</para>
34536
34537       <screenshot>
34538         <screeninfo>Serial Search Results</screeninfo>
34539
34540         <mediaobject>
34541           <imageobject>
34542             <imagedata fileref="images/serials/serialsearchresults.png"/>
34543           </imageobject>
34544         </mediaobject>
34545       </screenshot>
34546     </section>
34547   </chapter>
34548
34549   <chapter id="acqmodule">
34550     <title>Acquisitions</title>
34551
34552     <para>The Koha Acquisitions module provides a way for the library to
34553     record orders placed with vendors and manage purchase budgets.</para>
34554
34555     <itemizedlist>
34556       <listitem>
34557         <para><emphasis>Get there:</emphasis> More &gt; Acquisitions</para>
34558       </listitem>
34559     </itemizedlist>
34560
34561     <section id="acqsetup">
34562       <title>Setup</title>
34563
34564       <para>Before using the Acquisitions Module you will want to make sure
34565       that you have completed all of the set up.</para>
34566
34567       <para>First, set your <link linkend="acqprefs">Acquisitions System
34568       Preferences</link> and <link linkend="acqadmin">Acquisitions
34569       Administration</link> to match your library's workflow.</para>
34570
34571       <para>On the main acquisitions page you will see your library's funds
34572       listed.</para>
34573
34574       <screenshot>
34575         <screeninfo>Acquisitions Funds Summary</screeninfo>
34576
34577         <mediaobject>
34578           <imageobject>
34579             <imagedata fileref="images/acquisitions/acqfunds.png"/>
34580           </imageobject>
34581         </mediaobject>
34582       </screenshot>
34583
34584       <para><note>
34585           <para>If the total line is confusing for the funds you have set up
34586           you can hide it by adding <programlisting>#funds_total {display:none;}</programlisting></para>
34587
34588           <para>to the <link linkend="IntranetUserCSS">IntranetUserCSS</link>
34589           preference.</para>
34590         </note></para>
34591
34592       <para>To see all active funds you can click the checkbox next to 'Show active and inactive'
34593         above the funds table.</para>
34594
34595       <para>To see a history of all orders in a fund you can click on the
34596       linked amount and it will run a search for you.</para>
34597
34598       <screenshot>
34599         <screeninfo>Breakdown of orders against the FIC Fund</screeninfo>
34600
34601         <mediaobject>
34602           <imageobject>
34603             <imagedata fileref="images/acquisitions/fundbreakdown.png"/>
34604           </imageobject>
34605         </mediaobject>
34606       </screenshot>
34607
34608       <para>Learn more in the <link linkend="fundtracking">Budget/Fund
34609       Tracking</link> section of this manual.</para>
34610     </section>
34611
34612     <section id="acqvendors">
34613       <title>Vendors</title>
34614
34615       <para>Before any orders can be places you must first enter at least one
34616       vendor.</para>
34617
34618       <section id="addacqvendor">
34619         <title>Add a Vendor</title>
34620
34621         <para>To add a vendor click the 'New Vendor' button on the
34622         Acquisitions page</para>
34623
34624         <screenshot>
34625           <screeninfo>New Vendor Button on Acquisitions</screeninfo>
34626
34627           <mediaobject>
34628             <imageobject>
34629               <imagedata fileref="images/acquisitions/newvendbutton.png"/>
34630             </imageobject>
34631           </mediaobject>
34632         </screenshot>
34633
34634         <para>The vendor add form is broken into three pieces</para>
34635
34636         <itemizedlist>
34637           <listitem>
34638             <para>The first section is for basic information about the
34639             Vendor</para>
34640
34641             <screenshot>
34642               <screeninfo>Basic Vendor Information</screeninfo>
34643
34644               <mediaobject>
34645                 <imageobject>
34646                   <imagedata fileref="images/acquisitions/newvendor1.png"/>
34647                 </imageobject>
34648               </mediaobject>
34649             </screenshot>
34650
34651             <itemizedlist>
34652               <listitem>
34653                 <para>Of these fields, only the Vendor name is required, the
34654                 rest of the information should be added to help with
34655                 generating claim letters and invoices</para>
34656               </listitem>
34657             </itemizedlist>
34658           </listitem>
34659
34660           <listitem>
34661             <para>The second section is for information regarding your contact
34662             at the Vendor's office</para>
34663
34664             <screenshot>
34665               <screeninfo>Vendor Contact Details</screeninfo>
34666
34667               <mediaobject>
34668                 <imageobject>
34669                   <imagedata fileref="images/acquisitions/newvendor2.png"/>
34670                 </imageobject>
34671               </mediaobject>
34672             </screenshot>
34673
34674             <itemizedlist>
34675               <listitem>
34676                 <para>None of these fields are required, they should only be
34677                 entered if you want to keep track of your contact's
34678                 information within Koha</para>
34679               </listitem>
34680             </itemizedlist>
34681           </listitem>
34682
34683           <listitem>
34684             <para>The final section is for billing information</para>
34685
34686             <screenshot>
34687               <screeninfo>Vendor Ordering/Billing Information</screeninfo>
34688
34689               <mediaobject>
34690                 <imageobject>
34691                   <imagedata fileref="images/acquisitions/newvendor3.png"/>
34692                 </imageobject>
34693               </mediaobject>
34694             </screenshot>
34695
34696             <itemizedlist>
34697               <listitem>
34698                 <para>To be able to order from a vendor you must make them
34699                 'Active'</para>
34700               </listitem>
34701
34702               <listitem>
34703                 <para>For List Prices and Invoice Prices choose the
34704                 currency</para>
34705
34706                 <itemizedlist>
34707                   <listitem>
34708                     <para>Currencies are assigned in the <link linkend="currexchangeadmin">Currencies &amp; Exchange
34709                     Rates</link> admin area</para>
34710                   </listitem>
34711                 </itemizedlist>
34712               </listitem>
34713
34714               <listitem>
34715                 <para>If your library is charged tax mark your Tax Number as
34716                 registered</para>
34717               </listitem>
34718
34719               <listitem>
34720                 <para>Note if you list prices and/or invoice prices include
34721                 tax</para>
34722               </listitem>
34723
34724               <listitem>
34725                 <para>If the vendor offers a consistent blank discount, enter
34726                 that in the 'Discount' field</para>
34727
34728                 <itemizedlist>
34729                   <listitem>
34730                     <para>You can enter item specific discounts when placing
34731                     an order</para>
34732                   </listitem>
34733                 </itemizedlist>
34734               </listitem>
34735
34736               <listitem>
34737                 <para>Enter your tax rate if your library is charged taxes on
34738                 orders</para>
34739               </listitem>
34740
34741               <listitem>
34742                 <para>If you know about how long it usually takes orders to
34743                 arrive from this vendor you can enter a delivery time. This
34744                 will allow Koha to estimate when orders will arrive at your
34745                 library on the late orders report.</para>
34746               </listitem>
34747
34748               <listitem>
34749                 <para>Notes are for internal use</para>
34750               </listitem>
34751             </itemizedlist>
34752           </listitem>
34753         </itemizedlist>
34754       </section>
34755
34756       <section id="editacqvendor">
34757         <title>View/Edit a Vendor</title>
34758
34759         <para>To view a vendor's information page you must search for the
34760         vendor from the Acquisitions home page. Your search can be for any
34761         part of the Vendor's name:</para>
34762
34763         <screenshot>
34764           <screeninfo>Vendor Search Results</screeninfo>
34765
34766           <mediaobject>
34767             <imageobject>
34768               <imagedata fileref="images/acquisitions/vendorsearch.png"/>
34769             </imageobject>
34770           </mediaobject>
34771         </screenshot>
34772
34773         <para>From the results, click on the name of the vendor you want to
34774         view or edit</para>
34775
34776         <screenshot>
34777           <screeninfo>Vendor Information Page</screeninfo>
34778
34779           <mediaobject>
34780             <imageobject>
34781               <imagedata fileref="images/acquisitions/vendorpage.png"/>
34782             </imageobject>
34783           </mediaobject>
34784         </screenshot>
34785
34786         <para>To make changes to the vendor, simply click the 'Edit vendor' button.</para>
34787
34788         <para>If the vendor has no baskets attached to it then a 'Delete vendor' button will also be
34789           visible and the vendor can be deleted. Otherwise you will see a 'Receive shipment'
34790           button.</para>
34791
34792         <screenshot>
34793           <screeninfo>Receive shipment button</screeninfo>
34794
34795           <mediaobject>
34796             <imageobject>
34797               <imagedata fileref="images/acquisitions/receivebutton.png"/>
34798             </imageobject>
34799           </mediaobject>
34800         </screenshot>
34801       </section>
34802
34803       <section id="vendorcontracts">
34804         <title>Vendor Contracts</title>
34805
34806         <para>You can define contracts (with a start and end date) and attach
34807         them to a vendor. This is used so that at the end of the year you can
34808         see how much you spent on a specific contract with a vendor. In some
34809         places, contracts are set up with a minimum and maximum yearly
34810         amount.</para>
34811
34812         <section id="addvendorcontract">
34813           <title>Add a Contract</title>
34814
34815           <para>At the top of a Vendor Information Page, you will see a 'New
34816           Contract' button.</para>
34817
34818           <screenshot>
34819             <screeninfo>New Contract Button</screeninfo>
34820
34821             <mediaobject>
34822               <imageobject>
34823                 <imagedata fileref="images/acquisitions/newcontract.png"/>
34824               </imageobject>
34825             </mediaobject>
34826           </screenshot>
34827
34828           <para>The contract form will ask for some very basic information
34829           about the contract</para>
34830
34831           <screenshot>
34832             <screeninfo>New Contract Form</screeninfo>
34833
34834             <mediaobject>
34835               <imageobject>
34836                 <imagedata fileref="images/acquisitions/newcontractform.png"/>
34837               </imageobject>
34838             </mediaobject>
34839           </screenshot>
34840
34841           <important>
34842             <para>You cannot enter a contract retrospectively. The end date
34843             must not be before today's date.</para>
34844           </important>
34845
34846           <para>Once the contract is saved it will appear below the vendor
34847           information.</para>
34848
34849           <screenshot>
34850             <screeninfo>Vendor with contracts</screeninfo>
34851
34852             <mediaobject>
34853               <imageobject>
34854                 <imagedata fileref="images/acquisitions/contractdisplay.png"/>
34855               </imageobject>
34856             </mediaobject>
34857           </screenshot>
34858
34859           <para>It will also be an option when creating a basket</para>
34860
34861           <screenshot>
34862             <screeninfo>Contract Pull Down on New Basket Form</screeninfo>
34863
34864             <mediaobject>
34865               <imageobject>
34866                 <imagedata fileref="images/acquisitions/contractonbasket.png"/>
34867               </imageobject>
34868             </mediaobject>
34869           </screenshot>
34870         </section>
34871       </section>
34872     </section>
34873
34874     <section id="managesuggest">
34875       <title>Managing Suggestions</title>
34876
34877       <para>Purchase suggestions can be generated in one of two ways. You can create suggestions via
34878         the staff client either for the library or <link linkend="patronsuggestions">on the patron's
34879           behalf</link> from their record. Depending on your settings in the <link
34880           linkend="suggestionspref">suggestion</link> system preference, patrons may also be able to
34881         make purchase suggestions via the OPAC. When a suggestion is waiting for library review, it
34882         will appear on the Acquisitions home page under the vendor search.</para>
34883
34884       <screenshot>
34885         <screeninfo>Pending suggestions on Acquisitions</screeninfo>
34886
34887         <mediaobject>
34888           <imageobject>
34889             <imagedata fileref="images/acquisitions/suggestonacq.png"/>
34890           </imageobject>
34891         </mediaobject>
34892       </screenshot>
34893
34894       <para>It will also appear on the main staff dashboard under the module
34895       labels:</para>
34896
34897       <screenshot>
34898         <screeninfo>Pending suggestions on main page</screeninfo>
34899
34900         <mediaobject>
34901           <imageobject>
34902             <imagedata fileref="images/acquisitions/pendingsuggestions.png"/>
34903           </imageobject>
34904         </mediaobject>
34905       </screenshot>
34906
34907       <para>Clicking 'Manage suggestions' will take you to the suggestion
34908       management tool. If there are no pending suggestions you can access the
34909       suggestion management tool by clicking the 'Manage suggestions' link on
34910       the menu on the left of the Acquisitions page.</para>
34911
34912       <screenshot>
34913         <screeninfo>Suggestion Management</screeninfo>
34914
34915         <mediaobject>
34916           <imageobject>
34917             <imagedata fileref="images/acquisitions/suggestmanage.png"/>
34918           </imageobject>
34919         </mediaobject>
34920       </screenshot>
34921
34922       <para>Your suggestions will be sorted into several tabs: Accepted,
34923       Pending, Checked, Ordered and/or Rejected. Each accepted or rejected
34924       suggestion will show the name of the librarian who managed the
34925       suggestion and the reason they gave for accepting or rejecting it (found
34926       under 'Status').</para>
34927       <para>An 'Accepted' suggestion is one that you have marked as 'Accepted' using the form below
34928         the suggestions.  A 'Pending' suggestion is one that is awaiting action from the library.  A
34929         'Checked' suggestion is one that has been marked as 'Checked' using the form before the
34930         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
34931         'Rejected' suggestion is one that you have marked at 'Rejected' using the form below the
34932         list of suggestions.</para>
34933
34934       <para>For libraries with lots of suggestions, there are filters on the
34935       left hand side of the Manage Suggestions page to assist in limiting the
34936       number of titles displayed on the screen.</para>
34937
34938       <screenshot>
34939         <screeninfo>Suggestion Filtering</screeninfo>
34940
34941         <mediaobject>
34942           <imageobject>
34943             <imagedata fileref="images/acquisitions/suggestionsfilters.png"/>
34944           </imageobject>
34945         </mediaobject>
34946       </screenshot>
34947
34948       <para>Clicking on the blue headings will expand the filtering options
34949       and clicking '[clear]' will clear all filters and show all
34950       suggestions.<note>
34951           <para>The suggestions page will automatically be limited to
34952           suggestions for your library. To see information for all (or any
34953           other) libraries click on the 'Acquisition information' filter and
34954           change the library.</para>
34955
34956           <screenshot>
34957             <screeninfo>Branch filter</screeninfo>
34958
34959             <mediaobject>
34960               <imageobject>
34961                 <imagedata fileref="images/acquisitions/suggestbranchfilter.png"/>
34962               </imageobject>
34963             </mediaobject>
34964           </screenshot>
34965         </note></para>
34966
34967       <para>When reviewing 'Pending' suggestions you can choose to check the
34968       box next to the item(s) you want to approve/reject and then choose the
34969       status and reason for your selection. You can also choose to completely
34970       delete the suggestion by checking the 'Delete selected' box.</para>
34971
34972       <screenshot>
34973         <screeninfo>Pending Suggestions</screeninfo>
34974
34975         <mediaobject>
34976           <imageobject>
34977             <imagedata fileref="images/acquisitions/suggestpending.png"/>
34978           </imageobject>
34979         </mediaobject>
34980       </screenshot>
34981
34982       <para>Another option for libraries with long lists of suggestions is to
34983       approve or reject suggestions one by one by clicking on the title of the
34984       suggestion to open a summary of the suggestion, including information if
34985       the item was purchased.</para>
34986
34987       <screenshot>
34988         <screeninfo>Suggestion Information</screeninfo>
34989
34990         <mediaobject>
34991           <imageobject>
34992             <imagedata fileref="images/acquisitions/suggestiondetails.png"/>
34993           </imageobject>
34994         </mediaobject>
34995       </screenshot>
34996
34997       <para>Clicking 'edit' to the right of the suggested title or at the to pof the suggestion
34998         detail page will open a suggestion editing page.</para>
34999
35000       <screenshot>
35001         <screeninfo>Edit Purchase Suggestion</screeninfo>
35002
35003         <mediaobject>
35004           <imageobject>
35005             <imagedata fileref="images/acquisitions/editsuggestion.png"/>
35006           </imageobject>
35007         </mediaobject>
35008       </screenshot>
35009
35010       <para>From this form you can make edits to the suggestion (adding more
35011       details or updating incorrect information provided by the patron). You
35012       can also choose to accept or reject the suggestion on an individual
35013       basis.</para>
35014
35015       <itemizedlist>
35016         <listitem>
35017           <para>Choosing to mark a request as 'Pending' will move the request
35018           back to the 'Pending' tab.</para>
35019         </listitem>
35020       </itemizedlist>
35021
35022       <para>Reasons for accepting and rejecting suggestions are defined by the
35023       <link linkend="suggestauthorized">SUGGEST</link> authorized
35024       value.</para>
35025
35026       <screenshot>
35027         <screeninfo>Reasons for approving or rejecting
35028         suggestions</screeninfo>
35029
35030         <mediaobject>
35031           <imageobject>
35032             <imagedata fileref="images/acquisitions/suggestreasons.png"/>
35033           </imageobject>
35034         </mediaobject>
35035       </screenshot>
35036
35037       <para>If you choose 'Others...' as your reason you will be prompted to
35038       enter your reason in a text box. Clicking 'Cancel' to the right of the
35039       box will bring back the pull down menu with authorized reasons.</para>
35040
35041       <screenshot>
35042         <screeninfo>Enter reason for 'Others...'</screeninfo>
35043
35044         <mediaobject>
35045           <imageobject>
35046             <imagedata fileref="images/acquisitions/suggestothers.png"/>
35047           </imageobject>
35048         </mediaobject>
35049       </screenshot>
35050
35051       <para>Once you have clicked 'Submit' the suggestion will be moved to the
35052       matching tab. The status will also be updated on the patron's account in
35053       the OPAC and an <link linkend="notices">email notice</link> will be sent
35054       to the patron using the template that matches the status you have
35055       chosen.</para>
35056
35057       <screenshot>
35058         <screeninfo>Purchase suggestions in the OPAC</screeninfo>
35059
35060         <mediaobject>
35061           <imageobject>
35062             <imagedata fileref="images/acquisitions/mysuggestions.png"/>
35063           </imageobject>
35064         </mediaobject>
35065       </screenshot>
35066     </section>
35067
35068     <section id="placingacqorder">
35069       <title>Placing Orders</title>
35070
35071       <para>To place an order you must first search for the vendor or
35072       bookseller you want to send the order to.</para>
35073
35074       <section id="createacqbasket">
35075         <title>Create a basket</title>
35076
35077         <para>To create a basket you must first search for the vendor you're
35078         ordering from:</para>
35079
35080         <screenshot>
35081           <screeninfo>New Basket / Add Basket Options</screeninfo>
35082
35083           <mediaobject>
35084             <imageobject>
35085               <imagedata fileref="images/acquisitions/addbasketbutton.png"/>
35086             </imageobject>
35087           </mediaobject>
35088         </screenshot>
35089
35090         <para>And click the 'New basket' button to the right of the vendor name.<note>
35091             <para>You can also add to an existing basket by clicking the 'Add to basket' link to the
35092               far right of each basket's information in the results table. </para>
35093           </note></para>
35094         <para>After clicking 'New basket' you will be asked to enter some information about the
35095           order:</para>
35096
35097         <screenshot>
35098           <screeninfo>Add Basket Form</screeninfo>
35099
35100           <mediaobject>
35101             <imageobject>
35102               <imagedata fileref="images/acquisitions/addbasket.png"/>
35103             </imageobject>
35104           </mediaobject>
35105         </screenshot>
35106
35107         <itemizedlist>
35108           <listitem>
35109             <para>When adding a basket you want to give it a name that will
35110             help you identify it later</para>
35111           </listitem>
35112
35113           <listitem>
35114             <para>Enter in the Billing Place and Delivery Place (this will
35115             default the library you're logged in at)</para>
35116           </listitem>
35117
35118           <listitem>
35119             <para>If you would like to change the vendor you're ordering from
35120             you can use the Vendor pull down menu</para>
35121           </listitem>
35122
35123           <listitem>
35124             <para>The notes fields are optional and can contain any type of
35125             information</para>
35126           </listitem>
35127         </itemizedlist>
35128
35129         <para>If you have <link linkend="addvendorcontract">added
35130         contracts</link> to the vendor you're ordering from, you will also
35131         have an option to choose which contract you're ordering these items
35132         under.</para>
35133
35134         <screenshot>
35135           <screeninfo>Basket with contract options</screeninfo>
35136
35137           <mediaobject>
35138             <imageobject>
35139               <imagedata fileref="images/acquisitions/basketwithcontracts.png"/>
35140             </imageobject>
35141           </mediaobject>
35142         </screenshot>
35143
35144         <para>When finished, click 'Save'</para>
35145
35146         <screenshot>
35147           <screeninfo>New Empty Basket</screeninfo>
35148
35149           <mediaobject>
35150             <imageobject>
35151               <imagedata fileref="images/acquisitions/basket.png"/>
35152             </imageobject>
35153           </mediaobject>
35154         </screenshot>
35155
35156         <para>Once your basket is created you are presented with several
35157         options for adding items to the order.</para>
35158
35159         <itemizedlist>
35160           <listitem>
35161             <para>If you are ordering another copy of an existing item, you
35162             can simply search for the record in your system.</para>
35163
35164             <screenshot>
35165               <screeninfo>Search for existing records</screeninfo>
35166
35167               <mediaobject>
35168                 <imageobject>
35169                   <imagedata fileref="images/acquisitions/orderfromexisting.png"/>
35170                 </imageobject>
35171               </mediaobject>
35172             </screenshot>
35173
35174             <itemizedlist>
35175               <listitem>
35176                 <para>From the results, simply click 'Order' to be brought to
35177                 the order form.</para>
35178
35179                 <screenshot>
35180                   <screeninfo>Order form</screeninfo>
35181
35182                   <mediaobject>
35183                     <imageobject>
35184                       <imagedata fileref="images/acquisitions/existingitemorder.png"/>
35185                     </imageobject>
35186                   </mediaobject>
35187                 </screenshot>
35188
35189                 <itemizedlist>
35190                   <listitem>
35191                     <para>All of the details associated with the item will
35192                     already be listed under 'Catalog details.'</para>
35193                   </listitem>
35194                 </itemizedlist>
35195               </listitem>
35196             </itemizedlist>
35197           </listitem>
35198
35199           <listitem id="orderfromsuggestion">
35200             <para>If you allow patrons to make purchase suggestions (learn more in the <link linkend="managesuggest">Managing Suggestions</link> section of this manual), then
35201               you can place orders from those suggestions. In order to keep track of suggestions
35202               that have been ordered and received you must place the order using this link.  </para>
35203             <screenshot>
35204               <screeninfo>Approved Suggestions to Order From</screeninfo>
35205               <mediaobject>
35206                 <imageobject>
35207                   <imagedata fileref="images/acquisitions/orderfromsuggest.png"/>
35208                 </imageobject>
35209               </mediaobject>
35210             </screenshot>
35211             <itemizedlist>
35212               <listitem>
35213                 <para>From the results, click 'Order' next to the item you want to order and you
35214                   will be presented with the order form including a link to the suggestion</para>
35215                 <screenshot>
35216                   <screeninfo>Order from a Suggestion</screeninfo>
35217                   <mediaobject>
35218                     <imageobject>
35219                       <imagedata fileref="images/acquisitions/orderfromsuggestform.png"/>
35220                     </imageobject>
35221                   </mediaobject>
35222                 </screenshot>
35223                 <itemizedlist>
35224                   <listitem>
35225                     <para>From this form you can make changes to the Catalog Details if
35226                       necessary.</para>
35227                   </listitem>
35228                   <listitem>
35229                     <para>When the item appears in your basket it will include a link to the
35230                       suggestion.</para>
35231                     <screenshot>
35232                       <screeninfo>Suggestion Link in basket</screeninfo>
35233                       <mediaobject>
35234                         <imageobject>
35235                           <imagedata fileref="images/acquisitions/ordersuggestlink.png"/>
35236                         </imageobject>
35237                       </mediaobject>
35238                     </screenshot>
35239                   </listitem>
35240                 </itemizedlist>
35241               </listitem>
35242               <listitem>
35243                 <para>Orders added to the basket in this way will notify the patron via email that
35244                   their suggestion has been ordered and will update the patron's '<link linkend="opacmysuggestions">My purchase suggestions</link>' page in the
35245                   OPAC.</para>
35246               </listitem>
35247             </itemizedlist>
35248           </listitem>
35249           <listitem id="ordersubscription">
35250             <para>If you're using the <link linkend="serials">Serials</link> module you can link
35251               your subscription order information to acquisitions by choosing to order 'From a susbscription'<itemizedlist>
35252                 <listitem>
35253                   <para>After clicking the order link you will be brought to a search page that will
35254                     help you find your subscription</para>
35255                   <screenshot>
35256                       <screeninfo>Subscription order search</screeninfo>
35257                       <mediaobject>
35258                         <imageobject>
35259                           <imagedata fileref="images/acquisitions/subordersearch.png"/>
35260                         </imageobject>
35261                       </mediaobject>
35262                     </screenshot>
35263                 </listitem>
35264                 <listitem>
35265                   <para>Your results will appear to the right of the form and each subscription will
35266                     have an 'Order' link to the right</para>
35267                   <screenshot>
35268                       <screeninfo>Subscription results</screeninfo>
35269                       <mediaobject>
35270                         <imageobject>
35271                           <imagedata fileref="images/acquisitions/suborderresults.png"/>
35272                         </imageobject>
35273                       </mediaobject>
35274                     </screenshot>
35275                 </listitem>
35276                 <listitem>
35277                   <para>Clicking 'Order' will bring the subscription info in to the order form
35278                     without an 'Add item' section since you are just ordering a subscription and an
35279                     item isn't needed</para>
35280                   <screenshot>
35281                       <screeninfo>Order from subscription</screeninfo>
35282                       <mediaobject>
35283                         <imageobject>
35284                           <imagedata fileref="images/acquisitions/suborder.png"/>
35285                         </imageobject>
35286                       </mediaobject>
35287                     </screenshot>
35288                 </listitem>
35289               </itemizedlist></para>
35290           </listitem>
35291
35292           <listitem>
35293             <para>To order from a record that can't be found anywhere else,
35294             choose the 'From a new (empty) record.'</para>
35295
35296             <screenshot>
35297               <screeninfo>Order a new record</screeninfo>
35298
35299               <mediaobject>
35300                 <imageobject>
35301                   <imagedata fileref="images/acquisitions/fromnewemptyrecord.png"/>
35302                 </imageobject>
35303               </mediaobject>
35304             </screenshot>
35305
35306             <itemizedlist>
35307               <listitem>
35308                 <para>You will be presented with an empty form to fill in all
35309                 of the necessary details about the item you are
35310                 ordering.</para>
35311               </listitem>
35312             </itemizedlist>
35313           </listitem>
35314
35315           <listitem>
35316             <para>If you want to search other libraries for an item to
35317             purchase, you can use the 'From an external source' option that
35318             will allow you to order from a MARC record found via a Z39.50
35319             search.</para>
35320
35321             <screenshot>
35322               <screeninfo>Search for record to add</screeninfo>
35323
35324               <mediaobject>
35325                 <imageobject>
35326                   <imagedata fileref="images/acquisitions/orderz39.png"/>
35327                 </imageobject>
35328               </mediaobject>
35329             </screenshot>
35330
35331             <itemizedlist>
35332               <listitem>
35333                 <para>From the results, click the Order link next to the item
35334                 you want to purchase.</para>
35335
35336                 <screenshot>
35337                   <screeninfo>Search Results to Order From</screeninfo>
35338
35339                   <mediaobject>
35340                     <imageobject>
35341                       <imagedata fileref="images/acquisitions/orderz39results.png"/>
35342                     </imageobject>
35343                   </mediaobject>
35344                 </screenshot>
35345               </listitem>
35346
35347               <listitem>
35348                 <para>If the item you're ordering from an external source
35349                 looks like it might be a duplicate, Koha will warn you and
35350                 give you options on how to proceed.</para>
35351
35352                 <screenshot>
35353                   <screeninfo>Duplicate order warning</screeninfo>
35354
35355                   <mediaobject>
35356                     <imageobject>
35357                       <imagedata fileref="images/acquisitions/dupwarning.png"/>
35358                     </imageobject>
35359                   </mediaobject>
35360                 </screenshot>
35361
35362                 <itemizedlist>
35363                   <listitem>
35364                     <para>From the warning, you can choose to order another
35365                     copy on the existing bib record, create a new bib record,
35366                     or cancel your order of this item.</para>
35367                   </listitem>
35368                 </itemizedlist>
35369               </listitem>
35370
35371               <listitem>
35372                 <para>In the order form that pops up, you will not be able to
35373                 edit the catalog details.</para>
35374
35375                 <screenshot>
35376                   <screeninfo>New order from Z39.50 Search</screeninfo>
35377
35378                   <mediaobject>
35379                     <imageobject>
35380                       <imagedata fileref="images/acquisitions/orderz39form.png"/>
35381                     </imageobject>
35382                   </mediaobject>
35383                 </screenshot>
35384               </listitem>
35385             </itemizedlist>
35386           </listitem>
35387
35388           <listitem id="orderfromstagedfile">
35389             <para>The next option for ordering is to order from a staged record (<link
35390                 linkend="stagemarc">learn more about staging records</link>).</para>
35391             <screenshot>
35392               <screeninfo>Staged Files to Order From</screeninfo>
35393               <mediaobject>
35394                 <imageobject>
35395                   <imagedata fileref="images/acquisitions/stagedfiles.png"/>
35396                 </imageobject>
35397               </mediaobject>
35398             </screenshot>
35399             <itemizedlist>
35400               <listitem>
35401                 <para>From the list of files you are presented with, choose the 'Add orders' link to
35402                   add the records in the staged file to your order. <screenshot>
35403                     <screeninfo>Staged records</screeninfo>
35404                     <mediaobject>
35405                       <imageobject>
35406                         <imagedata fileref="images/acquisitions/importallstaged.png"/>
35407                       </imageobject>
35408                     </mediaobject>
35409                   </screenshot></para>
35410               </listitem>
35411               <listitem>
35412                 <para>Next to each title is a checkbox, check the items you would like to order, or
35413                   choose 'Check all' at the top. Depending on your settings in the <link
35414                     linkend="MarcFieldsToOrder">MarcFieldsToOrder</link> preference Koha will
35415                   populate the next screen with with the relevant Quantity, Price, Fund, Statistic
35416                   1, and Statistic 2 found within the staged file.<screenshot>
35417                     <screeninfo>Add orders from staged file</screeninfo>
35418                     <mediaobject>
35419                       <imageobject>
35420                         <imagedata fileref="images/acquisitions/selecttoimport.png"/>
35421                       </imageobject>
35422                     </mediaobject>
35423                   </screenshot></para>
35424               </listitem>
35425               <listitem>
35426                 <para>In the 'Item Information' tab you can enter information that will be added to
35427                   every ordered item such as item type, collection code and not for loan status.<screenshot>
35428                     <screeninfo>Item information</screeninfo>
35429                     <mediaobject>
35430                       <imageobject>
35431                         <imagedata fileref="images/acquisitions/itemfromstaged.png"/>
35432                       </imageobject>
35433                     </mediaobject>
35434                   </screenshot></para>
35435               </listitem>
35436               <listitem>
35437                 <para>If no information is imported from the MARC record regarding fund information
35438                   the 'Default accounting details' tab can be used to apply values related to the accounting.<screenshot>
35439                     <screeninfo>Accounting details</screeninfo>
35440                     <mediaobject>
35441                       <imageobject>
35442                         <imagedata fileref="images/acquisitions/stagedaccounting.png"/>
35443                       </imageobject>
35444                     </mediaobject>
35445                   </screenshot></para>
35446               </listitem>
35447             </itemizedlist>
35448           </listitem>
35449           <listitem>
35450             <para>The final option for ordering is to order from a list of titles with the highest
35451               hold ratios<itemizedlist>
35452                 <listitem>
35453                   <para>This option will take you to the Holds Ratio report where you can find items
35454                     with a high hold ratio and order additional copies.  Next to each title will be
35455                     a link with the number of items to order, click that and it will add the item to
35456                     your basket.<screenshot>
35457                       <screeninfo>Holds Ratio Order</screeninfo>
35458                       <mediaobject>
35459                         <imageobject>
35460                           <imagedata fileref="images/acquisitions/highestholdratio.png"/>
35461                         </imageobject>
35462                       </mediaobject>
35463                     </screenshot></para>
35464                 </listitem>
35465               </itemizedlist></para>
35466           </listitem>
35467         </itemizedlist>
35468
35469         <para>After bringing in the bib information (for all import methods except for the staged
35470           file), if your <link linkend="AcqCreateItem">AcqCreateItem</link> system preference is set
35471           to add an item when ordering you will enter the item info next. You need to fill out at
35472           least one item record and then click the 'Add' button at the bottom left of the item
35473           form.</para>
35474
35475         <screenshot>
35476           <screeninfo>Item order</screeninfo>
35477
35478           <mediaobject>
35479             <imageobject>
35480               <imagedata fileref="images/acquisitions/itemonorder.png"/>
35481             </imageobject>
35482           </mediaobject>
35483         </screenshot>
35484
35485         <para>After clicking the 'Add item' button below the item record the item will appear above
35486           the form and then you can enter your next item the same way (if ordering more than one
35487           item).</para>
35488
35489         <screenshot>
35490           <screeninfo>Item ordered</screeninfo>
35491
35492           <mediaobject>
35493             <imageobject>
35494               <imagedata fileref="images/acquisitions/itemonorderadded.png"/>
35495             </imageobject>
35496           </mediaobject>
35497         </screenshot>
35498
35499         <para>Once you have entered the info about the item, you need to enter
35500         the Accounting information.</para>
35501
35502         <screenshot>
35503           <screeninfo>Accounting Details</screeninfo>
35504
35505           <mediaobject>
35506             <imageobject>
35507               <imagedata fileref="images/acquisitions/accounting.png"/>
35508             </imageobject>
35509           </mediaobject>
35510         </screenshot>
35511
35512         <itemizedlist>
35513           <listitem>
35514             <para>Quantity is populated by the number of items you've added to the order above.<itemizedlist>
35515                 <listitem>
35516                   <important>
35517                     <para>You cannot edit the quantity manually, you must click 'Add' below the item
35518                       form to add as many items as you're ordering.</para>
35519                   </important>
35520                 </listitem>
35521               </itemizedlist></para>
35522           </listitem>
35523
35524           <listitem>
35525             <para>The list of funds is populated by the <link linkend="funds">funds</link> you have assigned in the Acquisitions
35526             Administration area.</para>
35527           </listitem>
35528
35529           <listitem>
35530             <para>The currency pull down will have the <link linkend="currexchangeadmin">currencies</link> you set up in the
35531             <link linkend="acqadmin">Acquisitions Administration</link>
35532             area.</para>
35533           </listitem>
35534
35535           <listitem>
35536             <para>The vendor price is the price before any taxes or discounts
35537             are applied.</para>
35538           </listitem>
35539
35540           <listitem>
35541             <para>If the price is uncertain, check the uncertain price
35542             box.</para>
35543
35544             <itemizedlist>
35545               <listitem>
35546                 <para>A basket with at least one uncertain price can't be
35547                 closed.</para>
35548               </listitem>
35549             </itemizedlist>
35550           </listitem>
35551
35552           <listitem>
35553             <para>If you are charged sales tax, choose that from the gstrate
35554             field</para>
35555           </listitem>
35556
35557           <listitem>
35558             <para>Enter the percentage discount you're receiving on this
35559             order, once you enter this, hit tab and Koha will populate the
35560             rest of the cost fields below.</para>
35561           </listitem>
35562
35563           <listitem>
35564             <para>If you added Planning Values when <link linkend="addbudgetfund">creating the Fund</link>, those values
35565             will appear in the two Planning Value fields.</para>
35566           </listitem>
35567         </itemizedlist>
35568         <para>Once you have filled in all of the fields click 'Save' to add the item to your basket.
35569           If your price goes over the amount availalbe in the fund you will be presented with a
35570           confirmation.</para>
35571         <screenshot>
35572           <screeninfo>Fund warning</screeninfo>
35573           <mediaobject>
35574             <imageobject>
35575               <imagedata fileref="images/acquisitions/fundconfirmation.png"/>
35576             </imageobject>
35577           </mediaobject>
35578         </screenshot>
35579         <para>The confirmation warning will allow you order past your fund amount if you so
35580           choose.</para>
35581
35582         <para>After an item is added to the basket you will be presented with a basket
35583           summary.</para>
35584
35585         <screenshot>
35586           <screeninfo>Basket with item info</screeninfo>
35587
35588           <mediaobject>
35589             <imageobject>
35590               <imagedata fileref="images/acquisitions/finalbasket.png"/>
35591             </imageobject>
35592           </mediaobject>
35593         </screenshot>
35594
35595         <para>If you would like to see more details you can check the 'Show
35596         all details' checkbox</para>
35597
35598         <screenshot>
35599           <screeninfo>Show all details</screeninfo>
35600
35601           <mediaobject>
35602             <imageobject>
35603               <imagedata fileref="images/acquisitions/showalldetails.png"/>
35604             </imageobject>
35605           </mediaobject>
35606         </screenshot>
35607
35608         <para>From here, you can edit or remove the items that you have
35609         added.</para>
35610
35611         <itemizedlist>
35612           <listitem>
35613             <para>Choosing to 'Delete the order' will delete the order line
35614             but leave the record in the catalog.</para>
35615           </listitem>
35616
35617           <listitem>
35618             <para>Choosing to 'Delete order and catalog record' removes both
35619             the order line and the record in the catalog.</para>
35620
35621             <itemizedlist>
35622               <listitem>
35623                 <para>The catalog record cannot always be deleted. You might
35624                 see notes explaining why.</para>
35625
35626                 <screenshot>
35627                   <screeninfo>Can't delete order line</screeninfo>
35628
35629                   <mediaobject>
35630                     <imageobject>
35631                       <imagedata fileref="images/acquisitions/cantdeleteorderline.png"/>
35632                     </imageobject>
35633                   </mediaobject>
35634                 </screenshot>
35635               </listitem>
35636             </itemizedlist>
35637           </listitem>
35638         </itemizedlist>
35639
35640         <para>On the summary page, you also have the option to edit the
35641         information that you entered about the basket by clicking the 'Edit
35642         basket header information' button, to delete the basket altogether by
35643         clicking the 'Delete this basket' button, or to export your basket as
35644         a CSV file by clicking the 'Export this basket as CSV' button.</para>
35645
35646         <screenshot>
35647           <screeninfo>Basket Buttons</screeninfo>
35648
35649           <mediaobject>
35650             <imageobject>
35651               <imagedata fileref="images/acquisitions/basketbuttons.png"/>
35652             </imageobject>
35653           </mediaobject>
35654         </screenshot>
35655
35656         <para>Once you're sure your basket is complete, you can click 'Close this basket' button to
35657           indicate that this basket is complete and has been sent to the vendor. </para>
35658         <important>
35659           <para>You must close the basket to be able to <link linkend="receiveacqorder">receive
35660               items</link> when they arrive.  Only items in closed baskets will show as ready to
35661             receive.</para>
35662         </important>
35663         <para>If you have your <link linkend="BasketConfirmations">BasketConfirmations</link>
35664           preference set to show a confirmation, you will be asked if you are sure about closing the
35665           basket.</para>
35666
35667         <screenshot>
35668           <screeninfo>Basket Closure Confirmation</screeninfo>
35669
35670           <mediaobject>
35671             <imageobject>
35672               <imagedata fileref="images/acquisitions/BasketConfirmations.png"/>
35673             </imageobject>
35674           </mediaobject>
35675         </screenshot>
35676
35677         <para>When closing the basket you can choose to add the basket to a group for easy printing
35678           and retrieval. If you check the box to 'Attach this basket to a new basket group' you will
35679           be brought to the group list where you can print a PDF of the order.</para>
35680
35681         <screenshot>
35682           <screeninfo>Closed Baskets</screeninfo>
35683
35684           <mediaobject>
35685             <imageobject>
35686               <imagedata fileref="images/acquisitions/basketgroup.png"/>
35687             </imageobject>
35688           </mediaobject>
35689         </screenshot>
35690
35691         <para><important>
35692             <para>A basket with at least one item marked as 'uncertain price'
35693             will not be able to be closed.</para>
35694
35695             <screenshot>
35696               <screeninfo>A basket with items where the price is
35697               uncertain</screeninfo>
35698
35699               <mediaobject>
35700                 <imageobject>
35701                   <imagedata fileref="images/acquisitions/basketuncertain.png"/>
35702                 </imageobject>
35703               </mediaobject>
35704             </screenshot>
35705           </important></para>
35706
35707         <para>Clicking the 'Uncertain Prices' button will call up a list of
35708         items with uncertain prices to quick editing. From that list, you can
35709         quickly edit the items by entering new prices and quantities.</para>
35710
35711         <screenshot>
35712           <screeninfo>Uncertain Prices</screeninfo>
35713
35714           <mediaobject>
35715             <imageobject>
35716               <imagedata fileref="images/acquisitions/uncertainprices.png"/>
35717             </imageobject>
35718           </mediaobject>
35719         </screenshot>
35720
35721         <important>
35722           <para>The Uncertain Prices page is independent of the basket. It is
35723           linked to the vendor so you will see all items on order with
35724           uncertain prices for that vendor.</para>
35725         </important>
35726         <para>Once your order is entered you can search for it through acquisitions or view the
35727           information on the biblio detail page in the staff client (if the <link
35728             linkend="AcquisitionDetails">AcquisitionDetails</link> preference is set to 'Display).<screenshot>
35729             <screeninfo>Acquisitions details</screeninfo>
35730             <mediaobject>
35731               <imageobject>
35732                 <imagedata fileref="images/acquisitions/AcquisitionDetails.png"/>
35733               </imageobject>
35734             </mediaobject>
35735           </screenshot></para>
35736       </section>
35737
35738       <section id="acqbasketgroup">
35739         <title>Create a basket group</title>
35740
35741         <para>A basket group is simply a group of baskets. In some libraries,
35742         you have several staff members that create baskets, and, at the end of
35743         a period of time, someone then groups them together to send to the
35744         vendor in bulk. That said, it is possible to have one basket in a
35745         basket group if that's the workflow used in your library.</para>
35746       </section>
35747
35748       <section id="printacqbasket">
35749         <title>Printing baskets</title>
35750
35751         <para>When you are finished adding items to your basket, click 'Close
35752         this Basket.'</para>
35753
35754         <screenshot>
35755           <screeninfo>Close Basket</screeninfo>
35756
35757           <mediaobject>
35758             <imageobject>
35759               <imagedata fileref="images/acquisitions/closebasket.png"/>
35760             </imageobject>
35761           </mediaobject>
35762         </screenshot>
35763
35764         <para>You will be asked if you want to 'Attach this basket to a new basket group with the
35765           same name'. A basket group is necessary if you want to be able to print PDFs of your
35766           orders.</para>
35767
35768         <screenshot>
35769           <screeninfo>Create Purchase Order</screeninfo>
35770
35771           <mediaobject>
35772             <imageobject>
35773               <imagedata fileref="images/acquisitions/createpurchaseorder.png"/>
35774             </imageobject>
35775           </mediaobject>
35776         </screenshot>
35777
35778         <para>Your completed order will be listed on the Basket Grouping page
35779         for printing or further modification.</para>
35780
35781         <screenshot>
35782           <screeninfo>Basket Grouping</screeninfo>
35783
35784           <mediaobject>
35785             <imageobject>
35786               <imagedata fileref="images/acquisitions/basketgroup.png"/>
35787             </imageobject>
35788           </mediaobject>
35789         </screenshot>
35790
35791         <para>Clicking the 'Print' button next to your order will generate a PDF for printing, which
35792           will have all of your library information followed by the items in your order.</para>
35793
35794         <screenshot>
35795           <screeninfo>Order found on PDF</screeninfo>
35796
35797           <mediaobject>
35798             <imageobject>
35799               <imagedata fileref="images/acquisitions/pdforder.png"/>
35800             </imageobject>
35801           </mediaobject>
35802         </screenshot>
35803       </section>
35804     </section>
35805
35806     <section id="receiveacqorder">
35807       <title>Receiving Orders</title>
35808       <important>
35809         <para>You must close the basket to be able to <link linkend="receiveacqorder">receive
35810             items</link> when they arrive.  Only items in closed baskets will show as ready to
35811           receive.</para>
35812       </important>
35813
35814       <para>Orders can be received from the vendor information page</para>
35815
35816       <screenshot>
35817         <screeninfo>Receive from Vendor Information</screeninfo>
35818
35819         <mediaobject>
35820           <imageobject>
35821             <imagedata fileref="images/acquisitions/receivebutton.png"/>
35822           </imageobject>
35823         </mediaobject>
35824       </screenshot>
35825
35826       <para>or the vendor search results page</para>
35827
35828       <screenshot>
35829         <screeninfo>Vendor Search Results</screeninfo>
35830
35831         <mediaobject>
35832           <imageobject>
35833             <imagedata fileref="images/acquisitions/receivefromsearch.png"/>
35834           </imageobject>
35835         </mediaobject>
35836       </screenshot>
35837
35838       <para>After clicking 'Receive shipment' you will be asked to enter a vendor invoice number, a
35839         shipment received date, a shipping cost and a budget to subtract that shipping amount
35840         from.</para>
35841
35842       <screenshot>
35843         <screeninfo>Receive Shipment</screeninfo>
35844
35845         <mediaobject>
35846           <imageobject>
35847             <imagedata fileref="images/acquisitions/receive.png"/>
35848           </imageobject>
35849         </mediaobject>
35850       </screenshot>
35851
35852       <para>The receive page will list all items still on order with the
35853       vendor regardless of the basket the item is from.</para>
35854
35855       <screenshot>
35856         <screeninfo>Receipt Summary</screeninfo>
35857
35858         <mediaobject>
35859           <imageobject>
35860             <imagedata fileref="images/acquisitions/receiptsummary.png"/>
35861           </imageobject>
35862         </mediaobject>
35863       </screenshot>
35864
35865       <para>To receive a specific item, click the 'Receive' link to the right
35866       of the item.</para>
35867
35868       <screenshot>
35869         <screeninfo>Receive Item Form</screeninfo>
35870
35871         <mediaobject>
35872           <imageobject>
35873             <imagedata fileref="images/acquisitions/receiveitem.png"/>
35874           </imageobject>
35875         </mediaobject>
35876       </screenshot>
35877
35878       <para>From this form you can alter the cost information. You can also
35879       choose to mark only part of the order as received if the vendor didn't
35880       send your entire order by checking only the boxes next to the items on
35881       the left that you want to receive. The values you enter in the
35882       'Replacement cost' and 'Actual cost' will automatically populate the
35883       item record by filling in subfield v (Cost, replacement price) and
35884       subfield g (Cost, normal purchase price) on the item record after
35885       saving.</para>
35886
35887       <screenshot>
35888         <screeninfo>Item record after receipt</screeninfo>
35889
35890         <mediaobject>
35891           <imageobject>
35892             <imagedata fileref="images/acquisitions/receiveditem.png"/>
35893           </imageobject>
35894         </mediaobject>
35895       </screenshot>
35896
35897       <para>You can also make edits to the item record from this form by clicking the 'Edit' link
35898         next to each item. This will allow you to enter in accurate call numbers and barcodes if
35899         you'd like to do that at the point of receipt. Once you have made any changes necessary (to
35900         the order and/or items, click 'Save' to mark the item(s) as received.<note>
35901           <para>If you have your <link linkend="AcqItemSetSubfieldsWhenReceived"
35902               >AcqItemSetSubfieldsWhenReceived</link> preference set to add or change values on
35903             received items those changes will take place after you hit 'Save'. </para>
35904         </note></para>
35905
35906       <screenshot>
35907         <screeninfo>Already Received Items</screeninfo>
35908
35909         <mediaobject>
35910           <imageobject>
35911             <imagedata fileref="images/acquisitions/received.png"/>
35912           </imageobject>
35913         </mediaobject>
35914       </screenshot>
35915       <para>If the item is no longer available from this vendor you can transfer the order to
35916         another vendor's basket by clicking the 'Transfer' link to the right of the title. This will
35917         pop up a vendor search box.</para>
35918       <screenshot>
35919         <screeninfo>Transfer search</screeninfo>
35920         <mediaobject>
35921           <imageobject>
35922             <imagedata fileref="images/acquisitions/transfersearch.png"/>
35923           </imageobject>
35924         </mediaobject>
35925       </screenshot>
35926       <para>From the results you can click 'Choose' to the right of the vendor you would like to
35927         reorder this item from.</para>
35928       <screenshot>
35929         <screeninfo>Transfer vendor</screeninfo>
35930         <mediaobject>
35931           <imageobject>
35932             <imagedata fileref="images/acquisitions/transfervendor.png"/>
35933           </imageobject>
35934         </mediaobject>
35935       </screenshot>
35936       <para>You will then be presented with the open baskets for that vendor to choose from. To move
35937         the item simply click 'Choose' to the right of the basket you would like to add the item
35938         to.</para>
35939       <screenshot>
35940         <screeninfo>Basket choice</screeninfo>
35941         <mediaobject>
35942           <imageobject>
35943             <imagedata fileref="images/acquisitions/transferbasket.png"/>
35944           </imageobject>
35945         </mediaobject>
35946       </screenshot>
35947       <para>Once you have chosen you will be presented with a confirmation message.</para>
35948       <screenshot>
35949         <screeninfo>Confirm transfer</screeninfo>
35950         <mediaobject>
35951           <imageobject>
35952             <imagedata fileref="images/acquisitions/transferconfirm.png"/>
35953           </imageobject>
35954         </mediaobject>
35955       </screenshot>
35956
35957       <para>When you're finished receiving items you can navigate away from
35958       this page or click the 'Finish receiving' button at the bottom of the
35959       screen.</para>
35960       <para>If the item cannot be found anywhere you can cancel the order by clicking 'Delete order'
35961         to the far right.  This will prompt you to enter your reason and confirm cancellation.<screenshot>
35962           <screeninfo>Cancel order</screeninfo>
35963           <mediaobject>
35964             <imageobject>
35965               <imagedata fileref="images/acquisitions/cancelorder.png"/>
35966             </imageobject>
35967           </mediaobject>
35968         </screenshot></para>
35969
35970       <para>You will also see that the item is received and/or cancelled if
35971       you view the basket.</para>
35972
35973       <screenshot>
35974         <screeninfo>One item marked (rcvd) in basket</screeninfo>
35975
35976         <mediaobject>
35977           <imageobject>
35978             <imagedata fileref="images/acquisitions/basketwithreceived.png"/>
35979           </imageobject>
35980         </mediaobject>
35981       </screenshot>
35982     </section>
35983     <section id="acqinvoices">
35984       <title>Invoices</title>
35985       <para>When orders are received invoices are generated.  Invoices can be searched by clicking
35986         on 'Invoices' in the left of the Acquisitions page.</para>
35987       <screenshot>
35988           <screeninfo>Invoices page</screeninfo>
35989           <mediaobject>
35990             <imageobject>
35991               <imagedata fileref="images/acquisitions/invoicesearch.png"/>
35992             </imageobject>
35993           </mediaobject>
35994         </screenshot>
35995       <para>After searching, your results will appear to the right of the search options.</para>
35996       <screenshot>
35997         <screeninfo>Invoice search results</screeninfo>
35998         <mediaobject>
35999           <imageobject>
36000             <imagedata fileref="images/acquisitions/invoices.png"/>
36001           </imageobject>
36002         </mediaobject>
36003       </screenshot>
36004       <para>From the results you can click the 'Details' link to see the full invoice or 'Close' to
36005         note that the invoice is closed/paid for.</para>
36006       <screenshot>
36007         <screeninfo>Invoice details</screeninfo>
36008         <mediaobject>
36009           <imageobject>
36010             <imagedata fileref="images/acquisitions/invoice.png"/>
36011           </imageobject>
36012         </mediaobject>
36013       </screenshot>
36014       <para>If you're allowing the uploading of acquisitions files with the <link
36015           linkend="AcqEnableFiles">AcqEnableFiles</link> preference you will see the option to
36016         manage invoice files next to the link to 'Go to receipt page'<screenshot>
36017           <screeninfo>AcqEnableFiles</screeninfo>
36018           <mediaobject>
36019             <imageobject>
36020               <imagedata fileref="images/acquisitions/AcqEnableFiles.png"/>
36021             </imageobject>
36022           </mediaobject>
36023         </screenshot></para>
36024       <para>To see or attach new files click the 'Manage invoice files' link</para>
36025       <screenshot>
36026         <screeninfo>No invoice files</screeninfo>
36027         <mediaobject>
36028           <imageobject>
36029             <imagedata fileref="images/acquisitions/noinvoicefiles.png"/>
36030           </imageobject>
36031         </mediaobject>
36032       </screenshot>
36033       <para>From here you can find a file to upload and/or see the files you have already
36034         attached.</para>
36035       <screenshot>
36036         <screeninfo>Invoice files</screeninfo>
36037         <mediaobject>
36038           <imageobject>
36039             <imagedata fileref="images/acquisitions/invoicefiles.png"/>
36040           </imageobject>
36041         </mediaobject>
36042       </screenshot>
36043       <para>From the invoice search results you can also merge together two invoices should you need
36044         to. Simply click the checkbox to the left of the invoices you would like to merge and click
36045         the 'Merge selected invoices' button at the bottom of the page. You will be presented with a
36046         confirmation screen:</para>
36047       <screenshot>
36048         <screeninfo>Merge invoices</screeninfo>
36049         <mediaobject>
36050           <imageobject>
36051             <imagedata fileref="images/acquisitions/mergeinvoices.png"/>
36052           </imageobject>
36053         </mediaobject>
36054       </screenshot>
36055       <para>Click on the row of the invoice number you would like to keep and it will be highlighted
36056         in yellow.  Enter any different billing information in the fields provided and click
36057         'Merge'. The two invoices will become one.</para>
36058     </section>
36059
36060     <section id="acqclaims">
36061       <title>Claims &amp; Late Orders</title>
36062
36063       <para>If you have entered in an email address for the vendors in your
36064       system you can send them claim emails when an order is late. Before you
36065       can send claims you will need to set up an <link linkend="ACQCLAIM">acquisitions claim notice</link>.</para>
36066
36067       <para>Upon clicking on the link to 'Late Orders' from the Acquisitions
36068       page you will be presented with a series of filter options on the left
36069       hand side. These filters will be applied only closed baskets.</para>
36070
36071       <screenshot>
36072         <screeninfo>Acquisitions Late Order Filters</screeninfo>
36073
36074         <mediaobject>
36075           <imageobject>
36076             <imagedata fileref="images/acquisitions/acqclaimfilter.png"/>
36077           </imageobject>
36078         </mediaobject>
36079       </screenshot>
36080
36081       <note>
36082         <para>The vendor pull down only shows vendors with closed baskets that
36083         are late.</para>
36084       </note>
36085
36086       <para>Once you filter your orders to show you the things you consider to
36087       be late you will be presented with a list of these items.</para>
36088
36089       <screenshot>
36090         <screeninfo>Late Orders</screeninfo>
36091
36092         <mediaobject>
36093           <imageobject>
36094             <imagedata fileref="images/acquisitions/lateorders.png"/>
36095           </imageobject>
36096         </mediaobject>
36097       </screenshot>
36098
36099       <para>To the right of each late title you will be see a checkbox. Check
36100       off the ones you want a claim letter sent to and click 'Claim Order' at
36101       the bottom right of the list. This will automatically send an email to
36102       the vendor at the email address you have on file.<note>
36103           <para>The Estimated Delivery Date is based on the Delivery time
36104           value entered on the vendor record.</para>
36105         </note></para>
36106
36107       <para>If you would rather use a different acquisition claim letter
36108       (other than the default) you can <link linkend="addnotices">create that
36109       in the notices module</link> and choose it from the menu above the list
36110       of late items.</para>
36111
36112       <screenshot>
36113         <screeninfo>Choose a Claim Letter</screeninfo>
36114
36115         <mediaobject>
36116           <imageobject>
36117             <imagedata fileref="images/acquisitions/claimletter.png"/>
36118           </imageobject>
36119         </mediaobject>
36120       </screenshot>
36121     </section>
36122
36123     <section id="acqsearch">
36124       <title>Acquisition Searches</title>
36125
36126       <para>At the top of the various Acquisition pages there is a quick
36127       search box where you can perform either a Vendor Search or an Order
36128       Search.</para>
36129
36130       <screenshot>
36131         <screeninfo>Acquisition Searches</screeninfo>
36132
36133         <mediaobject>
36134           <imageobject>
36135             <imagedata fileref="images/acquisitions/acqsearches.png"/>
36136           </imageobject>
36137         </mediaobject>
36138       </screenshot>
36139
36140       <para>In the Vendor Search you can enter any part of the vendor name to
36141       get results.</para>
36142
36143       <screenshot>
36144         <screeninfo>Vendor Search Results</screeninfo>
36145
36146         <mediaobject>
36147           <imageobject>
36148             <imagedata fileref="images/acquisitions/vendorquicksearch.png"/>
36149           </imageobject>
36150         </mediaobject>
36151       </screenshot>
36152
36153       <para>Using the Orders Search you can search for items that have been
36154       ordered with or without the vendor.</para>
36155
36156       <screenshot>
36157         <screeninfo>Order Search Box</screeninfo>
36158
36159         <mediaobject>
36160           <imageobject>
36161             <imagedata fileref="images/acquisitions/ordersearch.png"/>
36162           </imageobject>
36163         </mediaobject>
36164       </screenshot>
36165
36166       <para>You can enter info in one or both fields and you can enter any
36167       part of the title and/or vendor name.</para>
36168
36169       <screenshot>
36170         <screeninfo>Order Search Results</screeninfo>
36171
36172         <mediaobject>
36173           <imageobject>
36174             <imagedata fileref="images/acquisitions/ordersearchresults.png"/>
36175           </imageobject>
36176         </mediaobject>
36177       </screenshot>
36178
36179       <para>Clicking the plus sign to the right of the Vendor search box will
36180       expand the search and allow you to search for additional fields.</para>
36181
36182       <screenshot>
36183         <screeninfo>Expanded Orders Search</screeninfo>
36184
36185         <mediaobject>
36186           <imageobject>
36187             <imagedata fileref="images/acquisitions/ordersearchexpand.png"/>
36188           </imageobject>
36189         </mediaobject>
36190       </screenshot>
36191
36192       <para>Clicking Advanced Search to the right of the search button will
36193       give you all of the order search options available.</para>
36194
36195       <screenshot>
36196         <screeninfo>Full Order Search</screeninfo>
36197
36198         <mediaobject>
36199           <imageobject>
36200             <imagedata fileref="images/acquisitions/ordersearchfull.png"/>
36201           </imageobject>
36202         </mediaobject>
36203       </screenshot>
36204     </section>
36205
36206     <section id="fundtracking">
36207       <title>Budget/Fund Tracking</title>
36208
36209       <para>On the main acquisitions page there will be a table showing you all of your active funds
36210         and a breakdown of what has been ordered or spent against them.</para>
36211
36212       <screenshot>
36213         <screeninfo>Fund Table</screeninfo>
36214
36215         <mediaobject>
36216           <imageobject>
36217             <imagedata fileref="images/acquisitions/acqfunds.png"/>
36218           </imageobject>
36219         </mediaobject>
36220       </screenshot>
36221
36222       <para>Clicking on the linked amounts under spent or ordered will show you a summary of the
36223         titles ordered/received on that budget.</para>
36224
36225       <screenshot>
36226         <screeninfo>Titles Spent</screeninfo>
36227
36228         <mediaobject>
36229           <imageobject>
36230             <imagedata fileref="images/acquisitions/spent.png"/>
36231           </imageobject>
36232         </mediaobject>
36233       </screenshot>
36234     </section>
36235   </chapter>
36236
36237   <chapter id="stafflists">
36238     <title>Lists &amp; Cart</title>
36239
36240     <para>Lists are a way to save a collection of content on a specific topic
36241     or for a specific purpose. The Cart is a session specific storage
36242     space.</para>
36243
36244     <itemizedlist>
36245       <listitem>
36246         <para><emphasis>Get there:</emphasis> More &gt; Lists</para>
36247       </listitem>
36248     </itemizedlist>
36249
36250     <section id="lists">
36251       <title>Lists</title>
36252
36253       <para/>
36254
36255       <section id="createlist">
36256         <title>Create a List</title>
36257
36258         <para>A list can be created by visiting the Lists page and clicking
36259         'New List'</para>
36260
36261         <screenshot>
36262           <screeninfo>New List Button</screeninfo>
36263
36264           <mediaobject>
36265             <imageobject>
36266               <imagedata fileref="images/lists/newlistbutton.png"/>
36267             </imageobject>
36268           </mediaobject>
36269         </screenshot>
36270
36271         <para>The new list form offers several options for creating your
36272         list:</para>
36273
36274         <screenshot>
36275           <screeninfo>New List Form</screeninfo>
36276
36277           <mediaobject>
36278             <imageobject>
36279               <imagedata fileref="images/lists/newlistform.png"/>
36280             </imageobject>
36281           </mediaobject>
36282         </screenshot>
36283
36284         <itemizedlist>
36285           <listitem>
36286             <para>The name is what will appear on the list of Lists</para>
36287           </listitem>
36288
36289           <listitem>
36290             <para>You can also choose how to sort the list</para>
36291           </listitem>
36292           <listitem>
36293             <para>Next decide if your list is going to be private or public</para>
36294             <itemizedlist>
36295               <listitem>
36296                 <para>A Private List is managed by you and can be seen only by you (depending on
36297                   your permissions settings below)</para>
36298               </listitem>
36299               <listitem>
36300                 <para>A Public List can be seen by everybody, but managed only by you (depending on
36301                   your permissions settings below)</para>
36302               </listitem>
36303             </itemizedlist>
36304           </listitem>
36305           <listitem>
36306             <para>Finally decide what your permissions will be on the list. You can all or disallow:<itemizedlist>
36307                 <listitem>
36308                   <para>anyone else to add entries</para>
36309                 </listitem>
36310                 <listitem>
36311                   <para>anyone to remove his own contributed entries<itemizedlist>
36312                       <listitem>
36313                         <note>
36314                           <para>The owner of a list is always allowed to add entries, but needs
36315                             permission to remove.</para>
36316                         </note>
36317                       </listitem>
36318                     </itemizedlist></para>
36319                 </listitem>
36320                 <listitem>
36321                   <para>anyone to remove other contributed entries     </para>
36322                 </listitem>
36323               </itemizedlist></para>
36324           </listitem>
36325         </itemizedlist>
36326
36327         <para>A list can also be created from the catalog search
36328         results</para>
36329
36330         <screenshot>
36331           <screeninfo>New list from catalog search</screeninfo>
36332
36333           <mediaobject>
36334             <imageobject>
36335               <imagedata fileref="images/lists/newlistsearch.png"/>
36336             </imageobject>
36337           </mediaobject>
36338         </screenshot>
36339
36340         <itemizedlist>
36341           <listitem>
36342             <para>Check the box to the left of the titles you want to add to
36343             the new list</para>
36344           </listitem>
36345
36346           <listitem>
36347             <para>Choose [New List] from the 'Add to:' pull down menu</para>
36348
36349             <screenshot>
36350               <screeninfo>New List from Search Results</screeninfo>
36351
36352               <mediaobject>
36353                 <imageobject>
36354                   <imagedata fileref="images/lists/newlistfromsearch.png"/>
36355                 </imageobject>
36356               </mediaobject>
36357             </screenshot>
36358
36359             <itemizedlist>
36360               <listitem>
36361                 <para>Name the list and choose what type of list this
36362                 is</para>
36363
36364                 <itemizedlist>
36365                   <listitem>
36366                     <para>A Private List is managed by you and can be seen
36367                     only by you</para>
36368                   </listitem>
36369
36370                   <listitem>
36371                     <para>A Public List can be seen by everybody, but managed
36372                     only by you</para>
36373                   </listitem>
36374                 </itemizedlist>
36375               </listitem>
36376             </itemizedlist>
36377           </listitem>
36378         </itemizedlist>
36379
36380         <para>Once the list is saved it will accessible from the Lists page
36381         and from the 'Add to' menu at the top of the search results.</para>
36382       </section>
36383
36384       <section id="addtolist">
36385         <title>Add to a List</title>
36386
36387         <para>To add titles to an existing list click on the list name from
36388         the page of lists</para>
36389
36390         <screenshot>
36391           <screeninfo>List of Lists</screeninfo>
36392
36393           <mediaobject>
36394             <imageobject>
36395               <imagedata fileref="images/lists/listslist.png"/>
36396             </imageobject>
36397           </mediaobject>
36398         </screenshot>
36399
36400         <para>From the List page you can add titles by scanning barcodes into
36401         the box at the bottom of the page</para>
36402
36403         <screenshot>
36404           <screeninfo>Content of a List</screeninfo>
36405
36406           <mediaobject>
36407             <imageobject>
36408               <imagedata fileref="images/lists/listcontents.png"/>
36409             </imageobject>
36410           </mediaobject>
36411         </screenshot>
36412
36413         <para>A title can also be added to a list by selecting titles on the
36414         search results page and choosing the list from the 'Add to'
36415         menu</para>
36416
36417         <screenshot>
36418           <screeninfo>Add to List</screeninfo>
36419
36420           <mediaobject>
36421             <imageobject>
36422               <imagedata fileref="images/lists/addtolist.png"/>
36423             </imageobject>
36424           </mediaobject>
36425         </screenshot>
36426       </section>
36427
36428       <section id="viewlist">
36429         <title>Viewing Lists</title>
36430
36431         <para>To see the contents of a list, visit the Lists page on the staff
36432         client</para>
36433
36434         <screenshot>
36435           <screeninfo>List of Lists</screeninfo>
36436
36437           <mediaobject>
36438             <imageobject>
36439               <imagedata fileref="images/lists/listslist.png"/>
36440             </imageobject>
36441           </mediaobject>
36442         </screenshot>
36443
36444         <para>Clicking on the 'List Name' will show the contents of the
36445         list</para>
36446
36447         <screenshot>
36448           <screeninfo>Content of a List</screeninfo>
36449
36450           <mediaobject>
36451             <imageobject>
36452               <imagedata fileref="images/lists/listcontents.png"/>
36453             </imageobject>
36454           </mediaobject>
36455         </screenshot>
36456         <para>From this list of items you can perform several actions</para>
36457         <itemizedlist>
36458           <listitem>
36459             <para>'New list' will allow you to create another list</para>
36460           </listitem>
36461           <listitem>
36462             <para>'Edit' will allow you to edit the description and permissions for this list</para>
36463           </listitem>
36464           <listitem>
36465             <para>'Send list' will send the list to the email address you enter (<link
36466                 linkend="examplelistemail">view sample List email</link>)</para>
36467           </listitem>
36468           <listitem>
36469             <para>'Download list' will allow you to download the cart using one of 3 default formats
36470               or your <link linkend="csvprofiles">CSV Profiles</link></para>
36471           </listitem>
36472           <listitem>
36473             <para>'Print list' will present you with a printable version of the list</para>
36474           </listitem>
36475         </itemizedlist>
36476       </section>
36477
36478       <section id="mergebibrecs">
36479         <title>Merging Bibliographic Records Via Lists</title>
36480
36481         <para>The easiest way to merge together duplicate bibliographic
36482         records is to add them to a list and use the Merge Tool from
36483         there.</para>
36484
36485         <screenshot>
36486           <screeninfo>List of Duplicate Records</screeninfo>
36487
36488           <mediaobject>
36489             <imageobject>
36490               <imagedata fileref="images/lists/listofdups.png"/>
36491             </imageobject>
36492           </mediaobject>
36493         </screenshot>
36494
36495         <para>From the list, check the two items you want to merge. If you
36496         choose more than or fewer than 2, you will be presented with an
36497         error:</para>
36498
36499         <screenshot>
36500           <screeninfo>Merge Items Error</screeninfo>
36501
36502           <mediaobject>
36503             <imageobject>
36504               <imagedata fileref="images/lists/merge2rec.png"/>
36505             </imageobject>
36506           </mediaobject>
36507         </screenshot>
36508
36509         <para>Once you have selected the records you want to merge, click the 'Merge selected'
36510           button at the top of the list. You will be asked which of the two records you would like
36511           to keep as your primary record and which will be deleted after the merge. If the records
36512           were created using different frameworks, Koha will also ask you what Framework you would
36513           like the newly merged record to use.</para>
36514
36515         <screenshot>
36516           <screeninfo>Choose Primary Record for Merge</screeninfo>
36517
36518           <mediaobject>
36519             <imageobject>
36520               <imagedata fileref="images/lists/mergeprimary.png"/>
36521             </imageobject>
36522           </mediaobject>
36523         </screenshot>
36524
36525         <para>You will be presented with the MARC for both of the records
36526         (each accessible by tabs labeled with the bib numbers for those
36527         records). By default the entire first record will be selected, uncheck
36528         the fields you don't want in the final (destination) record and then
36529         move on to the second tab to choose which fields should be in the
36530         final (destination) record.</para>
36531
36532         <screenshot>
36533           <screeninfo>Merging Records</screeninfo>
36534
36535           <mediaobject>
36536             <imageobject>
36537               <imagedata fileref="images/lists/mergerecs.png"/>
36538             </imageobject>
36539           </mediaobject>
36540         </screenshot>
36541
36542         <para>Should you try to add a field that is not repeatable two times
36543         (like choosing the 245 field from both record #1 and #2) you will be
36544         presented with an error</para>
36545
36546         <screenshot>
36547           <screeninfo>Non-repeatable Error</screeninfo>
36548
36549           <mediaobject>
36550             <imageobject>
36551               <imagedata fileref="images/lists/nondupfield.png"/>
36552             </imageobject>
36553           </mediaobject>
36554         </screenshot>
36555
36556         <para>Once you have completed your selections click the 'merge'
36557         button. The primary record will now CONTAIN the data you chose for it
36558         as well as all of the items/holdings from both bib records, and the
36559         second record will be deleted.<important>
36560             <para>It is important to rebuild your zebra index immediately
36561             after merging records. If a search is performed for a record which
36562             has been deleted Koha will present the patrons with an error in
36563             the OPAC.</para>
36564           </important></para>
36565       </section>
36566     </section>
36567
36568     <section id="cart">
36569       <title>Cart</title>
36570
36571       <para>The cart is a temporary holding place for items in the OPAC and/or
36572       staff client. The cart will be emptied once the session is ended (by
36573       closing the browser or logging out). The cart is best used for
36574       performing batch operations (holds, printing, emailing) or for getting a
36575       list of items to be printed or emailed to yourself or a patron.</para>
36576
36577       <para>If you would like to enable the cart in the staff client, you need
36578       to set the <link linkend="intranetbookbag">intranetbookbag</link> system
36579       preference to 'Show.' To add things to the cart, search the catalog and
36580       select the items you would like added to your cart and choose 'Cart'
36581       from the 'Add to' menu</para>
36582
36583       <screenshot>
36584         <screeninfo>Add to Cart</screeninfo>
36585
36586         <mediaobject>
36587           <imageobject>
36588             <imagedata fileref="images/lists/addtocart.png"/>
36589           </imageobject>
36590         </mediaobject>
36591       </screenshot>
36592
36593       <para>A confirmation will appear below the cart button at the top of the
36594       staff client</para>
36595
36596       <screenshot>
36597         <screeninfo>Items added to Cart</screeninfo>
36598
36599         <mediaobject>
36600           <imageobject>
36601             <imagedata fileref="images/lists/itemsaddedcart.png"/>
36602           </imageobject>
36603         </mediaobject>
36604       </screenshot>
36605
36606       <para>Clicking on the Cart icon will provide you with the contents of
36607       the cart</para>
36608
36609       <screenshot>
36610         <screeninfo>Cart Contents</screeninfo>
36611
36612         <mediaobject>
36613           <imageobject>
36614             <imagedata fileref="images/lists/cart.png"/>
36615           </imageobject>
36616         </mediaobject>
36617       </screenshot>
36618       <para>From this list of items you can perform several actions</para>
36619
36620       <itemizedlist>
36621         <listitem>
36622           <para>'More details' will show more information about the items in the cart</para>
36623         </listitem>
36624
36625         <listitem>
36626           <para>'Send' will send the list to the email address you enter (<link
36627               linkend="examplecartemail">view sample Cart email</link>)</para>
36628         </listitem>
36629
36630         <listitem>
36631           <para>'Download' will allow you to download the cart using one of 3
36632           default formats or your <link linkend="csvprofiles">CSV
36633           Profiles</link></para>
36634         </listitem>
36635
36636         <listitem>
36637           <para>'Print' will present you with a printable version of the
36638           cart</para>
36639         </listitem>
36640
36641         <listitem>
36642           <para>'Empty and Close' will empty the list and close the
36643           window</para>
36644         </listitem>
36645
36646         <listitem>
36647           <para>'Hide Window' will close the window</para>
36648         </listitem>
36649       </itemizedlist>
36650     </section>
36651   </chapter>
36652
36653   <chapter id="reports">
36654     <title>Reports</title>
36655
36656     <para>Reports in Koha are a way to gather data. Reports are used to
36657     generate statistics, member lists, shelving lists, or any list of data in
36658     your database.</para>
36659
36660     <itemizedlist>
36661       <listitem>
36662         <para><emphasis>Get there:</emphasis> More &gt; Reports</para>
36663       </listitem>
36664     </itemizedlist>
36665
36666     <section id="customreports">
36667       <title>Custom Reports</title>
36668
36669       <para>Koha's data is stored in a MySQL database which means that
36670       librarians can generate nearly any report they would like by either
36671       using the <link linkend="quidedreportwizard">Guided Reports
36672       Wizard</link> or writing their own <link linkend="reportfromsql">SQL
36673       query</link>.</para>
36674
36675       <section id="customreport">
36676         <title>Add Custom Report</title>
36677
36678         <para/>
36679
36680         <section id="quidedreportwizard">
36681           <title>Guided Report Wizard</title>
36682
36683           <para>The guided report wizard will walk you through a six step
36684           process to generate a report.</para>
36685
36686           <para>Step 1: Choose the module you want to report on. This will
36687           determine what tables and fields are available for you to
36688           query.</para>
36689
36690           <para>'Report is public' should be left to the default of 'No' in
36691           most cases. A report can be made public if you intend to allow
36692           access to it through the JSON webservice interface. This is a system
36693           that can be used by developers to make custom presentations of the
36694           data from the report, for example displaying it using a graphing
36695           API. To learn more speak to your local developer.</para>
36696
36697           <itemizedlist>
36698             <listitem>
36699               <para>A public report is accessible via a URL that looks like
36700               this: http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</para>
36701             </listitem>
36702           </itemizedlist>
36703
36704           <screenshot>
36705             <screeninfo>Chose Module for Report</screeninfo>
36706
36707             <mediaobject>
36708               <imageobject>
36709                 <imagedata fileref="images/reports/report1.png"/>
36710               </imageobject>
36711             </mediaobject>
36712           </screenshot>
36713           <note>
36714             <para>If your system administrator has set up memcache on your server you might see one
36715               more option for the Cache expiry. This is related to your public reports. If you make
36716               the report public then  it's constantly running and will cause a large load on your
36717               system. Setting this value prevents that.<screenshot>
36718                 <screeninfo>Cache expiry</screeninfo>
36719                 <mediaobject>
36720                   <imageobject>
36721                     <imagedata fileref="images/reports/cacheexiprywizard.png"/>
36722                   </imageobject>
36723                 </mediaobject>
36724               </screenshot></para>
36725           </note>
36726           <para>Step 2: Choose a report type. For now, Tabular is the only option available.</para>
36727
36728           <screenshot>
36729             <screeninfo>Report Type</screeninfo>
36730
36731             <mediaobject>
36732               <imageobject>
36733                 <imagedata fileref="images/reports/report2.png"/>
36734               </imageobject>
36735             </mediaobject>
36736           </screenshot>
36737
36738           <para>Step 3: Choose the fields you want in your report. You can
36739           select multiple fields and add them all at once by using CTRL+Click
36740           on each item you want to add before clicking the Add button.</para>
36741
36742           <screenshot>
36743             <screeninfo>Select database fields to query</screeninfo>
36744
36745             <mediaobject>
36746               <imageobject>
36747                 <imagedata fileref="images/reports/report3.png"/>
36748               </imageobject>
36749             </mediaobject>
36750           </screenshot>
36751
36752           <para>Step 4: Choose any limits you might want to apply to your
36753           report (such as item types or branches). If you don't want to apply
36754           any limits, simply click Next instead of making an option.</para>
36755
36756           <screenshot>
36757             <screeninfo>Choose limits</screeninfo>
36758
36759             <mediaobject>
36760               <imageobject>
36761                 <imagedata fileref="images/reports/report4.png"/>
36762               </imageobject>
36763             </mediaobject>
36764           </screenshot>
36765
36766           <para>Step 5: Perform math functions. If you don't want to do any
36767           calculations, simply click Next instead of making an option.</para>
36768
36769           <screenshot>
36770             <screeninfo>Choose math functions</screeninfo>
36771
36772             <mediaobject>
36773               <imageobject>
36774                 <imagedata fileref="images/reports/report5.png"/>
36775               </imageobject>
36776             </mediaobject>
36777           </screenshot>
36778
36779           <para>Step 6: Choose data order. If you want the data to print out
36780           in the order it's found in the database, simply click Finish.</para>
36781
36782           <screenshot>
36783             <screeninfo>Choose ordering</screeninfo>
36784
36785             <mediaobject>
36786               <imageobject>
36787                 <imagedata fileref="images/reports/report6.png"/>
36788               </imageobject>
36789             </mediaobject>
36790           </screenshot>
36791
36792           <para>When you are finished you will be presented with the SQL
36793           generated by the report wizard. From here you can choose to save the
36794           report by clicking 'Save' or copy the SQL and make edits to it by
36795           hand.</para>
36796
36797           <screenshot>
36798             <screeninfo>Custom Report Confirmation</screeninfo>
36799
36800             <mediaobject>
36801               <imageobject>
36802                 <imagedata fileref="images/reports/reportconfirm.png"/>
36803               </imageobject>
36804             </mediaobject>
36805           </screenshot>
36806
36807           <para>If you choose to save the report you will be asked to name your report, sort it in
36808             to groups and subgroups and enter any notes regarding it.</para>
36809
36810           <screenshot>
36811             <screeninfo>Save custom report</screeninfo>
36812
36813             <mediaobject>
36814               <imageobject>
36815                 <imagedata fileref="images/reports/reportsave.png"/>
36816               </imageobject>
36817             </mediaobject>
36818           </screenshot>
36819
36820           <para>Once your report is saved it will appear on the 'Use Saved'
36821           page with all other saved reports.</para>
36822
36823           <screenshot>
36824             <screeninfo>Saved Reports list</screeninfo>
36825
36826             <mediaobject>
36827               <imageobject>
36828                 <imagedata fileref="images/reports/savedreports.png"/>
36829               </imageobject>
36830             </mediaobject>
36831           </screenshot>
36832
36833           <para>From here you can make edits, run the report, or schedule a time to have the report
36834             run. To find the report you created you can sort by any of the columns by clicking the
36835             on the column header (creation date is the best bet for finding the report you just
36836             added). You can also filter your results using the filter menu on the left or use the
36837             tabs to find reports based on your custom groups.</para>
36838         </section>
36839
36840         <section id="reportfromsql">
36841           <title>Report from SQL</title>
36842
36843           <para>In addition to the report wizard, you have the option to write
36844           your own queries using SQL. To find reports written by other Koha
36845           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>.
36846           You can also find your database structure in
36847           /installer/data/mysql/kohastructure.sql or online at: <ulink url="http://schema.koha-community.org/">http://schema.koha-community.org</ulink>.</para>
36848
36849           <para>To add your query, click the link to 'Create from SQL' on the main reports module or
36850             the 'New report' button at the top of the 'Saved reports' page.</para>
36851
36852           <screenshot>
36853             <screeninfo>New SQL Report</screeninfo>
36854
36855             <mediaobject>
36856               <imageobject>
36857                 <imagedata fileref="images/reports/newsql.png"/>
36858               </imageobject>
36859             </mediaobject>
36860           </screenshot>
36861
36862           <para>Fill in the form presented</para>
36863
36864           <screenshot>
36865             <screeninfo>Create Report from SQL</screeninfo>
36866
36867             <mediaobject>
36868               <imageobject>
36869                 <imagedata fileref="images/reports/reportfromsql.png"/>
36870               </imageobject>
36871             </mediaobject>
36872           </screenshot>
36873
36874           <itemizedlist>
36875             <listitem>
36876               <para>The 'Name' is what will appear on the Saved Reports page
36877               to help you identify the report later. It will also be
36878               searchable using the filters found the left of the Saved Reports
36879               page.</para>
36880             </listitem>
36881
36882             <listitem>
36883               <para>You can use the 'Report group' to organize your reports so that you can easily
36884                 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
36885                 creating the report by choosing the 'or create' radio button.<screenshot>
36886                   <screeninfo>Report group</screeninfo>
36887                   <mediaobject>
36888                     <imageobject>
36889                       <imagedata fileref="images/reports/reportgroup.png"/>
36890                     </imageobject>
36891                   </mediaobject>
36892                 </screenshot><itemizedlist>
36893                   <listitem>
36894                     <para>
36895                       <note>
36896                         <para>If you're adding a report group on the fly, remember that you code
36897                           should be fewer than 10 characters and should not include special
36898                           characters or spaces.</para>
36899                       </note>
36900                     </para>
36901                   </listitem>
36902                 </itemizedlist></para>
36903             </listitem>
36904
36905             <listitem>
36906               <para>You can use 'Report subgroup' to further organize your reports so that you can
36907                 easily filter reports by groups and subgroups. Report subgroups are set in the <link linkend="reportsubgroup">REPORT_SUBGROUP</link> authorized value category or can
36908                 be added on the fly when creating the report by choosing the 'or create' radio
36909                 button.</para>
36910               <screenshot>
36911                 <screeninfo>Report subgroup</screeninfo>
36912                 <mediaobject>
36913                   <imageobject>
36914                     <imagedata fileref="images/reports/reportsubgroup.png"/>
36915                   </imageobject>
36916                 </mediaobject>
36917               </screenshot>
36918               <itemizedlist>
36919                 <listitem>
36920                   <para>
36921                     <note>
36922                       <para>If you're adding a report subgroup on the fly, remember that you code
36923                         should be fewer than 10 characters and should not include special characters
36924                         or spaces.</para>
36925                     </note>
36926                   </para>
36927                 </listitem>
36928               </itemizedlist>
36929             </listitem>
36930
36931             <listitem id="publicreport">
36932               <para>'Report is public' should be left to the default of 'No' in most cases. A report
36933                 can be made public if you intend to allow access to it through the JSON webservice
36934                 interface. This is a system that can be used by developers to make custom
36935                 presentations of the data from the report, for example displaying it using a
36936                 graphing API. To learn more speak to your local developer.</para>
36937               <itemizedlist>
36938                 <listitem>
36939                   <para>A public report is accessible via a URL that looks like this:
36940                     http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</para>
36941                 </listitem>
36942               </itemizedlist>
36943             </listitem>
36944
36945             <listitem>
36946               <para>'Notes' will also appear on the Saved Reports page, this
36947               can be used to provide more details about the report or tips on
36948               how to enter values when it runs</para>
36949             </listitem>
36950
36951             <listitem>
36952               <para>The type should always be 'Tabular' at this time since the
36953               other formats have not been implemented</para>
36954             </listitem>
36955
36956             <listitem>
36957               <para>In the 'SQL' box you will type or paste the SQL for the
36958               report</para>
36959             </listitem>
36960
36961             <listitem>
36962               <para>If you feel that your report might be too resource
36963               intensive you might want to consider using runtime parameters to
36964               your query. Runtime parameters basically make a filter appear
36965               before the report is run to save your system resources.</para>
36966
36967               <para>There is a specific syntax that Koha will understand as
36968               'ask for values when running the report'. The syntax is
36969               &lt;&lt;Question to ask|authorized_value&gt;&gt;.</para>
36970
36971               <itemizedlist>
36972                 <listitem>
36973                   <para>The &lt;&lt; and &gt;&gt; are just delimiters. You
36974                   must put &lt;&lt; at the beginning and &gt;&gt; at the end
36975                   of your parameter</para>
36976                 </listitem>
36977
36978                 <listitem>
36979                   <para>The 'Question to ask' will be displayed on the left of
36980                   the string to enter.</para>
36981                 </listitem>
36982
36983                 <listitem>
36984                   <para>The authorized_value can be omitted if not applicable. If it contains an
36985                     authorized value category, or branches or itemtype or categorycode or
36986                     biblio_framework, a list with the Koha authorized values will be displayed
36987                     instead of a free field Note that you can have more than one parameter in a
36988                     given SQL Note that entering nothing at run time won't probably work as you
36989                     expect. It will be considered as "value empty" not as "ignore this parameter".
36990                     For example entering nothing for : "title=&lt;&lt;Enter title&gt;&gt;" will
36991                     display results with title='' (no title). If you want to have to have something
36992                     not mandatory, use "title like &lt;&lt;Enter title&gt;&gt;" and enter a % at run
36993                     time instead of nothing</para>
36994                 </listitem>
36995               </itemizedlist>
36996
36997               <para>Examples:</para>
36998
36999               <itemizedlist>
37000                 <listitem>
37001                   <para>SELECT surname,firstname FROM borrowers WHERE
37002                   branchcode=&lt;&lt;Enter patrons library|branches&gt;&gt;
37003                   AND surname like &lt;&lt;Enter filter for patron surname (%
37004                   if none)&gt;&gt;</para>
37005                 </listitem>
37006
37007                 <listitem>
37008                   <para>SELECT * FROM items WHERE homebranch = &lt;&lt;Pick your
37009                     branch|branches&gt;&gt; and barcode like &lt;&lt;Partial barcode value
37010                     here&gt;&gt;</para>
37011                 </listitem>
37012                 <listitem>
37013                   <para>SELECT title , author FROM biblio WHERE frameworkcode=&lt;&lt;Enter the
37014                     frameworkcode|biblio_framework>> </para>
37015                 </listitem>
37016               </itemizedlist>
37017
37018               <note>
37019                 <para>To generate a date picker calendar to the right of the
37020                 field when running a report you can use the 'date' keyword
37021                 like this: &lt;&lt;Enter Date|date&gt;&gt;</para>
37022
37023                 <screenshot>
37024                   <screeninfo>Date Picker</screeninfo>
37025
37026                   <mediaobject>
37027                     <imageobject>
37028                       <imagedata fileref="images/reports/datepicker.png"/>
37029                     </imageobject>
37030                   </mediaobject>
37031                 </screenshot>
37032               </note>
37033
37034               <note>
37035                 <para>You have to put "%" in a text box to 'leave it blank'.
37036                 Otherwise, it literally looks for "" (empty string) as the
37037                 value for the field.</para>
37038               </note>
37039
37040               <para><important>
37041                   <para>In addition to using any authorized value code to generate a dropdown, you
37042                     can use the following values as well: Framework codes (biblio_framework),
37043                     Branches (branches), Item Types (itemtypes) and Patron Categories
37044                     (categorycode). For example a branch pull down would be generated like this
37045                     &lt;&lt;Branch|branches&gt;&gt;</para>
37046
37047                   <screenshot>
37048                     <screeninfo>Branch pull down</screeninfo>
37049
37050                     <mediaobject>
37051                       <imageobject>
37052                         <imagedata fileref="images/reports/branchpulldown.png"/>
37053                       </imageobject>
37054                     </mediaobject>
37055                   </screenshot>
37056                 </important></para>
37057             </listitem>
37058           </itemizedlist>
37059
37060           <note>
37061             <para>There is a limit of 10,000 records put on SQL statements entered in Koha. To get
37062               around this you want to add 'LIMIT 100000' to the end of your SQL statement (or any
37063               other number above 10,000).</para>
37064           </note>
37065           <note>
37066             <para>If your system administrator has set up memcache on your server you might see one
37067               more option for the Cache expiry. This is related to your public reports. If you make
37068               the report public then  it's constantly running and will cause a large load on your
37069               system. Setting this value prevents that.<screenshot>
37070                 <screeninfo>Cache expiry</screeninfo>
37071                 <mediaobject>
37072                   <imageobject>
37073                     <imagedata fileref="images/reports/cacheexpiry.png"/>
37074                   </imageobject>
37075                 </mediaobject>
37076               </screenshot></para>
37077           </note>
37078
37079           <para>Once everything is entered click the 'Save Report' button and
37080           you'll be presented with options to run it. Once a report is saved
37081           you do not have to recreate it you can simply find it on the Saved
37082           Reports page and <link linkend="runcustomreport">run</link> or <link linkend="editcustomreports">edit</link> it.</para>
37083         </section>
37084         <section id="duplicatereport">
37085           <title>Duplicate Report</title>
37086           <para>Reports can also be added by duplicating an existing report.  Visit the 'Saved
37087             reports' page to see all of the reports listed on your system already.</para>
37088           <screenshot>
37089             <screeninfo>Saved Reports</screeninfo>
37090             <mediaobject>
37091               <imageobject>
37092                 <imagedata fileref="images/reports/duplicatereport.png"/>
37093               </imageobject>
37094             </mediaobject>
37095           </screenshot>
37096           <para>To the right of every report there is an 'Actions' pull down. Clickin that and
37097             choose 'Duplicate' to use an existing report as the basis for your new report. That will
37098             populate the new report form with the existing SQL for easy editing and resaving.</para>
37099         </section>
37100       </section>
37101
37102       <section id="editcustomreports">
37103         <title>Edit Custom Reports</title>
37104
37105         <para>Every report can be edited from the reports lists. To see the
37106         list of reports already stored in Koha, click 'Use Saved.'</para>
37107
37108         <screenshot>
37109           <screeninfo>Saved Reports</screeninfo>
37110
37111           <mediaobject>
37112             <imageobject>
37113               <imagedata fileref="images/reports/savedreports.png"/>
37114             </imageobject>
37115           </mediaobject>
37116         </screenshot>
37117
37118         <para>To find the report you'd like to edit you can sort by any of the columns by clicking
37119           the on the column header. You can also filter your results using the filter menu on the
37120           left or use the tabs to find reports based on your custom groups.</para>
37121
37122         <para>From this list you can edit any custom report by clicking 'Actions' to the right of
37123           the report and choosing 'Edit' from the menu that appears.</para>
37124         <screenshot>
37125           <screeninfo>Edit Report Option</screeninfo>
37126           <mediaobject>
37127             <imageobject>
37128               <imagedata fileref="images/reports/editreportoption.png"/>
37129             </imageobject>
37130           </mediaobject>
37131         </screenshot>
37132         <para>The form to edit the report will appear.</para>
37133
37134         <screenshot>
37135           <screeninfo>Edit SQL Form</screeninfo>
37136
37137           <mediaobject>
37138             <imageobject>
37139               <imagedata fileref="images/reports/editreport.png"/>
37140             </imageobject>
37141           </mediaobject>
37142         </screenshot>
37143       </section>
37144
37145       <section id="runcustomreport">
37146         <title>Running Custom Reports</title>
37147
37148         <para>Once custom reports are saved to Koha, you can run them by going to the Saved Reports
37149           page and clicking the 'Actions' button to the right of the report and choosing
37150           'Run'.</para>
37151
37152         <screenshot>
37153           <screeninfo>Run Report</screeninfo>
37154
37155           <mediaobject>
37156             <imageobject>
37157               <imagedata fileref="images/reports/runreport.png"/>
37158             </imageobject>
37159           </mediaobject>
37160         </screenshot>
37161
37162         <para>When you report runs you will either be asked for some
37163         values</para>
37164
37165         <screenshot>
37166           <screeninfo>Enter report parameters</screeninfo>
37167
37168           <mediaobject>
37169             <imageobject>
37170               <imagedata fileref="images/reports/reportparameters.png"/>
37171             </imageobject>
37172           </mediaobject>
37173         </screenshot>
37174
37175         <para>or you will see the results right away</para>
37176
37177         <screenshot>
37178           <screeninfo>Report results</screeninfo>
37179
37180           <mediaobject>
37181             <imageobject>
37182               <imagedata fileref="images/reports/reportresults.png"/>
37183             </imageobject>
37184           </mediaobject>
37185         </screenshot>
37186
37187         <para>From the results you can choose to rerun the report by clicking
37188         'Run report' at the top, edit the report by clicking the 'Edit' button
37189         or starting over and creating a new report by using the 'New' button.
37190         You can also download your results by choosing a file type at the
37191         bottom of the results next to the 'Download the report' label and
37192         clicking 'Download.'<note>
37193             <para>A Comma Separated Text file is a CSV file and it can be
37194             opened by any spreadsheet application.</para>
37195           </note></para>
37196       </section>
37197     </section>
37198
37199     <section id="statsreports">
37200       <title>Statistics Reports</title>
37201
37202       <para>Statistic reports will show you counts and sums. These reports are
37203       all about numbers and statistics, for reports that return more detailed
37204       data, use the <link linkend="quidedreportwizard">Guided Report
37205       Wizard</link>. These reports are limited in what data they can look at,
37206       so it's often recommended to use <link linkend="customreports">custom
37207       reports</link> for official end of the year statistics.</para>
37208
37209       <section id="acqstats">
37210         <title>Acquisitions Statistics</title>
37211
37212         <note>
37213           <para>These reports are limited in what data they can look at, so
37214           it's often recommended to use <link linkend="customreports">custom
37215           reports</link> for official end of the year statistics.</para>
37216         </note>
37217
37218         <para>Using the form provided, choose which value you would like to
37219         appear in the Column and which will appear in the Row.</para>
37220
37221         <screenshot>
37222           <screeninfo>Acquisitions Statistics</screeninfo>
37223
37224           <mediaobject>
37225             <imageobject>
37226               <imagedata fileref="images/reports/acqform.png"/>
37227             </imageobject>
37228           </mediaobject>
37229         </screenshot>
37230
37231         <para>If you choose to output to the browser your results will print
37232         to the screen.</para>
37233
37234         <screenshot>
37235           <screeninfo>Acquisitions Statistics Results</screeninfo>
37236
37237           <mediaobject>
37238             <imageobject>
37239               <imagedata fileref="images/reports/acqnumbers.png"/>
37240             </imageobject>
37241           </mediaobject>
37242         </screenshot>
37243
37244         <para>You can also choose to export to a file that you can manipulate
37245         to your needs.</para>
37246
37247         <para>When generating your report, note that you get to choose between
37248         counting or summing the values.</para>
37249
37250         <screenshot>
37251           <screeninfo>Acquisitions Stats Options</screeninfo>
37252
37253           <mediaobject>
37254             <imageobject>
37255               <imagedata fileref="images/reports/acqtotal.png"/>
37256             </imageobject>
37257           </mediaobject>
37258         </screenshot>
37259
37260         <para>Choosing amount will change your results to appear as the sum of
37261         the amounts spent.</para>
37262
37263         <screenshot>
37264           <screeninfo>Acquisitions statistics with totals</screeninfo>
37265
37266           <mediaobject>
37267             <imageobject>
37268               <imagedata fileref="images/reports/acqamounts.png"/>
37269             </imageobject>
37270           </mediaobject>
37271         </screenshot>
37272       </section>
37273
37274       <section id="patstats">
37275         <title>Patron Statistics</title>
37276
37277         <note>
37278           <para>These reports are limited in what data they can look at, so
37279           it's often recommended to use <link linkend="customreports">custom
37280           reports</link> for official end of the year statistics.</para>
37281         </note>
37282
37283         <para>Using the form provided, choose which value you would like to
37284         appear in the Column and which will appear in the Row.</para>
37285
37286         <screenshot>
37287           <screeninfo>Patron Statistics Options</screeninfo>
37288
37289           <mediaobject>
37290             <imageobject>
37291               <imagedata fileref="images/reports/patronform.png"/>
37292             </imageobject>
37293           </mediaobject>
37294         </screenshot>
37295
37296         <para>If you choose to output to the browser your results will print
37297         to the screen.</para>
37298
37299         <screenshot>
37300           <screeninfo>Patron Statistics Results</screeninfo>
37301
37302           <mediaobject>
37303             <imageobject>
37304               <imagedata fileref="images/reports/patronresults.png"/>
37305             </imageobject>
37306           </mediaobject>
37307         </screenshot>
37308
37309         <para>Based on your selections, you may see some query information
37310         above your results table. You can also choose to export to a file that
37311         you can manipulate to your needs.</para>
37312       </section>
37313
37314       <section id="catstats">
37315         <title>Catalog Statistics</title>
37316
37317         <note>
37318           <para>These reports are limited in what data they can look at, so
37319           it's often recommended to use <link linkend="customreports">custom
37320           reports</link> for official end of the year statistics.</para>
37321         </note>
37322
37323         <para>Using the form provided, choose which value you would like to
37324         appear in the Column and which will appear in the Row.</para>
37325
37326         <screenshot>
37327           <screeninfo>Catalog Statistics Form</screeninfo>
37328
37329           <mediaobject>
37330             <imageobject>
37331               <imagedata fileref="images/reports/catalogform.png"/>
37332             </imageobject>
37333           </mediaobject>
37334         </screenshot>
37335
37336         <para>If you choose to output to the browser your results will print
37337         to the screen.</para>
37338
37339         <screenshot>
37340           <screeninfo>Catalog Statistic Results</screeninfo>
37341
37342           <mediaobject>
37343             <imageobject>
37344               <imagedata fileref="images/reports/catalogresults.png"/>
37345             </imageobject>
37346           </mediaobject>
37347         </screenshot>
37348
37349         <para>You can also choose to export to a file that you can manipulate
37350         to your needs.</para>
37351       </section>
37352
37353       <section id="circstats">
37354         <title>Circulation Statistics</title>
37355
37356         <note>
37357           <para>These reports are limited in what data they can look at, so
37358           it's often recommended to use <link linkend="customreports">custom
37359           reports</link> for official end of the year statistics.</para>
37360         </note>
37361
37362         <para>Using the form provided, choose which value you would like to
37363         appear in the Column and which will appear in the Row.</para>
37364
37365         <screenshot>
37366           <screeninfo>Circulation Statistics</screeninfo>
37367
37368           <mediaobject>
37369             <imageobject>
37370               <imagedata fileref="images/reports/circform.png"/>
37371             </imageobject>
37372           </mediaobject>
37373         </screenshot>
37374
37375         <para>If you choose to output to the browser your results will print
37376         to the screen.</para>
37377
37378         <screenshot>
37379           <screeninfo>Circulation Statistic Results</screeninfo>
37380
37381           <mediaobject>
37382             <imageobject>
37383               <imagedata fileref="images/reports/circresults.png"/>
37384             </imageobject>
37385           </mediaobject>
37386         </screenshot>
37387
37388         <para>You can also choose to export to a file that you can manipulate
37389         to your needs.<note>
37390             <para>To get a complete picture of your monthly or daily
37391             circulation, you can run the report twice, once for 'Type' of
37392             'Checkout' and again for 'Renewal.'</para>
37393
37394             <para>This report uses 'Period,' or date, filtering that allows
37395             you to limit to a month by simply selecting the first day of the
37396             first month through the first day of the next month. For example,
37397             10/1 to 11/1 to find statistics for the month of October.</para>
37398
37399             <itemizedlist>
37400               <listitem>
37401                 <para>To find daily statistics, set your date
37402                 range.&lt;/br&gt; Example: "I want circulation data starting
37403                 with date XXX up to, but not including, date XXX."</para>
37404               </listitem>
37405
37406               <listitem>
37407                 <para>For a whole month, an example range would be: 11/01/2009
37408                 to 12/01/2009</para>
37409               </listitem>
37410
37411               <listitem>
37412                 <para>For a whole year, an example range would be: 01/01/2009
37413                 to 01/01/2010</para>
37414               </listitem>
37415
37416               <listitem>
37417                 <para>For a single day, an example would be: 11/15/2009 to
37418                 11/16/2009 to find what circulated on the 15th</para>
37419               </listitem>
37420             </itemizedlist>
37421           </note></para>
37422
37423         <section id="inhouseuse">
37424           <title>Tracking in house use</title>
37425
37426           <para>Using the Circulation statistics reporting wizard you can run
37427           reports on in house usage of items simply by choosing 'Local Use'
37428           from the 'Type' pull down:</para>
37429
37430           <screenshot>
37431             <screeninfo>In House Use Stats</screeninfo>
37432
37433             <mediaobject>
37434               <imageobject>
37435                 <imagedata fileref="images/reports/inhouse.png"/>
37436               </imageobject>
37437             </mediaobject>
37438           </screenshot>
37439         </section>
37440       </section>
37441
37442       <section id="serialstats">
37443         <title>Serials Statistics</title>
37444
37445         <note>
37446           <para>These reports are limited in what data they can look at, so
37447           it's often recommended to use <link linkend="customreports">custom
37448           reports</link> for official end of the year statistics.</para>
37449         </note>
37450
37451         <para>Using the form provided, choose how you would like to list the
37452         serials in your system.</para>
37453
37454         <screenshot>
37455           <screeninfo>Serials Statistics</screeninfo>
37456
37457           <mediaobject>
37458             <imageobject>
37459               <imagedata fileref="images/reports/serialsform.png"/>
37460             </imageobject>
37461           </mediaobject>
37462         </screenshot>
37463
37464         <para>If you choose to output to the browser your results will print
37465         to the screen.</para>
37466
37467         <screenshot>
37468           <screeninfo>Serials Results</screeninfo>
37469
37470           <mediaobject>
37471             <imageobject>
37472               <imagedata fileref="images/reports/serialsresults.png"/>
37473             </imageobject>
37474           </mediaobject>
37475         </screenshot>
37476
37477         <para>You can also choose to export to a file that you can manipulate
37478         to your needs.</para>
37479       </section>
37480
37481       <section id="holdstats">
37482         <title>Holds Statistics</title>
37483
37484         <note>
37485           <para>These reports are limited in what data they can look at, so
37486           it's often recommended to use <link linkend="customreports">custom
37487           reports</link> for official end of the year statistics.</para>
37488         </note>
37489
37490         <para>Using the form provided you can see statistics for holds placed,
37491         filled, cancelled and more at your library. From the form choose what
37492         value you want to display in the column and what value to show in the
37493         row. You can also choose from the filters on the far right of the
37494         form.</para>
37495
37496         <screenshot>
37497           <screeninfo>Hold Statistics Form</screeninfo>
37498
37499           <mediaobject>
37500             <imageobject>
37501               <imagedata fileref="images/reports/holdstatsform.png"/>
37502             </imageobject>
37503           </mediaobject>
37504         </screenshot>
37505
37506         <para>If you choose to output to the browser your results will print
37507         to the screen.</para>
37508
37509         <screenshot>
37510           <screeninfo>Hold Stats Results</screeninfo>
37511
37512           <mediaobject>
37513             <imageobject>
37514               <imagedata fileref="images/reports/holdstatsresults.png"/>
37515             </imageobject>
37516           </mediaobject>
37517         </screenshot>
37518
37519         <para>You can also choose to export to a file that you can manipulate
37520         to your needs.</para>
37521       </section>
37522
37523       <section id="mostcheckouts">
37524         <title>Patrons with the most checkouts</title>
37525
37526         <para>This report will simply list the patrons who have the most
37527         checkouts.</para>
37528
37529         <screenshot>
37530           <screeninfo>Patrons with the most checkouts form</screeninfo>
37531
37532           <mediaobject>
37533             <imageobject>
37534               <imagedata fileref="images/reports/topcheckoutsform.png"/>
37535             </imageobject>
37536           </mediaobject>
37537         </screenshot>
37538
37539         <para>If you choose to output to the browser your results will print
37540         to the screen.</para>
37541
37542         <screenshot>
37543           <screeninfo>Top checkouts results</screeninfo>
37544
37545           <mediaobject>
37546             <imageobject>
37547               <imagedata fileref="images/reports/topcheckoutsresult.png"/>
37548             </imageobject>
37549           </mediaobject>
37550         </screenshot>
37551
37552         <para>You can also choose to export to a file that you can manipulate
37553         to your needs.</para>
37554       </section>
37555
37556       <section id="mostcirculated">
37557         <title>Most Circulated Items</title>
37558
37559         <para>This report will simply list the items that have the been
37560         checked out the most.</para>
37561
37562         <screenshot>
37563           <screeninfo>Most Circulation Items Form</screeninfo>
37564
37565           <mediaobject>
37566             <imageobject>
37567               <imagedata fileref="images/reports/topcircform.png"/>
37568             </imageobject>
37569           </mediaobject>
37570         </screenshot>
37571
37572         <para>If you choose to output to the browser your results will print
37573         to the screen.</para>
37574
37575         <screenshot>
37576           <screeninfo>Top Circulation Items Results</screeninfo>
37577
37578           <mediaobject>
37579             <imageobject>
37580               <imagedata fileref="images/reports/topcircresults.png"/>
37581             </imageobject>
37582           </mediaobject>
37583         </screenshot>
37584
37585         <para>You can also choose to export to a file that you can manipulate
37586         to your needs.</para>
37587       </section>
37588
37589       <section id="patnocheckouts">
37590         <title>Patrons with no checkouts</title>
37591
37592         <para>This report will list for you the patrons in your system who
37593         haven't checked any items out.</para>
37594
37595         <screenshot>
37596           <screeninfo>Patrons with no Checkouts</screeninfo>
37597
37598           <mediaobject>
37599             <imageobject>
37600               <imagedata fileref="images/reports/patnocheckout.png"/>
37601             </imageobject>
37602           </mediaobject>
37603         </screenshot>
37604
37605         <para>If you choose to output to the browser your results will print
37606         to the screen.</para>
37607
37608         <screenshot>
37609           <screeninfo>Results for Patrons with no Checkouts</screeninfo>
37610
37611           <mediaobject>
37612             <imageobject>
37613               <imagedata fileref="images/reports/patnocheckout-results.png"/>
37614             </imageobject>
37615           </mediaobject>
37616         </screenshot>
37617
37618         <para>You can also choose to export to a file that you can manipulate
37619         to your needs.</para>
37620       </section>
37621
37622       <section id="itemnocheckouts">
37623         <title>Items with no checkouts</title>
37624
37625         <para>This report will list items in your collection that have never
37626         been checked out.</para>
37627
37628         <screenshot>
37629           <screeninfo>Items with No Checkouts</screeninfo>
37630
37631           <mediaobject>
37632             <imageobject>
37633               <imagedata fileref="images/reports/nocheckoutsform.png"/>
37634             </imageobject>
37635           </mediaobject>
37636         </screenshot>
37637
37638         <para>If you choose to output to the browser your results will print
37639         to the screen.</para>
37640
37641         <screenshot>
37642           <screeninfo>Items with no checkouts results</screeninfo>
37643
37644           <mediaobject>
37645             <imageobject>
37646               <imagedata fileref="images/reports/nocheckoutsresults.png"/>
37647             </imageobject>
37648           </mediaobject>
37649         </screenshot>
37650
37651         <para>You can also choose to export to a file that you can manipulate
37652         to your needs.</para>
37653       </section>
37654
37655       <section id="catbyitem">
37656         <title>Catalog by Item Type</title>
37657
37658         <para>This report will list the total number of items of each item
37659         type per branch.</para>
37660
37661         <screenshot>
37662           <screeninfo>Catalog by Item Type</screeninfo>
37663
37664           <mediaobject>
37665             <imageobject>
37666               <imagedata fileref="images/reports/itemtotals.png"/>
37667             </imageobject>
37668           </mediaobject>
37669         </screenshot>
37670
37671         <para>If you choose to output to the browser your results will print
37672         to the screen.</para>
37673
37674         <screenshot>
37675           <screeninfo>Total of Items by Type and Branch</screeninfo>
37676
37677           <mediaobject>
37678             <imageobject>
37679               <imagedata fileref="images/reports/itemtotalsresults.png"/>
37680             </imageobject>
37681           </mediaobject>
37682         </screenshot>
37683
37684         <para>You can also choose to export to a file that you can manipulate
37685         to your needs.</para>
37686       </section>
37687
37688       <section id="lostreport">
37689         <title>Lost Items</title>
37690
37691         <para>This report will allow you to generate a list of items that have
37692         been marked as Lost within the system</para>
37693
37694         <screenshot>
37695           <screeninfo>Lost Items Report</screeninfo>
37696
37697           <mediaobject>
37698             <imageobject>
37699               <imagedata fileref="images/reports/lostitems.png"/>
37700             </imageobject>
37701           </mediaobject>
37702         </screenshot>
37703       </section>
37704
37705       <section id="avloantime">
37706         <title>Average Loan Time</title>
37707
37708         <para>This report will list the average time items are out on loan
37709         based on the criteria you enter:</para>
37710
37711         <screenshot>
37712           <screeninfo>Average Checkout Period Form</screeninfo>
37713
37714           <mediaobject>
37715             <imageobject>
37716               <imagedata fileref="images/reports/averloanform.png"/>
37717             </imageobject>
37718           </mediaobject>
37719         </screenshot>
37720
37721         <para>If you choose to output to the browser your results will print
37722         to the screen.</para>
37723
37724         <screenshot>
37725           <screeninfo>Average Checkout Period Results</screeninfo>
37726
37727           <mediaobject>
37728             <imageobject>
37729               <imagedata fileref="images/reports/avercheckout.png"/>
37730             </imageobject>
37731           </mediaobject>
37732         </screenshot>
37733
37734         <para>You can also choose to export to a file that you can manipulate
37735         to your needs.</para>
37736       </section>
37737     </section>
37738
37739     <section id="reportdic">
37740       <title>Report Dictionary</title>
37741
37742       <para>The report dictionary is a way to pre-define common filters you'd
37743       like to apply to your reports. This is a good way to add in filters that
37744       the report wizard doesn't include by default. To add a new definition,
37745       or filter, click 'New Definition' on the Reports Dictionary page and
37746       follow the 4 step process.</para>
37747
37748       <para>Step 1: Name the definition and provide a description if
37749       necessary</para>
37750
37751       <screenshot>
37752         <screeninfo>Create a Definition</screeninfo>
37753
37754         <mediaobject>
37755           <imageobject>
37756             <imagedata fileref="images/reports/dict1.png"/>
37757           </imageobject>
37758         </mediaobject>
37759       </screenshot>
37760
37761       <para>Step 2: Choose the module that the will be queried.</para>
37762
37763       <screenshot>
37764         <screeninfo>Select Koha Module</screeninfo>
37765
37766         <mediaobject>
37767           <imageobject>
37768             <imagedata fileref="images/reports/dict2.png"/>
37769           </imageobject>
37770         </mediaobject>
37771       </screenshot>
37772
37773       <para>Step 3: Choose columns to query from the tables presented.</para>
37774
37775       <screenshot>
37776         <screeninfo>Choose columns</screeninfo>
37777
37778         <mediaobject>
37779           <imageobject>
37780             <imagedata fileref="images/reports/dict3.png"/>
37781           </imageobject>
37782         </mediaobject>
37783       </screenshot>
37784
37785       <para>Step 4: Choose the value(s) from the field(s). These will be
37786       automatically populated with options available in your database.</para>
37787
37788       <screenshot>
37789         <screeninfo>Choose fields and values</screeninfo>
37790
37791         <mediaobject>
37792           <imageobject>
37793             <imagedata fileref="images/reports/dict4.png"/>
37794           </imageobject>
37795         </mediaobject>
37796       </screenshot>
37797
37798       <para>Confirm your selections to save the definition.</para>
37799
37800       <screenshot>
37801         <screeninfo>Confirm Definition</screeninfo>
37802
37803         <mediaobject>
37804           <imageobject>
37805             <imagedata fileref="images/reports/dictconfirm.png"/>
37806           </imageobject>
37807         </mediaobject>
37808       </screenshot>
37809
37810       <para>Your definitions will all appear on the Reports Dictionary
37811       page</para>
37812
37813       <screenshot>
37814         <screeninfo>Reports Dictionary Listing</screeninfo>
37815
37816         <mediaobject>
37817           <imageobject>
37818             <imagedata fileref="images/reports/dictlist.png"/>
37819           </imageobject>
37820         </mediaobject>
37821       </screenshot>
37822
37823       <para>Then when generating reports on the module you created the value
37824       for you will see an option to limit by the definition at the bottom of
37825       the usual filters.</para>
37826
37827       <screenshot>
37828         <screeninfo>Dictionary Limit Option</screeninfo>
37829
37830         <mediaobject>
37831           <imageobject>
37832             <imagedata fileref="images/reports/dictionarylimit.png"/>
37833           </imageobject>
37834         </mediaobject>
37835       </screenshot>
37836     </section>
37837   </chapter>
37838
37839   <chapter id="opac">
37840     <title>OPAC</title>
37841
37842     <para>This chapter assumes that you have the following preferences set as
37843     follows:</para>
37844
37845     <itemizedlist>
37846       <listitem>
37847         <para><link linkend="opacthemes">opacthemes</link> = bootstrap</para>
37848       </listitem>
37849       <listitem>
37850         <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> = default</para>
37851       </listitem>
37852
37853       <listitem>
37854         <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
37855         default</para>
37856       </listitem>
37857
37858       <listitem>
37859         <para><link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
37860         = show</para>
37861       </listitem>
37862
37863       <listitem>
37864         <para><link linkend="TagsEnabled">TagsEnabled</link> = Allow</para>
37865       </listitem>
37866
37867       <listitem>
37868         <para><link linkend="TagsInputOnDetail">TagsInputOnDetail</link>
37869         =Allow</para>
37870       </listitem>
37871
37872       <listitem>
37873         <para><link linkend="TagsInputOnList">TagsInputOnList</link> =
37874         Allow</para>
37875       </listitem>
37876
37877       <listitem>
37878         <para><link linkend="reviewson">reviewson</link> = Allow</para>
37879       </listitem>
37880
37881       <listitem>
37882         <para><link linkend="ShowReviewer">ShowReviewer</link> = Allow</para>
37883       </listitem>
37884
37885       <listitem>
37886         <para><link linkend="ShowReviewerPhoto">ShowReviewerPhoto</link>
37887         =Allow</para>
37888       </listitem>
37889
37890       <listitem>
37891         <para><link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> =
37892         Show</para>
37893       </listitem>
37894
37895       <listitem>
37896         <para><link linkend="OPACAmazonCoverImages">OPACAmazonCoverImages</link> =
37897         Show</para>
37898       </listitem>
37899
37900       <listitem>
37901         <para><link linkend="XISBN">XISBN</link> = Use</para>
37902       </listitem>
37903
37904       <listitem>
37905         <para><link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
37906         = Default set of links</para>
37907       </listitem>
37908
37909       <listitem>
37910         <para><link linkend="OPACShowCheckoutName">OPACShowCheckoutName</link>
37911         = Don't show</para>
37912       </listitem>
37913
37914       <listitem>
37915         <para><link linkend="RequestOnOpac">RequestOnOpac</link> =
37916         Allow</para>
37917       </listitem>
37918
37919       <listitem>
37920         <para><link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link> =
37921         Allow</para>
37922       </listitem>
37923
37924       <listitem>
37925         <para><link linkend="OpacBrowseResults">OpacBrowseResults</link> =
37926         Enable</para>
37927       </listitem>
37928
37929       <listitem>
37930         <para><link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> =
37931         Allow</para>
37932       </listitem>
37933
37934       <listitem>
37935         <para><link linkend="OPACShowBarcode">OPACShowBarcode</link> = Don't show</para>
37936       </listitem>
37937       <listitem>
37938         <para><link linkend="OpacSeparateHoldings">OpacSeparateHoldings</link> = Don't
37939           separate</para>
37940       </listitem>
37941       <listitem>
37942         <para><link linkend="OpacSeparateHoldings">OpacSeparateHoldingsBranch</link> = home
37943           library</para>
37944       </listitem>
37945       <listitem>
37946         <para><link linkend="DisplayLibraryFacets">DisplayLibraryFacets</link> = holding
37947           library</para>
37948       </listitem>
37949     </itemizedlist>
37950
37951     <para>If your system preferences are set differently your displays may
37952     differ.</para>
37953
37954     <section id="opacsearchresults">
37955       <title>Search Results</title>
37956
37957       <para>To search the OPAC you can either choose to enter your search
37958       words in the box at the top of the OPAC or click on the 'Advanced
37959       Search' link to perform a more detailed search.</para>
37960
37961       <screenshot>
37962         <screeninfo>OPAC Search Box</screeninfo>
37963
37964         <mediaobject>
37965           <imageobject>
37966             <imagedata fileref="images/opac/searchbox.png"/>
37967           </imageobject>
37968         </mediaobject>
37969       </screenshot>
37970
37971       <para>For more on searching check the '<link linkend="searching">Searching</link>' chapter in this manual.</para>
37972
37973       <section id="opacresultsoverview">
37974         <title>Results Overview</title>
37975
37976         <para>After performing a search the number of results found for your
37977         search will appear above the results</para>
37978
37979         <screenshot>
37980           <screeninfo>Total Results</screeninfo>
37981
37982           <mediaobject>
37983             <imageobject>
37984               <imagedata fileref="images/opac/totalresults-rss.png"/>
37985             </imageobject>
37986           </mediaobject>
37987         </screenshot>
37988
37989         <para>By default your search results will be sorted based on your
37990         <link linkend="opacdefaultsort">OPACdefaultSortField and
37991         OPACdefaultSortOrder</link> system preference values. To change this
37992         you can choose another sorting method from the pull down on the
37993         right.</para>
37994
37995         <screenshot>
37996           <screeninfo>Results Sorting Options</screeninfo>
37997
37998           <mediaobject>
37999             <imageobject>
38000               <imagedata fileref="images/opac/sortingresults.png"/>
38001             </imageobject>
38002           </mediaobject>
38003         </screenshot>
38004
38005         <para>Under each title on your results list a series of values from your leader will appear.
38006           It is important to note that this has nothing to do with the item types or collection
38007           codes you have applied to your records, this data is all pulled from your fixed fields.
38008           This can be turned on or off with the <link linkend="DisplayOPACiconsXSLT"
38009             >DisplayOPACiconsXSLT</link> system preference.</para>
38010
38011         <screenshot>
38012           <screeninfo>Leader Visualization</screeninfo>
38013
38014           <mediaobject>
38015             <imageobject>
38016               <imagedata fileref="images/opac/leader.png"/>
38017             </imageobject>
38018           </mediaobject>
38019         </screenshot>
38020
38021         <para>Below each title you will see the availability for the items attached to the record. <note>
38022             <para>Even if you filtered on one library location all locations that hold the item will
38023               appear on the search results.</para>
38024           </note><important>
38025             <para>An item's hold status doesn't not affect whether or not the item is 'available'
38026               until the item is in 'waiting' status. Items with on-shelf holds will show as
38027               available until a librarian has pulled them from the shelf and checked the item in
38028               make it show 'waiting'.</para>
38029           </important></para>
38030
38031         <screenshot>
38032           <screeninfo>Holdings Information</screeninfo>
38033
38034           <mediaobject>
38035             <imageobject>
38036               <imagedata fileref="images/opac/holdings-results.png"/>
38037             </imageobject>
38038           </mediaobject>
38039         </screenshot>
38040
38041         <para>If you have turned on <link linkend="enhancedcontent">Enhanced
38042         Content</link> preferences you may have book jackets on your search
38043         results.</para>
38044
38045         <screenshot>
38046           <screeninfo>Book Jacket on Results</screeninfo>
38047
38048           <mediaobject>
38049             <imageobject>
38050               <imagedata fileref="images/opac/coverresults.png"/>
38051             </imageobject>
38052           </mediaobject>
38053         </screenshot>
38054         <para>If you have set your <link linkend="didyoumean">Did you mean?</link> options you will
38055           see a yellow bar across the top of your results will other related searches.</para>
38056         <screenshot>
38057             <screeninfo>Did you mean?</screeninfo>
38058             <mediaobject>
38059               <imageobject>
38060                 <imagedata fileref="images/opac/didyoumeanopac.png"/>
38061               </imageobject>
38062             </mediaobject>
38063           </screenshot>
38064       </section>
38065
38066       <section id="opacfilter">
38067         <title>Filters</title>
38068
38069         <para>To filter your results click on the links below the 'Refine Your
38070         Search' menu on the left of your screen</para>
38071
38072         <screenshot>
38073           <screeninfo>Refine Your Results</screeninfo>
38074
38075           <mediaobject>
38076             <imageobject>
38077               <imagedata fileref="images/opac/refineresults.png"/>
38078             </imageobject>
38079           </mediaobject>
38080         </screenshot>
38081         <para>Depending on your setting for the <link linkend="DisplayLibraryFacets"
38082             >DisplayLibraryFacets</link> system preference you will see filters for your home,
38083           holding or both libraries.<screenshot>
38084             <screeninfo>Library Facet</screeninfo>
38085             <mediaobject>
38086               <imageobject>
38087                 <imagedata fileref="images/opac/locationfacet.png"/>
38088               </imageobject>
38089             </mediaobject>
38090           </screenshot></para>
38091         <para>After clicking a facet you can remove that filter from your results by clicking the
38092           small 'x' that appears to the right of the facet.<screenshot>
38093             <screeninfo>Remove library facet</screeninfo>
38094             <mediaobject>
38095               <imageobject>
38096                 <imagedata fileref="images/opac/removefilter.png"/>
38097               </imageobject>
38098             </mediaobject>
38099           </screenshot></para>
38100       </section>
38101
38102       <section id="searchrss">
38103         <title>Search RSS Feeds</title>
38104
38105         <para>You will be able to subscribe to your search results as an RSS
38106         feed by clicking the RSS icon in your address bar or next to the
38107         number of results. To learn more about what RSS feeds are check out
38108         <ulink url="http://www.youtube.com/watch?v=0klgLsSxGsU">this tutorial
38109         video</ulink>.</para>
38110
38111         <screenshot>
38112           <screeninfo>RSS Feed Icon</screeninfo>
38113
38114           <mediaobject>
38115             <imageobject>
38116               <imagedata fileref="images/opac/totalresults-rss.png"/>
38117             </imageobject>
38118           </mediaobject>
38119         </screenshot>
38120
38121         <para>Subscribing to search results as RSS feeds will allow you to see
38122         when a new item is added to the catalog in your area of
38123         interest.</para>
38124       </section>
38125     </section>
38126
38127     <section id="opacbibrec">
38128       <title>Bibliographic Record</title>
38129
38130       <para>When you click on a title from the search results, you're brought
38131       to the bibliographic detail of the record. This page is broken down in
38132       several different areas.</para>
38133
38134       <para>At the top of your screen will be the title and the GMD:</para>
38135
38136       <screenshot>
38137         <screeninfo>Title</screeninfo>
38138
38139         <mediaobject>
38140           <imageobject>
38141             <imagedata fileref="images/opac/bibdetail/bibtitle.png"/>
38142           </imageobject>
38143         </mediaobject>
38144       </screenshot>
38145
38146       <para>Below the title the authors will be listed. These come from your
38147       1xx and 7xx fields. Clicking the author will run a search for other
38148       titles with that author.</para>
38149
38150       <screenshot>
38151         <screeninfo>Author Display</screeninfo>
38152
38153         <mediaobject>
38154           <imageobject>
38155             <imagedata fileref="images/opac/bibdetail/bibauthor.png"/>
38156           </imageobject>
38157         </mediaobject>
38158       </screenshot>
38159
38160       <para>If you have an authority file you will see a magnifying glass to
38161       the right of author (and other) authorities. Clicking that magnifying
38162       glass will take you directly to the authority record.</para>
38163
38164       <screenshot>
38165         <screeninfo>Authority link</screeninfo>
38166
38167         <mediaobject>
38168           <imageobject>
38169             <imagedata fileref="images/opac/bibdetail/authoritylink.png"/>
38170           </imageobject>
38171         </mediaobject>
38172       </screenshot>
38173
38174       <para>If you have your <link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> preference
38175       set to 'show' you will see a material type that is determined by values
38176       in your fixed fields (learn more in the <link linkend="XSLTiTypes">XSLT
38177       Item Types</link> Appendix).</para>
38178
38179       <screenshot>
38180         <screeninfo>XSLT Item Type</screeninfo>
38181
38182         <mediaobject>
38183           <imageobject>
38184             <imagedata fileref="images/opac/bibdetail/bibleader.png"/>
38185           </imageobject>
38186         </mediaobject>
38187       </screenshot>
38188
38189       <para>Next you'll see the description of the record you're
38190       viewing:</para>
38191
38192       <screenshot>
38193         <screeninfo>Basic Details</screeninfo>
38194
38195         <mediaobject>
38196           <imageobject>
38197             <imagedata fileref="images/opac/bibdetail/bibdetails.png"/>
38198           </imageobject>
38199         </mediaobject>
38200       </screenshot>
38201
38202       <para>Following that information you'll find the subject headings which
38203       can be clicked to search for other titles on similar topics</para>
38204
38205       <screenshot>
38206         <screeninfo>Bibliographic Subjects</screeninfo>
38207
38208         <mediaobject>
38209           <imageobject>
38210             <imagedata fileref="images/opac/bibdetail/bibsubjects.png"/>
38211           </imageobject>
38212         </mediaobject>
38213       </screenshot>
38214
38215       <para>If your record has a table of contents or summary it will appear
38216       next to the 'Summary' or 'Table of Contents' label</para>
38217
38218       <screenshot>
38219         <screeninfo>Summary</screeninfo>
38220
38221         <mediaobject>
38222           <imageobject>
38223             <imagedata fileref="images/opac/bibdetail/bibsummary.png"/>
38224           </imageobject>
38225         </mediaobject>
38226       </screenshot>
38227
38228       <para>If your record has data in the 856 fields you'll see the links to
38229       the right of the 'Online Resources' label</para>
38230
38231       <screenshot>
38232         <screeninfo>Online Resources</screeninfo>
38233
38234         <mediaobject>
38235           <imageobject>
38236             <imagedata fileref="images/opac/bibdetail/biblinks.png"/>
38237           </imageobject>
38238         </mediaobject>
38239       </screenshot>
38240
38241       <para>If the title you're viewing is in a public list then you'll see a
38242       list of those to the right of the 'List(s) this item appears in' label
38243       and if it has tags they will appear below the 'Tags from this library'
38244       label</para>
38245
38246       <screenshot>
38247         <screeninfo>Tags</screeninfo>
38248
38249         <mediaobject>
38250           <imageobject>
38251             <imagedata fileref="images/opac/bibdetail/bibtags.png"/>
38252           </imageobject>
38253         </mediaobject>
38254       </screenshot>
38255
38256       <para>In the tabs below the details you will find your holdings
38257       data</para>
38258
38259       <screenshot>
38260         <screeninfo/>
38261
38262         <mediaobject>
38263           <imageobject>
38264             <imagedata fileref="images/opac/bibdetail/bibholdings.png"/>
38265           </imageobject>
38266         </mediaobject>
38267       </screenshot>
38268
38269       <para>Any notes (5xx fields) that have been cataloged will appear under
38270       'Title Notes'</para>
38271
38272       <screenshot>
38273         <screeninfo>Title notes</screeninfo>
38274
38275         <mediaobject>
38276           <imageobject>
38277             <imagedata fileref="images/opac/bibdetail/bibtitlenotes.png"/>
38278           </imageobject>
38279         </mediaobject>
38280       </screenshot>
38281
38282       <para>If you're allowing comments they will appear in the next
38283       tab</para>
38284
38285       <screenshot>
38286         <screeninfo>Comments</screeninfo>
38287
38288         <mediaobject>
38289           <imageobject>
38290             <imagedata fileref="images/opac/bibdetail/bibcomments.png"/>
38291           </imageobject>
38292         </mediaobject>
38293       </screenshot>
38294
38295       <para>And finally if you have enabled FRBR and you have other editions
38296       of the title in your collection you will see the 'Editions' tab.</para>
38297
38298       <screenshot>
38299         <screeninfo>Editions</screeninfo>
38300
38301         <mediaobject>
38302           <imageobject>
38303             <imagedata fileref="images/opac/bibdetail/bibeditions.png"/>
38304           </imageobject>
38305         </mediaobject>
38306       </screenshot>
38307
38308       <para>To the right of the details you'll find a series of boxes. The
38309       first box is a list of buttons to help navigate the search results. From
38310       there you can see the next or previous result from your search or return
38311       to the results.</para>
38312
38313       <screenshot>
38314         <screeninfo>Search Options</screeninfo>
38315
38316         <mediaobject>
38317           <imageobject>
38318             <imagedata fileref="images/opac/bibdetail/bibsearch.png"/>
38319           </imageobject>
38320         </mediaobject>
38321       </screenshot>
38322
38323       <para>Clicking Browse Results at the top of the right column will open
38324       up your search results on the detail page</para>
38325
38326       <screenshot>
38327         <screeninfo>Search Results</screeninfo>
38328
38329         <mediaobject>
38330           <imageobject>
38331             <imagedata fileref="images/opac/bibdetail/bibbrowseresults.png"/>
38332           </imageobject>
38333         </mediaobject>
38334       </screenshot>
38335
38336       <para>Below the search buttons you'll find the links to place a hold,
38337       print the record, save the record to your lists, or add it to your
38338       cart</para>
38339
38340       <screenshot>
38341         <screeninfo>More options</screeninfo>
38342
38343         <mediaobject>
38344           <imageobject>
38345             <imagedata fileref="images/opac/bibdetail/biboptions.png"/>
38346           </imageobject>
38347         </mediaobject>
38348       </screenshot>
38349
38350       <para>Clicking 'More Searches' will show the list of libraries you
38351       entered in your <link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
38352       preference</para>
38353
38354       <screenshot>
38355         <screeninfo>More Searches</screeninfo>
38356
38357         <mediaobject>
38358           <imageobject>
38359             <imagedata fileref="images/opac/bibdetail/bibmoresearch.png"/>
38360           </imageobject>
38361         </mediaobject>
38362       </screenshot>
38363
38364       <para>Under the 'Save Record' label you will find a series of file
38365       formats you can save the record as. This list can be customized by
38366       altering the <link linkend="OpacExportOptions">OpacExportOptions</link>
38367       system preference.</para>
38368
38369       <screenshot>
38370         <screeninfo>Save Record</screeninfo>
38371
38372         <mediaobject>
38373           <imageobject>
38374             <imagedata fileref="images/opac/bibdetail/bibsave.png"/>
38375           </imageobject>
38376         </mediaobject>
38377       </screenshot>
38378
38379       <para>If at any time you want to change the view from the 'Normal' view
38380       to see the Marc or the ISBD you can click the tabs across the top of the
38381       record</para>
38382
38383       <screenshot>
38384         <screeninfo>Record Views</screeninfo>
38385
38386         <mediaobject>
38387           <imageobject>
38388             <imagedata fileref="images/opac/bibdetail/bibviews.png"/>
38389           </imageobject>
38390         </mediaobject>
38391       </screenshot>
38392     </section>
38393
38394     <section id="opaclistscart">
38395       <title>Lists &amp; Cart</title>
38396
38397       <para>A cart is a temporary holding place for records you're interested
38398       in finding during this session. That means that once you log out of the
38399       OPAC or close the browser you lose the items in your cart. A list is a
38400       more permanent location for saving items. To learn more about lists,
38401       check the <link linkend="stafflists">Lists in the Staff Client</link>
38402       chapter of this manual.</para>
38403
38404       <section id="opaclists">
38405         <title>Lists</title>
38406
38407         <para>Patrons can manage their own private lists by visiting the 'my
38408         lists' section of their account.</para>
38409
38410         <screenshot>
38411           <screeninfo>Lists Management</screeninfo>
38412
38413           <mediaobject>
38414             <imageobject>
38415               <imagedata fileref="images/opac/nolists.png"/>
38416             </imageobject>
38417           </mediaobject>
38418         </screenshot>
38419
38420         <section id="opacaddlists">
38421           <title>Creating Lists</title>
38422
38423           <para>Lists can also be created by choosing the 'New List' option in
38424           the 'Add to' menu on the search results</para>
38425
38426           <screenshot>
38427             <screeninfo>Add to New List</screeninfo>
38428
38429             <mediaobject>
38430               <imageobject>
38431                 <imagedata fileref="images/opac/addtonewlist.png"/>
38432               </imageobject>
38433             </mediaobject>
38434           </screenshot>
38435
38436           <para>To create a list the patron simply needs to click the 'New
38437           List' link and populate the form that appears</para>
38438
38439           <screenshot>
38440             <screeninfo>Create a new list</screeninfo>
38441
38442             <mediaobject>
38443               <imageobject>
38444                 <imagedata fileref="images/opac/publiclistpermissions.png"/>
38445               </imageobject>
38446             </mediaobject>
38447           </screenshot>
38448
38449           <para>The only field required is the 'List Name,' but the patron can also choose how they
38450             want the list sorted and if the list is public or private.<itemizedlist>
38451               <listitem>
38452                 <para>A Private List is managed by you and can be seen only by you (depending on
38453                   your permissions settings below)</para>
38454               </listitem>
38455               <listitem>
38456                 <para>A Public List can be seen by everybody, but managed only by you (depending on
38457                   your permissions settings below)</para>
38458               </listitem>
38459             </itemizedlist><important>
38460               <para>If you aren't allowing patrons to create public lists with the <link linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link>
38461                 preference then patrons will only be able to create private lists.</para>
38462               <screenshot>
38463                 <screeninfo>Create a new private list</screeninfo>
38464                 <mediaobject>
38465                   <imageobject>
38466                     <imagedata fileref="images/opac/newlist.png"/>
38467                   </imageobject>
38468                 </mediaobject>
38469               </screenshot>
38470             </important></para>
38471           <itemizedlist>
38472             <listitem>
38473               <para>Finally decide what your permissions will be on the list. You can all or disallow:<itemizedlist>
38474                   <listitem>
38475                     <para>anyone else to add entries</para>
38476                   </listitem>
38477                   <listitem>
38478                     <para>anyone to remove his own contributed entries<itemizedlist>
38479                         <listitem>
38480                           <note>
38481                             <para>The owner of a list is always allowed to add entries, but needs
38482                               permission to remove.</para>
38483                           </note>
38484                         </listitem>
38485                       </itemizedlist></para>
38486                   </listitem>
38487                   <listitem>
38488                     <para>anyone to remove other contributed entries     </para>
38489                   </listitem>
38490                 </itemizedlist></para>
38491             </listitem>
38492           </itemizedlist>
38493         </section>
38494
38495         <section id="opacaddtolists">
38496           <title>Adding titles to Lists</title>
38497
38498           <para>Titles can be added to lists from the search results and/or
38499           from the bibliographic record. On the search results options to add
38500           items to the list appear below each result and across the top of the
38501           results page</para>
38502
38503           <screenshot>
38504             <screeninfo>Add to Lists from Results</screeninfo>
38505
38506             <mediaobject>
38507               <imageobject>
38508                 <imagedata fileref="images/opac/addtolistcart.png"/>
38509               </imageobject>
38510             </mediaobject>
38511           </screenshot>
38512
38513           <para>To add a single title to a list, click the 'Save to Lists'
38514           option and then choose the list you'd like to add the title to. To
38515           add multiple titles to a list check the boxes on the left of the
38516           titles you want to add and then choose the list you want to add the
38517           titles to from the 'Add too' pull down at the top of the
38518           screen.</para>
38519         </section>
38520
38521         <section id="listscontent">
38522           <title>Viewing Lists Contents</title>
38523
38524           <para>To view the contents of a list, click on the list name under
38525           the Lists button.</para>
38526
38527           <screenshot>
38528             <screeninfo>Lists</screeninfo>
38529
38530             <mediaobject>
38531               <imageobject>
38532                 <imagedata fileref="images/opac/chooselist.png"/>
38533               </imageobject>
38534             </mediaobject>
38535           </screenshot>
38536
38537           <para>The contents of the list will look similar to your search
38538           results pages except that there will be different menu options
38539           across the top of the list.</para>
38540
38541           <screenshot>
38542             <screeninfo>List View</screeninfo>
38543
38544             <mediaobject>
38545               <imageobject>
38546                 <imagedata fileref="images/opac/listview.png"/>
38547               </imageobject>
38548             </mediaobject>
38549           </screenshot>
38550
38551           <para>Using the menu options above the list you can place multiple
38552           items on hold, download the list contents, email the list or print
38553           the list out.</para>
38554
38555           <itemizedlist>
38556             <listitem>
38557               <para>To place a hold on one or more list items check the box to
38558               the left of the item and click the 'Place Hold' link at the
38559               top</para>
38560             </listitem>
38561
38562             <listitem>
38563               <para>To download the list contents click the 'Download List'
38564               link and choose the format you'd like to download the list
38565               in</para>
38566             </listitem>
38567
38568             <listitem>
38569               <para>To email the list contents to someone, click the 'Send List' link and enter in
38570                 your email details in the form that pops up (<link linkend="examplelistemail">view a
38571                   sample Lists email</link>)</para>
38572
38573               <screenshot>
38574                 <screeninfo>Email List Contents</screeninfo>
38575
38576                 <mediaobject>
38577                   <imageobject>
38578                     <imagedata fileref="images/opac/emailist.png"/>
38579                   </imageobject>
38580                 </mediaobject>
38581               </screenshot>
38582             </listitem>
38583
38584             <listitem>
38585               <para>To print the contents of your list out click the 'Print List' link</para>
38586             </listitem>
38587           </itemizedlist>
38588         </section>
38589
38590         <section id="opacmanagelists">
38591           <title>Managing Lists</title>
38592
38593           <para>Once the list is saved patrons can begin adding items to it.
38594           From the 'my lists' tab on the patron record the patron can edit and
38595           delete the lists they have created by clicking the appropriate link
38596           to the right of the list name.</para>
38597
38598           <screenshot>
38599             <screeninfo>My Lists</screeninfo>
38600
38601             <mediaobject>
38602               <imageobject>
38603                 <imagedata fileref="images/opac/mylists.png"/>
38604               </imageobject>
38605             </mediaobject>
38606           </screenshot>
38607
38608           <para>To edit the list's title or sorting patrons click the 'Edit'
38609           link to the right of the list description.</para>
38610
38611           <screenshot>
38612             <screeninfo>Editing List</screeninfo>
38613
38614             <mediaobject>
38615               <imageobject>
38616                 <imagedata fileref="images/opac/editlist.png"/>
38617               </imageobject>
38618             </mediaobject>
38619           </screenshot>
38620
38621           <para>When clicking 'Delete' next to a list you will be asked to
38622           confirm that you want to delete the list.</para>
38623
38624           <screenshot>
38625             <screeninfo>Delete list confirmation</screeninfo>
38626
38627             <mediaobject>
38628               <imageobject>
38629                 <imagedata fileref="images/opac/deletelist.png"/>
38630               </imageobject>
38631             </mediaobject>
38632           </screenshot>
38633
38634           <para>The list will not be deleted until the 'Confirm' button is
38635           clicked to the right of the list you'd like to delete.</para>
38636
38637           <para>If the library is allowing you to share private lists with the <link
38638               linkend="OpacAllowSharingPrivateLists">OpacAllowSharingPrivateLists</link> preference
38639             then you will see the 'Share' link on your list of lists and the 'Share list' link at
38640             the top of each individual list. Clicking this will ask you to enter the email address
38641             of a patron.<screenshot>
38642               <screeninfo>Share list</screeninfo>
38643               <mediaobject>
38644                 <imageobject>
38645                   <imagedata fileref="images/opac/sharelist.png"/>
38646                 </imageobject>
38647               </mediaobject>
38648             </screenshot></para>
38649           <para>Once the email address is entered Koha will present you with a confirmation message </para>
38650           <screenshot>
38651             <screeninfo>Share list confirmation</screeninfo>
38652             <mediaobject>
38653               <imageobject>
38654                 <imagedata fileref="images/opac/shareconfirmation.png"/>
38655               </imageobject>
38656             </mediaobject>
38657           </screenshot>
38658           <para>and will send a message to that patron.</para>
38659         </section>
38660       </section>
38661
38662       <section id="opaccart">
38663         <title>Cart</title>
38664
38665         <para/>
38666
38667         <section id="opacaddtocart">
38668           <title>Adding titles to the Cart</title>
38669
38670           <para>Titles can be added to the cart from the search results and/or
38671           from the bibliographic record. On the search results options to add
38672           items to the cart appear below each result and across the top of the
38673           results page</para>
38674
38675           <screenshot>
38676             <screeninfo>Add to Cart on Search Results</screeninfo>
38677
38678             <mediaobject>
38679               <imageobject>
38680                 <imagedata fileref="images/opac/addtolistcart.png"/>
38681               </imageobject>
38682             </mediaobject>
38683           </screenshot>
38684
38685           <para>Clicking the 'Add to Cart' button will add the one title to
38686           your cart. To add multiple titles at once, check the box to the left
38687           of each result and then choose 'Cart' from the 'Add to' pull down at
38688           the top of the screen. Once titles are added to the cart you will be
38689           presented with a confirmation</para>
38690
38691           <screenshot>
38692             <screeninfo>Items added to Cart</screeninfo>
38693
38694             <mediaobject>
38695               <imageobject>
38696                 <imagedata fileref="images/opac/addedtocart.png"/>
38697               </imageobject>
38698             </mediaobject>
38699           </screenshot>
38700           <para>From the results you will see which items are in your cart and will be able to
38701             remove those items by clicking '(remove)'.<screenshot>
38702               <screeninfo>Item in your cart</screeninfo>
38703               <mediaobject>
38704                 <imageobject>
38705                   <imagedata fileref="images/opac/iteminyourcart.png"/>
38706                 </imageobject>
38707               </mediaobject>
38708             </screenshot></para>
38709         </section>
38710
38711         <section id="manageopaccart">
38712           <title>Managing the Cart</title>
38713
38714           <para>Once you have titles in your cart you can manage the contents by clicking on the
38715             'Cart' button usually found at the top of the screen. Your cart will open in a new
38716             window.</para>
38717
38718           <screenshot>
38719             <screeninfo>Contents of your cart</screeninfo>
38720
38721             <mediaobject>
38722               <imageobject>
38723                 <imagedata fileref="images/opac/cartcontents.png"/>
38724               </imageobject>
38725             </mediaobject>
38726           </screenshot>
38727
38728           <para>From this window you are presented with several options.
38729           Across the top of the cart are several buttons.</para>
38730
38731           <para>First is the 'More details' button. Clicking this will show you additional
38732             information about the titles in your cart (ISBNs, Subjects, Publisher Info, Notes and more).<screenshot>
38733               <screeninfo>More details in the cart</screeninfo>
38734               <mediaobject>
38735                 <imageobject>
38736                   <imagedata fileref="images/opac/cartmoredetails.png"/>
38737                 </imageobject>
38738               </mediaobject>
38739             </screenshot></para>
38740
38741           <para>Next is the option to send the contents of your cart to an email address. This is
38742             handy if you want to send the resources you found at the library to your home email
38743             account to refer to later or to send to a patron researching a specific topic. Clicking
38744             this link will open up a new window that asks for the email address and message to send.
38745               <link linkend="examplecartemail">View a sample Cart email</link>.</para>
38746
38747           <screenshot>
38748             <screeninfo>Email Cart</screeninfo>
38749
38750             <mediaobject>
38751               <imageobject>
38752                 <imagedata fileref="images/opac/emailcart.png"/>
38753               </imageobject>
38754             </mediaobject>
38755           </screenshot>
38756           <important>
38757             <para>The cart can only be emailed by logged in users. This will prevent your cart email
38758               function from being used for spamming.</para>
38759           </important>
38760
38761           <para>In addition to sending your cart you can download the contents
38762           of your cart in several pre-defined formats or using a <link linkend="csvprofiles">CSV Profile</link> that you defined in the
38763           Tools module.</para>
38764
38765           <screenshot>
38766             <screeninfo>Download Cart</screeninfo>
38767
38768             <mediaobject>
38769               <imageobject>
38770                 <imagedata fileref="images/opac/downloadcart.png"/>
38771               </imageobject>
38772             </mediaobject>
38773           </screenshot>
38774
38775           <para>Finally you can print out the contents of your cart by
38776           choosing the 'Print' link.</para>
38777
38778           <para>In addition to the various different ways to save the contents
38779           of your cart, there are ways to add value to the data in your cart.
38780           By selecting one or more titles from the cart you can add them to a
38781           list (click 'Add to a List'), place hold(s) (click 'Place hold'), or
38782           tag them (click 'Tag'). All of these operations follow the same
38783           procedure as they do when performing them in the OPAC.</para>
38784         </section>
38785       </section>
38786     </section>
38787
38788     <section id="opacplacehold">
38789       <title>Placing Holds</title>
38790
38791       <para>Patrons can place holds on items via the OPAC if they're logged in
38792       and you have the <link linkend="RequestOnOpac">RequestOnOpac</link>
38793       preference set to 'Allow'. If the item can be placed on hold the option
38794       to place it on hold will appear in several different places.</para>
38795
38796       <itemizedlist>
38797         <listitem>
38798           <para>When viewing a list or search results page you'll see the
38799           option to place hold on multiple items by checking the boxes to the
38800           left of the results and clicking 'Place Hold' at the top</para>
38801
38802           <screenshot>
38803             <screeninfo>Place Hold from Results</screeninfo>
38804
38805             <mediaobject>
38806               <imageobject>
38807                 <imagedata fileref="images/opac/opacplaceholdresults.png"/>
38808               </imageobject>
38809             </mediaobject>
38810           </screenshot>
38811         </listitem>
38812
38813         <listitem>
38814           <para>When viewing a list or search results page you'll see the
38815           option to place the item on hold below the basic information about
38816           the title</para>
38817
38818           <screenshot>
38819             <screeninfo>Place Hold</screeninfo>
38820
38821             <mediaobject>
38822               <imageobject>
38823                 <imagedata fileref="images/opac/opacplaceholdsindiv.png"/>
38824               </imageobject>
38825             </mediaobject>
38826           </screenshot>
38827         </listitem>
38828
38829         <listitem>
38830           <para>When viewing an individual title you'll see the option to
38831           place a hold in the box on the right side of the screen</para>
38832
38833           <screenshot>
38834             <screeninfo>Place Hold</screeninfo>
38835
38836             <mediaobject>
38837               <imageobject>
38838                 <imagedata fileref="images/opac/opacplaceholdsdetail.png"/>
38839               </imageobject>
38840             </mediaobject>
38841           </screenshot>
38842         </listitem>
38843       </itemizedlist>
38844
38845       <para>No matter which of the above links you click to place your hold
38846       you'll be brought to the same hold screen.</para>
38847
38848       <screenshot>
38849         <screeninfo>Place Hold Form</screeninfo>
38850
38851         <mediaobject>
38852           <imageobject>
38853             <imagedata fileref="images/opac/opacplacehold.png"/>
38854           </imageobject>
38855         </mediaobject>
38856       </screenshot>
38857
38858       <itemizedlist>
38859         <listitem>
38860           <para>Check the box to the left of the items you'd like to place on
38861           hold</para>
38862         </listitem>
38863
38864         <listitem>
38865           <para>The title includes a link back to the detail page for the
38866           record</para>
38867         </listitem>
38868
38869         <listitem>
38870           <para>The priority shows where in the holds queue this hold will
38871           fall</para>
38872         </listitem>
38873         <listitem>
38874           <para>If allowed by your <link linkend="OPACAllowUserToChooseBranch"
38875               >OPACAllowUserToChooseBranch</link> preference the patron can choose where they'd like
38876             to pick up their hold</para>
38877         </listitem>
38878         <listitem>
38879           <para>If you would like to see more options you can click 'Show more options'</para>
38880
38881
38882           <para>
38883             <screenshot>
38884               <screeninfo>Place Hold Form with More Options</screeninfo>
38885               <mediaobject>
38886                 <imageobject>
38887                   <imagedata fileref="images/opac/opacplaceholdmore.png"/>
38888                 </imageobject>
38889               </mediaobject>
38890             </screenshot>
38891           </para>
38892         </listitem>
38893         <listitem>
38894           <para>If allowed by your <link linkend="OPACAllowHoldDateInFuture"
38895               >OPACAllowHoldDateInFuture</link> preference, the 'Hold Starts on Date' column will
38896             show. This field allows the patron to have their hold start on a future date.</para>
38897         </listitem>
38898
38899         <listitem>
38900           <para>By default holds placed in the system remain until canceled,
38901           but if the patron fills in a 'Hold Not Needed After' date then the
38902           hold has an expiration date.</para>
38903
38904           <itemizedlist>
38905             <listitem>
38906               <important>
38907                 <para>Expired holds are removed by the <link linkend="expiredholdscron">Expired Holds Cron Job</link>, this
38908                 is not an automatic process and must be set up by your system
38909                 administrator</para>
38910               </important>
38911             </listitem>
38912           </itemizedlist>
38913         </listitem>
38914
38915         <listitem>
38916           <para>If allowed by the <link linkend="OpacHoldNotes">OpacHoldNotes</link> preference then
38917             patrons can leave notes about their holds for the library by clicking the 'Edit notes' button</para>
38918           <screenshot>
38919               <screeninfo>Hold notes</screeninfo>
38920               <mediaobject>
38921                 <imageobject>
38922                   <imagedata fileref="images/opac/holdnote.png"/>
38923                 </imageobject>
38924               </mediaobject>
38925             </screenshot>
38926         </listitem>
38927         <listitem>
38928           <para>Depending on the rules you set regarding item specific holds in your <link
38929               linkend="circfinerules">circulation and fines rules</link> the patron will be allowed
38930             to choose whether to place the hold on the next available copy and/or a specific
38931             copy</para>
38932           <screenshot>
38933             <screeninfo>Specific Copy Hold</screeninfo>
38934             <mediaobject>
38935               <imageobject>
38936                 <imagedata fileref="images/opac/opacplaceholdspecific.png"/>
38937               </imageobject>
38938             </mediaobject>
38939           </screenshot>
38940         </listitem>
38941       </itemizedlist>
38942
38943       <para>After clicking the Place Hold button the patron will be brought to
38944       their account page where they'll see all of the items they have on
38945       hold.</para>
38946     </section>
38947
38948     <section id="opacenhancedcontent">
38949       <title>Enhanced Content</title>
38950
38951       <para/>
38952
38953       <section id="opactagging">
38954         <title>Tagging</title>
38955
38956         <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
38957         may be able to add tags to bibliographic records from the search
38958         results and/or bibliographic records. If you are allowing patrons to
38959         add tags from the search results screen you will see an input box
38960         below each result and a 'Tag' option at the top of the screen.</para>
38961
38962         <screenshot>
38963           <screeninfo>Tagging Options on Results</screeninfo>
38964
38965           <mediaobject>
38966             <imageobject>
38967               <imagedata fileref="images/opac/tags-results.png"/>
38968             </imageobject>
38969           </mediaobject>
38970         </screenshot>
38971
38972         <para>To add a tag to one item, type the tabs (separated by commas) in
38973         the 'New tag' box and click 'Add'. You will be presented with a
38974         confirmation of your tags being added.</para>
38975
38976         <screenshot>
38977           <screeninfo>Tags Added on Results</screeninfo>
38978
38979           <mediaobject>
38980             <imageobject>
38981               <imagedata fileref="images/opac/tagsadded-results.png"/>
38982             </imageobject>
38983           </mediaobject>
38984         </screenshot>
38985
38986         <para>From the results you can also tag items in bulk by clicking the
38987         checkboxes on the left and then clicking the 'Tag' button at the top.
38988         After clicking the button it will change into an input box for you to
38989         add tags to all of the items you have selected.</para>
38990
38991         <screenshot>
38992           <screeninfo>Add Tags to Multiple Items</screeninfo>
38993
38994           <mediaobject>
38995             <imageobject>
38996               <imagedata fileref="images/opac/tagaddmultiple-results.png"/>
38997             </imageobject>
38998           </mediaobject>
38999         </screenshot>
39000       </section>
39001
39002       <section id="opaccomments">
39003         <title>Comments</title>
39004
39005         <para>Patrons can leave comments in the OPAC if you have the <link linkend="reviewson">reviewson</link> preference set to allow this.
39006         Each bibliographic record has a comments tab below the bibliographic
39007         information.</para>
39008
39009         <screenshot>
39010           <screeninfo>Comments Tab</screeninfo>
39011
39012           <mediaobject>
39013             <imageobject>
39014               <imagedata fileref="images/opac/commentstab.png"/>
39015             </imageobject>
39016           </mediaobject>
39017         </screenshot>
39018
39019         <para>If the patron is logged in they will see a link to add a comment
39020         to the item. Clicking this link will open a pop up window with a box
39021         for their comments.</para>
39022
39023         <screenshot>
39024           <screeninfo>Add a Comment</screeninfo>
39025
39026           <mediaobject>
39027             <imageobject>
39028               <imagedata fileref="images/opac/addcomment.png"/>
39029             </imageobject>
39030           </mediaobject>
39031         </screenshot>
39032
39033         <para>Once the comment has been typed and the 'Submit' button clicked,
39034         the patron will see their comment as pending and other patrons will
39035         simply see that there are no comments on the item.</para>
39036
39037         <screenshot>
39038           <screeninfo>Pending Comment</screeninfo>
39039
39040           <mediaobject>
39041             <imageobject>
39042               <imagedata fileref="images/opac/commentpending.png"/>
39043             </imageobject>
39044           </mediaobject>
39045         </screenshot>
39046
39047         <para>Once the comment is approved the patron will see the number of comments on the
39048           'Comments' tab and their comment labeled amongst the other comments. If you have set your
39049             <link linkend="ShowReviewerPhoto">ShowReviewerPhoto</link> preference to 'Show' then
39050           you'll see the patron's photo pulled from the <ulink url="https://www.libravatar.org"
39051             >Libravatar</ulink> library.</para>
39052
39053         <screenshot>
39054           <screeninfo>Your Comments</screeninfo>
39055
39056           <mediaobject>
39057             <imageobject>
39058               <imagedata fileref="images/opac/yourcomment.png"/>
39059             </imageobject>
39060           </mediaobject>
39061         </screenshot>
39062
39063         <para>Other patrons will see the comment with the name of the patron
39064         who left the comment (unless you have set the <link linkend="ShowReviewer">ShowReviewer</link> preference to not show
39065         patron names).</para>
39066
39067         <screenshot>
39068           <screeninfo>Comment by other patron</screeninfo>
39069
39070           <mediaobject>
39071             <imageobject>
39072               <imagedata fileref="images/opac/commentby.png"/>
39073             </imageobject>
39074           </mediaobject>
39075         </screenshot>
39076
39077         <para>If you have your <link linkend="OpacShowRecentComments">OpacShowRecentComments</link>
39078           set to show then you'll see the approved comments on that page.</para>
39079
39080         <screenshot>
39081           <screeninfo>Recent Comments List</screeninfo>
39082
39083           <mediaobject>
39084             <imageobject>
39085               <imagedata fileref="images/opac/recentcomments.png"/>
39086             </imageobject>
39087           </mediaobject>
39088         </screenshot>
39089         <para>From this page patrons can subscribe to the recent comments using RSS if they would
39090           like.</para>
39091       </section>
39092
39093       <section id="zotero">
39094         <title>Zotero</title>
39095
39096         <para>Zotero is a Firefox add on that allows for the saving and
39097         generating of a bibliography. Learn more about and download Zotero at
39098         <ulink url="http://zotero.org">http://zotero.org</ulink>.</para>
39099
39100         <para>When on the search results in the Koha OPAC, if you have Zotero
39101         installed, you will see a folder icon in the address bar to the right
39102         of the URL. Clicking that folder will open up a list of titles on the
39103         page for you to pick from to add to Zotero.</para>
39104
39105         <screenshot>
39106           <screeninfo>Zotero pop up</screeninfo>
39107
39108           <mediaobject>
39109             <imageobject>
39110               <imagedata fileref="images/opac/zoteroaddressbar.png"/>
39111             </imageobject>
39112           </mediaobject>
39113         </screenshot>
39114
39115         <para>Select the titles you want to add to Zotero and then click the
39116         'OK' button. This will add the title to Zotero. You can see the title
39117         by opening your Zotero library.</para>
39118
39119         <screenshot>
39120           <screeninfo>Title in the Zotero Library</screeninfo>
39121
39122           <mediaobject>
39123             <imageobject>
39124               <imagedata fileref="images/opac/zoterotitle.png"/>
39125             </imageobject>
39126           </mediaobject>
39127         </screenshot>
39128       </section>
39129
39130       <section id="customrss">
39131         <title>Custom RSS Feeds</title>
39132
39133         <para>Using misc/cronjobs/rss/rss.pl you can generate an RSS feed for
39134         any SQL query (for example a new acquisitions RSS feed). rss.pl is run
39135         on the command line to produce an RSS XML document.</para>
39136
39137         <para>The output should be placed in a directory accessible to the
39138         OPAC (or staff) web interface so that users can download the RSS
39139         feed.</para>
39140
39141         <para>An example of usage can be found at: misc/cronjobs/rss.pl
39142         lastAcquired.conf</para>
39143
39144         <para>Normally rss.pl should be run periodically (e.g., daily) to keep
39145         the feed up-to-date.</para>
39146
39147         <para>The configuration file (e.g., lastAcquired.conf) lists</para>
39148
39149         <itemizedlist>
39150           <listitem>
39151             <para>name of the template file to use</para>
39152           </listitem>
39153
39154           <listitem>
39155             <para>path of output file</para>
39156           </listitem>
39157
39158           <listitem>
39159             <para>SQL query</para>
39160           </listitem>
39161         </itemizedlist>
39162
39163         <para>rss.pl runs the SQL query, then feeds the output of the query
39164         through the template to produce the output file.</para>
39165
39166         <para><important>
39167             <para>To use custom RSS feeds you need to turn on the rss.pl cron job.</para>
39168           </important></para>
39169       </section>
39170     </section>
39171     <section id="selfregistration">
39172       <title>OPAC Self Registration</title>
39173       <para>If you allow it, patrons can register for their own accounts via the OPAC.  If you have
39174         the <link linkend="PatronSelfRegistration">PatronSelfRegistration</link> preference set to
39175         'Allow' then patrons will see a link to register below the log in box on the right of the
39176         main OPAC page.</para>
39177       <screenshot>
39178           <screeninfo>Registration link in OPAC</screeninfo>
39179           <mediaobject>
39180             <imageobject>
39181               <imagedata fileref="images/opac/PatronSelfRegistration.png"/>
39182             </imageobject>
39183           </mediaobject>
39184         </screenshot>
39185       <para>When the patron clicks the 'Register here' link they will be brough to a registration
39186         page. The options on the registration page can be conrolled by editing the <link
39187           linkend="PatronSelfRegistrationBorrowerMandatoryField"
39188           >PatronSelfRegistrationBorrowerMandatoryField</link> and the <link
39189           linkend="PatronSelfRegistrationBorrowerUnwantedField"
39190           >PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
39191       <screenshot>
39192           <screeninfo>Registration form</screeninfo>
39193           <mediaobject>
39194             <imageobject>
39195               <imagedata fileref="images/opac/patronregistration.png"/>
39196             </imageobject>
39197           </mediaobject>
39198         </screenshot>
39199       <para>Once the patron has confirmed submitted their registration they will either be sent an
39200         email to confirm their account (if you have the <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link>
39201         preference to require this) or presented with their new username and password.</para>
39202       <screenshot>
39203           <screeninfo>New account confirmation</screeninfo>
39204           <mediaobject>
39205             <imageobject>
39206               <imagedata fileref="images/opac/patronregistrationcomplete.png"/>
39207             </imageobject>
39208           </mediaobject>
39209         </screenshot>
39210       <para>Patrons registered in this way will not have a cardnumber until assigned one by the
39211         library, but will have access to all OPAC functionality immediately. For this reason it is
39212         recommended that you:<itemizedlist>
39213           <listitem>
39214             <para>set up a provisional <link linkend="addingpatroncat">patron category</link> for
39215               self registered patrons (such as 'Self Registered) instead of using an existing patron
39216               category and set that value in the <link
39217                 linkend="PatronSelfRegistrationDefaultCategory"
39218                 >PatronSelfRegistrationDefaultCategory</link> preference</para>
39219           </listitem>
39220           <listitem>
39221             <para>give this patron category minimal circulation privileges in the <link
39222                 linkend="circfinerules">Circulation and Fine Rules</link> (such as allowing a couple
39223               holds, but no check outs)</para>
39224           </listitem>
39225         </itemizedlist>That way patrons will either have to come in to the library to verify their
39226         identity before given a cardnumber and the ability to check items out or the library will
39227         have to come up with internal policy on generating cardnumbers before providing them to self
39228         registered patrons. Once this is done the library can change the category to one that is
39229         more appropriate (be it an adult, resident, non resident, student, etc) and add a
39230         cardnumber/barcode.</para>
39231     </section>
39232
39233     <section id="opacmyaccount">
39234       <title>My Account</title>
39235
39236       <para>From the OPAC patrons can log in and access their account if you
39237       have set the <link linkend="opacuserlogin">opacuserlogin</link>
39238       preference to 'Allow'. Once logged in patrons are brought to their
39239       account summary. If you would like to get to your account in the OPAC,
39240       you can click on your name in the top right of any page in the
39241       OPAC.</para>
39242
39243       <section id="opacmysummary">
39244         <title>My Summary</title>
39245
39246         <screenshot>
39247           <screeninfo>My Summary</screeninfo>
39248
39249           <mediaobject>
39250             <imageobject>
39251               <imagedata fileref="images/opac/myaccount.png"/>
39252             </imageobject>
39253           </mediaobject>
39254         </screenshot>
39255
39256         <para>From the 'my summary' tab, patrons will see all of the items
39257         they have checked out with the overdue items highlighted in red. If
39258         you have <link linkend="OpacRenewalAllowed">OpacRenewalAllowed</link>
39259         set to 'Allow' then your patrons will be able to renew their books
39260         right from the OPAC. If you have HTML entered in the <link linkend="OPACMySummaryHTML">OPACMySummaryHTML</link> preference then
39261         you will see that to the right of the 'Fines' column.</para>
39262
39263         <screenshot>
39264           <screeninfo>Checked out tab with OPACMySummaryHTML set</screeninfo>
39265
39266           <mediaobject>
39267             <imageobject>
39268               <imagedata fileref="images/opac/opacsummary-wlinks.png"/>
39269             </imageobject>
39270           </mediaobject>
39271         </screenshot>
39272
39273         <para id="barcodeattribute">If your patrons would like to see the items barcodes on their
39274           list of checked out items you can set up a <link linkend="patronattributetypes">patron
39275             attribute</link> with the value of SHOW_BCODE and <link linkend="authorizedvalues"
39276             >authorized value</link> of YES_NO.</para>
39277
39278         <screenshot>
39279           <screeninfo>Add SHOW_BCODE patron attribute</screeninfo>
39280
39281           <mediaobject>
39282             <imageobject>
39283               <imagedata fileref="images/opac/SHOW_BCODEadd.png"/>
39284             </imageobject>
39285           </mediaobject>
39286         </screenshot>
39287
39288         <para>Then on the <link linkend="editpatrons">patron's record set the
39289         value</link> for SHOW_BCODE to yes.</para>
39290
39291         <screenshot>
39292           <screeninfo>Setting value for SHOW_BCODE on patron
39293           record</screeninfo>
39294
39295           <mediaobject>
39296             <imageobject>
39297               <imagedata fileref="images/opac/SHOW_BCODEattribute.png"/>
39298             </imageobject>
39299           </mediaobject>
39300         </screenshot>
39301
39302         <para>This will add a column to the check out summary in the OPAC that
39303         shows the patrons the barcodes of the items they have checked
39304         out.</para>
39305
39306         <screenshot>
39307           <screeninfo>Barcode number on checkout list in OPAC</screeninfo>
39308
39309           <mediaobject>
39310             <imageobject>
39311               <imagedata fileref="images/opac/barcodeoncheckouts.png"/>
39312             </imageobject>
39313           </mediaobject>
39314         </screenshot>
39315
39316         <para>Clicking on the 'Overdue' tab will show only the items that are
39317         overdue.</para>
39318
39319         <screenshot>
39320           <screeninfo>Overdue Items</screeninfo>
39321
39322           <mediaobject>
39323             <imageobject>
39324               <imagedata fileref="images/opac/myoverdues.png"/>
39325             </imageobject>
39326           </mediaobject>
39327         </screenshot>
39328
39329         <para>The 'Fines' tab will show just a total of what the patron owes.
39330         Clicking on the total will take them to the 'my fines' tab where they
39331         will see a complete breakdown of their fines and bills. If you don't
39332         charge fines at your library you can turn the display of these tabs
39333         off by setting the <link linkend="OPACFinesTab">OPACFinesTab</link>
39334         preference to 'Don't Allow.'</para>
39335
39336         <screenshot>
39337           <screeninfo>Patron Fines</screeninfo>
39338
39339           <mediaobject>
39340             <imageobject>
39341               <imagedata fileref="images/opac/myfines.png"/>
39342             </imageobject>
39343           </mediaobject>
39344         </screenshot>
39345
39346         <para>Finally, clicking on the 'Holds' tab will show the patron the status of all of the
39347           items they have on hold. </para>
39348
39349         <screenshot>
39350           <screeninfo>Patron holds status</screeninfo>
39351
39352           <mediaobject>
39353             <imageobject>
39354               <imagedata fileref="images/opac/myholds.png"/>
39355             </imageobject>
39356           </mediaobject>
39357         </screenshot>
39358
39359         <para>Patrons can cancel or suspend (depending on the value of your <link
39360             linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> system preference) their own holds if
39361           they are not in transit or already waiting for them. When they click 'Suspend' they will
39362           be presented with the option to choose a date for their hold to resume.<screenshot>
39363             <screeninfo>Suspend until</screeninfo>
39364             <mediaobject>
39365               <imageobject>
39366                 <imagedata fileref="images/opac/suspenduntil.png"/>
39367               </imageobject>
39368             </mediaobject>
39369           </screenshot></para>
39370         <para>They can also suspend all of their holds indefinitely or until a specific date if they
39371           choose by filling in the suspend options at the bottom of the page.</para>
39372
39373         <note>
39374           <para>If you have your <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
39375           preference set to "Don't allow" then you will not have the option to
39376           put an end date on the hold suspension</para>
39377         </note>
39378       </section>
39379
39380       <section id="opacmyaccount-flags">
39381         <title>Patron Flags</title>
39382
39383         <para>If you have <link linkend="patronflags">flagged your patron's
39384         account</link> they may see one of the following error messages at the
39385         top of their account.</para>
39386
39387         <itemizedlist>
39388           <listitem>
39389             <para>Card marked as lost</para>
39390
39391             <screenshot>
39392               <screeninfo>Library card lost</screeninfo>
39393
39394               <mediaobject>
39395                 <imageobject>
39396                   <imagedata fileref="images/opac/nocard.png"/>
39397                 </imageobject>
39398               </mediaobject>
39399             </screenshot>
39400           </listitem>
39401
39402           <listitem>
39403             <para>Patron address in question</para>
39404
39405             <screenshot>
39406               <screeninfo>Patron address in question</screeninfo>
39407
39408               <mediaobject>
39409                 <imageobject>
39410                   <imagedata fileref="images/opac/noaddress.png"/>
39411                 </imageobject>
39412               </mediaobject>
39413             </screenshot>
39414
39415             <itemizedlist>
39416               <listitem>
39417                 <note>
39418                   <para>this error message will not include a link to the
39419                   update form if you have <link linkend="OPACPatronDetails">OPACPatronDetails</link> set to
39420                   'Don't allow'</para>
39421                 </note>
39422               </listitem>
39423             </itemizedlist>
39424           </listitem>
39425
39426           <listitem>
39427             <para>Patron marked restricted</para>
39428
39429             <screenshot>
39430               <screeninfo>Patron restricted</screeninfo>
39431
39432               <mediaobject>
39433                 <imageobject>
39434                   <imagedata fileref="images/opac/debarred.png"/>
39435                 </imageobject>
39436               </mediaobject>
39437             </screenshot>
39438           </listitem>
39439         </itemizedlist>
39440       </section>
39441
39442       <section id="opacmyfines">
39443         <title>My Fines</title>
39444
39445         <para>If your library charges fines the next tab on the left is 'my
39446         fines.' Opening this tab will show the patron an entire history of
39447         their accounting at the library.</para>
39448
39449         <screenshot>
39450           <screeninfo>Library Fines &amp; Charges</screeninfo>
39451
39452           <mediaobject>
39453             <imageobject>
39454               <imagedata fileref="images/opac/mybilling.png"/>
39455             </imageobject>
39456           </mediaobject>
39457         </screenshot>
39458       </section>
39459
39460       <section id="opacmydetails">
39461         <title>My Details</title>
39462
39463         <para>If you have your <link linkend="OPACPatronDetails">OPACPatronDetails</link> preference
39464           set to 'Allow', your patrons will see a form filled in with their contacting information
39465           by clicking on the 'my personal details' tab. You can control what fields patrons see and
39466           can modify via the OPAC by setting the <link linkend="PatronSelfRegistrationBorrowerMandatoryField">PatronSelfRegistrationBorrowerMandatoryField</link>
39467           <link linkend="PatronSelfRegistrationBorrowerUnwantedField">PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
39468
39469         <screenshot>
39470           <screeninfo>Patron's personal details</screeninfo>
39471
39472           <mediaobject>
39473             <imageobject>
39474               <imagedata fileref="images/opac/myprofile.png"/>
39475             </imageobject>
39476           </mediaobject>
39477         </screenshot>
39478
39479         <para>Patrons can edit their details in this form and click 'Submit Changes' to have their
39480           edits sent to the library for review before their record is updated. Staff will see all
39481           patrons requesting modification to their record listed below the modules on the main
39482           dashboard along with anything else awaiting library attention.</para>
39483         <screenshot>
39484             <screeninfo>Patron requests waiting review</screeninfo>
39485             <mediaobject>
39486               <imageobject>
39487                 <imagedata fileref="images/opac/patronrequestwaiting.png"/>
39488               </imageobject>
39489             </mediaobject>
39490           </screenshot>
39491
39492         <para>If the <link linkend="OPACPatronDetails">OPACPatronDetails</link> preference is set to
39493           'Don't allow' then patrons will simply see their details and a message stating that they
39494           should contact the library for changes.</para>
39495
39496         <screenshot>
39497           <screeninfo>Patron's personal details with no edits</screeninfo>
39498
39499           <mediaobject>
39500             <imageobject>
39501               <imagedata fileref="images/opac/myprofile-noedit.png"/>
39502             </imageobject>
39503           </mediaobject>
39504         </screenshot>
39505       </section>
39506
39507       <section id="opacmytags">
39508         <title>My Tags</title>
39509
39510         <para>If your library has <link linkend="TagsEnabled">TagsEnabled</link> set to 'Allowed' then the
39511         next tab on the left will be 'my tags.' This tab will show patrons all
39512         of the tags in the system as a cloud and then all of the tags they
39513         have applied in a list format. From here patrons have the ability to
39514         remove tags that they have added if they want.</para>
39515
39516         <screenshot>
39517           <screeninfo>Patron's tags</screeninfo>
39518
39519           <mediaobject>
39520             <imageobject>
39521               <imagedata fileref="images/opac/mytags.png"/>
39522             </imageobject>
39523           </mediaobject>
39524         </screenshot>
39525       </section>
39526
39527       <section id="opacmypassword">
39528         <title>Change My Password</title>
39529
39530         <para>Next, if you have <link linkend="OpacPasswordChange">OpacPasswordChange</link> set to 'Allow'
39531         the next tab will be 'change my password,' where patrons can change
39532         their password for logging into the OPAC. Patrons will be presented
39533         with a standard form asking them to enter their old password and then
39534         their new password twice.</para>
39535
39536         <screenshot>
39537           <screeninfo>Change my password</screeninfo>
39538
39539           <mediaobject>
39540             <imageobject>
39541               <imagedata fileref="images/opac/mypassword.png"/>
39542             </imageobject>
39543           </mediaobject>
39544         </screenshot>
39545       </section>
39546
39547       <section id="opacmysearchistory">
39548         <title>My Search History</title>
39549
39550         <para>If you have your <link linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
39551         preference set to 'Allow' then your patrons can access their search
39552         history via the 'my search history' tab.</para>
39553
39554         <screenshot>
39555           <screeninfo>my search history tab</screeninfo>
39556
39557           <mediaobject>
39558             <imageobject>
39559               <imagedata fileref="images/opac/mysearchhistory.png"/>
39560             </imageobject>
39561           </mediaobject>
39562         </screenshot>
39563
39564         <para>The search history is a record of all searches run by the
39565         patron. Clicking on any of the search phrases will re-run the search
39566         for the patron. The search history can be deleted by the patron at any
39567         time by clicking the 'Delete your search history' link found at the
39568         top of this tab or by clicking the little red 'x' next to the 'Search
39569         history' link at the top right of the OPAC.</para>
39570
39571         <screenshot>
39572           <screeninfo>Search history link at the top right of the
39573           OPAC</screeninfo>
39574
39575           <mediaobject>
39576             <imageobject>
39577               <imagedata fileref="images/opac/searchistory.png"/>
39578             </imageobject>
39579           </mediaobject>
39580         </screenshot>
39581       </section>
39582
39583       <section id="opacmyhistory">
39584         <title>My Reading History</title>
39585
39586         <para>Depending on your library's setting for <link linkend="opacreadinghistory">opacreadinghistory</link> your patrons
39587         may see the 'my reading history' tab next. This will show the patron
39588         their entire reading history unless they have asked the library to not
39589         keep that information via the 'my privacy' tab which will appear if
39590         you have the <link linkend="OPACPrivacy">OPACPrivacy</link> preference
39591         set to 'Allow.'</para>
39592
39593         <screenshot>
39594           <screeninfo>Patron reading history</screeninfo>
39595
39596           <mediaobject>
39597             <imageobject>
39598               <imagedata fileref="images/opac/myhistory.png"/>
39599             </imageobject>
39600           </mediaobject>
39601         </screenshot>
39602         <para>If you have HTML entered in the <link linkend="OPACMySummaryHTML"
39603             >OPACMySummaryHTML</link> preference then you will see that to the right of the 'Date'
39604           column.</para>
39605       </section>
39606
39607       <section id="opacmyprivacy">
39608         <title>My Privacy</title>
39609
39610         <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.'
39611         This tab will allow the patrons to decide how the library keeps their
39612         circulation history data.</para>
39613
39614         <screenshot>
39615           <screeninfo>my privacy tab</screeninfo>
39616
39617           <mediaobject>
39618             <imageobject>
39619               <imagedata fileref="images/opac/myprivacy.png"/>
39620             </imageobject>
39621           </mediaobject>
39622         </screenshot>
39623
39624         <para>The patron can choose from three options:</para>
39625
39626         <itemizedlist>
39627           <listitem>
39628             <para>Forever: keep my reading history without limit. This is the
39629             option for users who want to keep track of what they are
39630             reading.</para>
39631           </listitem>
39632
39633           <listitem>
39634             <para>Default: keep my reading history according to local laws.
39635             This is the default option : the library will keep your reading
39636             history for the duration permitted by local laws.</para>
39637           </listitem>
39638
39639           <listitem>
39640             <para>Never: Delete my reading history immediately. This will
39641             delete all record of the item that was checked-out upon
39642             check-in.</para>
39643           </listitem>
39644         </itemizedlist>
39645
39646         <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
39647         client may change.</para>
39648
39649         <para>Regardless of the patron's choice they can delete their reading
39650         history in bulk at any time by clicking the 'Immediate deletion'
39651         button.</para>
39652
39653         <screenshot>
39654           <screeninfo>Delete Circulation History</screeninfo>
39655
39656           <mediaobject>
39657             <imageobject>
39658               <imagedata fileref="images/opac/deletecirchistory.png"/>
39659             </imageobject>
39660           </mediaobject>
39661         </screenshot>
39662
39663         <para>Clicking this button will not delete items that are currently checked out, but will
39664           clear the patron's past reading history.<important>
39665             <para>In order for the patron to be able to delete their reading history you must have
39666               the <link linkend="AnonymousPatron">AnonymousPatron</link> preference set.</para>
39667           </important></para>
39668       </section>
39669
39670       <section id="opacmysuggestions">
39671         <title>My Purchase Suggestions</title>
39672
39673         <para>If your library allows patrons to make purchase suggestions the
39674         next tab will show all suggestions that the patron made to the library
39675         and their statuses. To disable this tab and the suggestion
39676         functionality set the <link linkend="suggestionspref">suggestion</link> preference to 'Don't
39677         allow.'</para>
39678
39679         <screenshot>
39680           <screeninfo>Patron purchase suggestions</screeninfo>
39681
39682           <mediaobject>
39683             <imageobject>
39684               <imagedata fileref="images/opac/mysuggestions.png"/>
39685             </imageobject>
39686           </mediaobject>
39687         </screenshot>
39688         <para>If you have <link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link>
39689           set to 'Show' then patrons will be able to search suggestions from the top of this
39690           list.</para>
39691       </section>
39692
39693       <section id="opacmymsgs">
39694         <title>My Messaging</title>
39695
39696         <para>If your library has the <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
39697         preference set to 'Allow' then your patrons will be able to choose
39698         which messages they receive from the library (with the exception of
39699         overdue notices which the library controls).</para>
39700
39701         <screenshot>
39702           <screeninfo>Patron messaging preferences</screeninfo>
39703
39704           <mediaobject>
39705             <imageobject>
39706               <imagedata fileref="images/opac/mymessages.png"/>
39707             </imageobject>
39708           </mediaobject>
39709         </screenshot>
39710
39711         <para>If you also allow SMS messages with the <link linkend="SMSSendDriver">SMSSendDriver</link> preference, you will see
39712         an additional column to receive these messages as SMS (or text
39713         messages) and a field for a cell (or SMS) number.</para>
39714
39715         <screenshot>
39716           <screeninfo>SMSSendDriver in the OPAC</screeninfo>
39717
39718           <mediaobject>
39719             <imageobject>
39720               <imagedata fileref="images/opac/OPACSMSSendDriver.png"/>
39721             </imageobject>
39722           </mediaobject>
39723         </screenshot>
39724         <para>If you are using the <link linkend="TalkingTechItivaPhoneNotification">Itiva Talking
39725             Tech</link> service you will see an additional column to receive these messages via Phone.<screenshot>
39726             <screeninfo>Phone messaging preferences in the OPAC</screeninfo>
39727             <mediaobject>
39728               <imageobject>
39729                 <imagedata fileref="images/opac/opacphonemsg.png"/>
39730               </imageobject>
39731             </mediaobject>
39732           </screenshot></para>
39733         <itemizedlist>
39734           <listitem>
39735             <para>These notices are:</para>
39736             <itemizedlist>
39737               <listitem>
39738                 <para>Advanced notice : A notice in advance of the patron's items being due (The
39739                   patron can choose the number of days in advance)</para>
39740               </listitem>
39741               <listitem>
39742                 <para>Item checkout : A notice that lists all the of the items the patron has just
39743                   checked out and/or renewed, this is an electronic form of the checkout
39744                   receipt</para>
39745               </listitem>
39746               <listitem>
39747                 <para>Hold filled : A notice when you have confirmed the hold is waiting for the
39748                   patron</para>
39749               </listitem>
39750               <listitem>
39751                 <para>Item due : A notice on the day and item is due back at the library</para>
39752               </listitem>
39753               <listitem>
39754                 <para>Item check-in : A notice that lists all the of the items the patron has just
39755                   checked in</para>
39756               </listitem>
39757             </itemizedlist>
39758           </listitem>
39759         </itemizedlist>
39760         <para>Patrons can choose to receive their notices as a digest by checking the 'Digest only?'
39761           box along with the delivery method.  A digest is a combination of all the messages of that
39762           type (so all items due in 3 days in one email) in to one email instead of multiple emails
39763           for each alert.</para>
39764         <important>
39765           <para>You must choose a delivery method (SMS or Email or Phone) along with 'Digest only?'
39766             if you would like to receive a digest of the messages.</para>
39767         </important>
39768       </section>
39769
39770       <section id="opacmylists">
39771         <title>My Lists</title>
39772
39773         <para>Finally, if your library has the <link linkend="virtualshelves">virtualshelves</link> set to 'Allow' then the
39774         last tab will by 'my lists.' From here your patrons can review public
39775         lists and create or edit their own private lists.</para>
39776
39777         <screenshot>
39778           <screeninfo>Patron lists</screeninfo>
39779
39780           <mediaobject>
39781             <imageobject>
39782               <imagedata fileref="images/opac/mylists.png"/>
39783             </imageobject>
39784           </mediaobject>
39785         </screenshot>
39786       </section>
39787     </section>
39788
39789     <section id="purchasesuggest">
39790       <title>Purchase Suggestions</title>
39791
39792       <para>If your library has the <link linkend="suggestionspref">suggestion</link> preference set to 'Allow'
39793       then patrons will have the option to make purchase suggestions in
39794       several areas in the OPAC.</para>
39795
39796       <para>If you are allowing everyone to see the purchase suggestions made by others with the
39797           <link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link> preference,
39798         then there will be a link at the top of your OPAC under the search box.</para>
39799
39800       <screenshot>
39801         <screeninfo>Purchase Suggestions Link on Search Box</screeninfo>
39802
39803         <mediaobject>
39804           <imageobject>
39805             <imagedata fileref="images/opac/suggestfromsearch.png"/>
39806           </imageobject>
39807         </mediaobject>
39808       </screenshot>
39809
39810       <para>There will be a link when the patron finds nothing for their
39811       search.</para>
39812
39813       <screenshot>
39814         <screeninfo>Purchase Suggestion Link from Search Results</screeninfo>
39815
39816         <mediaobject>
39817           <imageobject>
39818             <imagedata fileref="images/opac/suggestfromnoresults.png"/>
39819           </imageobject>
39820         </mediaobject>
39821       </screenshot>
39822
39823       <para>And there will be a link on the patron's <link linkend="opacmysuggestions">My Purchase Suggestions</link> tab.</para>
39824
39825       <screenshot>
39826         <screeninfo>Purchase Suggestion from My Purchase Suggestions
39827         Tab</screeninfo>
39828
39829         <mediaobject>
39830           <imageobject>
39831             <imagedata fileref="images/opac/suggestfrommyaccount.png"/>
39832           </imageobject>
39833         </mediaobject>
39834       </screenshot>
39835
39836       <para>Clicking any one of these links will open the purchase suggestion
39837       form.</para>
39838
39839       <screenshot>
39840         <screeninfo>New Purchase Suggestion</screeninfo>
39841
39842         <mediaobject>
39843           <imageobject>
39844             <imagedata fileref="images/opac/newsuggestion.png"/>
39845           </imageobject>
39846         </mediaobject>
39847       </screenshot>
39848
39849       <itemizedlist>
39850         <listitem>
39851           <para>From the form on the 'Title' is required by the
39852           library.</para>
39853         </listitem>
39854
39855         <listitem>
39856           <para>If you would like the 'Reason for suggestion' menu shown in
39857           the screenshot above to appear on your suggestions list you need to
39858           add an <link linkend="authorizedvalues">authorized value</link>
39859           category titled 'OPAC_SUG' and include reasons as values in that
39860           list.</para>
39861         </listitem>
39862
39863         <listitem>
39864           <para>If you would like the patron to be able to choose which branch
39865           they are making a suggestion for you need to set the <link linkend="AllowPurchaseSuggestionBranchChoice">AllowPurchaseSuggestionBranchChoice</link>
39866           preference to 'Allow'</para>
39867         </listitem>
39868       </itemizedlist>
39869
39870       <para>Once the form is submitted the data will be saved to the <link linkend="managesuggest">Acquisitions</link> module for the librarians to
39871       manage.</para>
39872     </section>
39873   </chapter>
39874
39875   <chapter id="searching">
39876     <title>Searching</title>
39877
39878     <para/>
39879
39880     <section id="searchprefixes">
39881       <title>Advanced Search Prefixes</title>
39882
39883       <para>The following prefixes can be added to search terms in the keyword
39884       search box to limit items returned</para>
39885
39886       <itemizedlist>
39887         <listitem>
39888           <para>ti: title search</para>
39889
39890           <itemizedlist>
39891             <listitem>
39892               <para>ex. ti:hamlet</para>
39893             </listitem>
39894           </itemizedlist>
39895         </listitem>
39896
39897         <listitem>
39898           <para>su: subject search</para>
39899
39900           <itemizedlist>
39901             <listitem>
39902               <para>ex. su:cooking</para>
39903             </listitem>
39904           </itemizedlist>
39905         </listitem>
39906
39907         <listitem>
39908           <para>pb: publisher search</para>
39909
39910           <itemizedlist>
39911             <listitem>
39912               <para>ex. pb:penguin</para>
39913             </listitem>
39914           </itemizedlist>
39915         </listitem>
39916
39917         <listitem>
39918           <para>au: author search</para>
39919
39920           <itemizedlist>
39921             <listitem>
39922               <para>ex. au:rowling</para>
39923             </listitem>
39924           </itemizedlist>
39925         </listitem>
39926
39927         <listitem>
39928           <para>su-geo: geographic subjects</para>
39929
39930           <itemizedlist>
39931             <listitem>
39932               <para>ex. su-geo:wales and kw:description and kw:travel</para>
39933             </listitem>
39934           </itemizedlist>
39935         </listitem>
39936
39937         <listitem>
39938           <para>bc: barcode</para>
39939
39940           <itemizedlist>
39941             <listitem>
39942               <para>ex. bc:502326000912</para>
39943             </listitem>
39944           </itemizedlist>
39945         </listitem>
39946
39947         <listitem>
39948           <para>lex: lexile</para>
39949
39950           <itemizedlist>
39951             <listitem>
39952               <para>levels lex:510</para>
39953             </listitem>
39954           </itemizedlist>
39955         </listitem>
39956       </itemizedlist>
39957
39958       <para/>
39959     </section>
39960
39961     <section id="searchguide">
39962       <sectioninfo>
39963         <authorgroup>
39964           <author>
39965             <firstname>Becky</firstname>
39966             <surname>Bell</surname>
39967             <affiliation>
39968               <orgname>WALDO</orgname>
39969             </affiliation>
39970           </author>
39971
39972           <editor>
39973             <firstname>Nicole C.</firstname>
39974             <surname>Engard</surname>
39975             <contrib>Fixed typos, changed content where necessary and added new
39976               screenshots.</contrib>
39977           </editor>
39978         </authorgroup>
39979
39980         <pubdate>October 2008</pubdate>
39981       </sectioninfo>
39982       <title>Guide to Searching</title>
39983
39984       <para>This brief guide will explain a chart that shows a sample of how a
39985       MARC21 database can be configured, as well as a brief introductory
39986       searching guide. The indexing fields described in this document relate
39987       to the bibliographic data and does not address authority database
39988       indexing.</para>
39989
39990       <section id="searchguide-indexing">
39991         <title>Indexing and Searching Description</title>
39992
39993         <para>Koha's databases are indexed by the Zebra open-source software.
39994         The overview to the documentation describes Zebra as:</para>
39995
39996         <blockquote>
39997           <para>"...Zebra is a high-performance, general-purpose structured
39998           text indexing and retrieval engine. It reads records in a variety of
39999           input formats (eg. email, XML, MARC) and provides access to them
40000           through a powerful combination of Boolean search expressions and
40001           relevance-ranked free-text queries.</para>
40002
40003           <para>Zebra supports large databases (tens of millions of records,
40004           tens of gigabytes of data). It allows safe, incremental database
40005           updates on live systems. Because Zebra supports the
40006           industry-standard information retrieval protocol, Z39.50, you can
40007           search Zebra databases using an enormous variety of programs and
40008           toolkits, both commercial and free, which understands this
40009           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>
40010         </blockquote>
40011
40012         <para>This brief guide will explain a chart that shows a sample of how
40013         a MARC21 database can be configured, as well as a brief introductory
40014         searching guide. The indexing fields described in this document relate
40015         to the bibliographic data and does not address authority database
40016         indexing.</para>
40017
40018         <note>
40019           <para>The indexing described in this document is the set used by
40020           SouthEastern University. Your local indexing may vary.</para>
40021         </note>
40022       </section>
40023
40024       <section id="searchguide-indexconfig">
40025         <title>Indexing Configuration</title>
40026
40027         <para>There are three configuration files that Koha uses while
40028         indexing.</para>
40029
40030         <para>The first configuration file (etc/zebradb/biblios/etc/bib1.att)
40031         contains the Z39.50 bib-1 attribute list, plus the Koha local use
40032         attributes for Biblio Indexes, Items Index, and Fixed Fields and other
40033         special indexes. The Z39.50 Bib-1 profile is made up of several
40034         different types of attributes: Use, Relation, Position, Structure,
40035         Truncation, and Completeness. The bib-1 'Use' attribute is represented
40036         on the chart; the other attributes are used primarily when doing
40037         searches. While there are over 150+ use attributes that could be used
40038         to define your indexing set, it's unlikely that you will choose to use
40039         them all. The attributes you elect to use are those that become the
40040         indexing rules for your database. The other five attribute sets define
40041         the various ways that a search can be further defined, and will not
40042         specifically be addressed in this document. For a complete list of the
40043         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>
40044
40045         <para>The second file is etc/zebradb/marc_defs/[marc21|unimarc]/biblios/record.abs if you
40046           use grs1 indexing [the default until 3.16] or
40047           etc/zebradb/marc_defs/[marc21|unimarc]/biblios/biblio-koha-indexdefs.xml if you use dom
40048           indexing [the default from 3.18]. Either files contains the abstract syntax which maps the
40049           MARC21 tags to the set of Use Attributes you choose to use. To be more precise the xml
40050           file to be activate needs to be transform into biblio-zebra-indexdefs.xsl, read the head
40051           of biblio-zebra-indexdefs.xsl to know more about this topic. The rules established in this
40052           file provides a passable Bath level 0 and 1 service, which includes author, title,
40053           subject, keyword and exact services such as standard identifiers (LCCN, ISBN, ISSN,
40054           etc.)</para>
40055
40056         <para>The third file (etc/zebradb/ccl.properties) is the Common
40057         Command Language (CCL) field mappings. This file combines the bib-1
40058         attribute set file and the abstract file and adds the qualifiers,
40059         usually known as index names. The qualifiers, or indexes, for this
40060         database are: pn, cpn, cfn, ti, se, ut, nb, ns, sn, lcn, callnum, su,
40061         su-to, su-geo, su-ut, yr,pubdate, acqdate, ln, pl, ab, nt, rtype,
40062         mc-rtype, mus, au, su-na, kw, pb, ctype, and an.</para>
40063
40064         <para>The <link linkend="kohasearchindexes">Koha Indexing Chart</link> summarizes the
40065           contents of all three of these files in a more readable format. The first two columns
40066           labeled Z39.50 attribute and Z39.50 name matches the Z39.50 bib-1 attributes file. The
40067           third column labeled MARC tags indexed is where you find which MARC tags are mapped to an
40068           attribute. The fourth column labeled Qualifiers identifies the search abbreviations used
40069           in the internal CCL query. The following description provides a definition for the word
40070           'qualifiers'.</para>
40071
40072         <para><emphasis>Qualifiers are used to direct the search to a
40073         particular searchable index, such as title (ti) and author indexes
40074         (au). The CCL standard itself doesn't specify a particular set of
40075         qualifiers, but it does suggest a few shorthand notations. You can
40076         customize the CCL parser to support a particular set of qualifiers to
40077         reflect the current target profile. Traditionally, a qualifier would
40078         map to a particular use-attribute within the BIB-1attribute set. It is
40079         also possible to set other attributes, such as the structure
40080         attribute.</emphasis></para>
40081
40082         <para>In the MARC tags indexed column, there are some conventions used
40083         that have specific meanings. They are:</para>
40084
40085         <itemizedlist>
40086           <listitem>
40087             <para>A three digit tag (100) means that all subfields in the tag
40088             can be used in a search query. So, if you enter a search for
40089             'Jackson' as an author, you will retrieve records where Jackson
40090             could be the last name or the first name.</para>
40091           </listitem>
40092
40093           <listitem>
40094             <para>A three digit tag that has a '$' followed by a letter
40095             (600$a) means that a search query will only search the 'a'
40096             subfield.</para>
40097           </listitem>
40098
40099           <listitem>
40100             <para>A three digit tag that is followed by a ':' and a letter
40101             (240:w) means that a search query can be further qualified. The
40102             letter following the ':' identifies how to conduct the search. The
40103             most common values you'll see are 'w' (word), 'p' (phrase), 's'
40104             (sort), and 'n' (numeric).</para>
40105           </listitem>
40106         </itemizedlist>
40107
40108         <para>The contents of the MARC tags, subfields, and/or fixed field
40109         elements that are listed in this chart are all indexed. You'll see
40110         that every attribute line is not mapped to a specific qualifier
40111         (index)-LC card number, line 9 is one example. However, every indexed
40112         word (a string of characters preceded and succeeded by a space) can be
40113         searched using a keyword (kw) search. So, although an LC card number
40114         specific index doesn't exist, you can still search by the LCCN since
40115         tag 010 is assigned to the LC-card-number attribute. To verify this,
40116         enter 72180055 in the persistent search box. You should retrieve The
40117         gods themselves, by Isaac Asimov.</para>
40118
40119         <para>Examples of fixed field elements indexing can be seen on the
40120         chart between Attribute 8822 and Attribute 8703. These attributes are
40121         most commonly used for limiting. The fixed field attributes currently
40122         represent the BK codes. Other format codes, if needed, could be
40123         defined.</para>
40124       </section>
40125
40126       <section id="searchguide-basics">
40127         <title>Basic Searching</title>
40128
40129         <para>The search box that library staff and library patrons will see
40130         most often is the persistent search box at the top of the page. Koha
40131         interprets the searches as keyword searches.</para>
40132
40133         <screenshot>
40134           <screeninfo>Koha search box</screeninfo>
40135
40136           <mediaobject>
40137             <imageobject>
40138               <imagedata fileref="images/searching/searchbox.png"/>
40139             </imageobject>
40140           </mediaobject>
40141         </screenshot>
40142
40143         <para>To start a search, you enter a word or multiple words in the
40144         search box. When a single word is entered, a keyword search is
40145         performed. You can check this out by typing one word into the form and
40146         note the number of results located. Then, repeat the search with a
40147         minor change. In front of the search word, type 'kw=' followed by the
40148         same search term. The results will be identical.</para>
40149
40150         <para>When you have more than one word in the search box, Koha will
40151         still do a keyword search, but a bit differently. Each word will be
40152         searched on its own, then the Boolean connector 'and' will narrow your
40153         search to those items with all words contained in matching
40154         records.</para>
40155
40156         <para>Suppose you want to find material about how libraries are using
40157         mashups. You'll select the major words and enter them into the
40158         persistent search box.</para>
40159
40160         <screenshot>
40161           <screeninfo>Keyword Search</screeninfo>
40162
40163           <mediaobject>
40164             <imageobject>
40165               <imagedata fileref="images/searching/searchterms.png"/>
40166             </imageobject>
40167           </mediaobject>
40168         </screenshot>
40169
40170         <para>The response to this search is:</para>
40171
40172         <screenshot>
40173           <screeninfo>Results</screeninfo>
40174
40175           <mediaobject>
40176             <imageobject>
40177               <imagedata fileref="images/searching/resultssummary.png"/>
40178             </imageobject>
40179           </mediaobject>
40180         </screenshot>
40181
40182         <para>The order of the words does not affect the retrieval results, so
40183         you could also enter the search as "mashups library". The response to
40184         this search is results</para>
40185
40186         <screenshot>
40187           <screeninfo>Results</screeninfo>
40188
40189           <mediaobject>
40190             <imageobject>
40191               <imagedata fileref="images/searching/resultssummary2.png"/>
40192             </imageobject>
40193           </mediaobject>
40194         </screenshot>
40195
40196         <para>Too many words in the search box will find very few matches, as
40197         the following example illustrates:</para>
40198
40199         <screenshot>
40200           <screeninfo>No results found</screeninfo>
40201
40202           <mediaobject>
40203             <imageobject>
40204               <imagedata fileref="images/searching/noresults.png"/>
40205             </imageobject>
40206           </mediaobject>
40207         </screenshot>
40208       </section>
40209
40210       <section id="searchguide-advanced">
40211         <title>Advanced Searching</title>
40212
40213         <para>When you can't find the most appropriate material with a general
40214         search, you can move to the Advanced Search page by clicking on the
40215         Search option on the persistent toolbar.</para>
40216
40217         <screenshot>
40218           <screeninfo>Koha Menu</screeninfo>
40219
40220           <mediaobject>
40221             <imageobject>
40222               <imagedata fileref="images/searching/menubar.png"/>
40223             </imageobject>
40224           </mediaobject>
40225         </screenshot>
40226
40227         <para>The Advanced Search page offers many ways to limit the results
40228         of your search. You can search using the Boolean operators AND, OR,
40229         and NOT; limit by item type; limit by year and language; limit by
40230         subtypes audience, content, format, or additional content types; by
40231         location and by availability.</para>
40232
40233         <para>The first limiting section on the Advanced Search page provides
40234         a quick and simple way to use the Boolean operators in your search.
40235         Note that this display depends on a system preference setting. This
40236         option can be found on the Administration &gt; System Preferences &gt;
40237         Searching page. The option called <link linkend="expandedSearchOption">expandedSearchOption</link> must be set
40238         to 'show' to see the following display.</para>
40239
40240         <screenshot>
40241           <screeninfo>Advanced Search Options</screeninfo>
40242
40243           <mediaobject>
40244             <imageobject>
40245               <imagedata fileref="images/searching/searchoptions.png"/>
40246             </imageobject>
40247           </mediaobject>
40248         </screenshot>
40249
40250         <para>In this section you can choose among the many indexes by
40251         clicking on the arrow in the first box. The blank box that follows is
40252         where you enter your first search term or terms. On the second line,
40253         you can choose the Boolean operator you want to use in your search.
40254         The options are 'and', 'or', and 'not'. Then, you would again choose
40255         the index to search, followed by the second term or terms. If you have
40256         more concepts you want to include in your search, you can click the
40257         [+] to add another line for your search.</para>
40258
40259         <para>A sample search is shown next, followed by its results:</para>
40260
40261         <screenshot>
40262           <screeninfo>Advanced Search</screeninfo>
40263
40264           <mediaobject>
40265             <imageobject>
40266               <imagedata fileref="images/searching/advsearch.png"/>
40267             </imageobject>
40268           </mediaobject>
40269         </screenshot>
40270
40271         <screenshot>
40272           <screeninfo>Results from Advanced Search</screeninfo>
40273
40274           <mediaobject>
40275             <imageobject>
40276               <imagedata fileref="images/searching/numresults.png"/>
40277             </imageobject>
40278           </mediaobject>
40279         </screenshot>
40280
40281         <para>When you use the Boolean operators to broaden or narrow a
40282         search, remember the action of each operator. The 'and' operator
40283         narrows the results you'll retrieve because the search will retrieve
40284         the records that include all your search terms. The 'or' operator
40285         expands the results because the search will look for occurrences of
40286         all of your search terms. The 'not' operator excludes records with the
40287         term that follows the operator.</para>
40288
40289         <para>Note: If you leave this <link linkend="expandedSearchOption">expandedSearchOption</link> set to
40290         'don't show', this is the display you will see:</para>
40291
40292         <screenshot>
40293           <screeninfo>Fewer Search Options</screeninfo>
40294
40295           <mediaobject>
40296             <imageobject>
40297               <imagedata fileref="images/searching/feweropts.png"/>
40298             </imageobject>
40299           </mediaobject>
40300         </screenshot>
40301
40302         <para>The Advanced Search page then shows the multiple kinds of limits
40303         that can be applied to your search results. Either check a box or
40304         select from the drop down menus to narrow your search. You will type
40305         the year, year range, or a 'greater than (&gt;)' or 'less than (&lt;)'
40306         year.</para>
40307
40308         <screenshot>
40309           <screeninfo>Other Advanced Search Options</screeninfo>
40310
40311           <mediaobject>
40312             <imageobject>
40313               <imagedata fileref="images/searching/advoptions.png"/>
40314             </imageobject>
40315           </mediaobject>
40316         </screenshot>
40317
40318         <para>Finally, you can choose how the results will be sorted. The
40319         pre-defined sort options are in the final area of the Advanced Search
40320         screen.</para>
40321
40322         <screenshot>
40323           <screeninfo>Sort Results By</screeninfo>
40324
40325           <mediaobject>
40326             <imageobject>
40327               <imagedata fileref="images/searching/advsortby.png"/>
40328             </imageobject>
40329           </mediaobject>
40330         </screenshot>
40331
40332         <para>The default sort is by relevance, although you can choose to sort by author, by title,
40333           by call number, by dates, or by popularity (which uses the information on total issues
40334           found in the items table). If you would prefer a different default sort, you can set <link
40335             linkend="defaultSortField">defaultSortField</link> to one of the other choices in
40336           Administration &gt; System Preferences &gt; Searching.</para>
40337       </section>
40338       <section id="searchguide-itemsearch">
40339         <title>Item Searching</title>
40340         <para>If you are looking for specific items you can use the item search engine in the staff
40341           client to find them. <itemizedlist>
40342             <listitem>
40343               <para><emphasis>Get there:</emphasis> Search &gt; Go to item search</para>
40344             </listitem>
40345           </itemizedlist></para>
40346         <para>At the top of the advanced search page in the staff client you will see a link to 'Go
40347           to item search'<screenshot>
40348             <screeninfo>Item search link</screeninfo>
40349             <mediaobject>
40350               <imageobject>
40351                 <imagedata fileref="images/searching/itemsearchlink.png"/>
40352               </imageobject>
40353             </mediaobject>
40354           </screenshot></para>
40355         <para>Clicking that link will open up a item specific search engine.<screenshot>
40356             <screeninfo>Item search</screeninfo>
40357             <mediaobject>
40358               <imageobject>
40359                 <imagedata fileref="images/searching/itemsearch.png"/>
40360               </imageobject>
40361             </mediaobject>
40362           </screenshot></para>
40363         <para>Using the search form that is presented you can find a list of specific items that can
40364           be output to the screen or to a CSV file. If your results are printed to the screen you
40365           will have the option to narrow your search further using filters at the top.<screenshot>
40366             <screeninfo>Item search results</screeninfo>
40367             <mediaobject>
40368               <imageobject>
40369                 <imagedata fileref="images/searching/itemsearchresults.png"/>
40370               </imageobject>
40371             </mediaobject>
40372           </screenshot></para>
40373       </section>
40374
40375       <section id="searchguide-ccl">
40376         <title>Common Command Language Searching</title>
40377
40378         <para>Koha uses the Common Command Language (CCL) (ISO 8777) as its
40379         internal search protocol. Searches initiated in the graphical
40380         interface use this protocol as well, although the searcher doesn't
40381         know which indexes, operators and limiters are available and being
40382         used to conduct their search. The searcher can use the Advanced Search
40383         when more precise results set are desired and where the search indexes
40384         are somewhat known. However, some library users and many library staff
40385         prefer using a command based structure. This part of the document will
40386         present and explain the use of the Koha command based structure. The
40387         indexes, operators, and limiters used are identical to those used in
40388         the graphical interface.</para>
40389
40390         <section id="searchguide-indexes">
40391           <title>Indexes</title>
40392
40393           <para>The CCL standard itself doesn't specify a particular set of
40394           qualifiers (indexes), but it does suggest a few short-hand notations
40395           such as 'ti', 'au', and 'su'. Koha has a default set of indexes;
40396           it's possible to customize that set by adding needed indexes based
40397           on local requirements. A qualifier (index) maps to a particular
40398           use-attribute within the Z39.50 BIB-1 attribute set. The complete
40399           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>
40400
40401           <para>The standard Koha set of indexes is a fairly common example of
40402           MARC21 indexing rules. The indexes that are defined in Koha are
40403           indexes typically used by other integrated library systems. The
40404           defined Z39.50 Bib-1 Attribute mapped to the indexes include:</para>
40405
40406           <table cellpadding="4" cellspacing="4" frame="all">
40407             <title>Attributes</title>
40408
40409             <tgroup align="left" cols="2" colsep="1" rowsep="1">
40410               <thead>
40411                 <row>
40412                   <entry>Bib-1 Attribute</entry>
40413
40414                   <entry>Qualifier (index)</entry>
40415                 </row>
40416               </thead>
40417
40418               <tbody>
40419                 <row>
40420                   <entry>Personal-name</entry>
40421
40422                   <entry>pn</entry>
40423                 </row>
40424
40425                 <row>
40426                   <entry>Corporate-name</entry>
40427
40428                   <entry>cpn</entry>
40429                 </row>
40430
40431                 <row>
40432                   <entry>Conference-name</entry>
40433
40434                   <entry>cfn</entry>
40435                 </row>
40436
40437                 <row>
40438                   <entry>Title</entry>
40439
40440                   <entry>ti</entry>
40441                 </row>
40442
40443                 <row>
40444                   <entry>Title-series</entry>
40445
40446                   <entry>se</entry>
40447                 </row>
40448
40449                 <row>
40450                   <entry>Title-uniform</entry>
40451
40452                   <entry>ut</entry>
40453                 </row>
40454
40455                 <row>
40456                   <entry>ISBN</entry>
40457
40458                   <entry>nb</entry>
40459                 </row>
40460
40461                 <row>
40462                   <entry>ISSN</entry>
40463
40464                   <entry>ns</entry>
40465                 </row>
40466
40467                 <row>
40468                   <entry>Local number</entry>
40469
40470                   <entry>sn</entry>
40471                 </row>
40472
40473                 <row>
40474                   <entry>Local-classification</entry>
40475
40476                   <entry>lcn and callnum</entry>
40477                 </row>
40478
40479                 <row>
40480                   <entry>Subject</entry>
40481
40482                   <entry>su, su-to, su-geo, su-ut</entry>
40483                 </row>
40484
40485                 <row>
40486                   <entry>Pubdate</entry>
40487
40488                   <entry>yr,pubdate</entry>
40489                 </row>
40490
40491                 <row>
40492                   <entry>Date-of-Acquisition</entry>
40493
40494                   <entry>acqdate</entry>
40495                 </row>
40496
40497                 <row>
40498                   <entry>Language</entry>
40499
40500                   <entry>ln</entry>
40501                 </row>
40502
40503                 <row>
40504                   <entry>Place-of-publication</entry>
40505
40506                   <entry>pl</entry>
40507                 </row>
40508
40509                 <row>
40510                   <entry>Abstract</entry>
40511
40512                   <entry>ab</entry>
40513                 </row>
40514
40515                 <row>
40516                   <entry>Notes</entry>
40517
40518                   <entry>nt</entry>
40519                 </row>
40520
40521                 <row>
40522                   <entry>Record-type</entry>
40523
40524                   <entry>rtype, mc-rtype, mus</entry>
40525                 </row>
40526
40527                 <row>
40528                   <entry>Author</entry>
40529
40530                   <entry>au, aut</entry>
40531                 </row>
40532
40533                 <row>
40534                   <entry>Subject-person-name</entry>
40535
40536                   <entry>su-na</entry>
40537                 </row>
40538
40539                 <row>
40540                   <entry>Any (keyword)</entry>
40541
40542                   <entry>kw</entry>
40543                 </row>
40544
40545                 <row>
40546                   <entry>Publisher</entry>
40547
40548                   <entry>pb</entry>
40549                 </row>
40550
40551                 <row>
40552                   <entry>Content-type</entry>
40553
40554                   <entry>ctype</entry>
40555                 </row>
40556
40557                 <row>
40558                   <entry>Koha-Auth-Number</entry>
40559
40560                   <entry>an</entry>
40561                 </row>
40562
40563                 <row>
40564                   <entry>Author-personal-bibliography</entry>
40565
40566                   <entry>aub</entry>
40567                 </row>
40568
40569                 <row>
40570                   <entry>Author-in-order</entry>
40571
40572                   <entry>auo</entry>
40573                 </row>
40574               </tbody>
40575             </tgroup>
40576           </table>
40577
40578           <para>Refer to the <link linkend="kohasearchindexes">Koha Indexing Chart</link> for the
40579             MARC21 tags mapped to each Bib-1 Attribute and index combination.</para>
40580
40581           <section id="search-audexamp">
40582             <title>Audience Examples</title>
40583
40584             <itemizedlist>
40585               <listitem>
40586                 <para>aud:a Preschool</para>
40587               </listitem>
40588               <listitem>
40589                 <para>aud:b Primary</para>
40590               </listitem>
40591               <listitem>
40592                 <para>aud:c Pre-Adolescent</para>
40593               </listitem>
40594               <listitem>
40595                 <para>aud:d Adolescent</para>
40596               </listitem>
40597
40598               <listitem>
40599                 <para>aud:e Adult</para>
40600               </listitem>
40601               <listitem>
40602                 <para>aud:f Specialized</para>
40603               </listitem>
40604               <listitem>
40605                 <para>aud:g General</para>
40606               </listitem>
40607               <listitem>
40608                 <para>aud:j Juvenile</para>
40609               </listitem>
40610             </itemizedlist>
40611           </section>
40612
40613           <section id="search-contentsexamp">
40614             <title>Contents Examples</title>
40615
40616             <itemizedlist>
40617               <listitem>
40618                 <para>fic:1 Fiction</para>
40619               </listitem>
40620
40621               <listitem>
40622                 <para>fic:0 Non Fiction</para>
40623               </listitem>
40624
40625               <listitem>
40626                 <para>bio:b Biography</para>
40627               </listitem>
40628
40629               <listitem>
40630                 <para>mus:j Musical recording</para>
40631               </listitem>
40632
40633               <listitem>
40634                 <para>mus:I Non musical record</para>
40635               </listitem>
40636             </itemizedlist>
40637           </section>
40638         </section>
40639
40640         <section id="searchguide-syntax">
40641           <title>Search Syntax</title>
40642
40643           <para>In the persistent search box, single words generally retrieve
40644           large sets. To narrow a search, you can use multiple words. Koha
40645           automatically uses the 'and' Boolean operator to create a set of
40646           records matching your input. When you want to narrow the search to
40647           an author or a title or a subject or some other specific field or
40648           use a Boolean operator, there isn't an obvious way to accomplish
40649           that specificity. The library user can, of course, go to the
40650           Advanced Search page; however, if you know how to construct a CCL
40651           search, you can achieve more specificity while using the persistent
40652           search box on any page.</para>
40653
40654           <para>There is a specific order to the CCL search syntax. Although
40655           it can be used for simple searches, it is an especially effective
40656           way to perform complex searches, as it affords you a great deal of
40657           control over your search results. To construct a CCL search, first
40658           enter a desired index code, then an equal sign, followed by your
40659           search word(s). Following are examples of simple CCL
40660           searches.</para>
40661
40662           <itemizedlist>
40663             <listitem>
40664               <para>ti=principles of accounting</para>
40665             </listitem>
40666
40667             <listitem>
40668               <para>au=brown joseph</para>
40669             </listitem>
40670
40671             <listitem>
40672               <para>su=poetry</para>
40673             </listitem>
40674
40675             <listitem>
40676               <para>su-na=Shakespeare</para>
40677             </listitem>
40678
40679             <listitem>
40680               <para>kw=marlin</para>
40681             </listitem>
40682           </itemizedlist>
40683
40684           <para>You can refine your search by combining search terms with
40685           Boolean operators 'and', 'or', or 'not'. Following are examples of
40686           searches using Boolean operators.</para>
40687
40688           <itemizedlist>
40689             <listitem>
40690               <para>ti=principles of accounting and au=brown joseph</para>
40691             </listitem>
40692
40693             <listitem>
40694               <para>su=poetry not su-na=Shakespeare</para>
40695             </listitem>
40696
40697             <listitem>
40698               <para>kw=communication and su=debate</para>
40699             </listitem>
40700           </itemizedlist>
40701
40702           <para>You can also choose to search for things that start with a
40703           character or series of characters</para>
40704
40705           <itemizedlist>
40706             <listitem>
40707               <para>ti,first-in-subfield=C (will show you all titles that
40708               start with the letter 'C')</para>
40709             </listitem>
40710           </itemizedlist>
40711
40712           <para>Other string location searches can be performed with the
40713           following keywords:</para>
40714
40715           <itemizedlist>
40716             <listitem>
40717               <para>rtrn : right truncation</para>
40718             </listitem>
40719
40720             <listitem>
40721               <para>ltrn : left truncation</para>
40722             </listitem>
40723
40724             <listitem>
40725               <para>lrtrn : left and right truncation</para>
40726             </listitem>
40727
40728             <listitem>
40729               <para>st-date : type date</para>
40730             </listitem>
40731
40732             <listitem>
40733               <para>st-numeric : type number (integer)</para>
40734             </listitem>
40735
40736             <listitem>
40737               <para>ext : exact search on whole subfield (does not work with
40738               icu)</para>
40739             </listitem>
40740
40741             <listitem>
40742               <para>phr : search on phrase anywhere in the subfield</para>
40743             </listitem>
40744
40745             <listitem>
40746               <para>startswithnt : subfield starts with</para>
40747             </listitem>
40748           </itemizedlist>
40749
40750           <para>Using specific indexes and Boolean operators are not the only
40751           way a search can be refined. You can also refine your search as a
40752           phrase when looking for a title, author, or subject. The syntax for
40753           this search is <emphasis>index,phr=search words</emphasis>.</para>
40754
40755           <para>To illustrate the results of various search types, a search
40756           was done for the words 'supreme court'. The results illustrate that
40757           the search index and the word order make a difference in search
40758           results. Only the results count and the search itself is in these
40759           examples. The search executed will always be between the single
40760           quotes.</para>
40761
40762           <screenshot>
40763             <screeninfo>Sample Search 1</screeninfo>
40764
40765             <mediaobject>
40766               <imageobject>
40767                 <imagedata fileref="images/searching/ex1.png"/>
40768               </imageobject>
40769             </mediaobject>
40770           </screenshot>
40771
40772           <screenshot>
40773             <screeninfo>Sample Search 2</screeninfo>
40774
40775             <mediaobject>
40776               <imageobject>
40777                 <imagedata fileref="images/searching/ex2.png"/>
40778               </imageobject>
40779             </mediaobject>
40780           </screenshot>
40781
40782           <screenshot>
40783             <screeninfo>Sample Search 3</screeninfo>
40784
40785             <mediaobject>
40786               <imageobject>
40787                 <imagedata fileref="images/searching/ex3.png"/>
40788               </imageobject>
40789             </mediaobject>
40790           </screenshot>
40791
40792           <screenshot>
40793             <screeninfo>Sample Search 4</screeninfo>
40794
40795             <mediaobject>
40796               <imageobject>
40797                 <imagedata fileref="images/searching/ex4.png"/>
40798               </imageobject>
40799             </mediaobject>
40800           </screenshot>
40801
40802           <screenshot>
40803             <screeninfo>Sample Search 5</screeninfo>
40804
40805             <mediaobject>
40806               <imageobject>
40807                 <imagedata fileref="images/searching/ex5.png"/>
40808               </imageobject>
40809             </mediaobject>
40810           </screenshot>
40811
40812           <screenshot>
40813             <screeninfo>Sample Search 6</screeninfo>
40814
40815             <mediaobject>
40816               <imageobject>
40817                 <imagedata fileref="images/searching/ex6.png"/>
40818               </imageobject>
40819             </mediaobject>
40820           </screenshot>
40821
40822           <screenshot>
40823             <screeninfo>Sample Search 7</screeninfo>
40824
40825             <mediaobject>
40826               <imageobject>
40827                 <imagedata fileref="images/searching/ex7.png"/>
40828               </imageobject>
40829             </mediaobject>
40830           </screenshot>
40831
40832           <screenshot>
40833             <screeninfo>Sample Search 8</screeninfo>
40834
40835             <mediaobject>
40836               <imageobject>
40837                 <imagedata fileref="images/searching/ex8.png"/>
40838               </imageobject>
40839             </mediaobject>
40840           </screenshot>
40841
40842           <screenshot>
40843             <screeninfo>Sample Search 9</screeninfo>
40844
40845             <mediaobject>
40846               <imageobject>
40847                 <imagedata fileref="images/searching/ex9.png"/>
40848               </imageobject>
40849             </mediaobject>
40850           </screenshot>
40851
40852           <para>You can also choose to use limiters in your search query. Some
40853           common limiters include dates, languages, record types, and item
40854           types. In the Advance Search, you can either click a box or key in
40855           data to limit your search. You can also apply the same limits with
40856           CCL by using the syntax in the following examples. In all</para>
40857
40858           <para><emphasis>By Date: su=supreme court and
40859           yr,st-numeric=&gt;2000</emphasis></para>
40860
40861           <screenshot>
40862             <screeninfo>Sample Search 10</screeninfo>
40863
40864             <mediaobject>
40865               <imageobject>
40866                 <imagedata fileref="images/searching/ex10.png"/>
40867               </imageobject>
40868             </mediaobject>
40869           </screenshot>
40870
40871           <para>When you limit by date, you can use the '&gt;' (greater than),
40872           '&lt;' (less than), '=' (equal), or 'yyyy-yyyy' (range)
40873           symbols.</para>
40874
40875           <para><emphasis>By Item Type: su=nursing and
40876           itype:BK</emphasis></para>
40877
40878           <screenshot>
40879             <screeninfo>Sample Search 11</screeninfo>
40880
40881             <mediaobject>
40882               <imageobject>
40883                 <imagedata fileref="images/searching/ex11.png"/>
40884               </imageobject>
40885             </mediaobject>
40886           </screenshot>
40887
40888           <para>Each library will have a different set of item types defined
40889           in their circulation configuration. When you set up item types, you
40890           define a code and a name for each one. The name will appear on the
40891           Advance Search page. The code you assigned is used as a CCL search
40892           limit, formatted as 'itype:x', where 'x' is the assigned code. The
40893           initial set of item types in Koha will usually be edited to reflect
40894           your collections, so your item type limiters may be different than
40895           the initial ones. The initial item type limiters follow.</para>
40896
40897           <itemizedlist>
40898             <listitem>
40899               <para>itype:BKS Books, Booklets, Workbooks</para>
40900             </listitem>
40901
40902             <listitem>
40903               <para>itype:SR Audio Cassettes, CDs</para>
40904             </listitem>
40905
40906             <listitem>
40907               <para>itype:IR Binders</para>
40908             </listitem>
40909
40910             <listitem>
40911               <para>itype:CF CD-ROMs, DVD-ROMs, General Online
40912               Resources</para>
40913             </listitem>
40914
40915             <listitem>
40916               <para>itype:VR DVDs, VHS</para>
40917             </listitem>
40918
40919             <listitem>
40920               <para>itype:KT Kit</para>
40921             </listitem>
40922
40923             <listitem>
40924               <para>itype:AR Models</para>
40925             </listitem>
40926
40927             <listitem>
40928               <para>itype:SER Serials</para>
40929             </listitem>
40930           </itemizedlist>
40931
40932           <para><emphasis>By format: su=supreme court not
40933           l-format:sr</emphasis></para>
40934
40935           <screenshot>
40936             <screeninfo>Sample Search 12</screeninfo>
40937
40938             <mediaobject>
40939               <imageobject>
40940                 <imagedata fileref="images/searching/ex12.png"/>
40941               </imageobject>
40942             </mediaobject>
40943           </screenshot>
40944
40945           <para>The format limiters are derived from a combination of LDR, 006
40946           and 007 positions. The formats that are currently defined are the
40947           following.</para>
40948
40949           <itemizedlist>
40950             <listitem>
40951               <para>l-format:ta Regular print</para>
40952             </listitem>
40953
40954             <listitem>
40955               <para>l-format:tb Large print</para>
40956             </listitem>
40957
40958             <listitem>
40959               <para>l-format:fk Braille</para>
40960             </listitem>
40961
40962             <listitem>
40963               <para>l-format:sd CD audio</para>
40964             </listitem>
40965
40966             <listitem>
40967               <para>l-format:ss Cassette recording</para>
40968             </listitem>
40969
40970             <listitem>
40971               <para>l-format:vf VHS tape</para>
40972             </listitem>
40973
40974             <listitem>
40975               <para>l-format:vd DVD video</para>
40976             </listitem>
40977
40978             <listitem>
40979               <para>l-format:co CD software</para>
40980             </listitem>
40981
40982             <listitem>
40983               <para>l-format:cr Website</para>
40984             </listitem>
40985           </itemizedlist>
40986
40987           <para><emphasis>By content type: su=supreme court not
40988           ctype:l</emphasis></para>
40989
40990           <screenshot>
40991             <screeninfo>Sample Search 13</screeninfo>
40992
40993             <mediaobject>
40994               <imageobject>
40995                 <imagedata fileref="images/searching/ex13.png"/>
40996               </imageobject>
40997             </mediaobject>
40998           </screenshot>
40999
41000           <para>The content types are taken from the 008 MARC tag, positions
41001           24-27.</para>
41002
41003           <para>There are two other limiter types that are not described in
41004           this document. They are: Audience and Content. The only difference
41005           in the syntax of the CCL is the actual limiter. They are reproduced
41006           here just in case you would like to use these limiters.</para>
41007         </section>
41008       </section>
41009     </section>
41010
41011     <section id="kohasearchindexes">
41012       <title>Koha Search Indexes</title>
41013
41014       <para>By default, not all fields are indexed in the Zebra search engine,
41015       but many are. Below are the MARC21 fields that are indexed in
41016       Zebra.</para>
41017
41018       <table cellpadding="4" cellspacing="4" frame="all">
41019         <title>Indexes</title>
41020
41021         <tgroup align="left" cols="2" colsep="1" rowsep="1">
41022           <thead>
41023             <row>
41024               <entry><para>Field</para></entry>
41025
41026               <entry><para>Description</para></entry>
41027             </row>
41028           </thead>
41029
41030           <tbody>
41031             <row>
41032               <entry><para>001</para></entry>
41033
41034               <entry><para>Control-number</para></entry>
41035             </row>
41036
41037             <row>
41038               <entry><para>005</para></entry>
41039
41040               <entry><para>Date/time-last-modified</para></entry>
41041             </row>
41042
41043             <row>
41044               <entry><para>007</para></entry>
41045
41046               <entry><para>Microform-generation:n:range(data,11,1),
41047               Material-type,ff7-00:w:range(data,0,1),
41048               ff7-01:w:range(data,1,1), ff7-02:w:range(data,2,1),
41049               ff7-01-02:w:range(data,0,2)</para></entry>
41050             </row>
41051
41052             <row>
41053               <entry><para>008</para></entry>
41054
41055               <entry><para>date-entered-on-file:n:range(data,0,5),
41056               date-entered-on-file:s:range(data,0,5),
41057               pubdate:w:range(data,7,4), pubdate:n:range(data,7,4),
41058               pubdate:y:range(data,7,4), pubdate:s:range(data,7,4),
41059               pl:w:range(data,15,3), ta:w:range(data,22,1),
41060               ff8-23:w:range(data,23,1), ff8-29:w:range(data,29,1),
41061               lf:w:range(data,33,1), bio:w:range(data,34,1),
41062               ln:n:range(data,35,3), ctype:w:range(data,24,4),
41063               Record-source:w:range(data,39,0)</para></entry>
41064             </row>
41065
41066             <row>
41067               <entry><para>010</para></entry>
41068
41069               <entry><para>LC-card-number, Identifier-standard</para></entry>
41070             </row>
41071
41072             <row>
41073               <entry><para>011</para></entry>
41074
41075               <entry><para>LC-card-number, Identifier-standard</para></entry>
41076             </row>
41077
41078             <row>
41079               <entry><para>015</para></entry>
41080
41081               <entry><para>BNB-card-number, BGF-number, Number-db,
41082               Number-natl-biblio, Identifier-standard</para></entry>
41083             </row>
41084
41085             <row>
41086               <entry><para>017</para></entry>
41087
41088               <entry><para>Number-legal-deposit,
41089               Identifier-standard</para></entry>
41090             </row>
41091
41092             <row>
41093               <entry><para>018</para></entry>
41094
41095               <entry><para>Identifier-standard</para></entry>
41096             </row>
41097
41098             <row>
41099               <entry><para>020$a</para></entry>
41100
41101               <entry><para>ISBN:w, Identifier-standard:w</para></entry>
41102             </row>
41103
41104             <row>
41105               <entry><para>020</para></entry>
41106
41107               <entry><para>Identifier-standard</para></entry>
41108             </row>
41109
41110             <row>
41111               <entry><para>022$a</para></entry>
41112
41113               <entry><para>ISSN:w, Identifier-standard:w</para></entry>
41114             </row>
41115
41116             <row>
41117               <entry><para>022</para></entry>
41118
41119               <entry><para>Identifier-standard</para></entry>
41120             </row>
41121
41122             <row>
41123               <entry><para>023</para></entry>
41124
41125               <entry><para>Identifier-standard</para></entry>
41126             </row>
41127
41128             <row>
41129               <entry><para>024$a</para></entry>
41130
41131               <entry><para>Identifier-other</para></entry>
41132             </row>
41133
41134             <row>
41135               <entry><para>024</para></entry>
41136
41137               <entry><para>Identifier-standard</para></entry>
41138             </row>
41139
41140             <row>
41141               <entry><para>025</para></entry>
41142
41143               <entry><para>Identifier-standard</para></entry>
41144             </row>
41145
41146             <row>
41147               <entry><para>027</para></entry>
41148
41149               <entry><para>Report-number, Identifier-standard</para></entry>
41150             </row>
41151
41152             <row>
41153               <entry><para>028</para></entry>
41154
41155               <entry><para>Number-music-publisher,
41156               Identifier-standard</para></entry>
41157             </row>
41158
41159             <row>
41160               <entry><para>030</para></entry>
41161
41162               <entry><para>CODEN, Identifier-standard</para></entry>
41163             </row>
41164
41165             <row>
41166               <entry><para>034</para></entry>
41167
41168               <entry><para>Map-scale</para></entry>
41169             </row>
41170
41171             <row>
41172               <entry><para>037</para></entry>
41173
41174               <entry><para>Identifier-standard, Stock-number</para></entry>
41175             </row>
41176
41177             <row>
41178               <entry><para>040</para></entry>
41179
41180               <entry><para>Code-institution, Record-source</para></entry>
41181             </row>
41182
41183             <row>
41184               <entry><para>041</para></entry>
41185
41186               <entry><para>ln</para></entry>
41187             </row>
41188
41189             <row>
41190               <entry><para>043</para></entry>
41191
41192               <entry><para>Code-geographic</para></entry>
41193             </row>
41194
41195             <row>
41196               <entry><para>050$b</para></entry>
41197
41198               <entry><para>LC-call-number:w, LC-call-number:p,
41199               LC-call-number:s</para></entry>
41200             </row>
41201
41202             <row>
41203               <entry><para>050</para></entry>
41204
41205               <entry><para>LC-call-number:w, LC-call-number:p,
41206               LC-call-number:s</para></entry>
41207             </row>
41208
41209             <row>
41210               <entry><para>052</para></entry>
41211
41212               <entry><para>Geographic-class</para></entry>
41213             </row>
41214
41215             <row>
41216               <entry><para>060</para></entry>
41217
41218               <entry><para>NLM-call-number</para></entry>
41219             </row>
41220
41221             <row>
41222               <entry><para>070</para></entry>
41223
41224               <entry><para>NAL-call-number</para></entry>
41225             </row>
41226
41227             <row>
41228               <entry><para>080</para></entry>
41229
41230               <entry><para>UDC-classification</para></entry>
41231             </row>
41232
41233             <row>
41234               <entry><para>082</para></entry>
41235
41236               <entry><para>Dewey-classification:w,
41237               Dewey-classification:s</para></entry>
41238             </row>
41239
41240             <row>
41241               <entry><para>086</para></entry>
41242
41243               <entry><para>Number-govt-pub</para></entry>
41244             </row>
41245
41246             <row>
41247               <entry><para>100$9</para></entry>
41248
41249               <entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
41250             </row>
41251
41252             <row>
41253               <entry><para>100$a</para></entry>
41254
41255               <entry><para>Author,Author:p, Author:s, Editor,
41256               Author-personal-bibliography, Author-personal-bibliography:p,
41257               Author-personal-bibliography:s</para></entry>
41258             </row>
41259
41260             <row>
41261               <entry><para>100</para></entry>
41262
41263               <entry><para>Author, Author-title, Author-name-personal, Name,
41264               Name-and-title, Personal-name</para></entry>
41265             </row>
41266
41267             <row>
41268               <entry><para>110$9</para></entry>
41269
41270               <entry><para>Koha-Auth-Number</para></entry>
41271             </row>
41272
41273             <row>
41274               <entry><para>110</para></entry>
41275
41276               <entry><para>Author, Author-title, Author-name-corporate, Name,
41277               Name-and-title, Corporate-name</para></entry>
41278             </row>
41279
41280             <row>
41281               <entry><para>111$9</para></entry>
41282
41283               <entry><para>Koha-Auth-Number</para></entry>
41284             </row>
41285
41286             <row>
41287               <entry><para>111</para></entry>
41288
41289               <entry><para>Author, Author-title, Author-name-corporate, Name,
41290               Name-and-title, Conference-name</para></entry>
41291             </row>
41292
41293             <row>
41294               <entry><para>130$n</para></entry>
41295
41296               <entry><para>Thematic-number</para></entry>
41297             </row>
41298
41299             <row>
41300               <entry><para>130$r</para></entry>
41301
41302               <entry><para>Music-key</para></entry>
41303             </row>
41304
41305             <row>
41306               <entry><para>130$9</para></entry>
41307
41308               <entry><para>Koha-Auth-Number</para></entry>
41309             </row>
41310
41311             <row>
41312               <entry><para>130</para></entry>
41313
41314               <entry><para>Title, Title-uniform</para></entry>
41315             </row>
41316
41317             <row>
41318               <entry><para>210</para></entry>
41319
41320               <entry><para>Title, Title-abbreviated</para></entry>
41321             </row>
41322
41323             <row>
41324               <entry><para>211</para></entry>
41325
41326               <entry><para>Title, Title-abbreviated</para></entry>
41327             </row>
41328
41329             <row>
41330               <entry><para>212</para></entry>
41331
41332               <entry><para>Title, Title-other-variant</para></entry>
41333             </row>
41334
41335             <row>
41336               <entry><para>214</para></entry>
41337
41338               <entry><para>Title, Title-expanded</para></entry>
41339             </row>
41340
41341             <row>
41342               <entry><para>222</para></entry>
41343
41344               <entry><para>Title, Title-key</para></entry>
41345             </row>
41346
41347             <row>
41348               <entry><para>240$r</para></entry>
41349
41350               <entry><para>Music-key</para></entry>
41351             </row>
41352
41353             <row>
41354               <entry><para>240$n</para></entry>
41355
41356               <entry><para>Thematic-number</para></entry>
41357             </row>
41358
41359             <row>
41360               <entry><para>240</para></entry>
41361
41362               <entry><para>Title:w, Title:p, Title-uniform</para></entry>
41363             </row>
41364
41365             <row>
41366               <entry><para>243$n</para></entry>
41367
41368               <entry><para>Thematic-number</para></entry>
41369             </row>
41370
41371             <row>
41372               <entry><para>243$r</para></entry>
41373
41374               <entry><para>Music-key</para></entry>
41375             </row>
41376
41377             <row>
41378               <entry><para>243</para></entry>
41379
41380               <entry><para>Title:w, Title:p, Title-collective</para></entry>
41381             </row>
41382
41383             <row>
41384               <entry><para>245$a</para></entry>
41385
41386               <entry><para>Title-cover:w, Title-cover:p, Title-cover:s,
41387               Title:w, Title:p, Title:s</para></entry>
41388             </row>
41389
41390             <row>
41391               <entry><para>245$c</para></entry>
41392
41393               <entry><para>Author, Author-in-order:w, Author-in-order:p,
41394               Author-in-order:s</para></entry>
41395             </row>
41396
41397             <row>
41398               <entry><para>245$9</para></entry>
41399
41400               <entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
41401             </row>
41402
41403             <row>
41404               <entry><para>245</para></entry>
41405
41406               <entry><para>Title:w, Title:p</para></entry>
41407             </row>
41408
41409             <row>
41410               <entry><para>246</para></entry>
41411
41412               <entry><para>Title, Title:p, Title-abbreviated, Title-expanded,
41413               Title-former</para></entry>
41414             </row>
41415
41416             <row>
41417               <entry><para>247</para></entry>
41418
41419               <entry><para>Title, Title:p, Title-former, Title-other-variant,
41420               Related-periodical</para></entry>
41421             </row>
41422
41423             <row>
41424               <entry><para>260$a</para></entry>
41425
41426               <entry><para>pl:w, pl:p</para></entry>
41427             </row>
41428
41429             <row>
41430               <entry><para>260$b</para></entry>
41431
41432               <entry><para>Publisher:w, Publisher:p</para></entry>
41433             </row>
41434
41435             <row>
41436               <entry><para>260$c</para></entry>
41437
41438               <entry><para>copydate, copydate:s</para></entry>
41439             </row>
41440
41441             <row>
41442               <entry><para>260</para></entry>
41443
41444               <entry><para>pl</para></entry>
41445             </row>
41446
41447             <row>
41448               <entry><para>300</para></entry>
41449
41450               <entry><para>Extent:w, Extent:p</para></entry>
41451             </row>
41452
41453             <row>
41454               <entry><para>400$a</para></entry>
41455
41456               <entry><para>Name-and-title</para></entry>
41457             </row>
41458
41459             <row>
41460               <entry><para>400$t</para></entry>
41461
41462               <entry><para>Author-title, Name-and-title, Title,
41463               Title-series</para></entry>
41464             </row>
41465
41466             <row>
41467               <entry><para>400$9</para></entry>
41468
41469               <entry><para>Koha-Auth-Number</para></entry>
41470             </row>
41471
41472             <row>
41473               <entry><para>400</para></entry>
41474
41475               <entry><para>Author, Author-name-personal, Name,
41476               Personal-name</para></entry>
41477             </row>
41478
41479             <row>
41480               <entry><para>410</para></entry>
41481
41482               <entry><para>Author, Corporate-name</para></entry>
41483             </row>
41484
41485             <row>
41486               <entry><para>410$a</para></entry>
41487
41488               <entry><para>Name-and-title</para></entry>
41489             </row>
41490
41491             <row>
41492               <entry><para>410$t</para></entry>
41493
41494               <entry><para>Author-title, Title, Title-series</para></entry>
41495             </row>
41496
41497             <row>
41498               <entry><para>410$9</para></entry>
41499
41500               <entry><para>Koha-Auth-Number</para></entry>
41501             </row>
41502
41503             <row>
41504               <entry><para>410</para></entry>
41505
41506               <entry><para>Author-name-corporate, Name</para></entry>
41507             </row>
41508
41509             <row>
41510               <entry><para>411</para></entry>
41511
41512               <entry><para>Author, Conference-name</para></entry>
41513             </row>
41514
41515             <row>
41516               <entry><para>411$a</para></entry>
41517
41518               <entry><para>Name-and-title</para></entry>
41519             </row>
41520
41521             <row>
41522               <entry><para>411$t</para></entry>
41523
41524               <entry><para>Author-title, Title-series</para></entry>
41525             </row>
41526
41527             <row>
41528               <entry><para>411</para></entry>
41529
41530               <entry><para>Author-name-corporate, Name</para></entry>
41531             </row>
41532
41533             <row>
41534               <entry><para>440$a</para></entry>
41535
41536               <entry><para>Title-series:w, Title-series:p</para></entry>
41537             </row>
41538
41539             <row>
41540               <entry><para>440$9</para></entry>
41541
41542               <entry><para>Koha-Auth-Number</para></entry>
41543             </row>
41544
41545             <row>
41546               <entry><para>440</para></entry>
41547
41548               <entry><para>Title-series:w, Title-series:p, Title,
41549               Title-series</para></entry>
41550             </row>
41551
41552             <row>
41553               <entry><para>490$a</para></entry>
41554
41555               <entry><para>Title-series:w, Title-series:p</para></entry>
41556             </row>
41557
41558             <row>
41559               <entry><para>490</para></entry>
41560
41561               <entry><para>Title, Title-series</para></entry>
41562             </row>
41563
41564             <row>
41565               <entry><para>490$9</para></entry>
41566
41567               <entry><para>Koha-Auth-Number</para></entry>
41568             </row>
41569
41570             <row>
41571               <entry><para>500</para></entry>
41572
41573               <entry><para>Note:w, Note:p</para></entry>
41574             </row>
41575
41576             <row>
41577               <entry><para>502</para></entry>
41578
41579               <entry><para>Material-type</para></entry>
41580             </row>
41581
41582             <row>
41583               <entry><para>505$r</para></entry>
41584
41585               <entry><para>Author</para></entry>
41586             </row>
41587
41588             <row>
41589               <entry><para>505$t</para></entry>
41590
41591               <entry><para>Title</para></entry>
41592             </row>
41593
41594             <row>
41595               <entry><para>505</para></entry>
41596
41597               <entry><para>Note:w, Note:p</para></entry>
41598             </row>
41599
41600             <row>
41601               <entry><para>510</para></entry>
41602
41603               <entry><para>Indexed-by</para></entry>
41604             </row>
41605
41606             <row>
41607               <entry><para>520</para></entry>
41608
41609               <entry><para>Abstract:w, Abstract:p</para></entry>
41610             </row>
41611
41612             <row>
41613               <entry><para>521$a</para></entry>
41614
41615               <entry><para>lex:n</para></entry>
41616             </row>
41617
41618             <row>
41619               <entry><para>526$c</para></entry>
41620
41621               <entry><para>arl, arl:n</para></entry>
41622             </row>
41623
41624             <row>
41625               <entry><para>526$d</para></entry>
41626
41627               <entry><para>arp, arp:n</para></entry>
41628             </row>
41629
41630             <row>
41631               <entry><para>590</para></entry>
41632
41633               <entry><para>Note:w, Note:p</para></entry>
41634             </row>
41635
41636             <row>
41637               <entry><para>600$a</para></entry>
41638
41639               <entry><para>Name-and-title, Name, Personal-name,
41640               Subject-name-personal, Subject</para></entry>
41641             </row>
41642
41643             <row>
41644               <entry><para>600$t</para></entry>
41645
41646               <entry><para>Name-and-title, Title, Subject</para></entry>
41647             </row>
41648
41649             <row>
41650               <entry><para>600$9</para></entry>
41651
41652               <entry><para>Koha-Auth-Number</para></entry>
41653             </row>
41654
41655             <row>
41656               <entry><para>600</para></entry>
41657
41658               <entry><para>Name, Personal-name, Subject-name-personal,
41659               Subject</para></entry>
41660             </row>
41661
41662             <row>
41663               <entry><para>610$a</para></entry>
41664
41665               <entry><para>Name-and-title</para></entry>
41666             </row>
41667
41668             <row>
41669               <entry><para>610$t</para></entry>
41670
41671               <entry><para>Name-and-title, Title</para></entry>
41672             </row>
41673
41674             <row>
41675               <entry><para>610$9</para></entry>
41676
41677               <entry><para>Koha-Auth-Number</para></entry>
41678             </row>
41679
41680             <row>
41681               <entry><para>610</para></entry>
41682
41683               <entry><para>Name, Subject, Corporate-name</para></entry>
41684             </row>
41685
41686             <row>
41687               <entry><para>611</para></entry>
41688
41689               <entry><para>Conference-name</para></entry>
41690             </row>
41691
41692             <row>
41693               <entry><para>611$a</para></entry>
41694
41695               <entry><para>Name-and-title</para></entry>
41696             </row>
41697
41698             <row>
41699               <entry><para>611$t</para></entry>
41700
41701               <entry><para>Name-and-title, Title</para></entry>
41702             </row>
41703
41704             <row>
41705               <entry><para>611$9</para></entry>
41706
41707               <entry><para>Koha-Auth-Number</para></entry>
41708             </row>
41709
41710             <row>
41711               <entry><para>611</para></entry>
41712
41713               <entry><para>Name, Subject</para></entry>
41714             </row>
41715
41716             <row>
41717               <entry><para>630$n</para></entry>
41718
41719               <entry><para>Thematic-number</para></entry>
41720             </row>
41721
41722             <row>
41723               <entry><para>630$r</para></entry>
41724
41725               <entry><para>Music-key</para></entry>
41726             </row>
41727
41728             <row>
41729               <entry><para>630$9</para></entry>
41730
41731               <entry><para>Koha-Auth-Number</para></entry>
41732             </row>
41733
41734             <row>
41735               <entry><para>630</para></entry>
41736
41737               <entry><para>Subject</para></entry>
41738             </row>
41739
41740             <row>
41741               <entry><para>650$9</para></entry>
41742
41743               <entry><para>Koha-Auth-Number</para></entry>
41744             </row>
41745
41746             <row>
41747               <entry><para>650</para></entry>
41748
41749               <entry><para>Subject, Subject:p</para></entry>
41750             </row>
41751
41752             <row>
41753               <entry><para>651$9</para></entry>
41754
41755               <entry><para>Koha-Auth-Number</para></entry>
41756             </row>
41757
41758             <row>
41759               <entry><para>651</para></entry>
41760
41761               <entry><para>Name-geographic, Subject,Subject:p</para></entry>
41762             </row>
41763
41764             <row>
41765               <entry><para>652$9</para></entry>
41766
41767               <entry><para>Koha-Auth-Number</para></entry>
41768             </row>
41769
41770             <row>
41771               <entry><para>653$9</para></entry>
41772
41773               <entry><para>Koha-Auth-Number</para></entry>
41774             </row>
41775
41776             <row>
41777               <entry><para>653</para></entry>
41778
41779               <entry><para>Subject, Subject:p</para></entry>
41780             </row>
41781
41782             <row>
41783               <entry><para>654$9</para></entry>
41784
41785               <entry><para>Koha-Auth-Number</para></entry>
41786             </row>
41787
41788             <row>
41789               <entry><para>654</para></entry>
41790
41791               <entry><para>Subject</para></entry>
41792             </row>
41793
41794             <row>
41795               <entry><para>655$9</para></entry>
41796
41797               <entry><para>Koha-Auth-Number</para></entry>
41798             </row>
41799
41800             <row>
41801               <entry><para>655</para></entry>
41802
41803               <entry><para>Subject</para></entry>
41804             </row>
41805
41806             <row>
41807               <entry><para>656$9</para></entry>
41808
41809               <entry><para>Koha-Auth-Number</para></entry>
41810             </row>
41811
41812             <row>
41813               <entry><para>656</para></entry>
41814
41815               <entry><para>Subject</para></entry>
41816             </row>
41817
41818             <row>
41819               <entry><para>657$9</para></entry>
41820
41821               <entry><para>Koha-Auth-Number</para></entry>
41822             </row>
41823
41824             <row>
41825               <entry><para>657</para></entry>
41826
41827               <entry><para>Subject</para></entry>
41828             </row>
41829
41830             <row>
41831               <entry><para>690$9</para></entry>
41832
41833               <entry><para>Koha-Auth-Number</para></entry>
41834             </row>
41835
41836             <row>
41837               <entry><para>690</para></entry>
41838
41839               <entry><para>Subject, Subject:p</para></entry>
41840             </row>
41841
41842             <row>
41843               <entry><para>700$9</para></entry>
41844
41845               <entry><para>Cross-Reference, Koha-Auth-Number</para></entry>
41846             </row>
41847
41848             <row>
41849               <entry><para>700$a</para></entry>
41850
41851               <entry><para>Author, Author:p</para></entry>
41852             </row>
41853
41854             <row>
41855               <entry><para>700$n</para></entry>
41856
41857               <entry><para>Thematic-number</para></entry>
41858             </row>
41859
41860             <row>
41861               <entry><para>700$r</para></entry>
41862
41863               <entry><para>Music-key</para></entry>
41864             </row>
41865
41866             <row>
41867               <entry><para>700$t</para></entry>
41868
41869               <entry><para>Author-title, Name-and-title, Title,
41870               Title-uniform</para></entry>
41871             </row>
41872
41873             <row>
41874               <entry><para>700</para></entry>
41875
41876               <entry><para>Author, Author-name-corporate,
41877               Author-name-personal, Name, Editor, Personal-name</para></entry>
41878             </row>
41879
41880             <row>
41881               <entry><para>710</para></entry>
41882
41883               <entry><para>Author, Corporate-name</para></entry>
41884             </row>
41885
41886             <row>
41887               <entry><para>710$t</para></entry>
41888
41889               <entry><para>Author-title, Name-and-title, Title,
41890               Title-uniform</para></entry>
41891             </row>
41892
41893             <row>
41894               <entry><para>710$a</para></entry>
41895
41896               <entry><para>Name-and-title</para></entry>
41897             </row>
41898
41899             <row>
41900               <entry><para>710$9</para></entry>
41901
41902               <entry><para>Koha-Auth-Number</para></entry>
41903             </row>
41904
41905             <row>
41906               <entry><para>710</para></entry>
41907
41908               <entry><para>Author, Name</para></entry>
41909             </row>
41910
41911             <row>
41912               <entry><para>711$a</para></entry>
41913
41914               <entry><para>Name-and-title</para></entry>
41915             </row>
41916
41917             <row>
41918               <entry><para>711$t</para></entry>
41919
41920               <entry><para>Author-title, Title, Title-uniform</para></entry>
41921             </row>
41922
41923             <row>
41924               <entry><para>711$9</para></entry>
41925
41926               <entry><para>Koha-Auth-Number</para></entry>
41927             </row>
41928
41929             <row>
41930               <entry><para>711</para></entry>
41931
41932               <entry><para>Author-name-corporate, Name,
41933               Conference-name</para></entry>
41934             </row>
41935
41936             <row>
41937               <entry><para>730$n</para></entry>
41938
41939               <entry><para>Thematic-number</para></entry>
41940             </row>
41941
41942             <row>
41943               <entry><para>730$r</para></entry>
41944
41945               <entry><para>Music-key</para></entry>
41946             </row>
41947
41948             <row>
41949               <entry><para>730$9</para></entry>
41950
41951               <entry><para>Koha-Auth-Number</para></entry>
41952             </row>
41953
41954             <row>
41955               <entry><para>730</para></entry>
41956
41957               <entry><para>Title, Title-uniform</para></entry>
41958             </row>
41959
41960             <row>
41961               <entry><para>740</para></entry>
41962
41963               <entry><para>Title, Title-other-variant</para></entry>
41964             </row>
41965
41966             <row>
41967               <entry><para>773$t</para></entry>
41968
41969               <entry><para>Host-item</para></entry>
41970             </row>
41971
41972             <row>
41973               <entry><para>780$t</para></entry>
41974
41975               <entry><para>Title</para></entry>
41976             </row>
41977
41978             <row>
41979               <entry><para>780</para></entry>
41980
41981               <entry><para>Title, Title-former,
41982               Related-periodical</para></entry>
41983             </row>
41984
41985             <row>
41986               <entry><para>785</para></entry>
41987
41988               <entry><para>Related-periodical</para></entry>
41989             </row>
41990
41991             <row>
41992               <entry><para>800$a</para></entry>
41993
41994               <entry><para>Name-and-title</para></entry>
41995             </row>
41996
41997             <row>
41998               <entry><para>800$t</para></entry>
41999
42000               <entry><para>Author-title, Name-and-title, Title,
42001               Title-series</para></entry>
42002             </row>
42003
42004             <row>
42005               <entry><para>800$9</para></entry>
42006
42007               <entry><para>Koha-Auth-Number</para></entry>
42008             </row>
42009
42010             <row>
42011               <entry><para>800</para></entry>
42012
42013               <entry><para>Author, Author-name-personal, Name,
42014               Personal-name</para></entry>
42015             </row>
42016
42017             <row>
42018               <entry><para>810$a</para></entry>
42019
42020               <entry><para>Name-and-title</para></entry>
42021             </row>
42022
42023             <row>
42024               <entry><para>810$t</para></entry>
42025
42026               <entry><para>Author-title, Name-and-title, Title,
42027               Title-series</para></entry>
42028             </row>
42029
42030             <row>
42031               <entry><para>810$9</para></entry>
42032
42033               <entry><para>Koha-Auth-Number</para></entry>
42034             </row>
42035
42036             <row>
42037               <entry><para>810</para></entry>
42038
42039               <entry><para>Author, Corporate-name, Author-name-corporate,
42040               Name</para></entry>
42041             </row>
42042
42043             <row>
42044               <entry><para>811$a</para></entry>
42045
42046               <entry><para>Name-and-title</para></entry>
42047             </row>
42048
42049             <row>
42050               <entry><para>811$9</para></entry>
42051
42052               <entry><para>Koha-Auth-Number</para></entry>
42053             </row>
42054
42055             <row>
42056               <entry><para>811$t</para></entry>
42057
42058               <entry><para>Author-title, Name-and-title, Title,
42059               Title-series</para></entry>
42060             </row>
42061
42062             <row>
42063               <entry><para>811</para></entry>
42064
42065               <entry><para>Author, Author-name-corporate, Name,
42066               Conference-name</para></entry>
42067             </row>
42068
42069             <row>
42070               <entry><para>830$9</para></entry>
42071
42072               <entry><para>Koha-Auth-Number</para></entry>
42073             </row>
42074
42075             <row>
42076               <entry><para>830</para></entry>
42077
42078               <entry><para>Title, Title-series</para></entry>
42079             </row>
42080
42081             <row>
42082               <entry><para>840</para></entry>
42083
42084               <entry><para>Title, Title-series</para></entry>
42085             </row>
42086
42087             <row>
42088               <entry><para>999$c</para></entry>
42089
42090               <entry><para>Local-Number:n, Local-Number:w,
42091               Local-Number:s</para></entry>
42092             </row>
42093
42094             <row>
42095               <entry><para>999$d</para></entry>
42096
42097               <entry><para>biblioitemnumber:n, biblioitemnumber:w,
42098               biblioitemnumber:s</para></entry>
42099             </row>
42100
42101             <row>
42102               <entry><para>942$0</para></entry>
42103
42104               <entry><para>totalissues:n, totalissues:s</para></entry>
42105             </row>
42106
42107             <row>
42108               <entry><para>942$2</para></entry>
42109
42110               <entry><para>cn-bib-source</para></entry>
42111             </row>
42112
42113             <row>
42114               <entry><para>942$6</para></entry>
42115
42116               <entry><para>cn-bib-sort:n, cn-bib-sort:s</para></entry>
42117             </row>
42118
42119             <row>
42120               <entry><para>942$c</para></entry>
42121
42122               <entry><para>itemtype:w</para></entry>
42123             </row>
42124
42125             <row>
42126               <entry><para>942$n</para></entry>
42127
42128               <entry><para>Suppress:w, Suppress:n</para></entry>
42129             </row>
42130
42131             <row>
42132               <entry><para>942$h</para></entry>
42133
42134               <entry><para>cn-class</para></entry>
42135             </row>
42136
42137             <row>
42138               <entry><para>942$i</para></entry>
42139
42140               <entry><para>cn-item</para></entry>
42141             </row>
42142
42143             <row>
42144               <entry><para>942$k</para></entry>
42145
42146               <entry><para>cn-prefix</para></entry>
42147             </row>
42148
42149             <row>
42150               <entry><para>942$m</para></entry>
42151
42152               <entry><para>cn-suffix</para></entry>
42153             </row>
42154
42155             <row>
42156               <entry><para>952$0</para></entry>
42157
42158               <entry><para>withdrawn:n, withdrawn:w</para></entry>
42159             </row>
42160
42161             <row>
42162               <entry><para>952$1</para></entry>
42163
42164               <entry><para>lost, lost:n</para></entry>
42165             </row>
42166
42167             <row>
42168               <entry><para>952$2</para></entry>
42169
42170               <entry><para>classification-source</para></entry>
42171             </row>
42172
42173             <row>
42174               <entry><para>952$3</para></entry>
42175
42176               <entry><para>materials-specified</para></entry>
42177             </row>
42178
42179             <row>
42180               <entry><para>952$4</para></entry>
42181
42182               <entry><para>damaged:n, damaged:w</para></entry>
42183             </row>
42184
42185             <row>
42186               <entry><para>952$5</para></entry>
42187
42188               <entry><para>restricted:n, restricted:w</para></entry>
42189             </row>
42190
42191             <row>
42192               <entry><para>952$6</para></entry>
42193
42194               <entry><para>cn-sort:n, cn-sort:s</para></entry>
42195             </row>
42196
42197             <row>
42198               <entry><para>952$7</para></entry>
42199
42200               <entry><para>notforloan:n, notforloan:w</para></entry>
42201             </row>
42202
42203             <row>
42204               <entry><para>952$8</para></entry>
42205
42206               <entry><para>ccode</para></entry>
42207             </row>
42208
42209             <row>
42210               <entry><para>952$9</para></entry>
42211
42212               <entry><para>itemnumber:n, itemnumber:s</para></entry>
42213             </row>
42214
42215             <row>
42216               <entry><para>952$a</para></entry>
42217
42218               <entry><para>homebranch</para></entry>
42219             </row>
42220
42221             <row>
42222               <entry><para>952$b</para></entry>
42223
42224               <entry><para>holdingbranch</para></entry>
42225             </row>
42226
42227             <row>
42228               <entry><para>952$c</para></entry>
42229
42230               <entry><para>location</para></entry>
42231             </row>
42232
42233             <row>
42234               <entry><para>952$d</para></entry>
42235
42236               <entry><para>Date-of-acquisition, Date-of-acquisition:d,
42237               Date-of-acquisition:s</para></entry>
42238             </row>
42239
42240             <row>
42241               <entry><para>952$e</para></entry>
42242
42243               <entry><para>acqsource</para></entry>
42244             </row>
42245
42246             <row>
42247               <entry><para>952$f</para></entry>
42248
42249               <entry><para>coded-location-qualifier</para></entry>
42250             </row>
42251
42252             <row>
42253               <entry><para>952$g</para></entry>
42254
42255               <entry><para>price</para></entry>
42256             </row>
42257
42258             <row>
42259               <entry><para>952$j</para></entry>
42260
42261               <entry><para>stack:n, stack:w</para></entry>
42262             </row>
42263
42264             <row>
42265               <entry><para>952$l</para></entry>
42266
42267               <entry><para>issues:n, issues:w, issues:s</para></entry>
42268             </row>
42269
42270             <row>
42271               <entry><para>952$m</para></entry>
42272
42273               <entry><para>renewals:n, renewals:w</para></entry>
42274             </row>
42275
42276             <row>
42277               <entry><para>952$n</para></entry>
42278
42279               <entry><para>reserves:n, reserves:w</para></entry>
42280             </row>
42281
42282             <row>
42283               <entry><para>952$o</para></entry>
42284
42285               <entry><para>Local-classification:w, Local-classification:p,
42286               Local-classification:s</para></entry>
42287             </row>
42288
42289             <row>
42290               <entry><para>952$p</para></entry>
42291
42292               <entry><para>barcode, barcode:n</para></entry>
42293             </row>
42294
42295             <row>
42296               <entry><para>952$q</para></entry>
42297
42298               <entry><para>onloan:n, onloan:w</para></entry>
42299             </row>
42300
42301             <row>
42302               <entry><para>952$r</para></entry>
42303
42304               <entry><para>datelastseen</para></entry>
42305             </row>
42306
42307             <row>
42308               <entry><para>952$s</para></entry>
42309
42310               <entry><para>datelastborrowed</para></entry>
42311             </row>
42312
42313             <row>
42314               <entry><para>952$t</para></entry>
42315
42316               <entry><para>copynumber</para></entry>
42317             </row>
42318
42319             <row>
42320               <entry><para>952$u</para></entry>
42321
42322               <entry><para>uri:u</para></entry>
42323             </row>
42324
42325             <row>
42326               <entry><para>952$v</para></entry>
42327
42328               <entry><para>replacementprice</para></entry>
42329             </row>
42330
42331             <row>
42332               <entry><para>952$w</para></entry>
42333
42334               <entry><para>replacementpricedate</para></entry>
42335             </row>
42336
42337             <row>
42338               <entry><para>952$y</para></entry>
42339
42340               <entry><para>itype:w</para></entry>
42341             </row>
42342
42343             <row>
42344               <entry><para>952$z</para></entry>
42345
42346               <entry><para>Note:w, Note:p</para></entry>
42347             </row>
42348           </tbody>
42349         </tgroup>
42350       </table>
42351     </section>
42352   </chapter>
42353   <chapter id="pluginsystem">
42354     <title>Plugin System</title>
42355     <para>Koha's Plugin System allows for you to add additional tools and reports to Koha that are
42356       specific to your library. Plugins are installed by uploading KPZ ( Koha Plugin Zip ) packages.
42357       A KPZ file is just a zip file containing the perl files, template files, and any other files
42358       necessary to make the plugin work.</para>
42359     <para>The plugin system needs to be turned on by a system administrator. </para>
42360     <section id="pluginsetup">
42361       <title>Set up</title>
42362       <para>To set up the Koha plugin system you must first make some changes to your install.<itemizedlist>
42363           <listitem>
42364             <para>Change &lt;enable_plugins&gt;0&lt;/enable_plugins&gt; to
42365               &lt;enable_plugins&gt;1&lt;/enable_plugins&gt; in your koha-conf.xml file</para>
42366           </listitem>
42367           <listitem>
42368             <para>Restart your webserver</para>
42369           </listitem>
42370         </itemizedlist>Once set up is complete you will need to alter your <link
42371           linkend="UseKohaPlugins">UseKohaPlugins</link> system preference. On the Tools page you
42372         will see the Tools Plugins and on the Reports page you will see the Reports Plugins.</para>
42373     </section>
42374   </chapter>
42375   <chapter id="staffsearchhistory">
42376     <title>Search History</title>
42377     <para>If you have your <link linkend="EnableSearchHistory">EnableSearchHistory</link> preference
42378       set to keep your search history then you can access this information by clicking on your
42379       username in the top right of the staff client and choosing 'Search history'.</para>
42380     <screenshot>
42381       <screeninfo>Search history</screeninfo>
42382       <mediaobject>
42383         <imageobject>
42384           <imagedata fileref="images/searchhistory/searchhistory.png"/>
42385         </imageobject>
42386       </mediaobject>
42387     </screenshot>
42388     <para>From this page you will see your bibliographic search history </para>
42389     <screenshot>
42390       <screeninfo>Bibliographic search history</screeninfo>
42391       <mediaobject>
42392         <imageobject>
42393           <imagedata fileref="images/searchhistory/bibsearch.png"/>
42394         </imageobject>
42395       </mediaobject>
42396     </screenshot>
42397     <para>And your authority search history.</para>
42398     <screenshot>
42399       <screeninfo>Authority search  history</screeninfo>
42400       <mediaobject>
42401         <imageobject>
42402           <imagedata fileref="images/searchhistory/authsearch.png"/>
42403         </imageobject>
42404       </mediaobject>
42405     </screenshot>
42406   </chapter>
42407
42408   <chapter id="aboutkoha">
42409     <title>About Koha</title>
42410
42411     <para>The 'About Koha' area will give you important server information as
42412     well as general information about Koha.</para>
42413
42414     <itemizedlist>
42415       <listitem>
42416         <para><emphasis>Get there:</emphasis> More &gt; About Koha</para>
42417       </listitem>
42418     </itemizedlist>
42419
42420     <section id="aboutserver">
42421       <title>Server Information</title>
42422
42423       <para>Under the 'Server Information' tab you will find information about
42424       the Koha version and the machine you have installed Koha on. This
42425       information is very important for debugging problems. When reporting
42426       issues to your support provider or to the various other support avenues
42427       (mailing lists, chat room, etc), it's always good to give the
42428       information from this screen.</para>
42429
42430       <screenshot>
42431         <screeninfo>Server Information on Koha</screeninfo>
42432
42433         <mediaobject>
42434           <imageobject>
42435             <imagedata fileref="images/about/aboutserver.png"/>
42436           </imageobject>
42437         </mediaobject>
42438       </screenshot>
42439     </section>
42440
42441     <section id="aboutserverperl">
42442       <title>Perl Modules</title>
42443
42444       <para>In order to take advantage of all of the functionalities of Koha,
42445       you will need to keep your Perl modules up to date. The 'Perl Modules'
42446       tab will show you all of the modules required by Koha, the version you
42447       have installed and whether you need to upgrade certain modules.</para>
42448
42449       <screenshot>
42450         <screeninfo>Perl Modules</screeninfo>
42451
42452         <mediaobject>
42453           <imageobject>
42454             <imagedata fileref="images/about/aboutperlmodules.png"/>
42455           </imageobject>
42456         </mediaobject>
42457       </screenshot>
42458
42459       <para>Items listed in bold are required by Koha, items highlighed in red
42460       are missing completely and items highlighted in yellow simply need to be
42461       upgraded.</para>
42462     </section>
42463
42464     <section id="aboutsystem">
42465       <title>System Information</title>
42466
42467       <para>This tab will provide you with warnings if you are using system
42468       preferences that have since been deprecated or system preferences that
42469       you have set without other required preferences</para>
42470
42471       <screenshot>
42472         <screeninfo>System Information</screeninfo>
42473
42474         <mediaobject>
42475           <imageobject>
42476             <imagedata fileref="images/about/systeminfo.jpg"/>
42477           </imageobject>
42478         </mediaobject>
42479       </screenshot>
42480     </section>
42481   </chapter>
42482
42483   <chapter id="implementation">
42484     <title>Implementation Checklist</title>
42485
42486     <para>The following guide will walk you through the areas of Koha you need
42487     to look at in order to prepare to start using the system.</para>
42488
42489     <section id="imp-migration">
42490       <title>Data Migration</title>
42491
42492       <para>Before you can start using Koha you'll need to have some data.
42493       This can be done by entering it all by hand, but most people already
42494       have their data in electronic format of some sort and just need to
42495       reformat it a bit for importing into Koha.</para>
42496
42497       <itemizedlist>
42498         <listitem>
42499           <para>Create a list of libraries and enter their info and codes into
42500           <link linkend="libsgroups">Libraries &amp; Groups</link></para>
42501         </listitem>
42502
42503         <listitem>
42504           <para>Define your list of <link linkend="itemtypeadmin">Item
42505           Types</link></para>
42506         </listitem>
42507
42508         <listitem>
42509           <para>Define your patron categories and enter the categories and their codes into <link
42510               linkend="patcats">Patron Categories</link></para>
42511         </listitem>
42512
42513         <listitem>
42514           <para>Enter any additional patron information fields you use in your
42515           library in the <link linkend="patronattributetypes">Patron
42516           Attributes</link></para>
42517
42518           <itemizedlist>
42519             <listitem>
42520               <para>Requires that you first set the <link linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
42521               system preference if you have custom fields</para>
42522             </listitem>
42523           </itemizedlist>
42524         </listitem>
42525
42526         <listitem>
42527           <para>Define all of your <link linkend="authorizedvalues">Authorized
42528           Values</link></para>
42529
42530           <itemizedlist>
42531             <listitem>
42532               <para><link linkend="ccode">Collection codes</link></para>
42533             </listitem>
42534
42535             <listitem>
42536               <para><link linkend="shelvelocvals">Shelving
42537               locations</link></para>
42538             </listitem>
42539
42540             <listitem>
42541               <para>Item statuses (<link linkend="lost">lost</link>, <link linkend="notforloan">not
42542                   for loan</link>, <link linkend="damageauth">damaged</link>, <link linkend="withdrawnauth">withdrawn</link>)</para>
42543             </listitem>
42544
42545             <listitem>
42546               <para>Plus any others that are needed in your library</para>
42547             </listitem>
42548           </itemizedlist>
42549         </listitem>
42550
42551         <listitem>
42552           <para>Optionally define <link linkend="citytowns">City/State/Postal Code</link> combos </para>
42553         </listitem>
42554
42555         <listitem>
42556           <para><link linkend="kohamarcmapping">Map your bibliographic
42557           data</link> from your legacy system to Koha fields and migrate
42558           (remembering to use the collection, shelving, item type and library
42559           codes you entered in the above setting areas)</para>
42560         </listitem>
42561
42562         <listitem>
42563           <para><link linkend="patronimport">Map your patron data</link> from
42564           your legacy system to the Koha fields and migrate (remembering to
42565           use the patron and library codes you defined above)</para>
42566         </listitem>
42567
42568         <listitem>
42569           <para>Test your migrated data to be sure that everything is as you
42570           expect it to be, some things to test include:</para>
42571
42572           <itemizedlist>
42573             <listitem>
42574               <para>Check some of your titles with diacritics and make sure
42575               that they migrated properly.</para>
42576             </listitem>
42577
42578             <listitem>
42579               <para>Check titles in a series and make sure that series
42580               information migrated properly.</para>
42581             </listitem>
42582
42583             <listitem>
42584               <para>Make sure that your patrons have their contact information
42585               in the right fields.</para>
42586             </listitem>
42587
42588             <listitem>
42589               <para>If your serials data was migrated search for these records
42590               in the catalog and confirm that they look right.</para>
42591             </listitem>
42592
42593             <listitem>
42594               <para>If your serials data was migrated search for these records
42595               in the serials module and confirm that they look right.</para>
42596             </listitem>
42597
42598             <listitem>
42599               <para>Check marc records to verify a variety of items are
42600               cataloged correctly</para>
42601             </listitem>
42602
42603             <listitem>
42604               <para>Check cataloging process to see if all necessary fields
42605               are available</para>
42606             </listitem>
42607
42608             <listitem>
42609               <para>If fines are migrated, check to see that they are applied
42610               correctly</para>
42611             </listitem>
42612
42613             <listitem>
42614               <para>If holds are migrated, check to see they are accurate in
42615               catalog and patron record</para>
42616             </listitem>
42617           </itemizedlist>
42618         </listitem>
42619       </itemizedlist>
42620     </section>
42621
42622     <section id="impadmin">
42623       <title>Admin Configuration</title>
42624
42625       <para>Most of these preferences won't need to be changed to use your
42626       Koha system, but there are a few that you might want to
42627       customize.</para>
42628
42629       <itemizedlist>
42630         <listitem>
42631           <para>If your library uses CAS Authentication, you'll want to set
42632           the various <link linkend="casauthentication">CAS system
42633           preferences</link></para>
42634         </listitem>
42635
42636         <listitem>
42637           <para>Administration System Preferences</para>
42638
42639           <itemizedlist>
42640             <listitem>
42641               <para><link linkend="KohaAdminEmailAddress">KohaAdminEmailAddress</link> :
42642               This is the email address that will be used by the system in
42643               'from' lines and to send errors to if there is no email set for
42644               the branch</para>
42645             </listitem>
42646
42647             <listitem>
42648               <para><link linkend="noItemTypeImages">noItemTypeImages</link> :
42649               Decide if you want to show item type icons in the staff client
42650               and opac</para>
42651             </listitem>
42652
42653             <listitem>
42654               <para><link linkend="delimiter">delimiter</link> : This value
42655               will be put in between fields when exporting data from
42656               Koha</para>
42657             </listitem>
42658
42659             <listitem>
42660               <para><link linkend="virtualshelves">virtualshelves</link> :
42661               Decide if you want the staff and/or patrons to use lists in
42662               Koha</para>
42663             </listitem>
42664
42665             <listitem>
42666               <para><link linkend="AutoLocation">AutoLocation</link> : Require
42667               staff to log in to the staff client from a specific IP
42668               range</para>
42669             </listitem>
42670
42671             <listitem>
42672               <para><link linkend="IndependentBranches">IndependentBranches</link> : Prevent
42673                 librarians from editing content that belongs to other branches</para>
42674             </listitem>
42675           </itemizedlist>
42676         </listitem>
42677
42678         <listitem>
42679           <para>Go through the <link linkend="logs">Log System Preferences</link> and decide which
42680             actions you want to keep track of in the logs</para>
42681         </listitem>
42682         <listitem>
42683           <para>Decide if you'd like to share your library's information with the Koha community by
42684             setting the <link linkend="heaprefs">Sharing system preferences</link>.</para>
42685         </listitem>
42686         <listitem>
42687           <para>Decide what <link linkend="cronjobsch">cron jobs</link> you need to run and when.<itemizedlist>
42688               <listitem>
42689                 <para>If you're using the long overdue cron job be sure to set your <link
42690                     linkend="DefaultLongOverdueChargeValue">DefaultLongOverdueChargeValue</link>,
42691                     <link linkend="DefaultLongOverdueLostValue">DefaultLongOverdueLostValue</link>
42692                   &amp; <link linkend="DefaultLongOverdueLostValue">DefaultLongOverdueDays</link>
42693                   preferences.</para>
42694               </listitem>
42695             </itemizedlist></para>
42696         </listitem>
42697       </itemizedlist>
42698     </section>
42699
42700     <section id="implocal">
42701       <title>Localization Configuration</title>
42702
42703       <para>Koha is used worldwide and so you need to make sure you set your
42704       localization preferences so that options throughout Koha appear properly
42705       for your location/language.</para>
42706
42707       <itemizedlist>
42708         <listitem>
42709           <para>Localization/Internationalization System Preferences</para>
42710
42711           <itemizedlist>
42712             <listitem>
42713               <para><link linkend="dateformat">dateformat</link> : Decide how
42714               dates are displayed throughout Koha</para>
42715             </listitem>
42716
42717             <listitem>
42718               <para><link linkend="opaclanguagesdisplay">opaclanguagesdisplay</link> :
42719               Decide if patrons can choose what language the OPAC appears
42720               in</para>
42721
42722               <itemizedlist>
42723                 <listitem>
42724                   <para><link linkend="opaclanguages">opaclanguages</link> :
42725                   Decide which languages the patrons can choose from</para>
42726                 </listitem>
42727               </itemizedlist>
42728             </listitem>
42729
42730             <listitem>
42731               <para><link linkend="languagepref">language</link> : Decide
42732               which languages appear in the staff client</para>
42733             </listitem>
42734
42735             <listitem>
42736               <para><link linkend="CalendarFirstDayOfWeek">CalendarFirstDayOfWeek</link> :
42737               Define your first day of the week</para>
42738             </listitem>
42739           </itemizedlist>
42740         </listitem>
42741       </itemizedlist>
42742     </section>
42743
42744     <section id="impcirc">
42745       <title>Circulation Configuration</title>
42746
42747       <para>Before you start circulating your collection you'll need to set up
42748       your rules and preferences for circulation.</para>
42749
42750       <itemizedlist>
42751         <listitem>
42752           <para>Define your <link linkend="circfinerules">Circulation/Fine rules</link></para>
42753         </listitem>
42754
42755         <listitem>
42756           <para>Enter the <link linkend="calholidays">days your library is
42757           closed</link> for fines and due date calculations</para>
42758         </listitem>
42759
42760         <listitem>
42761           <para>Circulation System Preferences</para>
42762
42763           <itemizedlist>
42764             <listitem>
42765               <para><link linkend="CircControl">CircControl</link> : Define
42766               whether circ rules are based on item's location, patron's
42767               location or transaction location</para>
42768             </listitem>
42769
42770             <listitem>
42771               <para><link linkend="useDaysMode">useDaysMode</link> : Define
42772               how due dates are calculated</para>
42773             </listitem>
42774
42775             <listitem>
42776               <para><link linkend="finesCalendar">finesCalendar</link> :
42777               Define how fines are calculated (for every late date or only for
42778               days the library is open)</para>
42779             </listitem>
42780
42781             <listitem>
42782               <para><link linkend="SpecifyDueDate">SpecifyDueDate</link> : Decide if staff are
42783                 allowed to override due dates on checkout</para>
42784             </listitem>
42785             <listitem>
42786               <para><link linkend="SpecifyReturnDate">SpecifyReturnDate</link> : Decide if you want
42787                 to let the staff specify an arbitrary return date on checkin</para>
42788             </listitem>
42789             <listitem>
42790               <para><link linkend="itemBarcodeFallbackSearch">itemBarcodeFallbackSearch</link> :
42791                 Decide if you want staff to be able to checkout using a keyword search (title, call
42792                 number, etc)</para>
42793             </listitem>
42794
42795             <listitem>
42796               <para><link linkend="AutomaticItemReturn">AutomaticItemReturn</link> :
42797               Decide if items are sent back to the owning branch when checked
42798               in</para>
42799             </listitem>
42800
42801             <listitem>
42802               <para><link linkend="todaysIssuesDefaultSortOrder">todaysIssuesDefaultSortOrder</link>
42803               : Decide how items checked out today display on the patron
42804               record</para>
42805             </listitem>
42806
42807             <listitem>
42808               <para><link linkend="previousIssuesDefaultSortOrder">previousIssuesDefaultSortOrder</link>
42809               : Decide how items checked out prior to today display on the
42810               patron record</para>
42811             </listitem>
42812
42813             <listitem>
42814               <para><link linkend="noissuescharge">noissuescharge</link> :
42815               Define the maximum amount a patron can owe before checkouts are
42816               blocked</para>
42817             </listitem>
42818
42819             <listitem>
42820               <para><link linkend="ReturnBeforeExpiry">ReturnBeforeExpiry</link> : Decide
42821               if patrons need to return items before their accounts
42822               expire</para>
42823             </listitem>
42824
42825             <listitem>
42826               <para><link linkend="AllowHoldsOnDamagedItems">AllowHoldsOnDamagedItems</link>
42827               : Decide if patrons can place holds on items that are marked as
42828               damaged</para>
42829
42830               <itemizedlist>
42831                 <listitem>
42832                   <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
42833                   : Decide if you want the staff to be able to override the
42834                   setting for the above at checkout</para>
42835                 </listitem>
42836               </itemizedlist>
42837             </listitem>
42838
42839             <listitem>
42840               <para><link linkend="maxreserves">maxreserves</link> : Decide
42841               how many items a patron can have on hold at once</para>
42842
42843               <itemizedlist>
42844                 <listitem>
42845                   <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
42846                   : Decide if you want the staff to be able to override the
42847                   setting for the above at checkout</para>
42848                 </listitem>
42849               </itemizedlist>
42850             </listitem>
42851
42852             <listitem>
42853               <para><link linkend="maxoutstanding">maxoutstanding</link> :
42854               Define the maximum amount a patron can owe before holds are
42855               blocked</para>
42856
42857               <itemizedlist>
42858                 <listitem>
42859                   <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
42860                   : Decide if you want the staff to be able to override the
42861                   setting for the above at checkout</para>
42862                 </listitem>
42863               </itemizedlist>
42864             </listitem>
42865
42866             <listitem>
42867               <para><link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link> :
42868               Define the number of days before a hold expires</para>
42869             </listitem>
42870
42871             <listitem>
42872               <para><link linkend="WebBasedSelfCheck">WebBasedSelfCheck</link>
42873               : Decide if you want to use the built in web-based self-checkout
42874               system</para>
42875
42876               <itemizedlist>
42877                 <listitem>
42878                   <para><link linkend="AutoSelfCheckAllowed">AutoSelfCheckAllowed</link> :
42879                   Decide if the self-checkout system requires login</para>
42880                 </listitem>
42881
42882                 <listitem>
42883                   <para><link linkend="ShowPatronImageInWebBasedSelfCheck">ShowPatronImageInWebBasedSelfCheck</link>
42884                   : Decide if you want patron images to show on the self
42885                   checkout screen</para>
42886                 </listitem>
42887               </itemizedlist>
42888             </listitem>
42889
42890             <listitem>
42891               <para><link linkend="AllowNotForLoanOverride">AllowNotForLoanOverride</link>
42892               : Decide if you want the staff to be able to checkout items
42893               marked as 'not for loan'</para>
42894             </listitem>
42895
42896             <listitem>
42897               <para><link linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
42898               : Decide if you want staff to override the limit put on
42899               renewals</para>
42900             </listitem>
42901
42902             <listitem>
42903               <para><link linkend="AllowFineOverride">AllowFineOverride</link> : Decide if you want
42904                 staff to be able to override fine limits</para>
42905             </listitem>
42906             <listitem>
42907               <para><link linkend="AllowTooManyOverride">AllowTooManyOverride</link> : Descide if
42908                 you want staff to be able to check out more than the limit to a patron</para>
42909             </listitem>
42910
42911             <listitem>
42912               <para><link linkend="RenewalPeriodBase">RenewalPeriodBase</link>
42913               : Decide what date renewals are based on</para>
42914             </listitem>
42915
42916             <listitem>
42917               <para><link linkend="finesMode">finesMode</link> : Switch to
42918               'Calculate and Charge' before go live if you charge fines</para>
42919             </listitem>
42920
42921             <listitem>
42922               <para><link linkend="OverdueNoticeBcc">OverdueNoticeBcc</link> :
42923               If you want to receive a copy of every overdue notice sent out,
42924               enter your email address here</para>
42925             </listitem>
42926
42927             <listitem>
42928               <para><link linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
42929               : Decide if you want an email every time a hold is placed</para>
42930             </listitem>
42931
42932             <listitem>
42933               <para><link linkend="ReservesControlBranch">ReservesControlBranch</link> :
42934               Decide which branch's hold rules are considered first</para>
42935             </listitem>
42936
42937             <listitem>
42938               <para><link linkend="soundon">soundon</link> : Decide if you
42939               want to have sounds on for circulation actions</para>
42940             </listitem>
42941
42942             <listitem>
42943               <para><link linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
42944               : If you have a large amount of overdues, you might want to turn
42945               this preference on so as to allow you to filter before results
42946               appear</para>
42947             </listitem>
42948
42949             <listitem>
42950               <para><link linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
42951               : If you have a lot of staff members sharing one circ computer
42952               you might want to enable this so that staff can clear the screen
42953               in between checkouts to protect patron's privacy</para>
42954             </listitem>
42955
42956             <listitem>
42957               <para><link linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link> :
42958               Decide how you want Koha to react if you scan in a blank barcode
42959               on the checkout screen</para>
42960             </listitem>
42961
42962             <listitem>
42963               <para><link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
42964               and/or <link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link>
42965               : Decide if you want patrons and/or staff to be able to suspend
42966               holds</para>
42967
42968               <itemizedlist>
42969                 <listitem>
42970                   <para><link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
42971                   : If you allow holds to be suspended decide if you want them
42972                   to automatically resume on the date entered by the staff
42973                   and/or patron</para>
42974                 </listitem>
42975               </itemizedlist>
42976             </listitem>
42977             <listitem>
42978               <para><link linkend="OnSiteCheckouts">OnSiteCheckouts</link> : Decide if you want to
42979                 allow items to be checked out for use within the library</para>
42980             </listitem>
42981             <listitem>
42982               <para><link linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link> : Set this
42983                 to record local use of items when you check them in</para>
42984             </listitem>
42985           </itemizedlist>
42986         </listitem>
42987
42988         <listitem>
42989           <para>Customize your <link linkend="notices">Notices &amp;
42990           Slips</link></para>
42991         </listitem>
42992
42993         <listitem>
42994           <para>Define your <link linkend="noticetriggers">Overdue Notice
42995           Triggers</link></para>
42996         </listitem>
42997
42998         <listitem>
42999           <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
43000
43001           <itemizedlist>
43002             <listitem>
43003               <para>Populate <link linkend="buildholdscron">your holds
43004               queue</link> (every 1-4 hours)</para>
43005             </listitem>
43006
43007             <listitem>
43008               <para>Decide <link linkend="expiredholdscron">when holds
43009               expire</link> (daily)</para>
43010             </listitem>
43011
43012             <listitem>
43013               <para><link linkend="finescronjob">Calculate fines due</link>
43014               (daily)</para>
43015
43016               <itemizedlist>
43017                 <listitem>
43018                   <para>Fines on hourly loans will calculate when you check
43019                   the items in</para>
43020                 </listitem>
43021               </itemizedlist>
43022             </listitem>
43023
43024             <listitem>
43025               <para><link linkend="longoverduecron">Mark long overdue items as
43026               lost</link> (daily)</para>
43027             </listitem>
43028
43029             <listitem>
43030               <para>Decide when the system <link linkend="msgqueuecron">sends
43031               out messages</link> (1-4 hours)</para>
43032             </listitem>
43033
43034             <listitem>
43035               <para>Decide when the system <link linkend="overduenoticecron">queues overdue notices</link>
43036               (daily)</para>
43037             </listitem>
43038
43039             <listitem>
43040               <para>Set up <link linkend="printholdcron">hold notices that
43041               didn't send for printing</link> (daily after overdues and
43042               message queue)</para>
43043             </listitem>
43044
43045             <listitem>
43046               <para>Decide when the system <link linkend="advnoticecron">queues the advanced notice of items
43047               due</link> (daily)</para>
43048             </listitem>
43049
43050             <listitem>
43051               <para>Find holds that need to be <link linkend="unsuspendholdcron">resumed and remove
43052                   suspension</link> (daily)</para>
43053             </listitem>
43054             <listitem>
43055               <para>If you're allowing automatic renewal of items <link linkend="autorenewcron">set
43056                   them to renew</link> (nightly)</para>
43057             </listitem>
43058           </itemizedlist>
43059         </listitem>
43060       </itemizedlist>
43061     </section>
43062
43063     <section id="imppratrons">
43064       <title>Patron Configuration</title>
43065
43066       <para>You have already imported patron data from your old system, but
43067       there are plenty of options available to you regarding patrons and their
43068       accounts.</para>
43069
43070       <itemizedlist>
43071         <listitem>
43072           <para>Enter your <link linkend="addstaffpatron">staff members as
43073           patrons</link></para>
43074
43075           <itemizedlist>
43076             <listitem>
43077               <para>Define <link linkend="patronpermissions">staff members
43078               access permissions</link></para>
43079             </listitem>
43080           </itemizedlist>
43081         </listitem>
43082
43083         <listitem>
43084           <para>Patron System Preferences</para>
43085
43086           <itemizedlist>
43087
43088             <listitem>
43089               <para><link linkend="autoMemberNum">autoMemberNum</link> :
43090               Decide if the patrons barcodes are auto-generated or if you
43091               enter them yourself</para>
43092             </listitem>
43093
43094             <listitem>
43095               <para><link linkend="MaxFine">MaxFine</link> : Determine the
43096               maximum amount that people can owe in fines</para>
43097             </listitem>
43098
43099             <listitem>
43100               <para><link linkend="NotifyBorrowerDeparture">NotifyBorrowerDeparture</link>
43101               : Decide when to warn staff that the patron account is about to
43102               expire</para>
43103             </listitem>
43104
43105             <listitem>
43106               <para><link linkend="intranetreadinghistory">intranetreadinghistory</link> :
43107               Decide if the staff can see the patron's reading/checkout
43108               history</para>
43109             </listitem>
43110
43111             <listitem>
43112               <para><link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> :
43113               List fields that you want to appear as mandatory on the patron
43114               add/edit form</para>
43115             </listitem>
43116
43117             <listitem>
43118               <para><link linkend="BorrowersTitles">BorrowersTitles</link> :
43119               Add or change the titles for your patrons</para>
43120             </listitem>
43121
43122             <listitem>
43123               <para><link linkend="borrowerRelationship">borrowerRelationship</link> : Add
43124               or change borrower relationships (child to adult and
43125               professional to organization)</para>
43126             </listitem>
43127
43128             <listitem>
43129               <para><link linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
43130               : Determine if the patrons get an email confirming the creation
43131               of their account</para>
43132             </listitem>
43133
43134             <listitem>
43135               <para><link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
43136               : Decide if patrons can choose from a series of notices (other
43137               than overdues)</para>
43138             </listitem>
43139
43140             <listitem>
43141               <para><link linkend="patronimages">patronimages</link> : Decide
43142               if you want to save patron images in your system</para>
43143             </listitem>
43144
43145             <listitem>
43146               <para><link linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
43147               : Decide if you want to enable custom patron fields</para>
43148             </listitem>
43149
43150             <listitem>
43151               <para><link linkend="minPasswordLength">minPasswordLength</link>
43152               : Enter the minimum number of characters you want passwords to
43153               have</para>
43154             </listitem>
43155
43156             <listitem>
43157               <para><link linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> :
43158               Decide what fields your library doesn't need to see on the
43159               patron entry form</para>
43160             </listitem>
43161           </itemizedlist>
43162         </listitem>
43163         <listitem>
43164           <para>Set up your <link linkend="cronjobs">cron jobs</link><itemizedlist>
43165               <listitem>
43166                 <para>Decide if you would like <link linkend="j2acron">children to automatically be
43167                     come adults</link></para>
43168               </listitem>
43169             </itemizedlist></para>
43170         </listitem>
43171       </itemizedlist>
43172     </section>
43173
43174     <section id="impcatalog">
43175       <title>Cataloging Configuration</title>
43176
43177       <para>Before you start cataloging in Koha you'll want to set up your
43178       preferences and other rules.</para>
43179
43180       <itemizedlist>
43181         <listitem>
43182           <para>Define your cataloging templates aka <link linkend="marcbibframeworks">MARC Bibliographic
43183           Frameworks</link></para>
43184
43185           <itemizedlist>
43186             <listitem>
43187               <para>Run the <link linkend="marcbibframeworkstest">MARC
43188               Bibliographic Framework Test</link> to be sure your changes are
43189               valid</para>
43190             </listitem>
43191           </itemizedlist>
43192         </listitem>
43193
43194         <listitem>
43195           <para>Define any <link linkend="authorizedvalues">authorized
43196           values</link> you might want to use in cataloging</para>
43197         </listitem>
43198
43199         <listitem>
43200           <para>Set up <link linkend="classificationsources">custom
43201           classification sources</link> (if you use something other than the
43202           defaults)</para>
43203         </listitem>
43204
43205         <listitem>
43206           <para>Set up <link linkend="recordmatchingrules">MARC matching rules</link> for importing
43207             records from mrc files or Z39.50</para>
43208         </listitem>
43209
43210         <listitem>
43211           <para>Set up <link linkend="keywordmapping">Koha to Keyword
43212           mapping</link> for deciding how to display marc fields to the screen
43213           (still in beta - only one field)</para>
43214         </listitem>
43215
43216         <listitem>
43217           <para>Set up the <link linkend="z3950admin">Z39.50 targets</link> you want to search for
43218             cataloging (and acquisitions)</para>
43219         </listitem>
43220
43221         <listitem>
43222           <para>Cataloging System Preferences</para>
43223
43224           <itemizedlist>
43225             <listitem>
43226               <para><link linkend="URLLinkText">URLLinkText</link> : Enter
43227               text to display when 856 fields do not have pre-defined
43228               labels</para>
43229             </listitem>
43230
43231             <listitem>
43232               <para><link linkend="hide_marc">hide_marc</link> : If you are
43233               unfamiliar with MARC you can have the MARC fields number
43234               hidden</para>
43235             </listitem>
43236
43237             <listitem>
43238               <para><link linkend="LabelMARCView">LabelMARCView</link> :
43239               Choose how you want duplicate fields to appear on the
43240               editor</para>
43241             </listitem>
43242
43243             <listitem>
43244               <para><link linkend="DefaultClassificationSource">DefaultClassificationSource</link>
43245               : Choose which classification source is the default in your
43246               library</para>
43247             </listitem>
43248
43249             <listitem>
43250               <para><link linkend="advancedMARCeditor">advancedMARCeditor</link> : Decide
43251               if you need labels to appear on your MARC editor</para>
43252             </listitem>
43253
43254             <listitem>
43255               <para><link linkend="marcflavour">marcflavour</link> : Choose
43256               your MARC format</para>
43257             </listitem>
43258
43259             <listitem>
43260               <para><link linkend="itemcallnumber">itemcallnumber</link> :
43261               Enter which field and subfields to look into for the call
43262               number</para>
43263             </listitem>
43264
43265             <listitem>
43266               <para><link linkend="MARCOrgCode">MARCOrgCode</link> : Enter
43267               your MARC Organizational Code (not the same as your OCLC
43268               number)</para>
43269             </listitem>
43270
43271             <listitem>
43272               <para><link linkend="autoBarcode">autoBarcode</link> : Decide if
43273               Koha generates item barcodes for you</para>
43274             </listitem>
43275
43276             <listitem>
43277               <para><link linkend="OpacSuppression">OpacSuppression</link> :
43278               Decide if you want to hide items marked as suppressed from the
43279               OPAC search results</para>
43280             </listitem>
43281           </itemizedlist>
43282         </listitem>
43283
43284         <listitem>
43285           <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
43286
43287           <itemizedlist>
43288             <listitem>
43289               <para>Decide when the system <link linkend="checkurlcron">checks
43290               URLs in catalog records</link> to see if they are still
43291               valid</para>
43292             </listitem>
43293           </itemizedlist>
43294         </listitem>
43295       </itemizedlist>
43296     </section>
43297
43298     <section id="impauthorities">
43299       <title>Authorities Configuration</title>
43300
43301       <para>Koha has the ability to keep track of your authority records and
43302       how they're linked to your bibliographic records. Before using
43303       authorities you should configure several preferences.</para>
43304
43305       <itemizedlist>
43306         <listitem>
43307           <para>Set <link linkend="authoritiesadmin">Authority
43308           Frameworks</link> aka templates</para>
43309         </listitem>
43310
43311         <listitem>
43312           <para>Authority System Preferences</para>
43313
43314           <itemizedlist>
43315             <listitem>
43316               <para><link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> :
43317               Decide if Koha creates authorities when cataloging</para>
43318             </listitem>
43319
43320             <listitem>
43321               <para><link linkend="dontmerge">dontmerge</link> : Decide if
43322               updates to authorities trigger updates to the bibliographic
43323               records that link to them</para>
43324             </listitem>
43325
43326             <listitem>
43327               <para><link linkend="AutoCreateAuthorities">AutoCreateAuthorities</link> :
43328               Decide when authorities are created</para>
43329             </listitem>
43330
43331             <listitem>
43332               <para><link linkend="LinkerModule">LinkerModule</link> : Decide
43333               which match the authority linker should use</para>
43334             </listitem>
43335
43336             <listitem>
43337               <para><link linkend="LinkerOptions">LinkerOptions</link> :
43338               Decide if you want authority linking to be broader or more
43339               specific</para>
43340             </listitem>
43341
43342             <listitem>
43343               <para><link linkend="CatalogModuleRelink">CatalogModuleRelink</link> :
43344               Decide if you want to enable authority linking while
43345               cataloging</para>
43346             </listitem>
43347           </itemizedlist>
43348         </listitem>
43349
43350         <listitem>
43351           <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
43352
43353           <itemizedlist>
43354             <listitem>
43355               <para>Choose when the system looks for authorities updates to
43356               <link linkend="mergeauthcron">merge changes into bibliographic
43357               records</link></para>
43358             </listitem>
43359           </itemizedlist>
43360         </listitem>
43361       </itemizedlist>
43362     </section>
43363
43364     <section id="impsearching">
43365       <title>Searching Configuration</title>
43366
43367       <para>There are several system preferences related to searching, it is
43368       not always recommended to make too many changes to these preferences
43369       since they are set to get you the most relevant results. If you would
43370       like to change the default way that Koha handles searching, view the
43371       <link linkend="searchingprefs">Searching system preferences</link>
43372       tab.</para>
43373
43374       <itemizedlist>
43375         <listitem>
43376           <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
43377
43378           <itemizedlist>
43379             <listitem>
43380               <para>Decide how often your <link linkend="rebuildsearchcron">system rebuilds the search
43381               index</link> (4-10 min)</para>
43382             </listitem>
43383           </itemizedlist>
43384         </listitem>
43385
43386         <listitem>
43387           <para>Searching System Preferences</para>
43388
43389           <itemizedlist>
43390             <listitem>
43391               <para><link linkend="AdvancedSearchTypes">AdvancedSearchTypes</link> : Decide which
43392                 authorized value fields you want patrons and staff to be able to limit their
43393                 advanced searches by</para>
43394             </listitem>
43395             <listitem>
43396               <para><link linkend="AdvancedSearchLanguages">AdvancedSearchLanguages</link> : Decide
43397                 which languages you want people to be able to limit to via the search engine</para>
43398             </listitem>
43399
43400             <listitem>
43401               <para><link linkend="UseAuthoritiesForTracings">UseAuthoritiesForTracings</link>
43402               : Decide how you want Koha to handle subject searches in the
43403               OPAC</para>
43404
43405               <itemizedlist>
43406                 <listitem>
43407                   <para><link linkend="TraceCompleteSubfields">TraceCompleteSubfields</link>
43408                   : Decide how you want Koha to handle subject searches in the
43409                   OPAC</para>
43410                 </listitem>
43411
43412                 <listitem>
43413                   <para><link linkend="TraceSubjectSubdivisions">TraceSubjectSubdivisions</link>
43414                   : Decide how you want Koha to handle subject searches in the
43415                   OPAC</para>
43416                 </listitem>
43417               </itemizedlist>
43418             </listitem>
43419
43420             <listitem>
43421               <para><link linkend="displayFacetCount">displayFacetCount</link>
43422               : Decide whether to show facet counts on search results</para>
43423             </listitem>
43424           </itemizedlist>
43425         </listitem>
43426       </itemizedlist>
43427     </section>
43428
43429     <section id="impopac">
43430       <title>OPAC Configuration</title>
43431
43432       <para>There are a lot of ways you can customize your OPAC in
43433       Koha.</para>
43434
43435       <itemizedlist>
43436         <listitem>
43437           <para>Decide how you want your OPAC to look &amp; what content you
43438           want on the main page</para>
43439         </listitem>
43440
43441         <listitem>
43442           <para>Create a library branded stylesheet using CSS</para>
43443
43444           <itemizedlist>
43445             <listitem>
43446               <important>
43447                 <para>Do not edit the default CSS files, instead create a new
43448                 one, that way the system can always fall back on the original
43449                 CSS.</para>
43450               </important>
43451             </listitem>
43452           </itemizedlist>
43453         </listitem>
43454
43455         <listitem>
43456           <para>Create a custom XSLT stylesheet to change the way search
43457           results and bib records appear in the OPAC</para>
43458         </listitem>
43459
43460         <listitem>
43461           <para>OPAC System preferences</para>
43462
43463           <itemizedlist>
43464             <listitem>
43465               <para><link linkend="OPACBaseURL">OPACBaseURL</link> : Enter your library's url
43466               </para>
43467             </listitem>
43468             <listitem>
43469               <para><link linkend="opacuserlogin">opacuserlogin</link> : Decide if you want to allow
43470                 patrons to login to the OPAC to access customized functionality (searching will be
43471                 allowed without logging in)</para>
43472               <itemizedlist>
43473                 <listitem>
43474                   <para><link linkend="RequestOnOpac">RequestOnOpac</link> : Decide if patrons can
43475                     place holds via the OPAC</para>
43476                 </listitem>
43477                 <listitem>
43478                   <para><link linkend="OpacPasswordChange">OpacPasswordChange</link> : Decide if
43479                     patrons can change their password (don't allow this if you're using LDAP)</para>
43480                 </listitem>
43481                 <listitem>
43482                   <para><link linkend="OpacRenewalAllowed">OpacRenewalAllowed</link> : Decide if
43483                     patrons can renew their checked out items via the OPAC</para>
43484                 </listitem>
43485                 <listitem>
43486                   <para><link linkend="opacreadinghistory">opacreadinghistory</link> : Decide if
43487                     patrons can view their reading/checkout history via the OPAC</para>
43488                 </listitem>
43489                 <listitem>
43490                   <para><link linkend="reviewson">reviewson</link> : Decide if you want to allow
43491                     patrons to comment on bib records via the OPAC</para>
43492                 </listitem>
43493                 <listitem>
43494                   <para><link linkend="OpacStarRatings">OpacStarRatings</link> : Decide if patrons
43495                     can leave star ratings</para>
43496                 </listitem>
43497                 <listitem>
43498                   <para><link linkend="virtualshelves">virtualshelves</link> : Decide if you want
43499                     patrons to be able to create Lists</para>
43500                 </listitem>
43501                 <listitem>
43502                   <para><link linkend="OpacAllowPublicListCreation"
43503                       >OpacAllowPublicListCreation</link> : If patrons can create lists then decide
43504                     if they are allowed to create public lists</para>
43505                 </listitem>
43506                 <listitem>
43507                   <para><link linkend="suggestionspref">suggestion</link> : Decide if you want
43508                     patrons to be able to submit purchase suggestions</para>
43509                 </listitem>
43510                 <listitem>
43511                   <para><link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link> :
43512                     Decide if you want patrons to be able to see purchase suggestions made by other
43513                     patrons</para>
43514                 </listitem>
43515               </itemizedlist>
43516             </listitem>
43517
43518             <listitem>
43519               <para><link linkend="opacbookbag">opacbookbag</link> : Decide if
43520               patrons can save items into their cart</para>
43521             </listitem>
43522
43523             <listitem>
43524               <para><link linkend="AnonSuggestions">AnonSuggestions</link> :
43525               Decide if you want non logged in users to be able to make
43526               purchase suggestions</para>
43527             </listitem>
43528
43529             <listitem>
43530               <para><link linkend="LibraryName">LibraryName</link> : Enter
43531               your library name for display in the &lt;title&gt; tag and on
43532               the top of the OPAC</para>
43533             </listitem>
43534
43535             <listitem>
43536               <para><link linkend="opaccredits">opaccredits</link> : Enter
43537               HTML to appear at the bottom of every page in the OPAC</para>
43538             </listitem>
43539
43540             <listitem>
43541               <para><link linkend="OpacMainUserBlock">OpacMainUserBlock</link>
43542               : Enter HTML that will appear in the center of the main OPAC
43543               page</para>
43544             </listitem>
43545
43546             <listitem>
43547               <para><link linkend="OpacNav">OpacNav</link> : Enter HTML that
43548               will appear to the left on the main OPAC page</para>
43549             </listitem>
43550
43551             <listitem>
43552               <para><link linkend="OpacNavBottom">OpacNavBottom</link> : Enter
43553               HTML that will appear below OpacNav</para>
43554             </listitem>
43555
43556             <listitem>
43557               <para><link linkend="OpacNavRight">OpacNavRight</link> : Enter
43558               HTML that will appear below the login box on the right</para>
43559             </listitem>
43560
43561             <listitem>
43562               <para><link linkend="opacheader">opacheader</link> : Enter the
43563               HTML that will appear above the search box on the OPAC</para>
43564             </listitem>
43565
43566             <listitem>
43567               <para><link linkend="OPACNoResultsFound">OPACNoResultsFound</link> : Enter
43568               the HTML that will appear when no results are found</para>
43569             </listitem>
43570
43571             <listitem>
43572               <para><link linkend="OPACResultsSidebar">OPACResultsSidebar</link> : Enter
43573               the HTML that will appear below the facets on your search
43574               results</para>
43575             </listitem>
43576
43577             <listitem>
43578               <para><link linkend="OPACMySummaryHTML">OPACMySummaryHTML</link>
43579               : Enter the HTML that will appear in the far right of the
43580               circulation summary in the OPAC</para>
43581             </listitem>
43582
43583             <listitem>
43584               <para>Customize your stylesheets:</para>
43585
43586               <itemizedlist>
43587                 <listitem>
43588                   <para><link linkend="OPACUserCSS">OPACUserCSS</link> : Enter
43589                   any additional fields you want to define styles for</para>
43590                 </listitem>
43591
43592                 <listitem>
43593                   <para><link linkend="opaclayoutstylesheet">opaclayoutstylesheet</link> :
43594                   Point to a CSS file on your Koha server</para>
43595                 </listitem>
43596               </itemizedlist>
43597             </listitem>
43598
43599             <listitem>
43600               <para><link linkend="OpacHighlightedWords">OpacHighlightedWords</link> :
43601               Decide if you want search terms to be highlighted on the search
43602               results</para>
43603             </listitem>
43604
43605             <listitem>
43606               <para><link linkend="hidelostitems">hidelostitems</link> :
43607               Decide if you want to show patrons items you have marked as
43608               lost</para>
43609             </listitem>
43610
43611             <listitem>
43612               <para><link linkend="BiblioDefaultView">BiblioDefaultView</link>
43613               : Decide what view is the default for bib records on the
43614               OPAC</para>
43615             </listitem>
43616
43617             <listitem>
43618               <para><link linkend="OPACShelfBrowser">OPACShelfBrowser</link> : Decide if you want to
43619                 enable the shelf browse functionality</para>
43620             </listitem>
43621
43622             <listitem>
43623               <para><link linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link> :
43624               Decide if URLs clicked in the OPAC are opened in a new
43625               window</para>
43626             </listitem>
43627
43628             <listitem>
43629               <para><link linkend="SearchMyLibraryFirst">SearchMyLibraryFirst</link> : If
43630               you have a multi-branch system decide if you want patrons to
43631               search their library first</para>
43632             </listitem>
43633
43634             <listitem>
43635               <para><link linkend="OpacAuthorities">OpacAuthorities</link> :
43636               Decide if you want patrons to be able to search your authority
43637               file</para>
43638             </listitem>
43639
43640             <listitem>
43641               <para><link linkend="OpacBrowser">OpacBrowser</link> : Decide if you want patrons to
43642                 browse your authority file (French libraries only)</para>
43643             </listitem>
43644
43645             <listitem>
43646               <para><link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link> :
43647               Choose which libraries you want patrons to be able to re-run
43648               their search in</para>
43649             </listitem>
43650
43651             <listitem>
43652               <para><link linkend="OpacAddMastheadLibraryPulldown">OpacAddMastheadLibraryPulldown</link>
43653               : If you're a multi-branch system you can add a pull down to the
43654               search bar for patrons to search which library to search</para>
43655             </listitem>
43656
43657             <listitem>
43658               <para><link linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
43659               : Decide if you want the system to keep a search history</para>
43660             </listitem>
43661           </itemizedlist>
43662         </listitem>
43663
43664         <listitem>
43665           <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
43666
43667           <itemizedlist>
43668             <listitem>
43669               <para>If you have the <link linkend="OpacBrowser">OpacBrowser</link> preference set
43670                 decide <link linkend="authbrowsercron">when you want the contents to rebuild</link>
43671                 (French libraries only)</para>
43672             </listitem>
43673
43674             <listitem>
43675               <para>If you have <link linkend="customrss">custom RSS
43676               feeds</link>, decide when you want the <link linkend="customrssfeedcron">feed to be populated</link></para>
43677             </listitem>
43678           </itemizedlist>
43679         </listitem>
43680       </itemizedlist>
43681
43682       <section id="editableopac">
43683         <title>Editable OPAC Regions</title>
43684
43685         <para>Using the OPAC system preferences you can customize various regions, the following
43686           graphic will define what preferences update each of the regions in the Bootstrap
43687           theme.</para>
43688
43689         <screenshot>
43690           <screeninfo>OPAC Editable Regions</screeninfo>
43691
43692           <mediaobject>
43693             <imageobject>
43694               <imagedata fileref="images/appendix-opac/opaccustomregions.jpg"/>
43695             </imageobject>
43696           </mediaobject>
43697         </screenshot>
43698       </section>
43699     </section>
43700
43701     <section id="impenhanced">
43702       <title>Enhanced Content Configuration</title>
43703
43704       <para>Koha allows you to pull in content from outside sources to enhance
43705       your bib records. All of this content can be toggled on and off using
43706       the enhanced content system preferences.</para>
43707
43708       <itemizedlist>
43709         <listitem>
43710           <para><link linkend="frbrenhancedprefs">FRBR/Editions</link></para>
43711
43712           <itemizedlist>
43713             <listitem>
43714               <para>If you would like to have your OPAC and/or staff client
43715               show an 'Editions' tab on the bib record, you want to enable one
43716               or the other FRBR preferences and then either one or both of the
43717               ISBN services (XISBN and ThingISBN).</para>
43718             </listitem>
43719           </itemizedlist>
43720         </listitem>
43721
43722         <listitem>
43723           <para><link linkend="amazonprefs">Amazon</link> : This service is
43724           free and just requires that you visit <ulink url="http://aws.amazon.com">http://aws.amazon.com</ulink> to sign
43725           up</para>
43726
43727           <itemizedlist>
43728             <listitem>
43729               <para>Using the Amazon preferences you can choose to show cover
43730               images from Amazon.</para>
43731             </listitem>
43732           </itemizedlist>
43733         </listitem>
43734
43735         <listitem>
43736           <para><link linkend="Babelthequeprefs">Babelthèque</link></para>
43737
43738           <itemizedlist>
43739             <listitem>
43740               <para>This is a pay service. Contact Babelthèque to learn how to
43741               enable this content in the OPAC.</para>
43742             </listitem>
43743           </itemizedlist>
43744         </listitem>
43745
43746         <listitem>
43747           <para><link linkend="btcontentprefs">Baker and Taylor</link></para>
43748
43749           <itemizedlist>
43750             <listitem>
43751               <para>This is a pay service from Baker &amp; Taylor. Contact
43752               Baker &amp; Taylor for the information to enter into these
43753               preferences.</para>
43754             </listitem>
43755           </itemizedlist>
43756         </listitem>
43757
43758         <listitem>
43759           <para><link linkend="html5">HTML5 Media</link><itemizedlist>
43760               <listitem>
43761                 <para>This allows libraries to embed streaming media in their catalog</para>
43762               </listitem>
43763             </itemizedlist></para>
43764         </listitem>
43765         <listitem>
43766           <para><link linkend="googleprefs">Google</link></para>
43767           <itemizedlist>
43768             <listitem>
43769               <para>This service is free and does not require registration, simply enable
43770                 GoogleJackets and you're set to go.</para>
43771             </listitem>
43772           </itemizedlist>
43773         </listitem>
43774
43775         <listitem>
43776           <para><link linkend="IDreamLibraries">I Deam Books</link><itemizedlist>
43777               <listitem>
43778                 <para>This is a free service that compiles reviews for popular titles from many
43779                   different sources.</para>
43780               </listitem>
43781             </itemizedlist></para>
43782         </listitem>
43783         <listitem>
43784           <para><link linkend="librarythingprefs">LibraryThing</link></para>
43785           <itemizedlist>
43786             <listitem>
43787               <para>With the exception of ThingISBN, you will need to contact LibraryThing for the
43788                 information to enter into these preferences</para>
43789             </listitem>
43790             <listitem>
43791               <para>Enabling ThingISBN will help to populate the editions tab on the bib record
43792                 display if you have enabled FRBR.</para>
43793             </listitem>
43794           </itemizedlist>
43795         </listitem>
43796
43797         <listitem>
43798           <para><link linkend="novelistselect">Novelist</link></para>
43799
43800           <itemizedlist>
43801             <listitem>
43802               <para>This is a pay service from Ebsco. Contact Ebsco for the
43803               information to enter into these preferences</para>
43804             </listitem>
43805           </itemizedlist>
43806         </listitem>
43807
43808         <listitem>
43809           <para><link linkend="oclcprefs">OCLC</link></para>
43810           <itemizedlist>
43811             <listitem>
43812               <para>XISBN is used to populate the editions tab on the bib record display if you have
43813                 enabled FRBR. This service is free for up to 999 queries a day.</para>
43814             </listitem>
43815           </itemizedlist>
43816         </listitem>
43817         <listitem>
43818           <para><link linkend="OpenLibraryPrefs">Open Library</link><itemizedlist>
43819               <listitem>
43820                 <para>Open Library project is an open system that you can pull cover images (and in
43821                   the future additional content) from</para>
43822               </listitem>
43823             </itemizedlist></para>
43824         </listitem>
43825
43826         <listitem>
43827           <para><link linkend="overdriveprefs">Overdrive</link><itemizedlist>
43828               <listitem>
43829                 <para>This is a pay service that libraries can subscribe to for ebook content.  If
43830                   the library subscribes to Overdrive they can integrate that content in to Koha for
43831                   free.</para>
43832               </listitem>
43833             </itemizedlist></para>
43834         </listitem>
43835         <listitem>
43836           <para><link linkend="Syndeticsprefs">Syndetics</link></para>
43837           <itemizedlist>
43838             <listitem>
43839               <para>This is a pay service from Syndetics to add content for your bib records.
43840                 Contact Syndetics for the information to enter into these preferences.</para>
43841             </listitem>
43842           </itemizedlist>
43843         </listitem>
43844
43845         <listitem>
43846           <para><link linkend="taggingprefs">Tagging</link></para>
43847
43848           <itemizedlist>
43849             <listitem>
43850               <para>Choose whether or not you want to allow patrons to add
43851               tags to records in Koha.</para>
43852             </listitem>
43853           </itemizedlist>
43854         </listitem>
43855       </itemizedlist>
43856     </section>
43857
43858     <section id="impacq">
43859       <title>Acquisitions Configuration</title>
43860
43861       <para>When using acquisitions in Koha you first need to define some
43862       defaults.</para>
43863
43864       <itemizedlist>
43865         <listitem>
43866           <para>Set up your <link linkend="budgetplanning">funds &amp;
43867           budgets</link></para>
43868         </listitem>
43869
43870         <listitem>
43871           <para>Choose your <link linkend="currexchangeadmin">default
43872           currency</link> and enter others if you order from multiple
43873           countries</para>
43874         </listitem>
43875
43876         <listitem>
43877           <para>Enter in your <link linkend="acqvendors">vendor
43878           information</link></para>
43879         </listitem>
43880
43881         <listitem>
43882           <para>Create an <link linkend="marcbibframeworks">Framework with the
43883           code ACQ</link> (if you're going to enter item records at the time
43884           of ordering or receiving)</para>
43885         </listitem>
43886
43887         <listitem>
43888           <para>Acquisitions System preferences</para>
43889
43890           <itemizedlist>
43891             <listitem>
43892               <para><link linkend="AcqCreateItem">AcqCreateItem</link> :
43893               Decide if an item record is created during acquisition</para>
43894             </listitem>
43895
43896             <listitem>
43897               <para><link linkend="CurrencyFormat">CurrencyFormat</link> :
43898               Decide how you want monetary amounts to display</para>
43899             </listitem>
43900
43901             <listitem>
43902               <para><link linkend="gist">gist</link> : Enter your sales tax
43903               (if you are billed for tax)</para>
43904             </listitem>
43905
43906             <listitem>
43907               <para><link linkend="OrderPdfFormat">OrderPdfFormat</link> :
43908               Decide what format you want your print orders to use</para>
43909             </listitem>
43910           </itemizedlist>
43911         </listitem>
43912       </itemizedlist>
43913     </section>
43914
43915     <section id="impserials">
43916       <title>Serials Configuration</title>
43917
43918       <para>When you use serials there are a few options you can set before
43919       hand.</para>
43920
43921       <itemizedlist>
43922         <listitem>
43923           <para>Serials System Preferences</para>
43924
43925           <itemizedlist>
43926             <listitem>
43927               <para><link linkend="RenewSerialAddsSuggestion">RenewSerialAddsSuggestion</link>
43928               : Decide if you want renewing serials to add a suggestion for
43929               easy purchasing</para>
43930             </listitem>
43931
43932             <listitem>
43933               <para><link linkend="RoutingSerials">RoutingSerials</link> :
43934               Decide if you want to route serials around your library</para>
43935             </listitem>
43936
43937             <listitem>
43938               <para><link linkend="RoutingListAddReserves">RoutingListAddReserves</link> :
43939               Decide if holds are placed on serials when there is a routing
43940               list in place</para>
43941             </listitem>
43942           </itemizedlist>
43943         </listitem>
43944
43945         <listitem>
43946           <para>Cataloging System Preferences</para>
43947
43948           <itemizedlist>
43949             <listitem>
43950               <para><link linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
43951               : Decide how many of the most recent issues to display in the
43952               staff client</para>
43953             </listitem>
43954
43955             <listitem>
43956               <para><link linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
43957               : Decide how many of the most recent issues to display in the
43958               OPAC</para>
43959             </listitem>
43960
43961             <listitem>
43962               <para><link linkend="SubscriptionHistory">SubscriptionHistory</link> :
43963               Decide how you want the subscription information to display in
43964               the OPAC</para>
43965             </listitem>
43966           </itemizedlist>
43967         </listitem>
43968       </itemizedlist>
43969     </section>
43970
43971     <section id="impgolive">
43972       <title>Planning for Go-Live</title>
43973
43974       <para>Once you have all of your settings ready, you need to prepare for
43975       making your system live:</para>
43976
43977       <itemizedlist>
43978         <listitem>
43979           <para>Decide if you need training by an outside service or if your
43980           staff can do the training themselves.</para>
43981         </listitem>
43982
43983         <listitem>
43984           <para>Make sure that there is time for your staff to play with your
43985           test system and get comfortable with it</para>
43986         </listitem>
43987
43988         <listitem>
43989           <para>If this is a migration, work with your previous company to
43990           extract data right before you go live</para>
43991         </listitem>
43992
43993         <listitem>
43994           <para>Come up with URLs for your new Koha OPAC &amp; Staff
43995           Client</para>
43996         </listitem>
43997
43998         <listitem>
43999           <para>Make sure that if you're hosting your own system you have a
44000           backup plan</para>
44001         </listitem>
44002       </itemizedlist>
44003     </section>
44004   </chapter>
44005
44006   <chapter id="sopac">
44007     <title>SOPAC2 Installation</title>
44008
44009     <section id="sopacintro">
44010       <sectioninfo>
44011         <authorgroup>
44012           <author>
44013             <firstname>Jean-André</firstname>
44014             <surname>Santoni</surname>
44015             <affiliation>
44016               <orgname>BibLibre</orgname>
44017             </affiliation>
44018           </author>
44019
44020           <editor>
44021             <firstname>Nicole C.</firstname>
44022             <surname>Engard</surname>
44023             <contrib>Translation and minor edits.</contrib>
44024           </editor>
44025         </authorgroup>
44026
44027         <pubdate>August 2009</pubdate>
44028       </sectioninfo>
44029       <title>Introduction</title>
44030
44031       <para>This is an installation guide for SOPAC2 and its Koha connector. It
44032       has been tested on Debian Lenny and Ubuntu Jaunty with Drupal 6.12 and Koha
44033       3.0.x. It does not cover the installation of Koha and Drupal, only
44034       SOPAC, its dependencies and the connector.</para>
44035     </section>
44036
44037     <section id="sopacinstall">
44038       <title>Installation of Locum and Insurge</title>
44039
44040       <para>Locum and Insurge are the two libraries used primarily by SOPAC.
44041       They serve as a layer of abstraction to the data. Insurge manages the
44042       social aspect (tags, reviews, ratings), while Locum manages the
44043       connection to the ILS via the connector. Both libraries use a different
44044       database from that of Drupal.</para>
44045
44046       <section id="sopacdepend">
44047         <title>Dependencies</title>
44048
44049         <para>There are no packages for Debian MDB2 yet, you can install it
44050         via pear:</para>
44051
44052         <programlisting># apt-get install php-pear
44053 # pear install MDB2
44054 # pear install MDB2#mysql</programlisting>
44055       </section>
44056
44057       <section id="sopacdownload">
44058         <title>Download</title>
44059
44060         <para>Download the Locum and Insurge libraries from SVN:</para>
44061
44062         <programlisting># cd /usr/local/lib
44063 # svn co http://dobby.darienlibrary.org/svn/locum/trunk/ locum
44064 # svn co http://dobby.darienlibrary.org/svn/insurge/trunk/ insurge</programlisting>
44065       </section>
44066
44067       <section id="sopaccreatedb">
44068         <title>Creation of the Database</title>
44069
44070         <programlisting>$ mysql -u root
44071 mysql&gt; create database scas;
44072 mysql&gt; grant all privileges on scas.* to scas_user@'localhost' identified by 'scas_pass';
44073 mysql&gt; flush privileges;
44074 mysql&gt; exit</programlisting>
44075       </section>
44076
44077       <section id="sopacdsn">
44078         <title>Sync DSN</title>
44079
44080         <para>This file will provide the connection information to a DB
44081         libraries:</para>
44082
44083         <programlisting># nano /usr/local/etc/locum_insurge_dsn.php</programlisting>
44084
44085         <para>It should contain:</para>
44086
44087         <programlisting>&lt;?php
44088 $dsn = 'mysql://scas_user:scas_pass@localhost/scas';</programlisting>
44089       </section>
44090
44091       <section id="sopacinstallinsurge">
44092         <title>Installation of Insurge</title>
44093
44094         <para>If you customize the name of the database, remember to edit the
44095         sql file:</para>
44096
44097         <programlisting># nano /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
44098
44099         <para>Import Insurge:</para>
44100
44101         <programlisting>$ mysql -u root -p &lt; /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
44102
44103         <para>Configure Insurge:</para>
44104
44105         <programlisting># nano /usr/local/lib/insurge/config/insurge.ini</programlisting>
44106
44107         <para>The variables in insurge.ini are empty. The default values are
44108         too long and cause MySQL errors.</para>
44109
44110         <para>Here is a sample of insurge.ini</para>
44111
44112         <programlisting>; This is the Locum configuration file
44113 ; General configuration options for your installation of Insurge.
44114 [insurge_config]
44115 dsn_file = "/usr/local/etc/locum_insurge_dsn.php"
44116 ; This is where you configure your repository membership information.
44117 ;
44118 ; parent_server is the server name of the repository parent server you have been
44119 ; told to use.
44120 ; group_id = The group ID you have been given by your repository admin.
44121 ; These configuration points are OPTIONAL and are only necessary if you are
44122 ; participating in a repository relationship.
44123 [repository_info]
44124 parent_server = ""
44125 group_id = ""
44126 group_key = ""</programlisting>
44127       </section>
44128
44129       <section id="sopacinstallocum">
44130         <title>Installation of Locum</title>
44131
44132         <para>The same procedure applies to Locum</para>
44133
44134         <programlisting># nano /usr/local/lib/locum/sql/scas_locum.sql
44135 # mysql &lt; /usr/local/lib/locum/sql/scas_locum.sql
44136 # nano /usr/local/lib/locum/sql/locum_init.sql
44137 # mysql &lt; /usr/local/lib/locum/sql/locum_init.sql
44138 # nano /usr/local/lib/locum/config/locum.ini
44139 # mkdir /usr/local/var
44140 # mkdir /usr/local/var/log</programlisting>
44141
44142         <para>Configure the DSN:</para>
44143
44144         <programlisting>[locum_config]
44145 dsn_file = "/usr/local/etc/locum_insurge_dsn.php"</programlisting>
44146
44147         <para>And the information for your Koha installation:</para>
44148
44149         <programlisting>[ils_config]
44150 ils = "koha";
44151 ils_version = "30x"
44152 ils_server = "localhost"
44153 ils_harvest_port = "80"</programlisting>
44154
44155         <para>The rest depends on your Koha configuration.</para>
44156       </section>
44157     </section>
44158
44159     <section id="sopackoha">
44160       <title>Installation of Koha Connector</title>
44161
44162       <para>Download the Koha connector using SVN:</para>
44163
44164       <programlisting># cd /usr/local/lib/locum/connectors/
44165 # svn co http://dobby.darienlibrary.org/svn/connectors/koha/ locum_koha_30x</programlisting>
44166     </section>
44167
44168     <section id="sopacharvest">
44169       <title>Harvest Records</title>
44170
44171       <para>Now that the connector is in place, we will be able to launch
44172       harvest.php, a tool that will reap Locum DB Koha and fill the
44173       locum.</para>
44174
44175       <para>Start by configuring harvest.php:</para>
44176
44177       <programlisting># nano /usr/local/lib/locum/tools/harvest.php</programlisting>
44178
44179       <para>Here are the variables you must change:</para>
44180
44181       <programlisting>$first_record = 1;
44182 $last_record = 30;</programlisting>
44183
44184       <para>These are the minimum and maximum biblionumbers from your Koha
44185       install.</para>
44186
44187       <para>Then start the harvest:</para>
44188
44189       <programlisting># chmod +x /usr/local/lib/locum/tools/harvest.php
44190 $ /usr/local/lib/locum/tools/harvest.php</programlisting>
44191     </section>
44192
44193     <section id="sopacphinx">
44194       <title>Installation of Sphinx</title>
44195
44196       <para>Sphinx is the indexer for the database used by Locum and
44197       Insurge.</para>
44198
44199       <section id="sphinxdepend">
44200         <title>Dependencies</title>
44201
44202         <para>There is no Debian package for Sphinx so you'll have to compile
44203         the source directly:</para>
44204
44205         <programlisting># apt-get install g++ make libmysql++-dev</programlisting>
44206       </section>
44207
44208       <section id="sphinxdownload">
44209         <title>Download and Compile</title>
44210
44211         <programlisting>$ wget http://sphinxsearch.com/downloads/sphinx-0.9.8.tar.gz
44212 $ tar zxvf sphinx-0.9.8.tar.gz
44213 $ cd sphinx-0.9.8
44214 $ ./configure --prefix=/usr/local/sphinx
44215 $ make
44216 # make install
44217 # mkdir /usr/local/sphinx
44218 # mkdir /usr/local/sphinx/lib
44219 # cp api/sphinxapi.php /usr/local/sphinx/lib/
44220 $ rm -R sphinx-0.9.8*</programlisting>
44221       </section>
44222
44223       <section id="sphinxuser">
44224         <title>Creation of User and Group</title>
44225
44226         <para>Creating a Sphinx user and change the owner:</para>
44227
44228         <programlisting># adduser sphinx
44229 # addgroup sphinx
44230 # usermod -G sphinx sphinx
44231 # mkdir /usr/local/sphinx/var/run
44232 # chown -R sphinx.sphinx /usr/local/sphinx/var</programlisting>
44233       </section>
44234
44235       <section id="demonsphinx">
44236         <title>The Sphinx daemon</title>
44237
44238         <para>Download:</para>
44239
44240         <programlisting># cd /etc/init.d
44241 # wget http://www.thesocialopac.net/sites/thesocialopac.net/files/sphinx
44242 # chmod +x /etc/init.d/sphinx</programlisting>
44243
44244         <para>Add Sphinx to the default boot services:</para>
44245
44246         <programlisting># update-rc.d sphinx defaults</programlisting>
44247       </section>
44248
44249       <section id="sphinxconfig">
44250         <title>Configuration</title>
44251
44252         <para>Copy the configuration file supplied with the source of Sphinx
44253         before the change:</para>
44254
44255         <programlisting># cp /usr/local/lib/locum/sphinx/sphinx.conf /usr/local/sphinx/etc/
44256 # sed 's/locum_db_user/scas_user/g' /usr/local/sphinx/etc/sphinx.conf &gt; tmpfile;
44257 mv tmpfile /usr/local/sphinx/etc/sphinx.conf
44258 # sed 's/locum_db_pass/scas_pass/g' /usr/local/sphinx/etc/sphinx.conf &gt; tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
44259
44260         <para>And if you personalize the name of the database:</para>
44261
44262         <programlisting># sed 's/scas/MY_DB/g' /usr/local/sphinx/etc/sphinx.conf &gt; tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
44263       </section>
44264
44265       <section id="sphinxindexing">
44266         <title>Indexing documents</title>
44267
44268         <para>Indexing is necessary if you want to use the search features of
44269         SOPAC.</para>
44270
44271         <para>You must first complete the Insurge table index</para>
44272
44273         <programlisting># chmod +x /usr/local/lib/insurge/tools/update-index.php
44274 $ /usr/local/lib/insurge/tools/update-index.php</programlisting>
44275
44276         <para>Then start indexing Sphinx</para>
44277
44278         <programlisting>$ /usr/local/sphinx/bin/indexer --all</programlisting>
44279
44280         <para>Finally, we must start the daemon:</para>
44281
44282         <programlisting># /etc/init.d/sphinx start</programlisting>
44283
44284         <para>When the daemon is running, you can update the index with:</para>
44285
44286         <programlisting>$ /usr/local/sphinx/bin/indexer --all --rotate</programlisting>
44287       </section>
44288     </section>
44289
44290     <section id="installsopac">
44291       <title>Installation of SOPAC2</title>
44292
44293       <para>Now to the SOPAC software itself:</para>
44294
44295       <section id="downloadsopac">
44296         <title>Download</title>
44297
44298         <para>Download from SVN:</para>
44299
44300         <programlisting>$ cd /chemin/vers/drupal/sites/all/
44301 $ mkdir modules
44302 $ cd modules/
44303 $ svn co http://dobby.darienlibrary.org/svn/sopac/trunk/ sopac</programlisting>
44304       </section>
44305
44306       <section id="sopacinstallation">
44307         <title>Installation</title>
44308
44309         <para>In Drupal's administration settings, activate the module.
44310         Also, enable the dependencies:</para>
44311
44312         <itemizedlist>
44313           <listitem>
44314             <para>Profile</para>
44315           </listitem>
44316
44317           <listitem>
44318             <para>PHP Filter</para>
44319           </listitem>
44320
44321           <listitem>
44322             <para>Path</para>
44323           </listitem>
44324         </itemizedlist>
44325
44326         <para>The Drupal menu should now list these entries.</para>
44327       </section>
44328
44329       <section id="configsopac">
44330         <title>Configuration</title>
44331
44332         <para>Then go into the settings of SOPAC.</para>
44333
44334         <itemizedlist>
44335           <listitem>
44336             <para>Configure the paths to the Locum and Insurge
44337             libraries</para>
44338           </listitem>
44339
44340           <listitem>
44341             <para>Choose a URL prefix SOPAC, in my "catalog". Create a node
44342             with content like:</para>
44343           </listitem>
44344         </itemizedlist>
44345
44346         <programlisting>&lt;?php
44347 print sopac_search_form('both');
44348 print theme('pages_catalog');</programlisting>
44349
44350         <itemizedlist>
44351           <listitem>
44352             <para>Check the Input Format "PHP Code"</para>
44353           </listitem>
44354
44355           <listitem>
44356             <para>Check Move to front page</para>
44357           </listitem>
44358
44359           <listitem>
44360             <para>In URL path settings, set the SOPAC URL prefix you have
44361             chosen.</para>
44362           </listitem>
44363         </itemizedlist>
44364
44365         <para>Go to the root of Drupal, a search form will appear.</para>
44366
44367         <para>Remember to empty Drupal's cache when something does not
44368         work.</para>
44369
44370         <para>Drupal offers a few blocks, which are not configured by default.
44371         You must specify on which page they should appear.</para>
44372       </section>
44373     </section>
44374   </chapter>
44375
44376   <chapter id="cronjobsch">
44377     <title>Cron Jobs</title>
44378
44379     <para>A cron job is a Linux command for scheduling a command or script on your server to
44380       complete repetitive tasks automatically. Scripts executed as a cron job are typically used to
44381       modify files or databases; however, they can perform other tasks that do not modify data on
44382       the server, like sending out email notifications. Koha has many cron jobs in place that you
44383       can enable (search engine indexing, overdue notice generation, data cleanup and more), this
44384       chapter will explain those for you.</para>
44385
44386     <section id="cronjobs">
44387       <title>Cron Jobs</title>
44388
44389       <para>The locations below assume a dev install which puts the crons in
44390       misc/, if you have a standard install you may want to look in bin/ for
44391       these files if you cannot find them in misc/</para>
44392
44393       <section id="searchcron">
44394         <title>Search</title>
44395
44396         <para/>
44397
44398         <section id="rebuildsearchcron">
44399           <title>Rebuild Index</title>
44400
44401           <para>Script path: misc/migration_tools/rebuild_zebra.pl</para>
44402
44403           <para>Does: Updates Zebra indexes with recently changed data.</para>
44404
44405           <para>Required by: Zebra</para>
44406
44407           <para>Frequency suggestion: every x minutes, (between 5-15 minutes)
44408           depending on performance needs</para>
44409         </section>
44410       </section>
44411
44412       <section id="circcron">
44413         <title>Circulation</title>
44414
44415         <section id="buildholdscron">
44416           <title>Holds Queue</title>
44417
44418           <para>Script path: misc/cronjobs/holds/build_holds_queue.pl</para>
44419
44420           <para>Does: Updates holds queue report</para>
44421
44422           <para>Required by: <link linkend="holdsqueue">Holds Queue
44423           Report</link></para>
44424
44425           <para>Frequency suggestion: every 1-4 hours</para>
44426
44427           <para>Description:</para>
44428
44429           <itemizedlist>
44430             <listitem>
44431               <para>A script that should be run periodically if your library
44432               system allows borrowers to place on-shelf holds. This script
44433               decides which library should be responsible for fulfilling a
44434               given hold request.</para>
44435
44436               <para>It's behavior is controlled by the system preferences
44437               <link linkend="holdqueueweight">StaticHoldsQueueWeight</link>
44438               and <link linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
44439
44440               <para>If you do not want all of your libraries to participate in
44441               the on-shelf holds fulfillment process, you should list the the
44442               libraries that *do* participate in the process here by inputting
44443               all the participating library's branchcodes, separated by commas
44444               ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
44445
44446               <para>By default, the holds queue will be generated such that
44447               the system will first attempt to hold fulfillment using items
44448               already at the pickup library if possible. If there are no items
44449               available at the pickup library to fill a hold,
44450               build_holds_queue.pl will then use the list of libraries defined
44451               in StaticHoldsQueueWeight. If RandomizeHoldsQueueWeight is
44452               disabled ( which it is by default ), the script will assign
44453               fulfillment requests in the order the branches are placed in the
44454               StaticHoldsQueueWeight system preference.</para>
44455
44456               <para>For example, if your system has three libraries, of
44457               varying sizes ( small, medium and large ) and you want the
44458               burden of holds fulfillment to be on larger libraries before
44459               smaller libraries, you would want StaticHoldsQueueWeight to look
44460               something like "LRG,MED,SML".</para>
44461
44462               <para>If you want the burden of holds fulfillment to be spread
44463               out equally throughout your library system, simply enable
44464               RandomizeHoldsQueueWeight. When this system preference is
44465               enabled, the order in which libraries will be requested to
44466               fulfill an on-shelf hold will be randomized each time the list
44467               is regenerated.</para>
44468
44469               <para>Leaving StaticHoldsQueueWeight empty is contraindicated at
44470               this time. Doing so will cause the build_holds_queue script to
44471               ignore RandomizeHoldsQueueWeight, causing the script to request
44472               hold fulfillment not randomly, but by alphabetical order.</para>
44473             </listitem>
44474           </itemizedlist>
44475
44476           <section id="buildholdscronperl">
44477             <title>Perl Documentation</title>
44478
44479             <para><emphasis role="bold">GetBibsWithPendingHoldRequests</emphasis></para>
44480
44481             <para>my $biblionumber_aref =
44482             GetBibsWithPendingHoldRequests();</para>
44483
44484             <para>Return an arrayref of the biblionumbers of all bibs that
44485             have one or more unfilled hold requests.</para>
44486
44487             <para><emphasis role="bold">GetPendingHoldRequestsForBib</emphasis></para>
44488
44489             <para>my $requests =
44490             GetPendingHoldRequestsForBib($biblionumber);</para>
44491
44492             <para>Returns an arrayref of hashrefs to pending, unfilled hold
44493             requests on</para>
44494
44495             <para>the bib identified by $biblionumber. The following keys are
44496             present in each hashref:</para>
44497
44498             <itemizedlist>
44499               <listitem>
44500                 <para>biblionumber</para>
44501               </listitem>
44502
44503               <listitem>
44504                 <para>borrowernumber</para>
44505               </listitem>
44506
44507               <listitem>
44508                 <para>itemnumber</para>
44509               </listitem>
44510
44511               <listitem>
44512                 <para>priority</para>
44513               </listitem>
44514
44515               <listitem>
44516                 <para>branchcode</para>
44517               </listitem>
44518
44519               <listitem>
44520                 <para>reservedate</para>
44521               </listitem>
44522
44523               <listitem>
44524                 <para>reservenotes</para>
44525               </listitem>
44526
44527               <listitem>
44528                 <para>borrowerbranch</para>
44529               </listitem>
44530             </itemizedlist>
44531
44532             <para>The arrayref is sorted in order of increasing
44533             priority.</para>
44534
44535             <para><emphasis role="bold">GetItemsAvailableToFillHoldRequestsForBib</emphasis></para>
44536
44537             <para>my $available_items =</para>
44538
44539             <para>GetItemsAvailableToFillHoldRequestsForBib($biblionumber);</para>
44540
44541             <para>Returns an arrayref of items available to fill hold requests
44542             for the bib identified by $biblionumber. An item is available to
44543             fill a hold</para>
44544
44545             <para>request if and only if:</para>
44546
44547             <itemizedlist>
44548               <listitem>
44549                 <para>it is not on loan</para>
44550               </listitem>
44551
44552               <listitem>
44553                 <para>it is not withdrawn</para>
44554               </listitem>
44555
44556               <listitem>
44557                 <para>it is not marked notforloan</para>
44558               </listitem>
44559
44560               <listitem>
44561                 <para>it is not currently in transit</para>
44562               </listitem>
44563
44564               <listitem>
44565                 <para>it is not lost</para>
44566               </listitem>
44567
44568               <listitem>
44569                 <para>it is not sitting on the hold shelf</para>
44570               </listitem>
44571             </itemizedlist>
44572
44573             <para><emphasis role="bold">MapItemsToHoldRequests</emphasis></para>
44574
44575             <para>MapItemsToHoldRequests($hold_requests,
44576             $available_items);</para>
44577
44578             <para><emphasis role="bold">CreatePickListFromItemMap</emphasis></para>
44579
44580             <para><emphasis role="bold">AddToHoldTargetMap</emphasis></para>
44581
44582             <para><emphasis role="bold">_get_branches_to_pull_from</emphasis></para>
44583
44584             <para>Query system preferences to get ordered list of branches to
44585             use to fill hold requests.</para>
44586           </section>
44587         </section>
44588
44589         <section id="expiredholdscron">
44590           <title>Expired Holds</title>
44591
44592           <para>Script path:
44593           misc/cronjobs/holds/cancel_expired_holds.pl</para>
44594
44595           <para>Does: By default, this cron job will only automatically cancel
44596           holds where the user has set an expiration date. If the library is
44597           using the <link linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>
44598           and <link linkend="ExpireReservesMaxPickUpDelayCharge">ExpireReservesMaxPickUpDelayCharge</link>
44599           preferences then this script will also cancel holds that have been
44600           sitting on the hold shelf for too long and will (if the library
44601           does) charge the patron for not picking up the hold.</para>
44602
44603           <para>Frequency suggestion: daily</para>
44604         </section>
44605
44606         <section id="unsuspendholdcron">
44607           <title>Unsuspend Holds</title>
44608
44609           <para>Script path:
44610           misc/cronjobs/holds/auto_unsuspend_holds.pl</para>
44611
44612           <para>Does: This script checks to find holds that should no longer
44613           be suspended and removes the suspension if the <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
44614           preference is set to 'allow'. This puts the patron back in to the
44615           queue where they were when the hold was suspended.</para>
44616
44617           <para>Frequency suggestion: daily</para>
44618         </section>
44619
44620         <section id="finescronjob">
44621           <title>Fines</title>
44622
44623           <para>Script path: misc/cronjobs/fines.pl</para>
44624           <para>Does: Calculates and posts fines to patron accounts.</para>
44625
44626           <para>Required by: <link linkend="finesMode">finesMode</link> system
44627           preference</para>
44628
44629           <para>Frequency suggestion: nightly</para>
44630         </section>
44631
44632         <section id="longoverduecron">
44633           <title>Long Overdues</title>
44634
44635           <para>Script path: misc/cronjobs/longoverdue.pl</para>
44636
44637           <para>Does: allows one to specify delays for changing items to
44638           different lost statuses, and optionally charge for them using the
44639           replacement price listed on the item record.</para>
44640
44641           <para>Frequency suggestion: nightly<note>
44642               <para>Staff can control some of the parameters for the longoverdue cron job with the
44643                   <link linkend="DefaultLongOverdueLostValue">DefaultLongOverdueLostValue</link> and
44644                   <link linkend="DefaultLongOverdueChargeValue">DefaultLongOverdueChargeValue</link>
44645                 preferences.</para>
44646             </note></para>
44647
44648           <section id="longoverduecronperl">
44649             <title>Perl Documentation</title>
44650
44651             <para><emphasis role="bold">NAME</emphasis></para>
44652
44653             <para>longoverdue.pl cron script to set lost statuses on overdue
44654             materials. Execute without options for help.</para>
44655             <para><emphasis role="bold">DESCRIPTION</emphasis></para>
44656             <para> --lost | -l </para>
44657             <para>This option takes the form of n=lv, where n is num days overdue, and lv is the
44658               lost value. See warning below.</para>
44659             <para> --charge | -c </para>
44660             <para>This specifies what lost value triggers Koha to charge the account for the lost
44661               item. Replacement costs are not charged if this is not specified. </para>
44662             <para>--verbose | v </para>
44663             <para>verbose. </para>
44664             <para>--confirm </para>
44665             <para>confirm. without this option, the script will report the number of affected items
44666               and return without modifying any records. </para>
44667             <para>--quiet </para>
44668             <para>suppress summary output. </para>
44669             <para>--maxdays </para>
44670             <para>Specifies the end of the range of overdue days to deal with (defaults to 366).
44671               This value is universal to all lost num days overdue passed. </para>
44672             <para>--mark-returned </para>
44673             <para>When an item is marked lost, remove it from the borrowers issued items.</para>
44674           </section>
44675         </section>
44676
44677         <section id="updateissuescron">
44678           <title>Track total checkouts</title>
44679
44680           <para>Script path: misc/cronjobs/update_totalissues.pl</para>
44681
44682           <para>Does: updates the biblioitems.totalissues field in the
44683           database with the latest tally of checkouts.</para>
44684
44685           <para>Frequency suggestion: nightly</para>
44686           <section id="updateissuesperldoc">
44687             <title>Perl Documentation</title>
44688             <para><emphasis role="bold">NAME</emphasis>
44689             </para>
44690             <para>update_totalissues.pl </para>
44691             <para><emphasis role="bold">SYNOPSIS</emphasis>
44692             </para>
44693             <para>update_totalissues.pl --use-stats </para>
44694             <para>update_totalissues.pl --use-items </para>
44695             <para>update_totalissues.pl --commit=1000 </para>
44696             <para>update_totalissues.pl --since='2012-01-01' </para>
44697             <para>update_totalissues.pl --interval=30d </para>
44698             <para><emphasis role="bold">DESCRIPTION</emphasis>
44699             </para>
44700             <para>This batch job populates bibliographic records' total issues count based on
44701               historical issue statistics. </para>
44702             <para>--help Prints this help </para>
44703             <para>-v|--verbose </para>
44704             <para>Provide verbose log information (list every bib modified). </para>
44705             <para>--use-stats </para>
44706             <para>Use the data in the statistics table for populating total issues. </para>
44707             <para>--use-items </para>
44708             <para>Use items.issues data for populating total issues. Note that issues data from the
44709               items table does not respect the --since or --interval options, by definition. Also
44710               note that if both --use-stats and --use-items are specified, the count of biblios
44711               processed will be misleading. </para>
44712             <para>-s|--since=DATE </para>
44713             <para>Only process issues recorded in the statistics table since DATE. </para>
44714             <para>-i|--interval=S </para>
44715             <para>Only process issues recorded in the statistics table in the last N units of time.
44716               The interval should consist of a number with a one- letter unit suffix. The valid
44717               suffixes are h (hours), d (days), w (weeks), m (months), and y (years). The default
44718               unit is days. </para>
44719             <para>--incremental </para>
44720             <para>Add the number of issues found in the statistics table to the existing total
44721               issues count. Intended so that this script can be used as a cron job to update
44722               popularity information during low-usage periods. If neither --since or --interval are
44723               specified, incremental mode will default to processing the last twenty-four hours. </para>
44724             <para>--commit=N </para>
44725             <para>Commit the results to the database after every N records are processed. </para>
44726             <para>--test </para>
44727             <para>Only test the popularity population script. </para>
44728             <para><emphasis role="bold">WARNING</emphasis>
44729             </para>
44730             <para>If the time on your database server does not match the time on your Koha server
44731               you will need to take that into account, and probably use the --since argument instead
44732               of the --interval argument for incremental updating. </para>
44733             <para><emphasis role="bold">CREDITS</emphasis>
44734             </para>
44735             <para>This patch to Koha was sponsored by the Arcadia Public Library and the Arcadia
44736               Public Library Foundation in honor of Jackie Faust-Moreno, late director of the
44737               Arcadia Public Library. </para>
44738             <para><emphasis role="bold">AUTHOR</emphasis>
44739             </para>
44740             <para>Jared Camins-Esakov &lt;jcamins AT cpbibliography DOT com></para>
44741           </section>
44742         </section>
44743         <section id="offlinecirccron">
44744           <title>Generate Patron File for Offline Circulation</title>
44745           <para>Script path: misc/cronjobs/create_koc_db.pl</para>
44746           <para>Does: Generates the borrowers.db file for use with the <link
44747               linkend="windowsofflinecirc">Koha Offline Circulation</link> tool</para>
44748           <para>Frequency suggestion: weekly</para>
44749         </section>
44750         <section id="autorenewcron">
44751           <title>Automatic renewal</title>
44752           <para>Script path: misc/cronjobs/automatic_renewals.pl</para>
44753           <para>Does: Will automatically renew items if you're allowing automatic renewal with your
44754               <link linkend="circfinerules">circulation and fine rules</link>.</para>
44755           <para>Frequency suggestion: nightly</para>
44756           <section id="autorenewcronperl">
44757             <title>Perl Documentation</title>
44758             <para><emphasis role="bold">NAME</emphasis>
44759             </para>
44760             <para>automatic_renewals.pl - cron script to renew loans </para>
44761             <para><emphasis role="bold">SYNOPSIS</emphasis>
44762             </para>
44763             <para>./automatic_renewals.pl </para>
44764             <para>or, in crontab: 0 3 * * * automatic_renewals.pl </para>
44765             <para><emphasis role="bold">DESCRIPTION</emphasis>
44766             </para>
44767             <para>This script searches for issues scheduled for automatic renewal
44768               (issues.auto_renew). If there are still renews left (Renewals allowed) and the renewal
44769               isn't premature (No Renewal before) the issue is renewed. </para>
44770             <para><emphasis role="bold">OPTIONS</emphasis>
44771             </para>
44772             <para>No options.</para>
44773           </section>
44774         </section>
44775       </section>
44776       <section id="patroncrons">
44777         <title>Patrons</title>
44778         <para/>
44779         <section id="deleteexpiredregistrationcron">
44780           <title>Unverified Registrations</title>
44781           <para>Script path: misc/cronjobs/delete_expired_opac_registrations.pl</para>
44782           <para>Does: Deletes patron registrations that were submitted via the OPAC but not reviewed
44783             by the library within the number of days entered in the <link linkend="PatronSelfRegistrationExpireTemporaryAccountsDelay">PatronSelfRegistrationExpireTemporaryAccountsDelay</link> preference.</para>
44784           <para>Frequency suggestion: nightly</para>
44785         </section>
44786         <section id="deleteunverifiedcron">
44787           <title>Unconfirmed Registrations</title>
44788           <para>Script path: misc/cronjobs/delete_unverified_opac_registrations.pl </para>
44789           <para>Does: Deletes patron self registrations that were submitted via the OPAC but not
44790             confirmed via email within 24 hours. This is only necessary if you are requiring patrons
44791             to confirm their registrations via email with the <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link> preference.</para>
44792           <para>Frequency suggestion: hourly</para>
44793         </section>
44794         <section id="anonymizecron">
44795           <title>Anonymize Patron Data</title>
44796           <para>Script path: misc/cronjobs/batch_anonymise.pl</para>
44797           <para>Does: Used to anonymize patron data.  This will remove borrowernumbers from
44798             circulation history so that the stats are kept, but the patron information is removed
44799             for privacy reasons.</para>
44800         </section>
44801         <section id="j2acron">
44802           <title>Update Child to Adult Patron Type</title>
44803           <para>Script path: misc/cronjobs/j2a.pl</para>
44804           <para>Does: Convert juvenile/child patrons from juvenile patron category and category code
44805             to corresponding adult patron category and category code when they reach the upper age
44806             limit defined in the Patron Categories. </para>
44807           <para>Frequency suggestion: nightly</para>
44808           <section id="j2aperldoc">
44809             <title>Perl Documentation</title>
44810             <para><emphasis role="bold">NAME</emphasis>
44811             </para>
44812             <para>juv2adult.pl - convert juvenile/child patrons from juvenile patron category and
44813               category code to corresponding adult patron category and category code when they reach
44814               the upper age limit defined in the Patron Categories. </para>
44815             <para><emphasis role="bold">SYNOPSIS</emphasis>
44816             </para>
44817             <para>juv2adult.pl [ -b=&lt;branchcode> -f=&lt;categorycode> -t=&lt;categorycode> ] </para>
44818             <para>Options: </para>
44819             <para>--help brief help message </para>
44820             <para>--man full documentation </para>
44821             <para>-v verbose mode </para>
44822             <para>-n take no action, display only </para>
44823             <para>-b &lt;branchname> only deal with patrons from this library/branch </para>
44824             <para>-f &lt;categorycode> change patron category from this category </para>
44825             <para>-t &lt;categorycode> change patron category to this category </para>
44826             <para>=head1 OPTIONS </para>
44827             <para>--help Print a brief help message and exits. </para>
44828             <para>--man Prints the manual page and exits. </para>
44829             <para>-v Verbose. Without this flag set, only fatal errors are reported. </para>
44830             <para>-n No Action. With this flag set, script will report changes but not actually
44831               execute them on the database. </para>
44832             <para>-b changes patrons for one specific branch. Use the value in the
44833               branches.branchcode table.</para>
44834             <para> -f *required* defines the juvenile category to update. Expects the code from
44835               categories.categorycode. </para>
44836             <para>-t *required* defines the category juvenile patrons will be converted to. Expects
44837               the code from categories.categorycode. </para>
44838             <para><emphasis role="bold">DESCRIPTION</emphasis>
44839             </para>
44840             <para>This script is designed to update patrons from juvenile to adult patron types,
44841               remove the guarantor, and update their category codes appropriately when they reach
44842               the upper age limit defined in the Patron Categories. </para>
44843             <para><emphasis role="bold">USAGE EXAMPLES</emphasis>
44844             </para>
44845             <para>"juv2adult.pl" - Suggests that you read this help. :) </para>
44846             <para>"juv2adult.pl" -b=&lt;branchcode> -f=&lt;categorycode> -t=&lt;categorycode> -
44847               Processes a single branch, and updates the patron categories from fromcat to tocat. </para>
44848             <para>"juv2adult.pl" -f=&lt;categorycode> -t=&lt;categorycode> -v -n - Processes all
44849               branches, shows all messages, and reports the patrons who would be affected. Takes no
44850               action on the database.</para>
44851           </section>
44852         </section>
44853       </section>
44854
44855       <section id="noticescron">
44856         <title>Notices</title>
44857
44858         <para/>
44859
44860         <section id="msgqueuecron">
44861           <title>Message Queue</title>
44862
44863           <para>Script path: misc/cronjobs/process_message_queue.pl</para>
44864
44865           <para>Does: processes the message queue to send the check out, check in and hold filled
44866             emails and SMS message to users and sends outgoing emails to patrons. requires <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link> to be
44867             on</para>
44868
44869           <para>Frequency suggestion: 1-4 hours<important>
44870               <para>Item due and Advanced due notices are controlled by the <link linkend="advnoticecron">advance_notices cron</link>.</para>
44871             </important></para>
44872         </section>
44873
44874         <section id="advnoticecron">
44875           <title>Advanced Notice</title>
44876
44877           <para>Script path: misc/cronjobs/advance_notices.pl</para>
44878
44879           <para>Does: prepares "pre-due" notices and "item due" notices for
44880           patrons who request them prepares notices for patrons for items just
44881           due or coming due soon. requires <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
44882           to be on</para>
44883
44884           <para>Frequency suggestion: nightly</para>
44885
44886           <note>
44887             <para>This script does not actually send the notices. It queues
44888             them in the <link linkend="msgqueuecron">message queue</link> for
44889             later</para>
44890           </note>
44891
44892           <section id="advnoticecronperl">
44893             <title>Perl Documentation</title>
44894
44895             <para><emphasis role="bold">NAME</emphasis></para>
44896
44897             <para>advance_notices.pl - cron script to put item due reminders
44898             into message queue</para>
44899
44900             <para><emphasis role="bold">SYNOPSIS</emphasis></para>
44901
44902             <para>./advance_notices.pl -c</para>
44903
44904             <para>or, in crontab: 0 1 * * * advance_notices.pl -c</para>
44905
44906             <para><emphasis role="bold">DESCRIPTION</emphasis></para>
44907
44908             <para>This script prepares pre-due and item due reminders to be
44909             sent to patrons. It queues them in the message queue, which is
44910             processed by the process_message_queue.pl cronjob. The type and
44911             timing of the messages can be configured by the patrons in their
44912             "My Alerts" tab in the OPAC.</para>
44913
44914             <para><emphasis role="bold">METHODS</emphasis></para>
44915
44916             <para>parse_letter</para>
44917           </section>
44918         </section>
44919
44920         <section id="overduenoticecron">
44921           <title>Overdue Notice</title>
44922
44923           <para>Script path: misc/cronjobs/overdue_notices.pl</para>
44924
44925           <para>Does: prepares messages to alert patrons of overdue messages
44926           (both via email and print)</para>
44927
44928           <para>Frequency suggestion: nightly</para>
44929
44930           <note>
44931             <para>This script does not actually send the notices. It queues
44932             them in the <link linkend="msgqueuecron">message queue</link> for
44933             later or generates the HTML for later printing</para>
44934           </note>
44935
44936           <section id="overduenoticecronperl">
44937             <title>Perl Documentation</title>
44938
44939             <para><emphasis role="bold">NAME</emphasis></para>
44940
44941             <para>overdue_notices.pl - prepare messages to be sent to patrons
44942             for overdue items</para>
44943
44944             <para><emphasis role="bold">SYNOPSIS</emphasis></para>
44945
44946             <para>overdue_notices.pl [ -n ] [ -library &lt;branchcode&gt; ] [
44947             -library &lt;branchcode&gt;...] [ -max &lt;number of days&gt; ] [
44948             -csv [ &lt;filename&gt; ] ] [-itemscontent &lt;field list&gt;
44949             ]</para>
44950
44951             <para>Options:</para>
44952
44953             <para>-help brief help message</para>
44954
44955             <para>-man full documentation</para>
44956
44957             <para>-n No email will be sent</para>
44958
44959             <para>-max &lt;days&gt; maximum days overdue to deal with</para>
44960
44961             <para>-library &lt;branchname&gt; only deal with overdues from
44962             this library (repeatable : several libraries can be given)</para>
44963
44964             <para>-csv &lt;filename&gt; populate CSV file</para>
44965
44966             <para>-html &lt;filename&gt; Output html to file</para>
44967
44968             <para>-itemscontent &lt;list of fields&gt; item information in
44969             templates</para>
44970
44971             <para>-borcat &lt;categorycode&gt; category code that must be
44972             included</para>
44973
44974             <para>-borcatout &lt;categorycode&gt; category code that must be
44975             excluded</para>
44976
44977             <para><emphasis role="bold">OPTIONS</emphasis></para>
44978
44979             <para>-help Print a brief help message and exits.</para>
44980
44981             <para>-man Prints the manual page and exits.</para>
44982
44983             <para>-v Verbose. Without this flag set, only fatal errors are
44984             reported.</para>
44985
44986             <para>-n Do not send any email. Overdue notices that would have
44987             been sent to the patrons or to the admin are printed to standard
44988             out. CSV data (if the -csv flag is set) is written to standard out
44989             or to any csv filename given.</para>
44990
44991             <para>-max Items older than max days are assumed to be handled
44992             somewhere else, probably the longoverdues.pl script. They are
44993             therefore ignored by this program. No notices are sent for them,
44994             and they are not added to any CSV files. Defaults to 90 to match
44995             longoverdues.pl.</para>
44996
44997             <para>-library</para>
44998
44999             <para>select overdues for one specific library. Use the value in
45000             the branches.branchcode table. This option can be repeated in
45001             order to select overdues for a group of libraries.</para>
45002
45003             <para>-csv Produces CSV data. if -n (no mail) flag is set, then
45004             this CSV data is sent to standard out or to a filename if
45005             provided. Otherwise, only overdues that could not be emailed are
45006             sent in CSV format to the admin.</para>
45007
45008             <para>-itemscontent</para>
45009
45010             <para>comma separated list of fields that get substituted into
45011             templates in places of the &lt;&lt;items.content&gt;&gt;
45012             placeholder. This defaults to
45013             issuedate,title,barcode,author</para>
45014
45015             <para>Other possible values come from fields in the biblios,
45016             items, and issues tables.</para>
45017
45018             <para>-borcat Repetable field, that permit to select only few of
45019             patrons categories.</para>
45020
45021             <para>-borcatout</para>
45022
45023             <para>Repetable field, permis to exclude some patrons
45024             categories.</para>
45025
45026             <para>-t | --triggered</para>
45027
45028             <para>This option causes a notice to be generated if and only if
45029             an item is overdue by the number of days defined in a notice
45030             trigger.</para>
45031
45032             <para>By default, a notice is sent each time the script runs,
45033             which is suitable for less frequent run cron script, but requires
45034             syncing notice triggers with the cron schedule to ensure proper
45035             behavior. Add the --triggered option for daily cron, at the risk
45036             of no notice being generated if the cron fails to run on
45037             time.</para>
45038
45039             <para>-list-all</para>
45040
45041             <para>Default items.content lists only those items that fall in
45042             the range of the currently processing notice. Choose list-all to
45043             include all overdue items in the list (limited by -max
45044             setting).</para>
45045
45046             <para><emphasis role="bold">DESCRIPTION</emphasis></para>
45047
45048             <para>This script is designed to alert patrons and administrators
45049             of overdue items.</para>
45050
45051             <para>Configuration</para>
45052
45053             <para>This script pays attention to the overdue notice
45054             configuration performed in the "Overdue notice/status triggers"
45055             section of the "Tools" area of the staff interface to Koha. There,
45056             you can choose which letter templates are sent out after a
45057             configurable number of days to patrons of each library. More
45058             information about the use of this section of Koha is available in
45059             the Koha manual.</para>
45060
45061             <para>The templates used to craft the emails are defined in the
45062             "Tools: Notices" section of the staff interface to Koha.</para>
45063
45064             <para>Outgoing emails</para>
45065
45066             <para>Typically, messages are prepared for each patron with
45067             overdue items. Messages for whom there is no email address on file
45068             are collected and sent as attachments in a single email to each
45069             library administrator, or if that is not set, then to the email
45070             address in the "KohaAdminEmailAddress" system preference.</para>
45071
45072             <para>These emails are staged in the outgoing message queue, as
45073             are messages produced by other features of Koha. This message
45074             queue must be processed regularly by the
45075             misc/cronjobs/process_message_queue.pl program.</para>
45076
45077             <para>In the event that the "-n" flag is passed to this program,
45078             no emails are sent. Instead, messages are sent on standard output
45079             from this program. They may be redirected to a file if
45080             desired.</para>
45081
45082             <para>Templates</para>
45083
45084             <para>Templates can contain variables enclosed in double angle
45085             brackets like &lt;&lt;this&gt;&gt;. Those variables will be
45086             replaced with values specific to the overdue items or relevant
45087             patron. Available variables are:</para>
45088
45089             <para>&lt;&lt;bib&gt;&gt;</para>
45090
45091             <para>the name of the library</para>
45092
45093             <para>&lt;&lt;items.content&gt;&gt;</para>
45094
45095             <para>one line for each item, each line containing a tab separated
45096             list of title, author, barcode, issuedate</para>
45097
45098             <para>&lt;&lt;borrowers.*&gt;&gt;</para>
45099
45100             <para>any field from the borrowers table</para>
45101
45102             <para>&lt;&lt;branches.*&gt;&gt;</para>
45103
45104             <para>any field from the branches table</para>
45105
45106             <para>CSV output</para>
45107
45108             <para>The "-csv" command line option lets you specify a file to
45109             which overdues data should be output in CSV format.</para>
45110
45111             <para>With the "-n" flag set, data about all overdues is written
45112             to the file. Without that flag, only information about overdues
45113             that were unable to be sent directly to the patrons will be
45114             written. In other words, this CSV file replaces the data that is
45115             typically sent to the administrator email address.</para>
45116
45117             <para><emphasis role="bold">USAGE EXAMPLES</emphasis></para>
45118
45119             <para>"overdue_notices.pl" - In this most basic usage, with no
45120             command line arguments, all libraries are processed individually,
45121             and notices are prepared for all patrons with overdue items for
45122             whom we have email addresses. Messages for those patrons for whom
45123             we have no email address are sent in a single attachment to the
45124             library administrator's email address, or to the address in the
45125             KohaAdminEmailAddress system preference.</para>
45126
45127             <para>"overdue_notices.pl -n -csv /tmp/overdues.csv" - sends no
45128             email and populates /tmp/overdues.csv with information about all
45129             overdue items.</para>
45130
45131             <para>"overdue_notices.pl -library MAIN max 14" - prepare notices
45132             of overdues in the last 2 weeks for the MAIN library.</para>
45133
45134             <para><emphasis role="bold">SEE ALSO</emphasis></para>
45135
45136             <para>The misc/cronjobs/advance_notices.pl program allows you to
45137             send messages to patrons in advance of their items becoming due,
45138             or to alert them of items that have just become due.</para>
45139
45140             <para><emphasis role="bold">INTERNAL METHODS</emphasis></para>
45141
45142             <para>These methods are internal to the operation of
45143             overdue_notices.pl.</para>
45144
45145             <para>parse_letter</para>
45146
45147             <para>parses the letter template, replacing the placeholders with
45148             data specific to this patron, biblio, or item</para>
45149
45150             <para>named parameters:</para>
45151
45152             <para>letter - required hashref</para>
45153
45154             <para>borrowernumber - required integer</para>
45155
45156             <para>substitute - optional hashref of other key/value pairs that
45157             should be substituted in the letter content</para>
45158
45159             <para>returns the "letter" hashref, with the content updated to
45160             reflect the substituted keys and values.</para>
45161
45162             <para>prepare_letter_for_printing</para>
45163
45164             <para>returns a string of text appropriate for printing in the
45165             event that an overdue notice will not be sent to the patron's
45166             email address. Depending on the desired output format, this may be
45167             a CSV string, or a human-readable representation of the
45168             notice.</para>
45169
45170             <para>required parameters:</para>
45171
45172             <para>letter</para>
45173
45174             <para>borrowernumber</para>
45175
45176             <para>optional parameters:</para>
45177
45178             <para>outputformat</para>
45179           </section>
45180         </section>
45181
45182         <section id="printholdcron">
45183           <title>Print Hold Notices</title>
45184
45185           <para>Script path: misc/cronjobs/gather_print_notices.pl</para>
45186
45187           <para>Does: looks through the message queue for hold notices that
45188           didn't go through because the patron didn't have an email address
45189           and generates a print notice</para>
45190
45191           <para>Frequency suggestion: nightly</para>
45192         </section>
45193
45194         <section id="talkingtechcrons">
45195           <title>Talking Tech</title>
45196
45197           <para>To learn more about setting up this third party product view
45198           the <link linkend="talkingtechappendix">Talking Tech
45199           Appendix</link>.</para>
45200
45201           <section id="talkingtechsendcron">
45202             <title>Sending Notices File</title>
45203
45204             <para>Script path:
45205             misc/cronjobs/thirdparty/TalkingTech_itiva_outbound.pl</para>
45206
45207             <para>Does: Script to generate Spec C outbound notifications file
45208             for Talking Tech i-tiva phone notification system.</para>
45209
45210             <para>Required by: <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
45211
45212             <para>Frequency suggestion: nightly</para>
45213
45214             <section id="talkingsendcronperl">
45215               <title>Perl Documentation</title>
45216
45217               <para><emphasis role="bold">USAGE</emphasis></para>
45218
45219               <para>TalkingTech_itiva_outbound.pl</para>
45220
45221               <para>TalkingTech_itiva_outbound.pl --type=OVERDUE -w 0 -w 2 -w
45222               6 --output=/tmp/talkingtech/outbound.csv</para>
45223
45224               <para>TalkingTech_itiva_outbound.pl --type=RESERVE
45225               --type=PREOVERDUE --lang=FR</para>
45226
45227               <para>Script to generate Spec C outbound notifications file for
45228               Talking Tech i-tiva phone notification system.</para>
45229
45230               <para>--help -h</para>
45231
45232               <para>Prints this help</para>
45233
45234               <para>-v Provide verbose log information.</para>
45235
45236               <para>--output -o</para>
45237
45238               <para>Destination for outbound notifications file (CSV format).
45239               If no value is specified, output is dumped to screen.</para>
45240
45241               <para>--lang</para>
45242
45243               <para>Sets the language for all outbound messages. Currently
45244               supported values are EN, FR and ES. If no value is specified, EN
45245               will be used by default.</para>
45246
45247               <para>--type</para>
45248
45249               <para>REQUIRED. Sets which messaging types are to be used. Can
45250               be given multiple times, to specify multiple types in a single
45251               output file. Currently supported values are RESERVE, PREOVERDUE
45252               and OVERDUE. If no value is given, this script will not produce
45253               any outbound notifications.</para>
45254
45255               <para>--waiting-hold-day -w</para>
45256
45257               <para>OPTIONAL for --type=RESERVE. Sets the days after a hold
45258               has been set to waiting on which to call. Use switch as many
45259               times as desired. For example, passing "-w 0 -w 2 -w 6" will
45260               cause calls to be placed on the day the hold was set to waiting,
45261               2 days after the waiting date, and 6 days after. See example
45262               above. If this switch is not used with --type=RESERVE, calls
45263               will be placed every day until the waiting reserve is picked up
45264               or canceled.</para>
45265
45266               <para>--library-code --code -c</para>
45267
45268               <para>OPTIONAL The code of the source library of the message.
45269               The library code is used to group notices together for
45270               consortium purposes and apply library specific settings, such as
45271               prompts, to those notices. This field can be blank if all
45272               messages are from a single library.</para>
45273             </section>
45274           </section>
45275
45276           <section id="talkingtechreceivecron">
45277             <title>Receiving Notices File</title>
45278
45279             <para>Script path:
45280             misc/cronjobs/thirdparty/TalkingTech_itiva_inbound.pl</para>
45281
45282             <para>Does: Script to process received Results files for Talking
45283             Tech i-tiva phone notification system.</para>
45284
45285             <para>Required by: <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
45286
45287             <para>Frequency suggestion: nightly</para>
45288
45289             <section id="talkingreceivecronperl">
45290               <title>Perl Documentation</title>
45291
45292               <para><emphasis role="bold">USAGE</emphasis></para>
45293
45294               <para>TalkingTech_itiva_inbound.pl</para>
45295
45296               <para>TalkingTech_itiva_inbound.pl -v
45297               --input=/tmp/talkingtech/results.csv</para>
45298
45299               <para>Script to process received Results files for Talking Tech
45300               i-tiva phone notification system.</para>
45301
45302               <para>--help -h</para>
45303
45304               <para>Prints this help</para>
45305
45306               <para>-v Provide verbose log information.</para>
45307
45308               <para>--input -i</para>
45309
45310               <para>REQUIRED. Path to incoming results file.</para>
45311             </section>
45312           </section>
45313         </section>
45314       </section>
45315
45316       <section id="proccartcron">
45317         <title>In Processing/Book Cart</title>
45318
45319         <para>Script path: misc/cronjobs/cart_to_shelf.pl</para>
45320
45321         <para>Does: Updates all items with a location of CART to the item's
45322         permanent location.</para>
45323
45324         <para>Required by: <link linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link>,
45325         <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>,
45326         &amp; <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
45327         system preferences</para>
45328
45329         <para>Frequency suggestion: hourly</para>
45330
45331         <section id="proccartcronperl">
45332           <title>Perl Documentation</title>
45333
45334           <para><emphasis role="bold">NAME</emphasis></para>
45335
45336           <para>cart_to_shelf.pl cron script to set items with location of
45337           CART to original shelving location after X hours. Execute without
45338           options for help.</para>
45339         </section>
45340       </section>
45341
45342       <section id="catalogcron">
45343         <title>Catalog</title>
45344
45345         <para/>
45346
45347         <section id="checkurlcron">
45348           <title>Check URLs</title>
45349
45350           <para>Script path: misc/cronjobs/check-url.pl</para>
45351
45352           <para>Does: checks URLs in 856$u field. Script output can now be
45353           formatted in CSV or HTML. The HTML version links directly to MARC
45354           biblio record editor.</para>
45355
45356           <para>Frequency suggestion: monthly</para>
45357
45358           <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>
45359
45360           <section id="checkurlcronperl">
45361             <title>Perl Documentation</title>
45362
45363             <para><emphasis role="bold">NAME</emphasis></para>
45364
45365             <para>C4::URL::Checker - base object for checking URL stored in
45366             Koha DB</para>
45367
45368             <para><emphasis role="bold">SYNOPSIS</emphasis></para>
45369
45370             <programlisting>use C4::URL::Checker;
45371
45372         my $checker = C4::URL::Checker-&gt;new( );
45373         $checker-&gt;{ host_default } = 'http://mylib.kohalibrary.com';
45374         my $checked_urls = $checker-&gt;check_biblio( 123 );
45375         foreach my $url ( @$checked_urls ) {
45376             print "url:        ", $url-&gt;{ url       A }, "\n",
45377                   "is_success: ", $url-&gt;{ is_success }, "\n",
45378                   "status:     ", $url-&gt;{ status     }, "\n";
45379         } </programlisting>
45380
45381             <para><emphasis role="bold">FUNCTIONS</emphasis></para>
45382
45383             <para>new</para>
45384
45385             <para>Create a URL Checker. The returned object can be used to set
45386             default host variable :</para>
45387
45388             <programlisting>my $checker = C4::URL::Checker-&gt;new( );
45389         $checker-&gt;{ host_default } = 'http://mylib.kohalibrary.com'; </programlisting>
45390
45391             <para>check_biblio</para>
45392
45393             <para>Check all URL from a biblio record. Returns a pointer to an
45394             array containing all URLs with checking for each of them.</para>
45395
45396             <programlisting> my $checked_urls = $checker-&gt;check_biblio( 123 ); </programlisting>
45397
45398             <para>With 2 URLs, the returned array will look like that:</para>
45399
45400             <programlisting>     [
45401            {
45402              'url' =&gt; 'http://mylib.tamil.fr/img/62265_0055B.JPG',
45403              'is_success' =&gt; 1,
45404              'status' =&gt; 'ok'
45405            },
45406            {
45407              'url' =&gt; 'http://mylib.tamil.fr//img/62265_0055C.JPG',
45408              'is_success' =&gt; 0,
45409              'status' =&gt; '404 - Page not found'
45410            }
45411          ], </programlisting>
45412
45413             <para><emphasis role="bold">NAME</emphasis></para>
45414
45415             <para>check-url.pl - Check URLs from 856$u field.</para>
45416
45417             <para><emphasis role="bold">USAGE</emphasis></para>
45418
45419             <para>check-url.pl [--verbose|--help]
45420             [--host=http://default.tld]</para>
45421
45422             <para>Scan all URLs found in 856$u of bib records and display if
45423             resources are available or not.</para>
45424
45425             <para><emphasis role="bold">PARAMETERS</emphasis></para>
45426
45427             <para>--host=http://default.tld</para>
45428
45429             <para>Server host used when URL doesn't have one, ie doesn't begin
45430             with 'http:'. For example, if --host=http://www.mylib.com, then
45431             when 856$u contains 'img/image.jpg', the url checked is:
45432             http://www.mylib.com/image.jpg'.</para>
45433
45434             <para>--verbose|-v</para>
45435
45436             <para>Outputs both successful and failed URLs.</para>
45437
45438             <para>--html</para>
45439
45440             <para>Formats output in HTML. The result can be redirected to a
45441             file accessible by http. This way, it's possible to link directly
45442             to biblio record in edit mode. With this parameter --host-pro is
45443             required.</para>
45444
45445             <para>--host-pro=http://koha-pro.tld</para>
45446
45447             <para>Server host used to link to biblio record editing
45448             page.</para>
45449
45450             <para>--help|-h</para>
45451
45452             <para>Print this help page.</para>
45453           </section>
45454         </section>
45455
45456         <section id="mergeauthcron">
45457           <title>Update Authorities</title>
45458
45459           <para>Script path: misc/migration_tools/merge_authority.pl</para>
45460
45461           <para>Does: Updates biblio data with changes to authorities records<note>
45462               <para>The name of this script is misleading.  This script does not merge authorities
45463                 together it instead merges authority data with linked bib records. Edits to
45464                 authority records will be applied to bibliographic records that use that authority
45465                 when this script is run.</para>
45466             </note></para>
45467
45468           <para>Required by: <link linkend="dontmerge">dontmerge</link> system
45469           preference</para>
45470
45471           <para>Frequency suggestion: nightly</para>
45472         </section>
45473
45474         <section id="serialscron">
45475           <title>Serials Update</title>
45476
45477           <para>Script path: misc/cronjobs/serialsUpdate.pl</para>
45478
45479           <para>Does: checks if there is a "late" issue on active
45480           subscriptions, and if there is, the script will set it as late, and
45481           add the next one as expected.</para>
45482
45483           <para>Frequency suggestion: nightly</para>
45484         </section>
45485       </section>
45486
45487       <section id="opaccrons">
45488         <title>OPAC</title>
45489
45490         <para/>
45491
45492         <section id="customrssfeedcron">
45493           <title>RSS Feeds</title>
45494
45495           <para>Script path: misc/cronjobs/rss/rss.pl</para>
45496
45497           <para>Does: Produces an RSS XML document for any SQL query (not used
45498           for search results RSS feed). <link linkend="customrss">Learn
45499           more</link>.</para>
45500
45501           <para>Frequency suggestion: hourly</para>
45502         </section>
45503
45504         <section id="authbrowsercron">
45505           <title>Authorities Browser</title>
45506
45507           <para>Script path: misc/cronjobs/build_browser_and_cloud.pl</para>
45508
45509           <para>Does: Generate content for authorities browse in OPAC</para>
45510
45511           <para>Required by: <link linkend="OpacBrowser">OpacBrowser</link> system preference<important>
45512               <para>This preference and cron job should only be used on French systems.</para>
45513             </important></para>
45514         </section>
45515
45516         <section id="keywordclouds">
45517           <title>Subject/Author Clouds</title>
45518
45519           <para>Script path: misc/cronjobs/cloud-kw.pl</para>
45520
45521           <para>Does: Generates HTML keywords clouds from Koha Zebra indexes.
45522           misc/cronjobs/cloud-sample.conf has a sample of how this script
45523           operates.</para>
45524
45525           <para>Frequency: This is the type of script you can run once a month
45526           or so, the content generated isn't going to change very much over
45527           time.</para>
45528
45529           <section id="keywordcloudsperl">
45530             <title>Perl Documentation</title>
45531
45532             <para><emphasis role="bold">NAME</emphasis></para>
45533
45534             <para>cloud-kw.pl - Creates HTML keywords clouds from Koha Zebra
45535             Indexes</para>
45536
45537             <para><emphasis role="bold">USAGE</emphasis></para>
45538
45539             <para>cloud-kw.pl [--verbose|--help] --conf=cloud.conf</para>
45540
45541             <para>Creates multiple HTML files containing keywords cloud with
45542             top terms sorted by their logarithmic weight. cloud.conf is a YAML
45543             configuration file driving cloud generation process.</para>
45544
45545             <para><emphasis role="bold">PARAMETERS</emphasis></para>
45546
45547             <para>--conf=configuration file</para>
45548
45549             <para>Specify configuration file name</para>
45550
45551             <para>--verbose|-v</para>
45552
45553             <para>Enable script verbose mode.</para>
45554
45555             <para>--help|-h</para>
45556
45557             <para>Print this help page.</para>
45558
45559             <para><emphasis role="bold">CONFIGURATION</emphasis></para>
45560
45561             <para>Configuration file looks like that:</para>
45562
45563             <para><programlisting>  ---
45564          # Koha configuration file for a specific installation
45565          # If not present, defaults to KOHA_CONF
45566          KohaConf: /home/koha/mylibray/etc/koha-conf.xml
45567          # Zebra index to scan
45568          ZebraIndex: Author
45569          # Koha index used to link found kewords with an opac search URL
45570          KohaIndex: au
45571          # Number of top keyword to use for the cloud
45572          Count: 50
45573          # Include CSS style directives with the cloud
45574          # This could be used as a model and then CSS directives are
45575          # put in the appropriate CSS file directly.
45576          Withcss: Yes
45577          # HTML file where to output the cloud
45578          Output: /home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html
45579         ---
45580          KohaConf: /home/koha/yourlibray/etc/koha-conf.xml
45581          ZebraIndex: Subject
45582          KohaIndex: su
45583          Count: 200
45584          Withcss: no
45585          Output: /home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html</programlisting><emphasis role="bold">IMPROVEMENTS</emphasis></para>
45586
45587             <para>Generated top terms have more informations than those
45588             outputted from the time being. Some parameters could be easily
45589             added to improve this script:</para>
45590
45591             <para>WithCount</para>
45592
45593             <para>In order to output terms with the number of occurrences they
45594             have been found in Koha Catalogue by Zebra.</para>
45595
45596             <para>CloudLevels</para>
45597
45598             <para>Number of levels in the cloud. Now 24 levels are
45599             hardcoded.</para>
45600
45601             <para>Weighting</para>
45602
45603             <para>Weighting method used to distribute terms in the cloud. We
45604             could have two values: Logarithmic and Linear. Now it's
45605             Logarithmic by default.</para>
45606
45607             <para>Order</para>
45608
45609             <para>Now terms are outputted in the lexical order. They could be
45610             sorted by their weight.</para>
45611           </section>
45612         </section>
45613       </section>
45614
45615       <section id="systemcron">
45616         <title>System Administration</title>
45617
45618         <para/>
45619
45620         <section id="cleandbcron">
45621           <title>Clean up Database</title>
45622
45623           <para>Script path: misc/cronjobs/cleanup_database.pl</para>
45624
45625           <para>Does: Truncates the sessions table, cleans out old zebraqueue entries, action logs
45626             and staged MARC files.</para>
45627           <section>
45628             <title>Perl Documentation</title>
45629             <para><emphasis role="bold">USAGE</emphasis></para>
45630             <para>kohaclone/misc/cronjobs/cleanup_database.pl [-h|--help] [--sessions] [--sessdays
45631               DAYS] [-v|--verbose] [--zebraqueue DAYS] [-m|--mail] [--merged] [--import DAYS]
45632               [--logs DAYS] [--searchhistory DAYS]</para>
45633             <para><emphasis role="bold">PARAMETERS</emphasis></para>
45634             <para>-h --help </para>
45635             <para>prints this help message, and exits, ignoring all other options</para>
45636             <para>--sessions </para>
45637             <para>purge the sessions table. If you use this while users are logged into Koha, they
45638               will have to reconnect.</para>
45639             <para>--sessdays DAYS </para>
45640             <para>purge only sessions older than DAYS days</para>
45641             <para>-v --verbose </para>
45642             <para>will cause the script to give you a bit more information about the run.</para>
45643             <para>--zebraqueue DAYS </para>
45644             <para>purge completed zebraqueue entries older than DAYS days. Defaults to 30 days if no
45645               days specified.</para>
45646             <para>-m --mail DAYS </para>
45647             <para>purge items from the mail queue that are older than DAYS days. Defaults to 30 days
45648               if no days specified.</para>
45649             <para>--merged </para>
45650             <para>purged completed entries from need_merge_authorities.</para>
45651             <para>--import DAYS </para>
45652             <para>purge records from import tables older than DAYS days. Defaults to 60 days if no
45653               days specified</para>
45654             <para>--z3950 </para>
45655             <para>purge records from import tables that are the result of Z39.50 searches</para>
45656             <para>--logs DAYS </para>
45657             <para>purge entries from action_logs older than DAYS days. Defaults to 180 days if no
45658               days specified</para>
45659             <para>--searchhistory DAYS </para>
45660             <para>purge entries from search_history older than DAYS days. Defaults to 30 days if no
45661               days specified</para>
45662             <para>--list-invites DAYS </para>
45663             <para>purge (unaccepted) list share invites older than DAYS days. Defaults to 14 days if
45664               no days specified.</para>
45665             <para>--restrictions DAYS</para>
45666             <para>purge patrons restrictions expired since more than DAYS days. Defaults to 30 days
45667               if no days specified. </para>
45668           </section>
45669         </section>
45670         <section id="usagecron">
45671           <title>Share Usage Stats</title>
45672           <para>Script path: misc/cronjobs/share_usage_with_koha_community.pl</para>
45673           <para>Does: If you're sharing information via the <link linkend="UsageStats"
45674               >UsageStats</link> feature this will send your info to the <ulink
45675               url="http://hea.koha-community.org/">Hea website</ulink>.</para>
45676           <para>Frequency: monthly</para>
45677           <section id="usagecronperl">
45678             <title>Perl Documentation</title>
45679             <para><emphasis role="bold">NAME</emphasis>
45680             </para>
45681             <para>share_usage_with_koha_community.pl - Share your library's usage with the Koha
45682               community</para>
45683             <para><emphasis role="bold">SYNOPSIS</emphasis>
45684             </para>
45685             <para>share_usage_with_koha_community.pl [-h|--help] [-v|--verbose] </para>
45686             <para>If the <link linkend="UsageStats">UsageStats</link> system preference is set, you
45687               can launch this script to share your usage data anonymously with the Koha community. </para>
45688             <para>Collecting Koha usage statistics will help developers to know how Koha is used
45689               across the world. </para>
45690             <para>This script will send the usage data for the bibliographic and authority records,
45691               checkouts, holds, orders, and subscriptions. </para>
45692             <para>Only the total number is retrieved. In no case will private data be shared! </para>
45693             <para>In order to know which parts of Koha modules are used, this script will collect
45694               some system preference values. </para>
45695             <para>If you want to tell us who you are, you can fill the <link
45696                 linkend="UsageStatsLibraryName">UsageStatsLibraryName</link> system preference with
45697               your library name, <link linkend="UsageStatsLibraryUrl">UsageStatsLibraryUrl</link>,
45698                 <link linkend="UsageStatsLibraryType">UsageStatsLibraryType</link> and/or <link
45699                 linkend="UsageStatsCountry">UsageStatsCountry</link>. </para>
45700             <para>All these data will be analyzed on the <ulink url="http://hea.koha-community.org"
45701                 >http://hea.koha-community.org</ulink> Koha community website. </para>
45702             <para>IMPORTANT : please do NOT run the cron on the 1st, but on another day. The idea is
45703               to avoid all Koha libraries sending their data at the same time ! So choose any day
45704               between 1 and 28 !</para>
45705             <para><emphasis role="bold">OPTIONS</emphasis>
45706             </para>
45707             <para>-h|--help </para>
45708             <para>Print a brief help message </para>
45709             <para>-v|--verbose </para>
45710             <para>Verbose mode. </para>
45711             <para>-f|--force </para>
45712             <para>Force the update.</para>
45713             <para><emphasis role="bold">AUTHOR</emphasis>
45714             </para>
45715             <para>Alex Arnaud &lt;alex.arnaud@biblibre.com> </para>
45716             <para>Jonathan Druart &lt;jonathan.druart@biblibre.com></para>
45717             <para><emphasis role="bold">COPYRIGHT</emphasis>
45718             </para>
45719             <para>Copyright 2014 BibLibre</para>
45720             <para><emphasis role="bold">LICENSE</emphasis>
45721             </para>
45722             <para>This file is part of Koha. </para>
45723             <para>Koha is free software; you can redistribute it and/or modify it under the terms of
45724               the GNU General Public License as published by the Free Software Foundation; either
45725               version 3 of the License, or (at your option) any later version. </para>
45726             <para>You should have received a copy of the GNU General Public License along with Koha;
45727               if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
45728               Boston, MA 02110-1301 USA.</para>
45729           </section>
45730         </section>
45731       </section>
45732
45733       <section id="acqcrons">
45734         <title>Acquisitions</title>
45735
45736         <section id="cleansuggcron">
45737           <title>Clean up old suggestions</title>
45738
45739           <para>Script path: misc/cronjobs/purge_suggestions.pl</para>
45740
45741           <para>Does: Removes old (defined by you) suggestions from the
45742           suggestion management area.</para>
45743         </section>
45744       </section>
45745
45746       <section id="deprecatedcrons">
45747         <title>Deprecated scripts</title>
45748
45749         <para>These should not be run without modification:</para>
45750
45751         <para>Script path: misc/cronjobs/update_items.pl</para>
45752
45753         <para>Script path:misc/cronjobs/smsoverdues.pl</para>
45754
45755         <para>Script path:misc/cronjobs/notifyMailsOp.pl</para>
45756
45757         <para>Script path:misc/cronjobs/reservefix.pl</para>
45758
45759         <para>Script path:misc/cronjobs/zebraqueue_start.pl</para>
45760       </section>
45761     </section>
45762   </chapter>
45763
45764   <chapter id="webservices">
45765     <title>Web Services</title>
45766
45767     <para/>
45768
45769     <section id="OAI-PMHservice">
45770       <title>OAI-PMH</title>
45771
45772       <para/>
45773
45774       <section id="oaiconfsample">
45775         <title>Sample OAI Conf File</title>
45776
45777         <para><programlisting>       format:
45778          vs:
45779            metadataPrefix: vs
45780            metadataNamespace: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs
45781            schema: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs.xsd
45782            xsl_file: /usr/local/koha/xslt/vs.xsl
45783          marcxml:
45784            metadataPrefix: marxml
45785            metadataNamespace: http://www.loc.gov/MARC21/slim
45786 http://www.loc.gov/standards/marcxml/schema/MARC21slim
45787            schema: http://www.loc.gov/MARC21/slim
45788 http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd
45789          oai_dc:
45790            metadataPrefix: oai_dc
45791            metadataNamespace: http://www.openarchives.org/OAI/2.0/oai_dc/
45792            schema: http://www.openarchives.org/OAI/2.0/oai_dc.xsd
45793            xsl_file:
45794 /usr/local/koha/koha-tmpl/intranet-tmpl/xslt/UNIMARCslim2OAIDC.xsl</programlisting></para>
45795       </section>
45796     </section>
45797     <section id="Rest-services">
45798       <title>REST services</title>
45799
45800       <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>
45801       <para>Services provided in 1.4 version are:
45802       <programlisting>
45803            GET branches
45804            GET user/byid/:borrowernumber/holds
45805            GET user/:user_name/holds
45806            GET user/byid/:borrowernumber/issues
45807            GET user/:user_name/issues
45808            GET user/:user_name/issues_history
45809            GET user/byid/:borrowernumber/issues_history
45810            GET user/today
45811            GET user/all
45812            POST user
45813            PUT user/:user_name
45814            GET biblio/:biblionumber/items
45815            GET biblio/:biblionumber/holdable
45816            GET biblio/:biblionumber/items_holdable_status
45817            GET item/:itemnumber/holdable
45818            PUT auth/change_password
45819            GET /suggestions
45820            GET /suggestions/:suggestionid
45821            POST /suggestions
45822            PUT /suggestions/:suggestionid
45823            DELETE /suggestions/:suggestionid
45824       </programlisting>
45825       </para>
45826     </section>
45827   </chapter>
45828
45829   <chapter id="sru">
45830     <title>Using the SRU server</title>
45831
45832     <section id="usingsru">
45833       <sectioninfo>
45834         <authorgroup>
45835           <author>
45836             <firstname>Nicolas</firstname>
45837             <surname>Morin</surname>
45838             <affiliation>
45839               <orgname>BibLibre</orgname>
45840             </affiliation>
45841           </author>
45842
45843           <editor>
45844             <firstname>Nicole C.</firstname>
45845             <surname>Engard</surname>
45846             <contrib>Edits where necessary.</contrib>
45847           </editor>
45848         </authorgroup>
45849
45850         <pubdate>December 2009</pubdate>
45851       </sectioninfo>
45852       <title>Using the SRU server</title>
45853
45854       <para>Koha implements the Search/Retrieve via URL (SRU) protocol. More
45855       information about the protocol itself can be found at <ulink url="http://www.loc.gov/standards/sru/">http://www.loc.gov/standards/sru/</ulink>.
45856       The version implemented is version 1.1.</para>
45857
45858       <section id="sru_explain">
45859         <title>Explain</title>
45860
45861         <para>If you want to have information about the implementation of SRU
45862         on a given server, you should have access to the Explain file using a
45863         request to the server without any parameter. Like
45864         &lt;http://myserver.com:9999/biblios/&gt;. The response from the
45865         server is an XML file that should look like the following and will
45866         give you information about the default settings of the SRU
45867         server.</para>
45868
45869         <programlisting>
45870                &lt;zs:explainResponse&gt;
45871                     &lt;zs:version&gt;1.1&lt;/zs:version&gt;
45872                     &lt;zs:record&gt;
45873                          &lt;zs:recordSchema&gt;http://explain.z3950.org/dtd/2.0/&lt;/zs:recordSchema&gt;
45874                          &lt;zs:recordPacking&gt;xml&lt;/zs:recordPacking&gt;
45875                          &lt;zs:recordData&gt;
45876                          &lt;explain xml:base="zebradb/explain-biblios.xml"&gt;
45877                          &lt;!--
45878                          try stylesheet url: http://./?stylesheet=docpath/sru2.xsl
45879                          --&gt;
45880                     &lt;serverInfo protocol="SRW/SRU/Z39.50"&gt;
45881                          &lt;host&gt;biblibre&lt;/host&gt;
45882                          &lt;port&gt;9999&lt;/port&gt;
45883                          &lt;database&gt;biblios&lt;/database&gt;
45884                     &lt;/serverInfo&gt;
45885                     &lt;databaseInfo&gt;
45886                          &lt;title lang="en" primary="true"&gt;Koha 3 Bibliographic SRU/SRW/Z39.50 server&lt;/title&gt;
45887                          &lt;description lang="en" primary="true"&gt;Koha 3 Bibliographic Server&lt;/description&gt;
45888                          &lt;links&gt;
45889                               &lt;sru&gt;http://biblibre:9999&lt;/sru&gt;
45890                          &lt;/links&gt;
45891                     &lt;/databaseInfo&gt;
45892                     &lt;indexInfo&gt;
45893                          &lt;set name="cql" identifier="info:srw/cql-context-set/1/cql-v1.1"&gt;
45894                               &lt;title&gt;CQL Standard Set&lt;/title&gt;
45895                          &lt;/set&gt;
45896                          &lt;index search="true" scan="true" sort="false"&gt;
45897                          &lt;title lang="en"&gt;CQL Server Choice&lt;/title&gt;
45898                          &lt;map&gt;
45899                               &lt;name set="cql"&gt;serverChoice&lt;/name&gt;
45900                          &lt;/map&gt;
45901                     &lt;map&gt;
45902                        &lt;attr type="1" set="bib1"&gt;text&lt;/attr&gt;
45903                        &lt;/map&gt;
45904                   &lt;/index&gt;
45905               &lt;index search="true" scan="true" sort="false"&gt;
45906                  &lt;title lang="en"&gt;CQL All&lt;/title&gt;
45907                      &lt;map&gt;
45908         &lt;name set="cql"&gt;all&lt;/name&gt;
45909         &lt;/map&gt;
45910         &lt;map&gt;
45911         &lt;attr type="1" set="bib1"&gt;text&lt;/attr&gt;
45912         &lt;/map&gt;
45913         &lt;/index&gt;
45914         &lt;!-- Record ID index --&gt;
45915         &lt;index search="true" scan="true" sort="false"&gt;
45916         &lt;title lang="en"&gt;Record ID&lt;/title&gt;
45917         &lt;map&gt;
45918         &lt;name set="rec"&gt;id&lt;/name&gt;
45919         &lt;/map&gt;
45920         &lt;map&gt;
45921         &lt;attr type="1" set="bib1"&gt;rec:id&lt;/attr&gt;
45922         &lt;attr type="4" set="bib1"&gt;3&lt;/attr&gt;
45923         &lt;/map&gt;
45924         &lt;/index&gt;
45925           </programlisting>
45926       </section>
45927
45928       <section id="sru_search">
45929         <title>Search</title>
45930
45931         <para>This url :
45932         http://myserver.com:9999/biblios?version=1.1&amp;operation=searchRetrieve&amp;query=reefs
45933         is composed of the following elements:</para>
45934
45935         <itemizedlist>
45936           <listitem>
45937             <para>base url of the SRU server :
45938             http://myserver.com:9999/biblios?</para>
45939           </listitem>
45940
45941           <listitem>
45942             <para>search part with the 3 required parameters : version,
45943             operation and query. The parameters within the search part should
45944             be of the key=value form, and can be combined with the &amp;
45945             character.</para>
45946           </listitem>
45947         </itemizedlist>
45948
45949         <para>One can add optional parameters to the query, for instance
45950         maximumRecords indicating the maximum number of records to be returned
45951         by the server. So
45952         http://myserver.com:9999/biblios?version=1.1&amp;operation=searchRetrieve&amp;query=reefs&amp;maximumRecords=5
45953         will only get the first 5 results results from the server.</para>
45954
45955         <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>
45956         gives more details about the search operations and in particular the
45957         list of optional parameters for searching.</para>
45958
45959         <section id="sru_search_more_details">
45960           <title>More details about Search</title>
45961
45962           <para>The "operation" key can take two values: scan or
45963           searchRetrieve.</para>
45964
45965           <para>If operation=searchRetrieve, then the search key should be
45966           query. As in : operation=searchRetrieve&amp;query=reefs</para>
45967
45968           <para>If operation=scan, then the search key should be scanClause.
45969           As in : operation=scan&amp;scanClause=reefs</para>
45970
45971           <para>etc/zebradb/biblios/etc/bib1.att defines Zebra/3950 indexes
45972           that exist on your system. For instance you'll see that we have
45973           indexes for Subject and for Title: att 21 Subject and att 4 Title
45974           respectively.</para>
45975
45976           <para>In the pqf.properties file located under
45977           etc/zebradb/pqf.properties I see that an access point already uses
45978           my Subject index (index.dc.subject = 1=21) while another uses my
45979           Title index (index.dc.title = 1=4) I know this is my Subject index
45980           because as I've seen just before in my bib1.att file, it's called
45981           with =1=21 in Z3950: so index.dc.subject = 1=21 correctly points to
45982           my Subject index. And Title was called with 1=4 so index.dc.title =
45983           1=4 correctly points to my Title index. I can now construct my query
45984           just like I would in a search box, just preceding it with the
45985           "query" key: query=Subject=reefs and Title=coral searches "reefs" in
45986           the subject and "coral" in the title. The full url would be
45987           http://myserver.com:9999/biblios?version=1.1&amp;operation=searchRetrieve&amp;query=Subject=reefs
45988           and Title=coral If I want to limit the result set to just 5 records,
45989           I can do
45990           http://myserver.com:9999/biblios?version=1.1&amp;operation=searchRetrieve&amp;query=Subject=reefs
45991           and Title=coral&amp;maximumRecords=5</para>
45992
45993           <para>I can also play with truncate, relations, etc. Those are also
45994           defined in my pqf.properties file. I can see for instance the
45995           position properties defined as:</para>
45996
45997           <programlisting>
45998                position.first              = 3=1 6=1
45999               # "first in field"
46000                position.any                = 3=3 6=1
46001                  # "any position in field"
46002                </programlisting>
46003
46004           <para>So as an example if I want "coral" to be at the beginning of
46005           the title, I can do this query :
46006           http://myserver.com:9999/biblios?version=1.1&amp;operation=searchRetrieve&amp;query=Title=coral
46007           first</para>
46008         </section>
46009       </section>
46010
46011       <section id="sru_retrieve">
46012         <title>Retrieve</title>
46013
46014         <para>My search for
46015         http://univ_lyon3.biblibre.com:9999/biblios?version=1.1&amp;operation=searchRetrieve&amp;query=coral
46016         reefs&amp;maximumRecords=1 retrieves just on record. The response
46017         looks like this:</para>
46018
46019         <programlisting>
46020           &lt;zs:searchRetrieveResponse&gt;
46021 &lt;zs:version&gt;1.1&lt;/zs:version&gt;
46022 &lt;zs:numberOfRecords&gt;1&lt;/zs:numberOfRecords&gt;
46023 &lt;zs:records&gt;
46024 &lt;zs:record&gt;
46025 &lt;zs:recordPacking&gt;xml&lt;/zs:recordPacking&gt;
46026 &lt;zs:recordData&gt;
46027 &lt;record xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd"&gt;
46028 &lt;leader&gt; cam a22 4500&lt;/leader&gt;
46029 &lt;datafield tag="010" ind1=" " ind2=" "&gt;
46030 &lt;subfield code="a"&gt;2-603-01193-6&lt;/subfield&gt;
46031 &lt;subfield code="b"&gt;rel.&lt;/subfield&gt;
46032 &lt;subfield code="d"&gt;159 F&lt;/subfield&gt;
46033 &lt;/datafield&gt;
46034 &lt;datafield tag="020" ind1=" " ind2=" "&gt;
46035 &lt;subfield code="a"&gt;FR&lt;/subfield&gt;
46036 &lt;subfield code="b"&gt;00065351&lt;/subfield&gt;
46037 &lt;/datafield&gt;
46038 &lt;datafield tag="101" ind1="1" ind2=" "&gt;
46039 &lt;subfield code="c"&gt;ita&lt;/subfield&gt;
46040 &lt;/datafield&gt;
46041 &lt;datafield tag="105" ind1=" " ind2=" "&gt;
46042 &lt;subfield code="a"&gt;a z 00|y|&lt;/subfield&gt;
46043 &lt;/datafield&gt;
46044 &lt;datafield tag="106" ind1=" " ind2=" "&gt;
46045 &lt;subfield code="a"&gt;r&lt;/subfield&gt;
46046 &lt;/datafield&gt;
46047 &lt;datafield tag="100" ind1=" " ind2=" "&gt;
46048 &lt;subfield code="a"&gt;20091130 frey50 &lt;/subfield&gt;
46049 &lt;/datafield&gt;
46050 &lt;datafield tag="200" ind1="1" ind2=" "&gt;
46051 &lt;subfield code="a"&gt;Guide des récifs coralliens / A Guide to Coral Reefs&lt;/subfield&gt;
46052 &lt;subfield code="b"&gt;Texte imprimé&lt;/subfield&gt;
46053 &lt;subfield code="e"&gt;la faune sous-marine des coraux&lt;/subfield&gt;
46054 &lt;subfield code="f"&gt;A. et A. Ferrari&lt;/subfield&gt;
46055 &lt;/datafield&gt;
46056 &lt;datafield tag="210" ind1=" " ind2=" "&gt;
46057 &lt;subfield code="a"&gt;Lausanne&lt;/subfield&gt;
46058 &lt;subfield code="a"&gt;Paris&lt;/subfield&gt;
46059 &lt;subfield code="c"&gt;Delachaux et Niestlé&lt;/subfield&gt;
46060 &lt;subfield code="d"&gt;cop. 2000&lt;/subfield&gt;
46061 &lt;subfield code="e"&gt;impr. en Espagne&lt;/subfield&gt;
46062 &lt;/datafield&gt;
46063 &lt;datafield tag="215" ind1=" " ind2=" "&gt;
46064 &lt;subfield code="a"&gt;287 p.&lt;/subfield&gt;
46065 &lt;subfield code="c"&gt;ill. en coul., couv. ill. en coul.&lt;/subfield&gt;
46066 &lt;subfield code="d"&gt;20 cm&lt;/subfield&gt;
46067 &lt;/datafield&gt;
46068 ......
46069 &lt;idzebra&gt;
46070 &lt;size&gt;4725&lt;/size&gt;
46071 &lt;localnumber&gt;2&lt;/localnumber&gt;
46072 &lt;filename&gt;/tmp/nw10BJv9Pk/upd_biblio/exported_records&lt;/filename&gt;
46073 &lt;/idzebra&gt;
46074 &lt;/record&gt;
46075 &lt;/zs:recordData&gt;
46076 &lt;zs:recordPosition&gt;1&lt;/zs:recordPosition&gt;
46077 &lt;/zs:record&gt;
46078 &lt;/zs:records&gt;
46079 &lt;/zs:searchRetrieveResponse&gt;
46080
46081           </programlisting>
46082       </section>
46083     </section>
46084   </chapter>
46085   <appendix id="coverflow">
46086
46087       <appendixinfo>
46088         <authorgroup>
46089           <author>
46090             <firstname>Kyle</firstname>
46091             <surname>Hall</surname>
46092             <affiliation>
46093               <orgname>ByWater Solutions</orgname>
46094             </affiliation>
46095           </author>
46096
46097           <editor>
46098             <firstname>Nicole C.</firstname>
46099             <surname>Engard</surname>
46100           </editor>
46101         </authorgroup>
46102
46103         <pubdate>2014</pubdate>
46104       </appendixinfo>
46105     <title>New titles slider for OPAC</title>
46106     <para>Often times libraries will want to add a flowing widget with new materials at the library
46107       to their main public catalog page.  To do this you can use a widget from any number of
46108       services (usually for a cost) or you can <link linkend="pluginsystem">enable plugins</link> in
46109       Koha and use the <ulink
46110         url="http://git.bywatersolutions.com/koha-plugins.git/shortlog/refs/heads/cover_flow">Cover
46111         Flow plugin</ulink> which is based on the <ulink
46112         url="https://github.com/drien/jquery-flipster">Flipster</ulink>, a responsive jQuery
46113       coverflow plugin.</para>
46114     <para>Once the plugin is installed, the steps to get your coverflow to show up are as
46115       follows:</para>
46116     <para>First, you need to create one or more public reports for your coverflow widget or widgets
46117       to be based on. This is how the plugin knows what the content of your widget should contain.
46118       Each report needs only three columns; title, biblionumber, and isbn. It is important that you
46119       have a good and valid isbn, as that is the datum used to actually fetch the cover. In the
46120       iteration of the plugin, we are using Amazon cover images, but I believe in the end I will
46121       make the cover image fetcher configurable so we can use any data source for cover image
46122       fetching.</para>
46123     <para>Second, we need to configure the plugin. The plugin configuration is a single text area
46124       that uses YAML ( actually, it’s JSON, whcih is a subset of YAML ) to store the configuration
46125       options. In this example it looks like
46126       this:<programlisting>- id: 42
46127   selector: #coverflow
46128   options:
46129   style: coverflow</programlisting></para>
46130     <para>In this example, we are telling the plugin to use the report with id 42, and use it to
46131       create a coverflow widget to replace the HTML element with the id “coverflow”. The options
46132       list is passed directly to Flipster, so any options supported by Flipster can be set from the
46133       plugin configuration! In fact, in addition to the traditional coverflow, Flipster has a
46134       “carousel” mode which is a much more compact version of the coverflow. You can also configure
46135       which cover the widget will start on, among other options.</para>
46136     <para>At the time the plugins options are saved or updated, the plugin will then generate some
46137       minified JavaScript code that is automatically stored in the Koha system preference
46138       OpacUserJS. Here is an example of the
46139       output:<programlisting>/* JS for Koha CoverFlow Plugin
46140  This JS was added automatically by installing the CoverFlow plugin
46141  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("&lt;link id='flipster-css' href='/plugin/Koha/Plugin/Com/ByWaterSolutions/CoverFlow/jquery-flipster/src/css/jquery.flipster.min.css' type='text/css' rel='stylesheet' /&gt;");$('#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',});});});});
46142 /* End of JS for Koha CoverFlow Plugin */</programlisting></para>
46143     <para>Why do this? For speed! Rather than regenerating this code each and every time the page
46144       loads, we can generate it once, and use it over and over again.</para>
46145     <para>If you inspect the code closely, you’ll notice it references a script “coverflow.pl”. This
46146       is a script that is included with the coverflow plugin. Since we need to access this from the
46147       OPAC ( and we don’t want to set off any XSS attack alarms ), we need to modify the web server
46148       configuration for the public catalog and add the followup to
46149       it:<programlisting>ScriptAlias /coverflow.pl "/var/lib/koha/mykoha/plugins/Koha/Plugin/Com/ByWaterSolutions/CoverFlow/coverflow.pl"</programlisting></para>
46150     <para>This line gives us access to the coverflow.pl script from the OPAC. This script retrieves
46151       the report data and passes it back to the public catalog for creating the coverflow widget.
46152       Koha::Cache is supported in order to make the widget load as quickly as possible!</para>
46153     <para>The final step is to put your selector element somewhere in your public catalog. In this
46154       example, I put the following in the system preference
46155       OpacMainUserBlock:<programlisting>&lt;span id="coverflow"&gt;Loading...&lt;/span&gt;</programlisting></para>
46156     <para>Once that is in place, you need only refresh your OPAC page, and there you have it, your
46157       very own catalog coverflow widget! Not only do these coverflows look great on a computer
46158       screen, but they look great on mobile platforms as well, and are even touch responsive!<screenshot>
46159         <screeninfo>Coverflow Widget</screeninfo>
46160         <mediaobject>
46161           <imageobject>
46162             <imagedata fileref="images/appendix-coverflow/coverflow_2-300x170.gif"/>
46163           </imageobject>
46164         </mediaobject>
46165       </screenshot></para>
46166   </appendix>
46167
46168   <appendix id="sysprefdefaults">
46169     <title>System Preference Defaults</title>
46170
46171     <para/>
46172
46173     <section id="isbddefaults">
46174       <title>ISBD Defaults</title>
46175
46176       <para/>
46177
46178       <section id="isbddefault">
46179         <title>MARC Default</title>
46180
46181         <para>#100||{ 100a }{ 100b }{ 100c }{ 100d }{ 110a }{ 110b }{ 110c }{
46182         110d }{ 110e }{ 110f }{ 110g }{ 130a }{ 130d }{ 130f }{ 130g }{ 130h
46183         }{ 130k }{ 130l }{ 130m }{ 130n }{ 130o }{ 130p }{ 130r }{ 130s }{
46184         130t }|&lt;br/&gt;&lt;br/&gt;</para>
46185
46186         <para>#245||{ 245a }{ 245b }{245f }{ 245g }{ 245k }{ 245n }{ 245p }{
46187         245s }{ 245h }|</para>
46188
46189         <para>#246||{ : 246i }{ 246a }{ 246b }{ 246f }{ 246g }{ 246n }{ 246p
46190         }{ 246h }|</para>
46191
46192         <para>#242||{ = 242a }{ 242b }{ 242n }{ 242p }{ 242h }|</para>
46193
46194         <para>#245||{ 245c }|</para>
46195
46196         <para>#242||{ = 242c }|</para>
46197
46198         <para>#250| - |{ 250a }{ 250b }|</para>
46199
46200         <para>#254|, |{ 254a }|</para>
46201
46202         <para>#255|, |{ 255a }{ 255b }{ 255c }{ 255d }{ 255e }{ 255f }{ 255g
46203         }|</para>
46204
46205         <para>#256|, |{ 256a }|</para>
46206
46207         <para>#257|, |{ 257a }|</para>
46208
46209         <para>#258|, |{ 258a }{ 258b }|</para>
46210
46211         <para>#260| - |{ 260a }{ 260b }{ 260c }|</para>
46212
46213         <para>#300| - |{ 300a }{ 300b }{ 300c }{ 300d }{ 300e }{ 300f }{ 300g
46214         }|</para>
46215
46216         <para>#306| - |{ 306a }|</para>
46217
46218         <para>#307| - |{ 307a }{ 307b }|</para>
46219
46220         <para>#310| - |{ 310a }{ 310b }|</para>
46221
46222         <para>#321| - |{ 321a }{ 321b }|</para>
46223
46224         <para>#340| - |{ 3403 }{ 340a }{ 340b }{ 340c }{ 340d }{ 340e }{ 340f
46225         }{ 340h }{ 340i }|</para>
46226
46227         <para>#342| - |{ 342a }{ 342b }{ 342c }{ 342d }{ 342e }{ 342f }{ 342g
46228         }{ 342h }{ 342i }{ 342j }{ 342k }{ 342l }{ 342m }{ 342n }{ 342o }{
46229         342p }{ 342q }{ 342r }{ 342s }{ 342t }{ 342u }{ 342v }{ 342w }|</para>
46230
46231         <para>#343| - |{ 343a }{ 343b }{ 343c }{ 343d }{ 343e }{ 343f }{ 343g
46232         }{ 343h }{ 343i }|</para>
46233
46234         <para>#351| - |{ 3513 }{ 351a }{ 351b }{ 351c }|</para>
46235
46236         <para>#352| - |{ 352a }{ 352b }{ 352c }{ 352d }{ 352e }{ 352f }{ 352g
46237         }{ 352i }{ 352q }|</para>
46238
46239         <para>#362| - |{ 362a }{ 351z }|</para>
46240
46241         <para>#440| - |{ 440a }{ 440n }{ 440p }{ 440v }{ 440x }|.</para>
46242
46243         <para>#490| - |{ 490a }{ 490v }{ 490x }|.</para>
46244
46245         <para>#800| - |{ 800a }{ 800b }{ 800c }{ 800d }{ 800e }{ 800f }{ 800g
46246         }{ 800h }{ 800j }{ 800k }{ 800l }{ 800m }{ 800n }{ 800o }{ 800p }{
46247         800q }{ 800r }{ 800s }{ 800t }{ 800u }{ 800v }|.</para>
46248
46249         <para>#810| - |{ 810a }{ 810b }{ 810c }{ 810d }{ 810e }{ 810f }{ 810g
46250         }{ 810h }{ 810k }{ 810l }{ 810m }{ 810n }{ 810o }{ 810p }{ 810r }{
46251         810s }{ 810t }{ 810u }{ 810v }|.</para>
46252
46253         <para>#811| - |{ 811a }{ 811c }{ 811d }{ 811e }{ 811f }{ 811g }{ 811h
46254         }{ 811k }{ 811l }{ 811n }{ 811p }{ 811q }{ 811s }{ 811t }{ 811u }{
46255         811v }|.</para>
46256
46257         <para>#830| - |{ 830a }{ 830d }{ 830f }{ 830g }{ 830h }{ 830k }{ 830l
46258         }{ 830m }{ 830n }{ 830o }{ 830p }{ 830r }{ 830s }{ 830t }{ 830v
46259         }|.</para>
46260
46261         <para>#500|&lt;br/&gt;&lt;br/&gt;|{ 5003 }{ 500a }|</para>
46262
46263         <para>#501|&lt;br/&gt;&lt;br/&gt;|{ 501a }|</para>
46264
46265         <para>#502|&lt;br/&gt;&lt;br/&gt;|{ 502a }|</para>
46266
46267         <para>#504|&lt;br/&gt;&lt;br/&gt;|{ 504a }|</para>
46268
46269         <para>#505|&lt;br/&gt;&lt;br/&gt;|{ 505a }{ 505t }{ 505r }{ 505g }{
46270         505u }|</para>
46271
46272         <para>#506|&lt;br/&gt;&lt;br/&gt;|{ 5063 }{ 506a }{ 506b }{ 506c }{
46273         506d }{ 506u }|</para>
46274
46275         <para>#507|&lt;br/&gt;&lt;br/&gt;|{ 507a }{ 507b }|</para>
46276
46277         <para>#508|&lt;br/&gt;&lt;br/&gt;|{ 508a }{ 508a }|</para>
46278
46279         <para>#510|&lt;br/&gt;&lt;br/&gt;|{ 5103 }{ 510a }{ 510x }{ 510c }{
46280         510b }|</para>
46281
46282         <para>#511|&lt;br/&gt;&lt;br/&gt;|{ 511a }|</para>
46283
46284         <para>#513|&lt;br/&gt;&lt;br/&gt;|{ 513a }{513b }|</para>
46285
46286         <para>#514|&lt;br/&gt;&lt;br/&gt;|{ 514z }{ 514a }{ 514b }{ 514c }{
46287         514d }{ 514e }{ 514f }{ 514g }{ 514h }{ 514i }{ 514j }{ 514k }{ 514m
46288         }{ 514u }|</para>
46289
46290         <para>#515|&lt;br/&gt;&lt;br/&gt;|{ 515a }|</para>
46291
46292         <para>#516|&lt;br/&gt;&lt;br/&gt;|{ 516a }|</para>
46293
46294         <para>#518|&lt;br/&gt;&lt;br/&gt;|{ 5183 }{ 518a }|</para>
46295
46296         <para>#520|&lt;br/&gt;&lt;br/&gt;|{ 5203 }{ 520a }{ 520b }{ 520u
46297         }|</para>
46298
46299         <para>#521|&lt;br/&gt;&lt;br/&gt;|{ 5213 }{ 521a }{ 521b }|</para>
46300
46301         <para>#522|&lt;br/&gt;&lt;br/&gt;|{ 522a }|</para>
46302
46303         <para>#524|&lt;br/&gt;&lt;br/&gt;|{ 524a }|</para>
46304
46305         <para>#525|&lt;br/&gt;&lt;br/&gt;|{ 525a }|</para>
46306
46307         <para>#526|&lt;br/&gt;&lt;br/&gt;|{\n510i }{\n510a }{ 510b }{ 510c }{
46308         510d }{\n510x }|</para>
46309
46310         <para>#530|&lt;br/&gt;&lt;br/&gt;|{\n5063 }{\n506a }{ 506b }{ 506c }{
46311         506d }{\n506u }|</para>
46312
46313         <para>#533|&lt;br/&gt;&lt;br/&gt;|{\n5333 }{\n533a }{\n533b }{\n533c
46314         }{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }|</para>
46315
46316         <para>#534|&lt;br/&gt;&lt;br/&gt;|{\n533p }{\n533a }{\n533b }{\n533c
46317         }{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }{\n533t }{\n533x
46318         }{\n533z }|</para>
46319
46320         <para>#535|&lt;br/&gt;&lt;br/&gt;|{\n5353 }{\n535a }{\n535b }{\n535c
46321         }{\n535d }|</para>
46322
46323         <para>#538|&lt;br/&gt;&lt;br/&gt;|{\n5383 }{\n538a }{\n538i }{\n538u
46324         }|</para>
46325
46326         <para>#540|&lt;br/&gt;&lt;br/&gt;|{\n5403 }{\n540a }{ 540b }{ 540c }{
46327         540d }{\n520u }|</para>
46328
46329         <para>#544|&lt;br/&gt;&lt;br/&gt;|{\n5443 }{\n544a }{\n544b }{\n544c
46330         }{\n544d }{\n544e }{\n544n }|</para>
46331
46332         <para>#545|&lt;br/&gt;&lt;br/&gt;|{\n545a }{ 545b }{\n545u }|</para>
46333
46334         <para>#546|&lt;br/&gt;&lt;br/&gt;|{\n5463 }{\n546a }{ 546b }|</para>
46335
46336         <para>#547|&lt;br/&gt;&lt;br/&gt;|{\n547a }|</para>
46337
46338         <para>#550|&lt;br/&gt;&lt;br/&gt;|{ 550a }|</para>
46339
46340         <para>#552|&lt;br/&gt;&lt;br/&gt;|{ 552z }{ 552a }{ 552b }{ 552c }{
46341         552d }{ 552e }{ 552f }{ 552g }{ 552h }{ 552i }{ 552j }{ 552k }{ 552l
46342         }{ 552m }{ 552n }{ 562o }{ 552p }{ 552u }|</para>
46343
46344         <para>#555|&lt;br/&gt;&lt;br/&gt;|{ 5553 }{ 555a }{ 555b }{ 555c }{
46345         555d }{ 555u }|</para>
46346
46347         <para>#556|&lt;br/&gt;&lt;br/&gt;|{ 556a }{ 506z }|</para>
46348
46349         <para>#563|&lt;br/&gt;&lt;br/&gt;|{ 5633 }{ 563a }{ 563u }|</para>
46350
46351         <para>#565|&lt;br/&gt;&lt;br/&gt;|{ 5653 }{ 565a }{ 565b }{ 565c }{
46352         565d }{ 565e }|</para>
46353
46354         <para>#567|&lt;br/&gt;&lt;br/&gt;|{ 567a }|</para>
46355
46356         <para>#580|&lt;br/&gt;&lt;br/&gt;|{ 580a }|</para>
46357
46358         <para>#581|&lt;br/&gt;&lt;br/&gt;|{ 5633 }{ 581a }{ 581z }|</para>
46359
46360         <para>#584|&lt;br/&gt;&lt;br/&gt;|{ 5843 }{ 584a }{ 584b }|</para>
46361
46362         <para>#585|&lt;br/&gt;&lt;br/&gt;|{ 5853 }{ 585a }|</para>
46363
46364         <para>#586|&lt;br/&gt;&lt;br/&gt;|{ 5863 }{ 586a }|</para>
46365
46366         <para>#020|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;ISBN: &lt;/label&gt;|{
46367         020a }{ 020c }|</para>
46368
46369         <para>#022|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;ISSN: &lt;/label&gt;|{
46370         022a }|</para>
46371
46372         <para>#222| = |{ 222a }{ 222b }|</para>
46373
46374         <para>#210| = |{ 210a }{ 210b }|</para>
46375
46376         <para>#024|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Standard No.:
46377         &lt;/label&gt;|{ 024a }{ 024c }{ 024d }{ 0242 }|</para>
46378
46379         <para>#027|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Standard Tech. Report.
46380         No.: &lt;/label&gt;|{ 027a }|</para>
46381
46382         <para>#028|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Publisher. No.:
46383         &lt;/label&gt;|{ 028a }{ 028b }|</para>
46384
46385         <para>#013|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Patent No.:
46386         &lt;/label&gt;|{ 013a }{ 013b }{ 013c }{ 013d }{ 013e }{ 013f
46387         }|</para>
46388
46389         <para>#030|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;CODEN: &lt;/label&gt;|{
46390         030a }|</para>
46391
46392         <para>#037|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Source: &lt;/label&gt;|{
46393         037a }{ 037b }{ 037c }{ 037f }{ 037g }{ 037n }|</para>
46394
46395         <para>#010|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;LCCN: &lt;/label&gt;|{
46396         010a }|</para>
46397
46398         <para>#015|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Nat. Bib. No.:
46399         &lt;/label&gt;|{ 015a }{ 0152 }|</para>
46400
46401         <para>#016|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Nat. Bib. Agency Control
46402         No.: &lt;/label&gt;|{ 016a }{ 0162 }|</para>
46403
46404         <para>#600|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Subjects--Personal
46405         Names: &lt;/label&gt;|{\n6003 }{\n600a}{ 600b }{ 600c }{ 600d }{ 600e
46406         }{ 600f }{ 600g }{ 600h }{--600k}{ 600l }{ 600m }{ 600n }{ 600o
46407         }{--600p}{ 600r }{ 600s }{ 600t }{ 600u
46408         }{--600x}{--600z}{--600y}{--600v}|</para>
46409
46410         <para>#610|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Subjects--Corporate
46411         Names: &lt;/label&gt;|{\n6103 }{\n610a}{ 610b }{ 610c }{ 610d }{ 610e
46412         }{ 610f }{ 610g }{ 610h }{--610k}{ 610l }{ 610m }{ 610n }{ 610o
46413         }{--610p}{ 610r }{ 610s }{ 610t }{ 610u
46414         }{--610x}{--610z}{--610y}{--610v}|</para>
46415
46416         <para>#611|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Subjects--Meeting Names:
46417         &lt;/label&gt;|{\n6113 }{\n611a}{ 611b }{ 611c }{ 611d }{ 611e }{ 611f
46418         }{ 611g }{ 611h }{--611k}{ 611l }{ 611m }{ 611n }{ 611o }{--611p}{
46419         611r }{ 611s }{ 611t }{ 611u }{--611x}{--611z}{--611y}{--611v}|</para>
46420
46421         <para>#630|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Subjects--Uniform
46422         Titles: &lt;/label&gt;|{\n630a}{ 630b }{ 630c }{ 630d }{ 630e }{ 630f
46423         }{ 630g }{ 630h }{--630k }{ 630l }{ 630m }{ 630n }{ 630o }{--630p}{
46424         630r }{ 630s }{ 630t }{--630x}{--630z}{--630y}{--630v}|</para>
46425
46426         <para>#648|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Subjects--Chronological
46427         Terms: &lt;/label&gt;|{\n6483 }{\n648a
46428         }{--648x}{--648z}{--648y}{--648v}|</para>
46429
46430         <para>#650|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Subjects--Topical Terms:
46431         &lt;/label&gt;|{\n6503 }{\n650a}{ 650b }{ 650c }{ 650d }{ 650e
46432         }{--650x}{--650z}{--650y}{--650v}|</para>
46433
46434         <para>#651|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Subjects--Geographic
46435         Terms: &lt;/label&gt;|{\n6513 }{\n651a}{ 651b }{ 651c }{ 651d }{ 651e
46436         }{--651x}{--651z}{--651y}{--651v}|</para>
46437
46438         <para>#653|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Subjects--Index Terms:
46439         &lt;/label&gt;|{ 653a }|</para>
46440
46441         <para>#654|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Subjects--Facted Index
46442         Terms: &lt;/label&gt;|{\n6543
46443         }{\n654a}{--654b}{--654x}{--654z}{--654y}{--654v}|</para>
46444
46445         <para>#655|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Index Terms--Genre/Form:
46446         &lt;/label&gt;|{\n6553 }{\n655a}{--655b}{--655x
46447         }{--655z}{--655y}{--655v}|</para>
46448
46449         <para>#656|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Index Terms--Occupation:
46450         &lt;/label&gt;|{\n6563
46451         }{\n656a}{--656k}{--656x}{--656z}{--656y}{--656v}|</para>
46452
46453         <para>#657|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Index Terms--Function:
46454         &lt;/label&gt;|{\n6573
46455         }{\n657a}{--657x}{--657z}{--657y}{--657v}|</para>
46456
46457         <para>#658|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Index Terms--Curriculum
46458         Objective:
46459         &lt;/label&gt;|{\n658a}{--658b}{--658c}{--658d}{--658v}|</para>
46460
46461         <para>#050|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;LC Class. No.:
46462         &lt;/label&gt;|{ 050a }{ / 050b }|</para>
46463
46464         <para>#082|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Dewey Class. No.:
46465         &lt;/label&gt;|{ 082a }{ / 082b }|</para>
46466
46467         <para>#080|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Universal Decimal Class.
46468         No.: &lt;/label&gt;|{ 080a }{ 080x }{ / 080b }|</para>
46469
46470         <para>#070|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;National Agricultural
46471         Library Call No.: &lt;/label&gt;|{ 070a }{ / 070b }|</para>
46472
46473         <para>#060|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;National Library of
46474         Medicine Call No.: &lt;/label&gt;|{ 060a }{ / 060b }|</para>
46475
46476         <para>#074|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;GPO Item No.:
46477         &lt;/label&gt;|{ 074a }|</para>
46478
46479         <para>#086|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Gov. Doc. Class. No.:
46480         &lt;/label&gt;|{ 086a }|</para>
46481
46482         <para>#088|&lt;br/&gt;&lt;br/&gt;&lt;label&gt;Report. No.:
46483         &lt;/label&gt;|{ 088a }|</para>
46484       </section>
46485
46486       <section id="unimarcdefault">
46487         <title>UNIMARC Default</title>
46488
46489         <para>#200|&lt;h2&gt;Title : |{200a}{. 200c}{ : 200e}{200d}{. 200h}{.
46490         200i}|&lt;/h2&gt;</para>
46491
46492         <para>#461|&lt;label class="ipt"&gt;A part of : &lt;/label&gt;|&lt;a
46493         href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&amp;q=461t&amp;idx=ti}"&gt;{461t}&lt;/a&gt;{N∞
46494         461h} {v. 461v}{(461d)}&lt;br/&gt;|</para>
46495
46496         <para>#200b|&lt;label class="ipt"&gt;Material Designation :
46497         &lt;/label&gt;| {200b }|&lt;br/&gt;</para>
46498
46499         <para>#101a|&lt;label class="ipt"&gt;Language(s): &lt;/label&gt;|&lt;a
46500         href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&amp;q=101a&amp;idx=ln}"&gt;{101a}&lt;/a&gt;|&lt;br/&gt;</para>
46501
46502         <para>#200f|&lt;label class="ipt"&gt;Authors : &lt;/label&gt;|&lt;a
46503         href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&amp;q=200f&amp;idx=au}"&gt;{200f
46504         ; }&lt;/a&gt;|&lt;br/&gt;</para>
46505
46506         <para>#200g|&lt;label class="ipt"&gt;Co-authors : &lt;/label&gt;|&lt;a
46507         href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&amp;q=200g&amp;idx=au}"&gt;{200g
46508         ; }&lt;/a&gt;|&lt;br/&gt;</para>
46509
46510         <para>#210a|&lt;br/&gt;&lt;label class="ipt"&gt;Place of pubblication
46511         : &lt;/label&gt;|&lt;a
46512         href="/cgi-bin/koha/catalogue/search.pl?op=do_search&amp;idx=pl&amp;q={210a}"&gt;{210a}&lt;/a&gt;|&lt;br/&gt;</para>
46513
46514         <para>#210c|&lt;label class="ipt"&gt;Publisher : &lt;/label&gt;|&lt;a
46515         href="/cgi-bin/koha/catalogue/search.pl?op=do_search&amp;idx=pb&amp;q={210c}"&gt;{210c
46516         ; }&lt;/a&gt;|&lt;br/&gt;</para>
46517
46518         <para>#210d|&lt;label class="ipt"&gt;Date of pubblication :
46519         &lt;/label&gt;|{ 210d}|&lt;br/&gt;</para>
46520
46521         <para>#215|&lt;label class="ipt"&gt;Description :
46522         &lt;/label&gt;|{215a}{ : 215c}{ ; 215d}{ + 215e}|&lt;br/&gt;</para>
46523
46524         <para>#225a|&lt;label class="ipt"&gt;Series :&lt;/label&gt;|&lt;a
46525         href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&amp;q=225a&amp;idx=se}"&gt;{225a
46526         ;}&lt;/a&gt; |</para>
46527
46528         <para>#225||{ = 225d}{ : 225e}{. 225h}{. 225i}{ / 225f}{, 225x}{ ;
46529         225v}|&lt;br/&gt;</para>
46530
46531         <para>#686|&lt;label&gt;Classification : &lt;/label&gt;|{ 686a
46532         }|&lt;br/&gt;</para>
46533
46534         <para>#608|&lt;label&gt;Form, Genre : &lt;/label&gt;|&lt;a
46535         href="/cgi-bin/koha/catalogue/search.pl?op=do_search&amp;idx=su&amp;q={608a}"&gt;&lt;img
46536         border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
46537         title="Search on {608a}"&gt;{
46538         608a}&lt;/a&gt;|&lt;br/&gt;&lt;br/&gt;</para>
46539
46540         <para>#200||&lt;label class="ipt"&gt;Subjects :
46541         &lt;/label&gt;&lt;br/&gt;|&lt;ul&gt;</para>
46542
46543         <para>#600|&lt;label class="ipt"&gt;Person(s)
46544         &lt;/label&gt;&lt;br/&gt; |&lt;li&gt;&lt;a
46545         href="/cgi-bin/koha/catalogue/search.pl?op=do_search&amp;idx=su&amp;q={600a}"&gt;&lt;img
46546         border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
46547         title="Search on {600a}"&gt;{
46548         600a}&lt;/a&gt;&lt;/li&gt;|&lt;br/&gt;</para>
46549
46550         <para>#601|&lt;label class="ipt"&gt;Organisation(s)
46551         &lt;/label&gt;&lt;br/&gt;|&lt;li&gt;&lt;a
46552         href="/cgi-bin/koha/catalogue/search.pl?op=do_search&amp;idx=su&amp;q={601a}"&gt;&lt;img
46553         border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
46554         title="Search on {601a}"&gt;{
46555         601a}&lt;/a&gt;&lt;/li&gt;|&lt;br/&gt;</para>
46556
46557         <para>#606|&lt;label class="ipt"&gt;Term(s)
46558         &lt;/label&gt;&lt;br/&gt;|&lt;li&gt;&lt;a
46559         href="/cgi-bin/koha/catalogue/search.pl?op=do_search&amp;idx=su&amp;q={606a}"&gt;&lt;img
46560         border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
46561         title="Search on {606a}"&gt;{
46562         606a}&lt;/a&gt;&lt;/li&gt;|&lt;br/&gt;</para>
46563
46564         <para>#607|&lt;label class="ipt"&gt;Place(s)
46565         &lt;/label&gt;&lt;br/&gt;|&lt;li&gt;&lt;a
46566         href="/cgi-bin/koha/catalogue/search.pl?op=do_search&amp;idx=su&amp;q={607a}"&gt;&lt;img
46567         border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
46568         title="Search on {607a}"&gt;{
46569         607a}&lt;/a&gt;&lt;/li&gt;|&lt;br/&gt;</para>
46570
46571         <para>#610|&lt;label&gt;Keywords&lt;/label&gt;&lt;br/&gt;|&lt;li&gt;&lt;a
46572         href="/cgi-bin/koha/catalogue/search.pl?op=do_search&amp;idx=su&amp;q={610a}"&gt;&lt;img
46573         border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
46574         title="Search on {610a}"&gt;{ 610a}&lt;/a&gt;&lt;/li&gt;|</para>
46575
46576         <para>#200||&lt;/ul&gt;|</para>
46577
46578         <para>#856|&lt;label class="ipt"&gt;Electronic resource :
46579         &lt;/label&gt;|&lt;a href="{856u}"&gt;click here&lt;/a&gt; to go to
46580         the external resource&lt;br/&gt;</para>
46581
46582         <para>#010|&lt;label class="ipt"&gt;ISBN : &lt;/label&gt;|{010a
46583         ;}|&lt;br/&gt;</para>
46584
46585         <para>#011|&lt;label class="ipt"&gt;ISSN : &lt;/label&gt;|{011a
46586         ;}|&lt;br/&gt;</para>
46587
46588         <para>#200||&lt;label class="ipt"&gt;Notes :
46589         &lt;/label&gt;|&lt;br/&gt;&lt;ul&gt;</para>
46590
46591         <para>#300||&lt;li&gt;{300a}&lt;/li&gt;|</para>
46592
46593         <para>#307||&lt;li&gt;{307a}&lt;/li&gt;|</para>
46594
46595         <para>#310||&lt;li&gt;{310a}&lt;/li&gt;|</para>
46596
46597         <para>#326||&lt;li&gt;{326a}&lt;/li&gt;|</para>
46598
46599         <para>#327||&lt;li&gt;{327a}&lt;/li&gt;|</para>
46600
46601         <para>#333|&lt;li&gt;Public : |{333a}&lt;/li&gt;|</para>
46602
46603         <para>#200||&lt;/ul&gt;|</para>
46604
46605         <para>#330||&lt;label class="ipt"&gt;Abstract :
46606         &lt;/label&gt;|&lt;br/&gt;</para>
46607
46608         <para>#330||{330a}|&lt;br/&gt;</para>
46609
46610         <para>#200||&lt;br/&gt;&lt;h2&gt;Items&lt;/h2&gt;|</para>
46611
46612         <para>#200|&lt;table&gt;|&lt;th&gt;Call
46613         number&lt;/th&gt;&lt;th&gt;Copy
46614         note&lt;/th&gt;&lt;th&gt;Fonds&lt;/th&gt;&lt;th&gt;Genre
46615         detail&lt;/th&gt;&lt;th&gt;Circulation
46616         type&lt;/th&gt;&lt;th&gt;Barcode&lt;/th&gt;|</para>
46617
46618         <para>#995||&lt;tr&gt;&lt;td&gt; {995k}&lt;/td&gt;&lt;td&gt;
46619         {995u}&lt;/td&gt;&lt;td&gt;
46620         {995y}&lt;/td&gt;&lt;td&gt;{995e}  &lt;/td&gt;&lt;td&gt;
46621         {995o}&lt;/td&gt;&lt;td&gt;{995f}&lt;/td&gt;&lt;/tr&gt;|&lt;/table&gt;</para>
46622       </section>
46623     </section>
46624   </appendix>
46625
46626   <appendix id="receiptprint">
46627     <title>Configuring Receipt Printers</title>
46628
46629     <para>The following instructions are for specific receipt printers, but
46630     can probably be used to help with setup of other brands as well.</para>
46631
46632     <section id="epsonprinters">
46633       <sectioninfo>
46634         <corpauthor>NEKLS</corpauthor>
46635
46636         <pubdate>2008</pubdate>
46637
46638         <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>
46639       </sectioninfo>
46640
46641       <title>For Epson TM-T88III (3) &amp; TM-T88IV (4) Printers</title>
46642
46643       <para/>
46644
46645       <section id="epsonprintdriver">
46646         <title>In the Print Driver</title>
46647
46648         <para>For these instructions, we are using version 5,0,3,0 of the
46649         Epson TM-T88III print driver; the EPSON TM-T88IV version is ReceiptE4.
46650         Register at the <ulink url="https://www.epsonexpert.com/login">EpsonExpert Technical Resource
46651         Center website</ulink> to gain access to the drivers; go to Technical
46652         Resources, then choose the printer model from the Printers drop-down
46653         list.</para>
46654
46655         <para>Click Start &gt; Printers and Faxes &gt; Right click the receipt
46656         printer &gt; Properties:</para>
46657
46658         <itemizedlist>
46659           <listitem>
46660             <para>Advanced Tab, click Printing Defaults button</para>
46661           </listitem>
46662
46663           <listitem>
46664             <para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
46665           </listitem>
46666
46667           <listitem>
46668             <para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
46669             Printable Width</para>
46670           </listitem>
46671
46672           <listitem>
46673             <para>TM-T88IV: Check Reduced Size Print; Click OK on the popup
46674             window that appears. Fit to Printable Width should be
46675             automatically selected.</para>
46676           </listitem>
46677
46678           <listitem>
46679             <para>OK your way out of there.</para>
46680           </listitem>
46681         </itemizedlist>
46682       </section>
46683
46684       <section id="epsonfirefox">
46685         <title>In Firefox</title>
46686
46687         <para>Under File &gt; Page Setup:</para>
46688
46689         <itemizedlist>
46690           <listitem>
46691             <para>Shrink to fit page on Format &amp; Options tab</para>
46692           </listitem>
46693
46694           <listitem>
46695             <para>0,0,0,0 for Margins on Margins &amp; Header/Footer Tab. This
46696             makes the receipts use all available space on the paper
46697             roll.</para>
46698           </listitem>
46699
46700           <listitem>
46701             <para>Set all Headers/Footers to -blank-. This removes all of the
46702             gunk you might normally find on a print from Firefox, such as the
46703             URL, number of pages, etc.</para>
46704           </listitem>
46705
46706           <listitem>
46707             <para>Click OK</para>
46708           </listitem>
46709         </itemizedlist>
46710
46711         <para>Set the default printer settings in Firefox so you don't see a
46712         "Print" dialog:</para>
46713
46714         <itemizedlist>
46715           <listitem>
46716             <para>Go to File &gt; Print</para>
46717           </listitem>
46718
46719           <listitem>
46720             <para>Set the Printer to the receipt printer.</para>
46721           </listitem>
46722
46723           <listitem>
46724             <para>Click the Advanced (or Properties) button</para>
46725           </listitem>
46726
46727           <listitem>
46728             <para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
46729           </listitem>
46730
46731           <listitem>
46732             <para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
46733             Printable Width</para>
46734           </listitem>
46735
46736           <listitem>
46737             <para>TM-T88IV: Check Reduced Size Print; click OK on the popup
46738             window that appears. Fit to Printable Width should be
46739             automatically selected.</para>
46740           </listitem>
46741
46742           <listitem>
46743             <para>OK your way out, go ahead and print whatever page you are
46744             on.</para>
46745           </listitem>
46746
46747           <listitem>
46748             <para>Type about:config, in the address bar. Click "I'll be
46749             careful, I promise!" on the warning message.</para>
46750           </listitem>
46751
46752           <listitem>
46753             <para>Type, print.always in Filter.</para>
46754           </listitem>
46755
46756           <listitem>
46757             <para>Look for print.always_print_silent.</para>
46758
46759             <itemizedlist>
46760               <listitem>
46761                 <para>If the preference is there then set the value to
46762                 true.</para>
46763               </listitem>
46764             </itemizedlist>
46765           </listitem>
46766
46767           <listitem>
46768             <para>If the preference is not there (and it shouldn't be in most
46769             browsers) you have to add the preference.</para>
46770
46771             <itemizedlist>
46772               <listitem>
46773                 <para>Right click the preference area and select New &gt;
46774                 Boolean</para>
46775               </listitem>
46776
46777               <listitem>
46778                 <para>Type print.always_print_silent in the dialog box and set
46779                 the value to True. This sets the print settings in Firefox to
46780                 always use the same settings and print without showing a
46781                 dialog box.</para>
46782               </listitem>
46783             </itemizedlist>
46784           </listitem>
46785         </itemizedlist>
46786
46787         <warning>
46788           <para>Setting the print.always_print_silent setting in about:config
46789           DISABLES the ability to choose a printer in Firefox.</para>
46790         </warning>
46791       </section>
46792     </section>
46793
46794     <section id="epson2">
46795       <sectioninfo>
46796         <corpauthor>NEKLS</corpauthor>
46797
46798         <pubdate>2008</pubdate>
46799
46800         <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>
46801       </sectioninfo>
46802
46803       <title>For Epson TM-T88II (2) Printers</title>
46804
46805       <para>Register at the <ulink url="https://www.epsonexpert.com/login">EpsonExpert Technical Resource
46806       Center website</ulink> to gain access to the drivers; go to Technical
46807       Resources, then choose the printer model from the Printers drop-down
46808       list.</para>
46809
46810       <section id="epson2firefox">
46811         <title>In Firefox</title>
46812
46813         <para>Under File &gt; Page Setup:</para>
46814
46815         <itemizedlist>
46816           <listitem>
46817             <para>Shrink to fit page on Format &amp; Options tab</para>
46818           </listitem>
46819
46820           <listitem>
46821             <para>0,0,0,0 for Margins on Margins &amp; Header/Footer Tab. This
46822             makes the receipts use all available space on the paper
46823             roll.</para>
46824           </listitem>
46825
46826           <listitem>
46827             <para>Set all Headers/Footers to -blank-. This removes all of the
46828             gunk you might normally find on a print from Firefox, such as the
46829             URL, number of pages, etc.</para>
46830           </listitem>
46831
46832           <listitem>
46833             <para>Click OK</para>
46834           </listitem>
46835         </itemizedlist>
46836
46837         <para>Set the default printer settings in Firefox so you don't see a
46838         "Print" dialog:</para>
46839
46840         <itemizedlist>
46841           <listitem>
46842             <para>Go to File &gt; Print</para>
46843           </listitem>
46844
46845           <listitem>
46846             <para>Set the Printer to the receipt printer.</para>
46847           </listitem>
46848
46849           <listitem>
46850             <para>Print whatever page you are on.</para>
46851           </listitem>
46852
46853           <listitem>
46854             <para>Type about:config, in the address bar. Click "I'll be
46855             careful, I promise!" on the warning message.</para>
46856           </listitem>
46857
46858           <listitem>
46859             <para>Type, print.always in Filter.</para>
46860           </listitem>
46861
46862           <listitem>
46863             <para>Look for, print.always_print_silent.</para>
46864
46865             <itemizedlist>
46866               <listitem>
46867                 <para>If the preference is there then set the value to
46868                 true.</para>
46869               </listitem>
46870             </itemizedlist>
46871           </listitem>
46872
46873           <listitem>
46874             <para>If the preference is not there (and it shouldn't be in most
46875             browsers) you have to add the preference.</para>
46876
46877             <itemizedlist>
46878               <listitem>
46879                 <para>Right click the preference area and select New &gt;
46880                 Boolean</para>
46881               </listitem>
46882
46883               <listitem>
46884                 <para>Type, print.always_print_silent in the dialog box and
46885                 set the value to True. This sets the print settings in Firefox
46886                 to always use the same settings and print without showing a
46887                 dialog box.</para>
46888               </listitem>
46889             </itemizedlist>
46890           </listitem>
46891         </itemizedlist>
46892
46893         <warning>
46894           <para>Setting the print.always_print_silent setting in about:config
46895           DISABLES the ability to choose a printer in Firefox.</para>
46896         </warning>
46897       </section>
46898     </section>
46899
46900     <section id="starprinter">
46901       <sectioninfo>
46902         <corpauthor>RHCL</corpauthor>
46903
46904         <editor>
46905           <firstname>Nicole C.</firstname>
46906
46907           <surname>Engard</surname>
46908         </editor>
46909
46910         <pubdate>2010</pubdate>
46911       </sectioninfo>
46912
46913       <title>For Star SP542 Printers</title>
46914
46915       <section id="installstarprinter">
46916         <title>Installing the Printer</title>
46917
46918         <para>While the following comments are based on the Star SP542 receipt
46919         printer, they probably apply to all printers in the SP5xx
46920         series.</para>
46921
46922         <para>The Star SP542 receipt printer works well with Koha and <emphasis role="bold">Firefox
46923             on Windows XP SP3</emphasis>. This printer, with either the parallel or USB interface,
46924           is fairly easy to install and configure. You will need the following executable file which
46925           is available from numerous places on the Internet:</para>
46926
46927         <para>linemode_2k-xp_20030205.exe</para>
46928
46929         <para>This executable actually does all of the installation; you will
46930         not need to use the Microsoft Windows "Add Printer" program. We
46931         recommend that when installing, the option for the software monitor
46932         not be selected; we have experienced significant pauses and delays in
46933         printing with it. Instead, simply choose to install the receipt
46934         printer without the monitor.</para>
46935
46936         <para>Additionally, the install program may not put the printer on the
46937         correct port, especially if using the USB interface. This is easily
46938         corrected by going to "Start -&gt; Printers and Faxes -&gt; Properties
46939         for the SP542 printer -&gt; Ports", then check the appropriate
46940         port.</para>
46941
46942         <para>A reboot may be required, even if not indicated by the
46943         installation software or the operating system.</para>
46944         <para><emphasis role="bold">Windows 7</emphasis> users should refer to this page:  <ulink
46945             url="http://www.starmicronics.com/supports/win7.aspx"
46946             >http://www.starmicronics.com/supports/win7.aspx</ulink>.
46947         </para>
46948       </section>
46949     </section>
46950
46951     <section id="firefoxreceipt">
46952       <sectioninfo>
46953         <corpauthor>VOKAL</corpauthor>
46954
46955         <editor>
46956           <firstname>Nicole C.</firstname>
46957
46958           <surname>Engard</surname>
46959         </editor>
46960
46961         <pubdate>2010</pubdate>
46962
46963         <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>
46964       </sectioninfo>
46965
46966       <title>Configuring Firefox to Print to Receipt Printer</title>
46967
46968       <itemizedlist>
46969         <listitem>
46970           <para>Open File &gt; Page Setup</para>
46971         </listitem>
46972
46973         <listitem>
46974           <para>Make all the headers and footers blank</para>
46975         </listitem>
46976
46977         <listitem>
46978           <para>Set the margins to 0 (zero)</para>
46979         </listitem>
46980
46981         <listitem>
46982           <para>In the address bar of Firefox, type about:config</para>
46983         </listitem>
46984
46985         <listitem>
46986           <para>Search for print.always_print_silent and double click
46987           it</para>
46988         </listitem>
46989
46990         <listitem>
46991           <para>Change it from false to true</para>
46992
46993           <itemizedlist>
46994             <listitem>
46995               <para>This lets you skip the Print pop up box that comes up, as
46996               well as skipping the step where you have to click OK,
46997               automatically printing the right sized slip.</para>
46998             </listitem>
46999           </itemizedlist>
47000         </listitem>
47001
47002         <listitem>
47003           <para>If print.always_print_silent does not come up</para>
47004
47005           <itemizedlist>
47006             <listitem>
47007               <para>Right click on a blank area of the preference
47008               window</para>
47009             </listitem>
47010
47011             <listitem>
47012               <para>Select new &gt; Boolean</para>
47013             </listitem>
47014
47015             <listitem>
47016               <para>Enter "print.always_print_silent" as the name (without
47017               quotes)</para>
47018             </listitem>
47019
47020             <listitem>
47021               <para>Click OK</para>
47022             </listitem>
47023
47024             <listitem>
47025               <para>Select true for the value</para>
47026             </listitem>
47027           </itemizedlist>
47028         </listitem>
47029
47030         <listitem>
47031           <para>You may also want to check what is listed for
47032           print.print_printer</para>
47033
47034           <itemizedlist>
47035             <listitem>
47036               <para>You may have to choose Generic/Text Only (or whatever your
47037               receipt printer might be named)</para>
47038             </listitem>
47039           </itemizedlist>
47040         </listitem>
47041       </itemizedlist>
47042     </section>
47043   </appendix>
47044   <appendix id="noticesappendix">
47045     <title>Notice &amp; Slips Guides</title>
47046     <section id="noticesfieldguide">
47047       <sectioninfo>
47048         <authorgroup>
47049           <author>
47050             <firstname>Barton</firstname>
47051             <surname>Chittenden</surname>
47052             <affiliation>
47053               <orgname>ByWater Solutions</orgname>
47054             </affiliation>
47055           </author>
47056           <editor>
47057             <firstname>Nicole C.</firstname>
47058             <surname>Engard</surname>
47059           </editor>
47060         </authorgroup>
47061         <pubdate>2014</pubdate>
47062       </sectioninfo>
47063       <title>Field Guide for Notices &amp; Slips</title>
47064       <para>This guide will break down the notices and slips information in 3 ways.  First it will
47065         tell you what file generates the notice, then how you will present the item info in that
47066         notice and finally if the notice can be branch specific or not.</para>
47067       <para>
47068         <informaltable
47069           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">
47070           <thead>
47071             <tr>
47072               <th rowspan="1" colspan="1" align="left">Letter Code</th>
47073               <th rowspan="1" colspan="1" align="left">Used In</th>
47074               <th rowspan="1" colspan="1" align="left">Detail tag</th>
47075               <th rowspan="1" colspan="1" align="left">Can be branch specific</th>
47076             </tr>
47077           </thead>
47078           <tbody>
47079             <tr>
47080               <td rowspan="1" colspan="1" align="left">DUE</td>
47081               <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
47082               <td rowspan="1" colspan="1" align="left">&lt;&lt;items.content&gt;&gt;</td>
47083               <td rowspan="1" colspan="1" align="left">No</td>
47084             </tr>
47085             <tr>
47086               <td rowspan="1" colspan="1" align="left">DUEDGST</td>
47087               <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
47088               <td rowspan="1" colspan="1" align="left">&lt;&lt;items.content&gt;&gt;</td>
47089               <td rowspan="1" colspan="1" align="left">No</td>
47090             </tr>
47091             <tr>
47092               <td rowspan="1" colspan="1" align="left">PREDUE</td>
47093               <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
47094               <td rowspan="1" colspan="1" align="left">&lt;&lt;items.content&gt;&gt;</td>
47095               <td rowspan="1" colspan="1" align="left">No</td>
47096             </tr>
47097             <tr>
47098               <td rowspan="1" colspan="1" align="left">PREDUEDGST</td>
47099               <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
47100               <td rowspan="1" colspan="1" align="left">&lt;&lt;items.content&gt;&gt;</td>
47101               <td rowspan="1" colspan="1" align="left">No</td>
47102             </tr>
47103             <tr>
47104               <td rowspan="1" colspan="1" align="left">ODUE*</td>
47105               <td rowspan="1" colspan="1" align="left">overdue_notices.pl</td>
47106               <td rowspan="1" colspan="1" align="left">&lt;&lt;items.content&gt;&gt; or &lt;item&gt;
47107                 &lt;/item&gt;</td>
47108               <td rowspan="1" colspan="1" align="left">Yes</td>
47109             </tr>
47110             <tr>
47111               <td rowspan="1" colspan="1" align="left">CHECKOUT</td>
47112               <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
47113               <td rowspan="1" colspan="1" align="left">N/A</td>
47114               <td rowspan="1" colspan="1" align="left">Yes</td>
47115             </tr>
47116             <tr>
47117               <td rowspan="1" colspan="1" align="left">RENEWAL</td>
47118               <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
47119               <td rowspan="1" colspan="1" align="left">N/A</td>
47120               <td rowspan="1" colspan="1" align="left">Yes</td>
47121             </tr>
47122             <tr>
47123               <td rowspan="1" colspan="1" align="left">TRANSFERSLIP</td>
47124               <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
47125               <td rowspan="1" colspan="1" align="left">N/A</td>
47126               <td rowspan="1" colspan="1" align="left">Yes</td>
47127             </tr>
47128             <tr>
47129               <td rowspan="1" colspan="1" align="left">ISSUESLIP</td>
47130               <td rowspan="1" colspan="1" align="left">C4/Members.pm</td>
47131               <td rowspan="1" colspan="1" align="left">
47132                 <para>&lt;checkedout&gt; &lt;/checkedout&gt; </para>
47133                 <para> &lt;overdue&gt; &lt;/overdue&gt; </para>
47134                 <para> &lt;news&gt; &lt;/news&gt; </para>
47135               </td>
47136               <td rowspan="1" colspan="1" align="left">Yes</td>
47137             </tr>
47138             <tr>
47139               <td rowspan="1" colspan="1" align="left">ISSUEQSLIP</td>
47140               <td rowspan="1" colspan="1" align="left">C4/Members.pm</td>
47141               <td rowspan="1" colspan="1" align="left">&lt;checkedout&gt; &lt;/checkedout&gt;</td>
47142               <td rowspan="1" colspan="1" align="left">Yes</td>
47143             </tr>
47144             <tr>
47145               <td rowspan="1" colspan="1" align="left">HOLDPLACED</td>
47146               <td rowspan="1" colspan="1" align="left">C4/Reserves.pm</td>
47147               <td rowspan="1" colspan="1" align="left">N/A</td>
47148               <td rowspan="1" colspan="1" align="left">Yes</td>
47149             </tr>
47150             <tr>
47151               <td rowspan="1" colspan="1" align="left">RESERVESLIP</td>
47152               <td rowspan="1" colspan="1" align="left">C4/Reserves.pm</td>
47153               <td rowspan="1" colspan="1" align="left">N/A</td>
47154               <td rowspan="1" colspan="1" align="left">Yes</td>
47155             </tr>
47156             <tr>
47157               <td rowspan="1" colspan="1" align="left">ASKED</td>
47158               <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
47159               <td rowspan="1" colspan="1" align="left">N/A</td>
47160               <td rowspan="1" colspan="1" align="left">Yes</td>
47161             </tr>
47162             <tr>
47163               <td rowspan="1" colspan="1" align="left">CHECKED</td>
47164               <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
47165               <td rowspan="1" colspan="1" align="left">N/A</td>
47166               <td rowspan="1" colspan="1" align="left">Yes</td>
47167             </tr>
47168             <tr>
47169               <td rowspan="1" colspan="1" align="left">ACCEPTED</td>
47170               <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
47171               <td rowspan="1" colspan="1" align="left">N/A</td>
47172               <td rowspan="1" colspan="1" align="left">Yes</td>
47173             </tr>
47174             <tr>
47175               <td rowspan="1" colspan="1" align="left">REJECTED</td>
47176               <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
47177               <td rowspan="1" colspan="1" align="left">N/A</td>
47178               <td rowspan="1" colspan="1" align="left">Yes</td>
47179             </tr>
47180             <tr>
47181               <td rowspan="1" colspan="1" align="left">OPAC_REG_VERIFY</td>
47182               <td rowspan="1" colspan="1" align="left">opac/opac-memberentry.pl</td>
47183               <td rowspan="1" colspan="1" align="left">N/A</td>
47184               <td rowspan="1" colspan="1" align="left">No</td>
47185             </tr>
47186           </tbody>
47187         </informaltable>
47188       </para>
47189     </section>
47190   </appendix>
47191
47192   <appendix id="samplenotice">
47193     <title>Example Notice</title>
47194
47195     <para>Nicole Engard</para>
47196
47197     <para>410 Library Rd.</para>
47198
47199     <para>Philadelphia, PA 19107</para>
47200
47201     <para>Dear Nicole Engard (23529000035726),</para>
47202
47203     <para>According to our records, at the time of this notice, you have items
47204     that are overdue. Please return or renew them as soon as possible to avoid
47205     increasing late fines.</para>
47206
47207     <para>If you have registered a password with the library, you may use it
47208     with your library card number to renew online.</para>
47209
47210     <para>If you believe you have returned the items below please call at and
47211     library staff will be happy to help resolve the issue.</para>
47212
47213     <para>The following item(s) are currently overdue:</para>
47214
47215     <para>07/08/2008 Creating drug-free schools and communities : 502326000054
47216     Fox, C. Lynn.</para>
47217
47218     <para>06/27/2008 Eating fractions / 502326000022 McMillan, Bruce.</para>
47219
47220     <para>Sincerely, Library Staff</para>
47221   </appendix>
47222
47223   <appendix id="sampleserialsapp">
47224     <title>Sample Serials</title>
47225
47226     <para/>
47227
47228     <section id="readersdigestsample">
47229       <title>Reader's Digest (0034-0375)</title>
47230
47231       <itemizedlist>
47232         <listitem>
47233           <para>Published 12 times a year (monthly)</para>
47234         </listitem>
47235
47236         <listitem>
47237           <para>The Volume number changes every 6 months and the numbers
47238           continues on (requires an advanced pattern).</para>
47239
47240           <screenshot>
47241             <screeninfo>Sample Reader's Digest Subscription</screeninfo>
47242
47243             <mediaobject>
47244               <imageobject>
47245                 <imagedata fileref="images/serialssamples/readersserial.png"/>
47246               </imageobject>
47247             </mediaobject>
47248           </screenshot>
47249         </listitem>
47250       </itemizedlist>
47251
47252       <para/>
47253     </section>
47254
47255     <section id="peoplesample">
47256       <title>People Weekly (1076-0091)</title>
47257
47258       <itemizedlist>
47259         <listitem>
47260           <para>Published weekly</para>
47261
47262           <itemizedlist>
47263             <listitem>
47264               <para>The website says "on Saturday except the first week of
47265               August, Thanksgiving week, the first and last weeks of the year"
47266               but this does not match the pattern for 2007 or 2008</para>
47267             </listitem>
47268           </itemizedlist>
47269         </listitem>
47270
47271         <listitem>
47272           <para>In the Jul-Dec there are 26 issues</para>
47273         </listitem>
47274
47275         <listitem>
47276           <para>In the Jan-Jun there are 25 issues (no issue for the first
47277           week of January)</para>
47278         </listitem>
47279       </itemizedlist>
47280
47281       <para>Since the irregularity on the first # 26 does not skip a week,
47282       this would be set up as to roll over on issue 25. The 26th issue in the
47283       second half of the year would have to be received as a
47284       supplemental.</para>
47285
47286       <para>The irregularity check will complain that 52 issues were expected,
47287       but 25 entered. The current irregularity check can only check that the
47288       first position of the numbering pattern matches the expected issue count
47289       of the periodicity. But we do need to trigger the rollover on the
47290       volume, so we need to define the last two weeks of the year as
47291       irregularities. So we receive 50 issues the first 50 weeks, then one
47292       supplemental issue in week 51, which we have to define the enumeration
47293       for, then the next predicted issue will be the following year's first
47294       week.</para>
47295     </section>
47296
47297     <section id="hebrewserialsample">
47298       <title>Et-Mol</title>
47299
47300       <para>This journal is published with the following rules:</para>
47301
47302       <itemizedlist>
47303         <listitem>
47304           <para>6 issues a year (every 2 months)</para>
47305         </listitem>
47306
47307         <listitem>
47308           <para>year changes every 6 issues</para>
47309         </listitem>
47310
47311         <listitem>
47312           <para>we start in 2011</para>
47313         </listitem>
47314
47315         <listitem>
47316           <para>the issue number goes up indefinitely</para>
47317         </listitem>
47318
47319         <listitem>
47320           <para>starting from issue 215</para>
47321         </listitem>
47322       </itemizedlist>
47323
47324       <para>The planning would look like this:</para>
47325
47326       <screenshot>
47327         <screeninfo>Sample for this Hebrew Journal</screeninfo>
47328
47329         <mediaobject>
47330           <imageobject>
47331             <imagedata fileref="images/serialssamples/hebrewnewspaper.png"/>
47332           </imageobject>
47333         </mediaobject>
47334       </screenshot>
47335     </section>
47336     <section id="backpackerserial">
47337       <title>Backpacker (0277-867X)</title>
47338       <para>Published 9 times a year irregularly.  The issues continues while the volume and number
47339         rolls over every 9 issues.  If you're holding Volume 41, Number 3, Issue 302 in your hand
47340         the prediction would look like this:</para>
47341       <screenshot>
47342           <screeninfo>Backpacker numbering pattern</screeninfo>
47343           <mediaobject>
47344             <imageobject>
47345               <imagedata fileref="images/serialssamples/backpacker.png"/>
47346             </imageobject>
47347           </mediaobject>
47348         </screenshot>
47349       <para>And the received issues would number like this:</para>
47350       <para>v. 41, no. 3, iss. 302   </para>
47351       <para>v. 41, no. 4, iss. 303 </para>
47352       <para>v. 41, no. 5, iss. 304 </para>
47353       <para>v. 41, no. 6, iss. 305 </para>
47354       <para>v. 41, no. 7, iss. 306 </para>
47355       <para>v. 41, no. 8, iss. 307</para>
47356       <para>v. 41, no. 9, iss. 308 </para>
47357       <para>v. 42, no. 1, iss. 309 </para>
47358       <para>v. 42, no. 2, iss. 310 </para>
47359       <para>v. 42, no. 3, iss. 311 </para>
47360       <para>v. 42, no. 4, iss. 312</para>
47361     </section>
47362     <section id="keatsserial">
47363       <title>Keats-Shelley Journal (0453-4387)</title>
47364       <para>This journal is published once per year in July.  The numbering follows this pattern:  <itemizedlist>
47365           <listitem>
47366             <para>Vol. 61 2013</para>
47367           </listitem>
47368           <listitem>
47369             <para>Vol. 62 2014</para>
47370           </listitem>
47371           <listitem>
47372             <para>Vol. 63 2015</para>
47373           </listitem>
47374         </itemizedlist> Setup should look like this (if you're starting in July 2014):</para>
47375       <screenshot>
47376           <screeninfo>Serial planning</screeninfo>
47377           <mediaobject>
47378             <imageobject>
47379               <imagedata fileref="images/serialssamples/keatsplanning.png"/>
47380             </imageobject>
47381           </mediaobject>
47382         </screenshot>
47383     </section>
47384     <section id="cilserial">
47385       <title>Computers in Libraries (1041-7915)</title>
47386       <para>Computers in Libraries is published ten times per year (monthly with January/February
47387         and July/August combined issues).</para>
47388       <screenshot>
47389         <screeninfo>Subscription details</screeninfo>
47390         <mediaobject>
47391           <imageobject>
47392             <imagedata fileref="images/serialssamples/cilirregular.png"/>
47393           </imageobject>
47394         </mediaobject>
47395       </screenshot>
47396       <screenshot>
47397         <screeninfo>Serial Planning</screeninfo>
47398         <mediaobject>
47399           <imageobject>
47400             <imagedata fileref="images/serialssamples/cilpattern.png"/>
47401           </imageobject>
47402         </mediaobject>
47403       </screenshot>
47404       <screenshot>
47405         <screeninfo>Received details</screeninfo>
47406         <mediaobject>
47407           <imageobject>
47408             <imagedata fileref="images/serialssamples/cilreceived.png"/>
47409           </imageobject>
47410         </mediaobject>
47411       </screenshot>
47412     </section>
47413   </appendix>
47414   <appendix id="samplelistemail">
47415     <title>Sample List &amp; Cart Emails</title>
47416     <section id="examplelistemail">
47417       <title>Example Email from List</title>
47418       <para>Below is an example of an email from a list in
47419         Koha.<programlisting>Hi,
47420
47421 Here is your list called If You Like Jodi Picoult, sent from our online catalog.
47422
47423 Please note that the attached file is a MARC bibliographic records file
47424 which can be imported into a Personal Bibliographic Software like EndNote,
47425 Reference Manager or ProCite.
47426 ---------------------------------------------
47427
47428 Home safe : a novel /
47429
47430 by Berg, Elizabeth.
47431
47432 Published by: Random House,, 260 p. ;, 25 cm.
47433 Copyright year: 2009
47434 LCCN:   2008049247
47435 In the online catalog:
47436     http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=12113
47437 Items :
47438     North Branch FIC (FIC Ber) TVSN500088894O
47439     Main Library FIC (FIC Boh) TVSN5000921548
47440     South Branch FIC (FIC Boh) TVSN500092156A
47441     West Branch FIC (FIC Boh) TVSN5000921559
47442
47443 ---------------------------------------------
47444
47445 Half a heart /
47446
47447 by Brown, Rosellen.
47448
47449 Published by: Farrar, Straus, and Giroux,, 402 p. ;, 24 cm.
47450 Copyright year: 2000
47451 LCCN:    00022926
47452 In the online catalog:
47453     http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=12501
47454 Items :
47455     East Branch  (813/.54)
47456     South Branch FIC (FIC Bro) TVSN5000451333</programlisting></para>
47457     </section>
47458     <section id="examplecartemail">
47459       <title>Example Email from Cart</title>
47460       <para>Below is a sample of what an email from the Cart in Koha will look
47461         like:<programlisting>Hi,
47462
47463    Joaquin D'Planque sent you a cart from our online catalog.
47464
47465    Please note that the attached file is a MARC bibliographic records
47466    file which can be imported into personal bibliographic software like
47467    EndNote, Reference Manager or ProCite.
47468
47469    ---------------------------------------------------------------------
47470
47471
47472      1.  Book /
47473        Author(s): Brookfield, Karen. ;
47474        Published by: Knopf : | Distributed by Random House, , 63 p. : ,
47475        29 cm.
47476        Copyright year: 1993
47477        Notes : Includes index.
47478        LCCN: 93018833 /AC
47479
47480        In online catalog:
47481        http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=31644
47482
47483        Items:
47484
47485          *  East Branch (JNF 002 Bro) TVSN500017618A
47486
47487        -----------------------------------------------------------------
47488
47489      2.  The 1965 World book year book :
47490
47491        Published by: Field Enterprises Educational Corp., , 628 p. : , 26
47492        cm.
47493        Copyright year: 1965
47494        Notes : Includes index. | Spine title: Year book, 1965. | Cover
47495        title: The World book year book, 1965.
47496        URL:
47497        http://www.archive.org/details/1965worldbookyea00chic%20%7C%20http://www.openlibrary.org/books/OL24199089M
47498
47499        In online catalog:
47500        http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=88666
47501
47502        -----------------------------------------------------------------</programlisting></para>
47503     </section>
47504   </appendix>
47505
47506   <appendix id="kohacms">
47507     <title>Using Koha as a Content Management System (CMS)</title>
47508
47509     <para/>
47510
47511     <section id="kohacmssetup">
47512       <title>Setup</title>
47513
47514       <para>These are instructions for taking a default install of Koha and allowing it to function
47515         as a little content management system. This will allow a library to publish an arbitrary
47516         number of pages based on a template. This example uses the template for the main opac page,
47517         but you could just as well use any template you wish with a bit more editing. This may be
47518         appropriate if you have a small library, want to allow librarians to easily add pages, and
47519         do not want to support a complete CMS. </para>
47520
47521       <itemizedlist>
47522         <listitem>
47523           <para>Copy /usr/share/koha/opac/cgi-bin/opac/opac-main.pl to
47524             /usr/share/koha/opac/cgi-bin/opac/pages.pl (in the same directory) </para>
47525         </listitem>
47526
47527         <listitem>
47528           <para>Edit pages.pl in an editor</para>
47529         </listitem>
47530
47531         <listitem>
47532           <para>At approximately line 33 change this code: </para>
47533
47534           <programlisting>template_name  => "opac-main.tmpl",</programlisting>
47535         </listitem>
47536
47537         <listitem>
47538           <para>To this code:</para>
47539
47540           <programlisting>template_name  => "pages.tmpl", </programlisting>
47541         </listitem>
47542
47543         <listitem>
47544           <para>At approximately line 62 after this code: </para>
47545           <programlisting>$template->param(
47546            koha_news       => $all_koha_news,
47547            koha_news_count => $koha_news_count,
47548            display_daily_quote => C4::Context->preference('QuoteOfTheDay'),
47549            daily_quote         => $quote,
47550            );</programlisting>
47551         </listitem>
47552         <listitem>
47553           <para>Add these lines: </para>
47554           <programlisting>        my $page = "page_" . $cgi->param('p');            # go for "p" value in URL and do the concatenation
47555         my $preference = C4::Context->preference($page);  # Go for preference
47556         $template->{VARS}->{'page_test'} = $preference    # pass variable to template pages.tt</programlisting>
47557         </listitem>
47558
47559         <listitem>
47560           <para>Note pages.pl file must have Webserver user execution permissions, you can use
47561               <ulink url="http://en.wikipedia.org/wiki/Chmod">chmod</ulink> command if you are
47562             actually logged in as such user:
47563             <programlisting>        $chmod 755 pages.pl</programlisting></para>
47564         </listitem>
47565
47566         <listitem>
47567           <para>In the browser go to Home &gt; Administration &gt; System Preferences &gt; Local Use and add
47568             a New Preference called "page_test" </para>
47569         </listitem>
47570
47571         <listitem>
47572           <para>Fill it out as so</para>
47573
47574           <itemizedlist>
47575             <listitem>
47576               <para>Explanation: test page for pages tiny cms</para>
47577             </listitem>
47578
47579             <listitem>
47580               <para>Variable: page_test</para>
47581             </listitem>
47582
47583             <listitem>
47584               <para>Value: Lorem ipsum</para>
47585             </listitem>
47586
47587             <listitem>
47588               <para>Click the TextArea link (or enter "TextArea" into the
47589               input field below it)</para>
47590             </listitem>
47591
47592             <listitem>
47593               <para>variable options (last field): 80|50</para>
47594             </listitem>
47595           </itemizedlist>
47596         </listitem>
47597
47598         <listitem>
47599           <para>In a browser go to http://youraddress/cgi-bin/koha/pages.pl?p=test The page should
47600             come up with the words "Lorem ipsum" in the main content area of the page. (replace
47601             "youraddress" with localhost, 127.0.0.1, or your domain name depending on how you have
47602             Apache set up.) </para>
47603         </listitem>
47604
47605         <listitem>
47606           <para>To add more pages simply create a system preference where the title begins with
47607             "page_" followed by any arbitrary letters. You can add any markup you want as the value
47608             of the field. Reference the new page by changing the value of the "p" parameter in the
47609             URL. </para>
47610         </listitem>
47611       </itemizedlist>
47612       <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>
47613       <section id="kohacmstmpl">
47614         <title>Editing the pages template</title>
47615         <para>The file to create / edit for the pages template will depend on your <link
47616             linkend="opacthemes">opacthemes</link> system preference setting </para>
47617         <section id="kohacmstmplboot">
47618           <title>Editing 'bootstrap' theme template (current)</title>
47619           <itemizedlist>
47620             <listitem>
47621               <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>
47622             </listitem>
47623             <listitem>
47624               <para>Edit /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/modules/pages.tt</para>
47625             </listitem>
47626             <listitem>
47627               <para>At approximately line 61, change this:
47628                 <programlisting>        [% IF ( OpacMainUserBlock ) %]&lt;div id="opacmainuserblock">[% OpacMainUserBlock %]&lt;/div>[% END %]</programlisting></para>
47629             </listitem>
47630             <listitem>
47631               <para>To this:
47632                 <programlisting>        [% IF ( page_test ) %]&lt;div id="opacmainuserblock">[% page_test %]&lt;/div>[% END %]</programlisting></para>
47633             </listitem>
47634           </itemizedlist>
47635           <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.
47636             <programlisting>
47637                       [% IF ( koha_news_count ) %]
47638                       &lt;div id="news">
47639                       &lt;table class="table table-bordered">
47640                       [% FOREACH koha_new IN koha_news %]
47641                         &lt;thead>&lt;tr>&lt;th>[% koha_new.title %]&lt;/th>&lt;/tr>&lt;/thead>
47642                         &lt;tbody>&lt;tr>&lt;td>&lt;p>[% koha_new.new %]&lt;/p>
47643                         &lt;p class="newsfooter">&lt;i>(published on [% koha_new.newdate %])&lt;/i>&lt;/p>&lt;/td>&lt;/tr>&lt;/tbody>
47644                       [% END %]
47645                       &lt;/table>
47646                       &lt;/div>
47647                      [% END %]
47648             </programlisting>
47649           </para>
47650         </section>
47651       </section>
47652       <section id="kohacmstrouble">
47653         <title>Troubleshooting</title>
47654
47655         <para>If you have problems check file permissions on pages.pl and
47656         pages.tmpl. They should have the same user and group as other Koha
47657         files like opac-main.pl.</para>
47658       </section>
47659
47660       <section id="kohacmsbonus">
47661         <title>Bonus Points</title>
47662
47663         <para>Instead of using the address
47664         http://youraddress/cgi-bin/koha/pages.pl?p=test you can shorten it to
47665         http://youraddress/pages.pl?p=test Just open up
47666         /etc/koha/koha-httpd.conf and add the follow at about line
47667         13:<programlisting>ScriptAlias /pages.pl "/usr/share/koha/opac/cgi-bin/opac/pages.pl" </programlisting></para>
47668
47669         <para>Then restart Apache.</para>
47670       </section>
47671     </section>
47672
47673     <section id="kohacmsusage">
47674       <title>Usage</title>
47675
47676       <para>After setting up Koha as a CMS you can create new pages following
47677       these instructions:</para>
47678
47679       <section id="kohacmspages">
47680         <title>Adding Pages</title>
47681
47682         <para>To add a new page you need to add a system preference under
47683         Local Use.</para>
47684
47685         <itemizedlist>
47686           <listitem>
47687             <para>Get there: More &gt; Administration &gt; Global System
47688             Preferences &gt; Local Use</para>
47689           </listitem>
47690
47691           <listitem>
47692             <para>Click 'New Preference'</para>
47693           </listitem>
47694
47695           <listitem>
47696             <para>Enter in a description in the Explanation field</para>
47697           </listitem>
47698
47699           <listitem>
47700             <para>Enter a value that starts with 'page_' in the Variable
47701             field</para>
47702           </listitem>
47703
47704           <listitem>
47705             <para>Enter starting HTML in the Value field</para>
47706
47707             <screenshot>
47708               <screeninfo>Add a new preference</screeninfo>
47709
47710               <mediaobject>
47711                 <imageobject>
47712                   <imagedata fileref="images/appendix-cms/newpreference.png"/>
47713                 </imageobject>
47714               </mediaobject>
47715             </screenshot>
47716           </listitem>
47717
47718           <listitem>
47719             <para>Set the Variable Type to Textarea</para>
47720           </listitem>
47721
47722           <listitem>
47723             <para>Set the Variable options to something like 20|20 for 20 rows
47724             and 20 columns</para>
47725
47726             <screenshot>
47727               <screeninfo>Settings for the new preference</screeninfo>
47728
47729               <mediaobject>
47730                 <imageobject>
47731                   <imagedata fileref="images/appendix-cms/newpref-settings.png"/>
47732                 </imageobject>
47733               </mediaobject>
47734             </screenshot>
47735           </listitem>
47736         </itemizedlist>
47737       </section>
47738
47739       <section id="kohacmsview">
47740         <title>Viewing your page</title>
47741
47742         <para>You can view your new page at
47743         http://YOUR-OPAC/cgi-bin/koha/pages.pl?p=PAGENAME where PAGENAME is
47744         the part you entered after 'page_' in the Variable field.</para>
47745       </section>
47746
47747       <section id="kohacmsexpage">
47748         <title>Example</title>
47749
47750         <para>This process can be used to create recommended reading lists
47751         within Koha. So once the code changes have been made per the
47752         instructions on 'Koha as a CMS' you go through the 'Adding a New Page'
47753         instructions above to great a page for 'Recommended Reading
47754         Lists'</para>
47755
47756         <screenshot>
47757           <screeninfo>Create page by modifying a system
47758           preference</screeninfo>
47759
47760           <mediaobject>
47761             <imageobject>
47762               <imagedata fileref="images/appendix-cms/recommendedreading.png"/>
47763             </imageobject>
47764           </mediaobject>
47765         </screenshot>
47766
47767         <para>Next we need to create pages for our various classes (or
47768         categories). To do this, return to the 'Adding a New Page' section and
47769         create a preference for the first class.</para>
47770
47771         <screenshot>
47772           <screeninfo>Add a new sys pref for another page</screeninfo>
47773
47774           <mediaobject>
47775             <imageobject>
47776               <imagedata fileref="images/appendix-cms/class101-pref.png"/>
47777             </imageobject>
47778           </mediaobject>
47779         </screenshot>
47780
47781         <para>Next you'll want to link your first page to your new second
47782         page, go to the page_recommend preference and click 'Edit.' Now you
47783         want to edit the HTML to include a link to your newest page:</para>
47784
47785         <screenshot>
47786           <screeninfo>Edit original preference to add new page</screeninfo>
47787
47788           <mediaobject>
47789             <imageobject>
47790               <imagedata fileref="images/appendix-cms/editrecommendpref.png"/>
47791             </imageobject>
47792           </mediaobject>
47793         </screenshot>
47794       </section>
47795
47796       <section id="examplecms">
47797         <title>Live Examples</title>
47798
47799         <itemizedlist>
47800           <listitem>
47801             <para>The Crawford Library at Dallas Christian College is using
47802             this method for their recommended reading lists: <ulink url="http://opac.dallas.edu/">http://opac.dallas.edu/</ulink></para>
47803           </listitem>
47804         </itemizedlist>
47805       </section>
47806     </section>
47807   </appendix>
47808
47809   <appendix id="resetkohadb">
47810     <title>Resetting the Koha Database</title>
47811
47812     <para>These notes on how to reset the database for Koha were derived from the following email
47813       thread: <ulink
47814         url="http://lists.koha-community.org/pipermail/koha-devel/2009-January/008939.html"
47815         >http://lists.koha-community.org/pipermail/koha-devel/2009-January/008939.html</ulink> and
47816         <ulink url="http://lists.katipo.co.nz/public/koha/2014-June/039701.html"
47817         >http://lists.katipo.co.nz/public/koha/2014-June/039701.html</ulink>
47818     </para>
47819
47820     <para>Resetting the database may be useful if you install Koha with the
47821     sample data, and then wish to use real data without reinstalling the
47822     software.</para>
47823
47824     <section id="deletetables">
47825       <title>Delete Tables</title>
47826       <para>Use your preferred MySQL client to <ulink
47827           url="http://dev.mysql.com/doc/refman/5.5/en/delete.html">delete</ulink> the following
47828         tables:</para>
47829       <itemizedlist>
47830         <listitem>
47831           <para>bibio</para>
47832         </listitem>
47833         <listitem>
47834           <para>biblioitems</para>
47835         </listitem>
47836         <listitem>
47837           <para>items</para>
47838         </listitem>
47839         <listitem>
47840           <para>auth_header</para>
47841         </listitem>
47842         <listitem>
47843           <para>sessions</para>
47844         </listitem>
47845         <listitem>
47846           <para>zebraqueue</para>
47847         </listitem>
47848       </itemizedlist>
47849     </section>
47850
47851     <section id="resetzebra">
47852       <title>Reset the Zebra Index</title>
47853
47854       <para>Run the following commands to reset the authorities and biblios
47855       Zebra indices. <programlisting>$ zebraidx -c /etc/koha/zebradb/zebra-authorities-dom.cfg -g iso2709 -d authorities init
47856 $ zebraidx -c /etc/koha/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init </programlisting></para>
47857       <para>If you are running a package install then you'll want to run the following commands to
47858         reset the authorities and biblios Zebra indices
47859         instead:<programlisting>$ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-authorities-dom.cfg  -g iso2709 -d authorities init
47860 $ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-biblios.cfg  -g iso2709 -d biblios init </programlisting></para>
47861       <para>Replacing YOURLIBRARY with your Koha installation name.</para>
47862     </section>
47863   </appendix>
47864
47865   <appendix id="importantlinks">
47866     <title>Important Links</title>
47867
47868     <para/>
47869
47870     <section id="koharelatedlinks">
47871       <title>Koha Related</title>
47872
47873       <itemizedlist>
47874         <listitem>
47875           <para>Report Koha Bugs - <ulink url="http://bugs.koha-community.org">http://bugs.koha-community.org</ulink></para>
47876         </listitem>
47877
47878         <listitem>
47879           <para>Koha Versioning Control - <ulink url="http://git.koha-community.org/">http://git.koha-community.org/</ulink></para>
47880         </listitem>
47881
47882         <listitem>
47883           <para>Database Structure - <ulink url="http://schema.koha-community.org"
47884               >http://schema.koha-community.org</ulink></para>
47885         </listitem>
47886         <listitem>
47887           <para>Koha Community Statistics - <ulink url="http://hea.koha-community.org"
47888               >http://hea.koha-community.org</ulink></para>
47889         </listitem>
47890
47891         <listitem>
47892           <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>
47893         </listitem>
47894
47895         <listitem>
47896           <para>Kyles's Koha Tools - <ulink url="http://kylehall.info/index.php/projects/koha/"
47897               >http://kylehall.info/index.php/projects/koha/</ulink></para>
47898         </listitem>
47899
47900         <listitem>
47901           <para>Koha Bibliography - <ulink url="http://www.zotero.org/groups/koha">http://www.zotero.org/groups/koha</ulink></para>
47902         </listitem>
47903
47904         <listitem>
47905           <para>Koha Shared Links - <ulink url="http://groups.diigo.com/group/everything-koha">http://groups.diigo.com/group/everything-koha</ulink></para>
47906         </listitem>
47907
47908         <listitem>
47909           <para>Koha Presentations - <ulink url="http://www.slideshare.net/group/koha-ils/slideshows">http://www.slideshare.net/group/koha-ils/slideshows</ulink></para>
47910         </listitem>
47911       </itemizedlist>
47912     </section>
47913
47914     <section id="catalogrelatedlinks">
47915       <title>Cataloging Related</title>
47916
47917       <itemizedlist>
47918         <listitem>
47919           <para>Koha MARC Tutorials - <ulink url="http://www.pakban.net/brooke/">http://www.pakban.net/brooke/</ulink></para>
47920         </listitem>
47921
47922         <listitem>
47923           <para>IRSpy Open Z39.50 Server Search - <ulink url="http://irspy.indexdata.com/"
47924               >http://irspy.indexdata.com/</ulink></para>
47925         </listitem>
47926
47927         <listitem>
47928           <para>Z39.50 Server List - <ulink
47929               url="http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm"
47930               >http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm</ulink></para>
47931         </listitem>
47932         <listitem>
47933           <para>Open Koha Z39.50 Targets - <ulink
47934               url="http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources"
47935               >http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources</ulink></para>
47936         </listitem>
47937
47938         <listitem>
47939           <para>Library of Congress Authorities - <ulink url="http://authorities.loc.gov/">http://authorities.loc.gov/</ulink></para>
47940         </listitem>
47941
47942         <listitem>
47943           <para>MARC Country Codes - <ulink url="http://www.loc.gov/marc/countries/">http://www.loc.gov/marc/countries/</ulink></para>
47944         </listitem>
47945
47946         <listitem>
47947           <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>
47948         </listitem>
47949
47950         <listitem>
47951           <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>
47952         </listitem>
47953
47954         <listitem>
47955           <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>
47956         </listitem>
47957       </itemizedlist>
47958     </section>
47959
47960     <section id="enhancedcontentlinks">
47961       <title>Enhanced Content Related</title>
47962
47963       <itemizedlist>
47964         <listitem>
47965           <para>Amazon Associates - <ulink url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com</ulink></para>
47966         </listitem>
47967
47968         <listitem>
47969           <para>Amazon Web Services - <ulink url="http://aws.amazon.com">http://aws.amazon.com</ulink></para>
47970         </listitem>
47971
47972         <listitem>
47973           <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>
47974         </listitem>
47975
47976         <listitem>
47977           <para>XISBN - <ulink url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
47978         </listitem>
47979
47980         <listitem>
47981           <para>LibraryThing for Libraries - <ulink url="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</ulink></para>
47982         </listitem>
47983       </itemizedlist>
47984     </section>
47985
47986     <section id="opaclinks">
47987       <title>Design Related</title>
47988
47989       <itemizedlist>
47990         <listitem>
47991           <para>JQuery Library - <ulink url="http://wiki.koha-community.org/wiki/JQuery_Library"
47992               >http://wiki.koha-community.org/wiki/JQuery_Library</ulink></para>
47993         </listitem>
47994         <listitem>
47995           <para>HTML &amp; CSS Library - <ulink
47996               url="http://wiki.koha-community.org/wiki/HTML_%26_CSS_Library"
47997               >http://wiki.koha-community.org/wiki/HTML_%26_CSS_Library</ulink></para>
47998         </listitem>
47999
48000         <listitem>
48001           <para>Owen Leonard's Koha Blog - <ulink url="http://www.myacpl.org/koha">http://www.myacpl.org/koha</ulink></para>
48002         </listitem>
48003       </itemizedlist>
48004     </section>
48005
48006     <section id="reportlinks">
48007       <title>Reports Related</title>
48008
48009       <itemizedlist>
48010         <listitem>
48011           <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>
48012         </listitem>
48013
48014         <listitem>
48015           <para>Database Schema - <ulink url="http://schema.koha-community.org">http://schema.koha-community.org</ulink></para>
48016         </listitem>
48017
48018         <listitem>
48019           <para>Sample reports from NEKLS - <ulink
48020               url="http://www.nexpresslibrary.org/training/reports-training/"
48021               >http://www.nexpresslibrary.org/training/reports-training/</ulink></para>
48022         </listitem>
48023       </itemizedlist>
48024     </section>
48025
48026     <section id="installlinks">
48027       <title>Installation Guides</title>
48028
48029       <itemizedlist>
48030         <listitem>
48031           <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>
48032         </listitem>
48033
48034         <listitem>
48035           <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>
48036         </listitem>
48037
48038         <listitem>
48039           <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>
48040         </listitem>
48041       </itemizedlist>
48042     </section>
48043
48044     <section id="misclinks">
48045       <title>Misc</title>
48046
48047       <itemizedlist>
48048         <listitem>
48049           <para>Zotero - <ulink url="http://zotero.org">http://zotero.org</ulink></para>
48050         </listitem>
48051
48052         <listitem>
48053           <para>SOPAC - <ulink url="http://thesocialopac.net/">http://thesocialopac.net</ulink></para>
48054         </listitem>
48055       </itemizedlist>
48056     </section>
48057   </appendix>
48058
48059   <appendix id="XSLTiTypes">
48060     <title>Koha XSLT Item Types</title>
48061
48062     <para>When you have any of the XSLT system preferences (<link linkend="OPACXSLTDetailsDisplay"
48063         >OPACXSLTDetailsDisplay</link>, <link linkend="OPACXSLTResultsDisplay"
48064         >OPACXSLTResultsDisplay</link>, <link linkend="XSLTDetailsDisplay"
48065       >XSLTDetailsDisplay</link>, and/or <link linkend="XSLTResultsDisplay"
48066         >XSLTResultsDisplay</link>) along with the <link linkend="DisplayOPACiconsXSLT"
48067         >DisplayOPACiconsXSLT</link> and <link linkend="DisplayIconsXSLT">DisplayIconsXSLT</link>
48068       preferences turned on you will see item type icons on the related screen. <important>
48069         <para>These images are coming from values found in your leader, if your leader is not
48070           cataloged properly it might be best to turn off the <link linkend="DisplayOPACiconsXSLT"
48071             >DisplayOPACiconsXSLT</link> preference (which can be done while leaving the other XSLT
48072           preferences turned on).</para>
48073       </important></para>
48074
48075     <screenshot>
48076       <screeninfo>Book image</screeninfo>
48077
48078       <mediaobject>
48079         <imageobject>
48080           <imagedata fileref="images/appendix-xslt/book.png"/>
48081         </imageobject>
48082       </mediaobject>
48083     </screenshot>
48084
48085     <itemizedlist>
48086       <listitem>
48087         <para>Book [BK]</para>
48088
48089         <itemizedlist>
48090           <listitem>
48091             <para>leader6 = a (and one of the leader7 values below)</para>
48092
48093             <itemizedlist>
48094               <listitem>
48095                 <para>leader7 = a</para>
48096               </listitem>
48097
48098               <listitem>
48099                 <para>leader7 = c</para>
48100               </listitem>
48101
48102               <listitem>
48103                 <para>leader7 = d</para>
48104               </listitem>
48105
48106               <listitem>
48107                 <para>leader7 = m</para>
48108               </listitem>
48109             </itemizedlist>
48110           </listitem>
48111
48112           <listitem>
48113             <para>leader6 = t</para>
48114           </listitem>
48115         </itemizedlist>
48116       </listitem>
48117     </itemizedlist>
48118
48119     <screenshot>
48120       <screeninfo>Computer Image</screeninfo>
48121
48122       <mediaobject>
48123         <imageobject>
48124           <imagedata fileref="images/appendix-xslt/comp.png"/>
48125         </imageobject>
48126       </mediaobject>
48127     </screenshot>
48128
48129     <itemizedlist>
48130       <listitem>
48131         <para>Computer File [CF]</para>
48132
48133         <itemizedlist>
48134           <listitem>
48135             <para>leader6 = m</para>
48136           </listitem>
48137         </itemizedlist>
48138       </listitem>
48139     </itemizedlist>
48140
48141     <screenshot>
48142       <screeninfo>Continuing Resource Image</screeninfo>
48143
48144       <mediaobject>
48145         <imageobject>
48146           <imagedata fileref="images/appendix-xslt/cr.png"/>
48147         </imageobject>
48148       </mediaobject>
48149     </screenshot>
48150
48151     <itemizedlist>
48152       <listitem>
48153         <para>Continuing Resource [CR]</para>
48154
48155         <itemizedlist>
48156           <listitem>
48157             <para>leader7 = b</para>
48158           </listitem>
48159
48160           <listitem>
48161             <para>leader7 = i</para>
48162           </listitem>
48163
48164           <listitem>
48165             <para>leader7 = s</para>
48166           </listitem>
48167         </itemizedlist>
48168       </listitem>
48169     </itemizedlist>
48170
48171     <screenshot>
48172       <screeninfo>Map Image</screeninfo>
48173
48174       <mediaobject>
48175         <imageobject>
48176           <imagedata fileref="images/appendix-xslt/map.png"/>
48177         </imageobject>
48178       </mediaobject>
48179     </screenshot>
48180
48181     <itemizedlist>
48182       <listitem>
48183         <para>Map [MP]</para>
48184
48185         <itemizedlist>
48186           <listitem>
48187             <para>leader6 = e</para>
48188           </listitem>
48189
48190           <listitem>
48191             <para>leader6 = f</para>
48192           </listitem>
48193         </itemizedlist>
48194       </listitem>
48195     </itemizedlist>
48196
48197     <screenshot>
48198       <screeninfo>Mixed Materials Image</screeninfo>
48199
48200       <mediaobject>
48201         <imageobject>
48202           <imagedata fileref="images/appendix-xslt/mixed.png"/>
48203         </imageobject>
48204       </mediaobject>
48205     </screenshot>
48206
48207     <itemizedlist>
48208       <listitem>
48209         <para>Mixed [MX]</para>
48210
48211         <itemizedlist>
48212           <listitem>
48213             <para>leader6 = p</para>
48214           </listitem>
48215         </itemizedlist>
48216       </listitem>
48217     </itemizedlist>
48218
48219     <screenshot>
48220       <screeninfo>Sound Image</screeninfo>
48221
48222       <mediaobject>
48223         <imageobject>
48224           <imagedata fileref="images/appendix-xslt/sound.png"/>
48225         </imageobject>
48226       </mediaobject>
48227     </screenshot>
48228
48229     <itemizedlist>
48230       <listitem>
48231         <para>Sound [MU]</para>
48232
48233         <itemizedlist>
48234           <listitem>
48235             <para>leader6 = c</para>
48236           </listitem>
48237
48238           <listitem>
48239             <para>leader6 = d</para>
48240           </listitem>
48241
48242           <listitem>
48243             <para>leader6 = i</para>
48244           </listitem>
48245
48246           <listitem>
48247             <para>leader6 = j</para>
48248           </listitem>
48249         </itemizedlist>
48250       </listitem>
48251     </itemizedlist>
48252
48253     <screenshot>
48254       <screeninfo>Visual Material Image</screeninfo>
48255
48256       <mediaobject>
48257         <imageobject>
48258           <imagedata fileref="images/appendix-xslt/visual.png"/>
48259         </imageobject>
48260       </mediaobject>
48261     </screenshot>
48262
48263     <itemizedlist>
48264       <listitem>
48265         <para>Visual Material [VM]</para>
48266
48267         <itemizedlist>
48268           <listitem>
48269             <para>leader6 = g</para>
48270           </listitem>
48271
48272           <listitem>
48273             <para>leader6 = k</para>
48274           </listitem>
48275
48276           <listitem>
48277             <para>leader6 = r</para>
48278           </listitem>
48279         </itemizedlist>
48280       </listitem>
48281     </itemizedlist>
48282
48283     <screenshot>
48284       <screeninfo>Kit Image</screeninfo>
48285
48286       <mediaobject>
48287         <imageobject>
48288           <imagedata fileref="images/appendix-xslt/kit.png"/>
48289         </imageobject>
48290       </mediaobject>
48291     </screenshot>
48292
48293     <itemizedlist>
48294       <listitem>
48295         <para>Kit</para>
48296
48297         <itemizedlist>
48298           <listitem>
48299             <para>leader6 = o</para>
48300           </listitem>
48301         </itemizedlist>
48302       </listitem>
48303     </itemizedlist>
48304   </appendix>
48305
48306   <appendix id="marcedit">
48307     <title>MarcEdit</title>
48308
48309     <para>Download MarcEdit : <ulink url="http://marcedit.reeset.net/"
48310         >http://marcedit.reeset.net/</ulink></para>
48311
48312     <section id="marceditprefix">
48313       <title>Adding a prefix to call numbers</title>
48314
48315       <para>When bringing data into Koha, you may want to first clean it up.
48316       One common action among Koha users is to add a prefix to the call
48317       number.</para>
48318
48319       <itemizedlist>
48320         <listitem>
48321           <para>Open MarcEdit</para>
48322
48323           <screenshot>
48324             <screeninfo>MarcEdit</screeninfo>
48325
48326             <mediaobject>
48327               <imageobject>
48328                 <imagedata fileref="images/appendix-marcedit/marcedit.png"/>
48329               </imageobject>
48330             </mediaobject>
48331           </screenshot>
48332         </listitem>
48333
48334         <listitem>
48335           <para>Click 'MarcEditor'</para>
48336         </listitem>
48337
48338         <listitem>
48339           <para>Go to Tools &gt; Edit Subfield Data</para>
48340
48341           <screenshot>
48342             <screeninfo>Edit subfield data</screeninfo>
48343
48344             <mediaobject>
48345               <imageobject>
48346                 <imagedata fileref="images/appendix-marcedit/marcedit-editsubfield.png"/>
48347               </imageobject>
48348             </mediaobject>
48349           </screenshot>
48350         </listitem>
48351
48352         <listitem>
48353           <para>To prepend data the special character is: ^b  To simply
48354           prepend data to the beginning of a subfield, add ^b to the Field
48355           Data: textbox and the data to be appended in the Replace</para>
48356
48357           <screenshot>
48358             <screeninfo>Prepend data to a field</screeninfo>
48359
48360             <mediaobject>
48361               <imageobject>
48362                 <imagedata fileref="images/appendix-marcedit/editsubfield.png"/>
48363               </imageobject>
48364             </mediaobject>
48365           </screenshot>
48366
48367           <itemizedlist>
48368             <listitem>
48369               <para>To prepend data to the beginning of the subfield while
48370               replacing a text string, add ^b[string to replace] to the Field
48371               Data textbox and the data to be appended in the Replace With
48372               textbox.</para>
48373             </listitem>
48374           </itemizedlist>
48375         </listitem>
48376       </itemizedlist>
48377     </section>
48378
48379     <section id="marceditexcel">
48380       <sectioninfo>
48381         <authorgroup>
48382           <author>
48383             <firstname>Kanika</firstname>
48384             <surname>Goyal</surname>
48385             <affiliation>
48386               <orgname>Delhi Technological University</orgname>
48387             </affiliation>
48388           </author>
48389
48390           <editor>
48391             <firstname>Nicole C.</firstname>
48392             <surname>Engard</surname>
48393             <contrib>Edits where necessary.</contrib>
48394           </editor>
48395         </authorgroup>
48396
48397         <pubdate>2010</pubdate>
48398
48399         <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>
48400       </sectioninfo>
48401       <title>Importing Excel data into Koha</title>
48402
48403       <para>Suppose you have records of your library in excel data sheet
48404       format and want them to import into Koha. But how will you do this? Koha
48405       will not let you import excel records directly. Well here is a very
48406       simple solution for you which will let you import your excel records in
48407       Koha easily. First, we will convert excel file into Marc file and then
48408       will import it into Koha.</para>
48409
48410       <para>Follow the given steps to import your excel records into
48411       Koha</para>
48412
48413       <section id="convertexcel">
48414         <title>Converting from Excel format into .mrk format</title>
48415
48416         <para>First, we will convert excel format into .mrk format. For this we will use MarcEdit.
48417           You can download it from <ulink url="http://marcedit.reeset.net/"
48418             >http://marcedit.reeset.net/</ulink></para>
48419
48420         <para>Now open it and select Add-ins--&gt;Delimited Text
48421         Translator.</para>
48422
48423         <screenshot>
48424           <screeninfo>Delimited Text Translator</screeninfo>
48425
48426           <mediaobject>
48427             <imageobject>
48428               <imagedata fileref="images/appendix-marcedit/excelimport/step-1.png"/>
48429             </imageobject>
48430           </mediaobject>
48431         </screenshot>
48432
48433         <para>Click Next when the following window appears.</para>
48434
48435         <screenshot>
48436           <screeninfo>Delimited Text Translator</screeninfo>
48437
48438           <mediaobject>
48439             <imageobject>
48440               <imagedata fileref="images/appendix-marcedit/excelimport/step-2.png"/>
48441             </imageobject>
48442           </mediaobject>
48443         </screenshot>
48444
48445         <para>Browse for your excel file.</para>
48446
48447         <screenshot>
48448           <screeninfo>Delimited Text Translator</screeninfo>
48449
48450           <mediaobject>
48451             <imageobject>
48452               <imagedata fileref="images/appendix-marcedit/excelimport/step-3.png"/>
48453             </imageobject>
48454           </mediaobject>
48455         </screenshot>
48456
48457         <para>Locate your excel file by choosing the format Excel
48458         File(*.xls).</para>
48459
48460         <screenshot>
48461           <screeninfo>Delimited Text Translator</screeninfo>
48462
48463           <mediaobject>
48464             <imageobject>
48465               <imagedata fileref="images/appendix-marcedit/excelimport/step-4.png"/>
48466             </imageobject>
48467           </mediaobject>
48468         </screenshot>
48469
48470         <para>Similarly, fill all the other entries such as Output File, Excel
48471         Sheet Name and check UTF-8 Encoded (if required) and Click
48472         Next.</para>
48473
48474         <screenshot>
48475           <screeninfo>Delimited Text Translator</screeninfo>
48476
48477           <mediaobject>
48478             <imageobject>
48479               <imagedata fileref="images/appendix-marcedit/excelimport/step-5.png"/>
48480             </imageobject>
48481           </mediaobject>
48482         </screenshot>
48483
48484         <para>Now you will be prompted for mapping the fields to recognise the
48485         fields by standard marc format.</para>
48486
48487         <para>Suppose for Field 0 that is first column I entered Map to:
48488         022$a( Valid ISSN for the continuing resource) and then click on
48489         Apply.</para>
48490
48491         <screenshot>
48492           <screeninfo>Delimited Text Translator</screeninfo>
48493
48494           <mediaobject>
48495             <imageobject>
48496               <imagedata fileref="images/appendix-marcedit/excelimport/step-6.png"/>
48497             </imageobject>
48498           </mediaobject>
48499         </screenshot>
48500
48501         <note>
48502           <para>You can customize Indicators and all other things, for more
48503           information on marc21 format visit the <ulink url="http://www.loc.gov/marc/bibliographic/">official library of
48504           congress site</ulink>.</para>
48505         </note>
48506
48507         <para>Similarly map all other fields and then Click on Finish.</para>
48508
48509         <screenshot>
48510           <screeninfo>Delimited Text Translator</screeninfo>
48511
48512           <mediaobject>
48513             <imageobject>
48514               <imagedata fileref="images/appendix-marcedit/excelimport/step-7.png"/>
48515             </imageobject>
48516           </mediaobject>
48517         </screenshot>
48518
48519         <para>And then a window will appear indicating that your Marc Text
48520         File(*.mrk) has been created.</para>
48521
48522         <screenshot>
48523           <screeninfo>Delimited Text Translator</screeninfo>
48524
48525           <mediaobject>
48526             <imageobject>
48527               <imagedata fileref="images/appendix-marcedit/excelimport/step-8.png"/>
48528             </imageobject>
48529           </mediaobject>
48530         </screenshot>
48531
48532         <para>Click Close and we have created a .mrk file from .xls file in
48533         this step. You can view the file by double clicking on it.</para>
48534       </section>
48535
48536       <section id="convertmrk">
48537         <title>Convert .mrk file to .mrc</title>
48538
48539         <para>We will convert .mrk file that we have created in the above step
48540         into raw Marc format that can be directly imported into Koha.</para>
48541
48542         <para>For this again open MarcEdit and Select MARC Tools.</para>
48543
48544         <screenshot>
48545           <screeninfo>MARC Tools</screeninfo>
48546
48547           <mediaobject>
48548             <imageobject>
48549               <imagedata fileref="images/appendix-marcedit/excelimport/step-9.png"/>
48550             </imageobject>
48551           </mediaobject>
48552         </screenshot>
48553
48554         <para>Next Select MarcMaker to convert .mrk file into .mrc
48555         format.</para>
48556
48557         <screenshot>
48558           <screeninfo>MarcMaker</screeninfo>
48559
48560           <mediaobject>
48561             <imageobject>
48562               <imagedata fileref="images/appendix-marcedit/excelimport/step-10.png"/>
48563             </imageobject>
48564           </mediaobject>
48565         </screenshot>
48566
48567         <para>Locate your input file and name your output file. Then Click
48568         Execute.</para>
48569
48570         <screenshot>
48571           <screeninfo>MarcMaker</screeninfo>
48572
48573           <mediaobject>
48574             <imageobject>
48575               <imagedata fileref="images/appendix-marcedit/excelimport/step-11.png"/>
48576             </imageobject>
48577           </mediaobject>
48578         </screenshot>
48579
48580         <para>And it will show you the Result.</para>
48581
48582         <screenshot>
48583           <screeninfo>MarcMaker</screeninfo>
48584
48585           <mediaobject>
48586             <imageobject>
48587               <imagedata fileref="images/appendix-marcedit/excelimport/step-12.png"/>
48588             </imageobject>
48589           </mediaobject>
48590         </screenshot>
48591
48592         <para>Click Close and now we have raw Marc records with us (.mrc
48593         file).</para>
48594       </section>
48595
48596       <section id="importmrc">
48597         <title>Import .mrc into Koha</title>
48598
48599         <para>More information on importing records into Koha can be found in
48600         the '<link linkend="stagemarc">Stage MARC Records for Import</link>'
48601         section of this manual.</para>
48602
48603         <para>Finally we will import above created .mrc file into Koha.</para>
48604
48605         <para>Click on Tools in your Koha staff client.</para>
48606
48607         <screenshot>
48608           <screeninfo>Koha Staff Client</screeninfo>
48609
48610           <mediaobject>
48611             <imageobject>
48612               <imagedata fileref="images/appendix-marcedit/excelimport/step-13.png"/>
48613             </imageobject>
48614           </mediaobject>
48615         </screenshot>
48616
48617         <para>Next Click on Stage MARC Records for Import.</para>
48618
48619         <screenshot>
48620           <screeninfo>Stage MARC Records for Import</screeninfo>
48621
48622           <mediaobject>
48623             <imageobject>
48624               <imagedata fileref="images/appendix-marcedit/excelimport/step-14.png"/>
48625             </imageobject>
48626           </mediaobject>
48627         </screenshot>
48628
48629         <para>After this, choose your previously created .mrc file and click
48630         on Upload.</para>
48631
48632         <screenshot>
48633           <screeninfo>Stage File</screeninfo>
48634
48635           <mediaobject>
48636             <imageobject>
48637               <imagedata fileref="images/appendix-marcedit/excelimport/step-15.png"/>
48638             </imageobject>
48639           </mediaobject>
48640         </screenshot>
48641
48642         <para>You can also add comment about file and finally click on Stage
48643         For Import.</para>
48644
48645         <screenshot>
48646           <screeninfo>Stage for Import</screeninfo>
48647
48648           <mediaobject>
48649             <imageobject>
48650               <imagedata fileref="images/appendix-marcedit/excelimport/step-17.png"/>
48651             </imageobject>
48652           </mediaobject>
48653         </screenshot>
48654
48655         <para>When the import is done, you will get a result something like
48656         this</para>
48657
48658         <screenshot>
48659           <screeninfo>Staged Records Summary</screeninfo>
48660
48661           <mediaobject>
48662             <imageobject>
48663               <imagedata fileref="images/appendix-marcedit/excelimport/step-18.png"/>
48664             </imageobject>
48665           </mediaobject>
48666         </screenshot>
48667
48668         <para>Next, click on Manage staged records.</para>
48669
48670         <para>Here you can even change matching rules.</para>
48671
48672         <screenshot>
48673           <screeninfo>Manage Staged Records</screeninfo>
48674
48675           <mediaobject>
48676             <imageobject>
48677               <imagedata fileref="images/appendix-marcedit/excelimport/step-19.png"/>
48678             </imageobject>
48679           </mediaobject>
48680         </screenshot>
48681
48682         <para>Click on Import this batch into catalog when you are
48683         done.</para>
48684
48685         <para>Thats it. After all the records get imported, check Status and
48686         it should read "imported"</para>
48687
48688         <screenshot>
48689           <screeninfo>Finalize Import</screeninfo>
48690
48691           <mediaobject>
48692             <imageobject>
48693               <imagedata fileref="images/appendix-marcedit/excelimport/step-20.png"/>
48694             </imageobject>
48695           </mediaobject>
48696         </screenshot>
48697
48698         <para>You can even undo the Import operation.</para>
48699
48700         <para>And within few minutes, we have imported around 10,000 records
48701         in Koha</para>
48702       </section>
48703     </section>
48704   </appendix>
48705
48706   <appendix id="talkingtechappendix">
48707     <title>Talking Tech</title>
48708
48709     <para>Talking Tech I-tiva is a third party, proprietary, product that
48710     libraries can subscribe to. Learn more here: <ulink url="http://www.talkingtech.com/solutions/library">http://www.talkingtech.com/solutions/library</ulink>.</para>
48711
48712     <section id="talkingtechinstall">
48713       <title>Installation and Setup Instructions</title>
48714
48715       <para>Be sure you've run
48716       installer/data/mysql/atomicupdate/Bug-4246-Talking-Tech-itiva-phone-notifications.pl
48717       to install the required data pack (new syspref, notice placeholders and
48718       messaging transport preferences)</para>
48719
48720       <para>To use, <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link>
48721       syspref must be turned on.</para>
48722
48723       <para>If you wish to process PREOVERDUE or RESERVES messages, you'll
48724       need the <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
48725       system preference turned on, and patrons to have filled in a preference
48726       for receiving these notices by phone.</para>
48727
48728       <para>For OVERDUE messages, overdue notice triggers must be configured
48729       under Koha -&gt; Tools -&gt; <link linkend="noticetriggers">Overdue
48730       Notice Triggers</link>. Either branch-specific triggers or the default
48731       level triggers may be used (script will select whichever is
48732       appropriate).</para>
48733     </section>
48734
48735     <section id="talkingtechsend">
48736       <title>Sending Notices File</title>
48737
48738       <orderedlist>
48739         <listitem>
48740           <para>Add the <link linkend="talkingtechsendcron">TalkingTech_itiva_outbound.pl</link>
48741           script to your crontab</para>
48742         </listitem>
48743
48744         <listitem>
48745           <para>Add an FTP/SFTP or other transport method to send the output
48746           file to the I-tiva server</para>
48747         </listitem>
48748
48749         <listitem>
48750           <para>If you wish, archive the sent notices file in another
48751           directory after sending</para>
48752         </listitem>
48753       </orderedlist>
48754
48755       <para>Run TalkingTech_itiva_outbound.pl --help for more
48756       information</para>
48757     </section>
48758
48759     <section id="talkingtechreceive">
48760       <title>Receiving Results File</title>
48761
48762       <orderedlist>
48763         <listitem>
48764           <para>Add an FTP/SFTP or other transport method to send the Results
48765           file to a known directory on your Koha server</para>
48766         </listitem>
48767
48768         <listitem>
48769           <para>Add the <link linkend="talkingtechreceivecron">TalkingTech_itiva_inbound.pl</link>
48770           script to your crontab, aimed at that directory</para>
48771         </listitem>
48772
48773         <listitem>
48774           <para>If you wish, archive the results file in another directory
48775           after processing</para>
48776         </listitem>
48777       </orderedlist>
48778
48779       <para>Run TalkingTech_itiva_inbound.pl --help for more
48780       information</para>
48781     </section>
48782   </appendix>
48783   <appendix id="oclcappendix">
48784     <title>OCLC Connexion Gateway</title>
48785     <para>Koha can be set to work with the OCLC Connextion Gateway.  This allows libraries to use
48786       OCLC Connexion as their cataloging tool and simply send those records to Koha with a single
48787       click.  The following instructions will help you set up the OCLC Connexion Gateway, if you
48788       have a system administrator you will want to consult with them on this process.</para>
48789     <section id="oclckohasetup">
48790             <sectioninfo>
48791               <authorgroup>
48792                 <author>
48793                   <firstname>D. Ruth</firstname>
48794                   <surname>Bavousett</surname>
48795                   <affiliation>
48796                     <orgname>ByWater Solutions</orgname>
48797                   </affiliation>
48798                 </author>
48799
48800                 <editor>
48801                   <firstname>Nicole C.</firstname>
48802                   <surname>Engard</surname>
48803                 </editor>
48804               </authorgroup>
48805
48806           <pubdate>2012</pubdate>
48807         </sectioninfo>
48808       <title>Setting up OCLC service on Koha</title>
48809       <para>First, you'll need to create a file somewhere on your system with configuration
48810         information.  You could put this anywhere that is visible to the account that will be
48811         running the service. </para>
48812       <para>The file contains 11 lines. The first 6 will be about your Koha
48813         system:<programlisting>host: The IP address of your Koha server
48814 port: The port you want to use for the Connexion service. This port must be different from your SIP port, or any other service
48815 koha: The full URL of your staff client
48816 log: The location (full file specification) of your log for the service
48817 user: The default Koha username to use for importing
48818 password: The password that goes with that username</programlisting></para>
48819       <para>The remaining lines describe how to do the staging:
48820         <programlisting>match: The name of the matching rule from your system to use
48821 overlay_action: "replace", "create_new", or "ignore"-- what to do if there is a match
48822 nomatch_action: "create_new" or "ignore"-- what to do if there is no match
48823 item_action: "always_add","add_only_for_matches","add_only_for_new", or "ignore" -- what to do with embedded 952 item data
48824 import_mode: "direct" or "stage"</programlisting></para>
48825       <para> A sample file would look like
48826         this:<programlisting>host: 1.2.3.4
48827 port: 8000
48828 log: /home/koha/koha-dev/var/log/connexion.log
48829 koha: http://kohastaff.myuniversity.edu
48830 user: koha_generic_staff
48831 password: password
48832 match: 001
48833 overlay_action: replace
48834 nomatch_action: create_new
48835 item_action: ignore
48836 import_mode: direct</programlisting></para>
48837       <para>When choosing an 'import_mode' if you use "direct" then the staged record will be
48838         immediately imported into Koha, and should be searchable after your indexes catch up.  If
48839         you choose "stage", then the record will be placed in a staged batch for you to later go the
48840           <link linkend="managestaged">Managed Staged MARC Records</link> tool to finish the import. </para>
48841       <para>If you import multiple records, they'll be in the same batch, until that batch is
48842         imported, then a new batch will be created. </para>
48843       <para>In "direct" mode, each record will be in its' own batch. </para>
48844       <para>To start the service, run the script:
48845         <programlisting>/location/of/connexion/import/daemon/connexion_import_daemon.pl -d -c /location/of/config/file.cnf</programlisting></para>
48846     </section>
48847     <section id="oclcdesktopsetup">
48848       <sectioninfo>
48849         <authorgroup>
48850           <author>
48851             <firstname>D. Ruth</firstname>
48852             <surname>Bavousett</surname>
48853             <affiliation>
48854               <orgname>ByWater Solutions</orgname>
48855             </affiliation>
48856           </author>
48857
48858           <author>
48859             <firstname>Heather</firstname>
48860             <surname>Hernandez</surname>
48861             <affiliation>
48862               <orgname>San Francisco Maritime National Historical Park</orgname>
48863             </affiliation>
48864           </author>
48865
48866           <editor>
48867             <firstname>Nicole C.</firstname>
48868             <surname>Engard</surname>
48869           </editor>
48870         </authorgroup>
48871
48872         <pubdate>2012/2014</pubdate>
48873       </sectioninfo>
48874       <title>Setting up your OCLC desktop client</title>
48875       <note>
48876         <para>Screenshots are OCLC Connexion Client v.2.50, Koha v.3.12</para>
48877       </note>
48878       <para>To set up the OCLC Connexion desktop client to connect to Koha, go to Tools > Options,
48879         then choose the Export tab. <screenshot>
48880           <screeninfo>Connexion Export Tab</screeninfo>
48881           <mediaobject>
48882             <imageobject>
48883               <imagedata fileref="images/appendix-oclc/oclcexporttab.png"/>
48884             </imageobject>
48885           </mediaobject>
48886         </screenshot><itemizedlist>
48887           <listitem>
48888             <para>Click the "Create..." button to set up a new destination, then choose "OCLC
48889               Gateway Export" and click OK.</para>
48890             <itemizedlist>
48891               <listitem>
48892                 <para>Enter the following information:</para>
48893
48894               <itemizedlist>
48895               <listitem>
48896                     <para>"Host Name:" Your catalog’s appropriate IP address (from your <link
48897                         linkend="oclckohasetup">config file above</link>) </para>
48898                   </listitem>
48899                   <listitem>
48900                     <para>"Port:" Your catalog's appropriate port number (from your <link
48901                         linkend="oclckohasetup">config file above</link>) </para>
48902                   </listitem>
48903                   <listitem>
48904                     <para>"Login ID:" The cataloger's Koha login </para>
48905                   </listitem>
48906                   <listitem>
48907                     <para>"Password:" The cataloger's Koha password </para>
48908                   </listitem>
48909                   <listitem>
48910                     <para>"Notify Host Before Disconnect" = checked, </para>
48911                   </listitem>
48912                   <listitem>
48913                     <para>"Timeout" = 100, "Retries" = 3, "Delay" = 0 (zero), </para>
48914                   </listitem>
48915                   <listitem>
48916                     <para>"Send Local System Logon ID  Password" = checked. </para>
48917                   </listitem>
48918               </itemizedlist>
48919               </listitem>
48920             </itemizedlist>
48921             <screenshot>
48922               <screeninfo>OCLC Gateway Export Settings</screeninfo>
48923               <mediaobject>
48924                 <imageobject>
48925                   <imagedata fileref="images/appendix-oclc/oclcgatewaysetup.png"/>
48926                 </imageobject>
48927               </mediaobject>
48928             </screenshot>
48929           </listitem>
48930           <listitem>
48931             <para>Select "OK" when finished, and you should see your new "Gateway Export" option
48932               listed (The catalog's IP address and port are blacked out in the following
48933               screenshot)</para>
48934             <para>
48935               <screenshot>
48936                 <screeninfo>Gateway Export Added</screeninfo>
48937                 <mediaobject>
48938                   <imageobject>
48939                     <imagedata fileref="images/appendix-oclc/oclcgatewayexport.png"/>
48940                   </imageobject>
48941                 </mediaobject>
48942               </screenshot>
48943             </para>
48944           </listitem>
48945           <listitem>
48946             <para>Click on "Record Characteristics" and make sure that the bibliographic records are
48947               using MARC21, UTF-8 Unicode, and click OK to save. </para>
48948             <para>
48949               <screenshot>
48950                 <screeninfo>Record Characteristics</screeninfo>
48951                 <mediaobject>
48952                   <imageobject>
48953                     <imagedata fileref="images/appendix-oclc/oclcrecordchar.png"/>
48954                   </imageobject>
48955                 </mediaobject>
48956               </screenshot>
48957             </para>
48958           </listitem>
48959         </itemizedlist></para>
48960       <para>You should be ready to go!  To export a record from OCLC Connexion Client to Koha, just
48961         press F5 while the record is on-screen.  The export dialog will pop up, and you'll see
48962         Connexion attempting to talk to Koha.  You should get a message that the record was added or
48963         overlaid, including its biblio number, and a URL that you can copy into your web browser to
48964         jump straight to the record. </para>
48965     </section>
48966     <section id="oclcgateway">
48967       <sectioninfo>
48968         <authorgroup>
48969           <author>
48970             <firstname>Heather</firstname>
48971             <surname>Hernandez</surname>
48972             <affiliation>
48973               <orgname>San Francisco Maritime National Historical Park</orgname>
48974             </affiliation>
48975           </author>
48976           <editor>
48977             <firstname>Nicole C.</firstname>
48978             <surname>Engard</surname>
48979           </editor>
48980         </authorgroup>
48981         <pubdate>2014</pubdate>
48982       </sectioninfo>
48983       <title>Using the OCLC Connexion Gateway</title>
48984       <para>Records can be exported from Connexion either in a batch or one by one.  </para>
48985       <section id="oclconeexport">
48986         <title>Exporting records one by one</title>
48987         <para>To export bibliographic records one by one, be sure your "Batch" options are correct:
48988           from the "Tools" menu, select "Options", and select the "Batch" tab. In the "Perform local
48989           actions in batch" area, "Bibliographic Record Export" should be unchecked<screenshot>
48990             <screeninfo>Connexion batch options</screeninfo>
48991             <mediaobject>
48992               <imageobject>
48993                 <imagedata fileref="images/appendix-oclc/oclcoptions.png"/>
48994               </imageobject>
48995             </mediaobject>
48996           </screenshot></para>
48997         <para>When ready to export, from the "Action" menu, select "Export" or use the F5 key. You
48998           will see a screen similar to the following if the import is successful and if the record
48999           is new to the Catalog; you may copy &amp; paste the resulting URL into your Koha catalog
49000           to see the new record.<screenshot>
49001             <screeninfo>Connexion Export</screeninfo>
49002             <mediaobject>
49003               <imageobject>
49004                 <imagedata fileref="images/appendix-oclc/oclcstatus.png"/>
49005               </imageobject>
49006             </mediaobject>
49007           </screenshot></para>
49008         <para>If the record was overlaid, you will see a message to that effect in the "OCLC Gateway
49009           Export Status" window<screenshot>
49010             <screeninfo>Overlay confirmation</screeninfo>
49011             <mediaobject>
49012               <imageobject>
49013                 <imagedata fileref="images/appendix-oclc/oclcoverlay.png"/>
49014               </imageobject>
49015             </mediaobject>
49016           </screenshot></para>
49017       </section>
49018       <section id="oclcbatchexport">
49019         <title>Exporting records in a batch</title>
49020         <para>To export bibliographic records in a batch, be sure your "Batch" options are correct:
49021           from the "Tools" menu, select "Options", and select the "Batch" tab. In the "Perform local
49022           actions in batch" area, "Bibliographic Record Export" should be checked<screenshot>
49023             <screeninfo>OCLC Batch Export Options</screeninfo>
49024             <mediaobject>
49025               <imageobject>
49026                 <imagedata fileref="images/appendix-oclc/oclcexportbatch.png"/>
49027               </imageobject>
49028             </mediaobject>
49029           </screenshot></para>
49030         <para>When a record is ready to export, from the "Action" menu, select "Export" or use the
49031           F5 key, and it’s export status will be "ready." </para>
49032         <para>When ready to export the batch, from the "Batch" menu, select "Process batch" and
49033           check the appropriate "Path" and "Export" boxes<screenshot>
49034             <screeninfo>Batch import process</screeninfo>
49035             <mediaobject>
49036               <imageobject>
49037                 <imagedata fileref="images/appendix-oclc/oclcprocessbatch.png"/>
49038               </imageobject>
49039             </mediaobject>
49040           </screenshot></para>
49041         <para>The export will begin, and the bib records will be exported &amp; imported into Koha
49042           one by one; you will see "OCLC Gateway Export Status" windows, as above, showing you the
49043           results of each export. That window will stay there until you select "Close," and then the
49044           next record’s export/import will begin. The process will continue until all records in the
49045           batch are completed. Then you may or may not see the Connexion Client export report
49046           (depending on your Client options for that). </para>
49047       </section>
49048     </section>
49049   </appendix>
49050
49051   <appendix id="faqs">
49052     <title>FAQs</title>
49053
49054     <para/>
49055
49056     <section id="displayfaq">
49057       <title>Display</title>
49058
49059       <para/>
49060
49061       <section id="customicons">
49062         <title>Custom Item Type/Authorized Value Icons</title>
49063
49064         <para><emphasis role="bold">Question:</emphasis> Can I have my own set
49065         of item type images (or authorized value icons)?</para>
49066
49067         <para><emphasis role="bold">Answer: </emphasis>Absolutely. To add
49068         additional icons to your system you simply add a new directory to
49069         koha-tmpl/intranet-tmpl/prog/img/itemtypeimg/ and to
49070         koha-tmpl/opac-tmpl/prog/itemtypeimg and put your icons in the new
49071         directory. Your icons will show up in a new tab as soon as they are in
49072         the folders.</para>
49073
49074         <itemizedlist>
49075           <listitem>
49076             <note>
49077               <para>Remember to put the icons in both places (on the OPAC and
49078               the intranet).</para>
49079             </note>
49080           </listitem>
49081         </itemizedlist>
49082       </section>
49083
49084       <section id="customkohaimages">
49085         <title>Customizing Koha Images</title>
49086
49087         <para><emphasis role="bold">Question</emphasis>: Can I customize the
49088         images in the OPAC?</para>
49089
49090         <para><emphasis role="bold">Answer</emphasis>: Absolutely. Koha comes
49091         with a series of original images that you can alter to meet your
49092         needs. The originals can be found in the misc/interface_customization/
49093         directory.</para>
49094       </section>
49095
49096       <section id="opacdisplayfaq">
49097         <title>OPAC Display Fields</title>
49098
49099         <para><emphasis role="bold">Question</emphasis>: What MARC fields
49100         print to the different OPAC screens in Koha?</para>
49101
49102         <para><emphasis role="bold">Answer</emphasis>: The XSLT preference
49103         must be set as follows for the following fields to show</para>
49104
49105         <itemizedlist>
49106           <listitem>
49107             <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> =
49108             using XSLT stylesheets</para>
49109           </listitem>
49110
49111           <listitem>
49112             <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
49113             using XSLT stylesheets</para>
49114           </listitem>
49115
49116           <listitem>
49117             <para><link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> =
49118             show</para>
49119           </listitem>
49120         </itemizedlist>
49121
49122         <para>The OPAC Results page shows:</para>
49123
49124         <itemizedlist>
49125           <listitem>
49126             <para>245</para>
49127           </listitem>
49128
49129           <listitem>
49130             <para>100, 110, 111</para>
49131           </listitem>
49132
49133           <listitem>
49134             <para>700, 710, 711</para>
49135           </listitem>
49136
49137           <listitem>
49138             <para>250</para>
49139           </listitem>
49140
49141           <listitem>
49142             <para>260</para>
49143           </listitem>
49144
49145           <listitem>
49146             <para>246</para>
49147           </listitem>
49148
49149           <listitem>
49150             <para>856</para>
49151           </listitem>
49152         </itemizedlist>
49153
49154         <para>The OPAC Details page shows:</para>
49155
49156         <itemizedlist>
49157           <listitem>
49158             <para>245</para>
49159           </listitem>
49160
49161           <listitem>
49162             <para>100, 110, 111</para>
49163           </listitem>
49164
49165           <listitem>
49166             <para>700, 710, 711</para>
49167           </listitem>
49168
49169           <listitem>
49170             <para>440, 490</para>
49171           </listitem>
49172
49173           <listitem>
49174             <para>260</para>
49175           </listitem>
49176
49177           <listitem>
49178             <para>250</para>
49179           </listitem>
49180
49181           <listitem>
49182             <para>300</para>
49183           </listitem>
49184
49185           <listitem>
49186             <para>020</para>
49187           </listitem>
49188
49189           <listitem>
49190             <para>022</para>
49191           </listitem>
49192
49193           <listitem>
49194             <para>246</para>
49195           </listitem>
49196
49197           <listitem>
49198             <para>130, 240</para>
49199           </listitem>
49200
49201           <listitem>
49202             <para>6xx</para>
49203           </listitem>
49204
49205           <listitem>
49206             <para>856</para>
49207           </listitem>
49208
49209           <listitem>
49210             <para>505</para>
49211           </listitem>
49212
49213           <listitem>
49214             <para>773</para>
49215           </listitem>
49216
49217           <listitem>
49218             <para>520</para>
49219           </listitem>
49220
49221           <listitem>
49222             <para>866</para>
49223           </listitem>
49224
49225           <listitem>
49226             <para>775</para>
49227           </listitem>
49228
49229           <listitem>
49230             <para>780</para>
49231           </listitem>
49232
49233           <listitem>
49234             <para>785</para>
49235           </listitem>
49236
49237           <listitem>
49238             <para>plus all of the 5xx fields in the Notes tab at the
49239             bottom</para>
49240           </listitem>
49241         </itemizedlist>
49242       </section>
49243
49244       <section id="displaysubtitle">
49245         <title>Subtitle Display on Bib Records</title>
49246
49247         <para><emphasis role="bold">Question</emphasis>: How do I get the
49248         subtitle to display on the detail pages for my bib records?</para>
49249
49250         <para><emphasis role="bold">Answer</emphasis>: Subtitle display now
49251         depends on there being a <link linkend="keywordmapping">keyword
49252         mapping</link> for the MARC field in question. Adding a mapping for
49253         "subtitle" -&gt; "245b" for an item's framework results in display of
49254         the subtitle in OPAC and staff client search and detail pages
49255         (although not in all instances where subtitles might be displayed,
49256         e.g. the Cart).</para>
49257       </section>
49258
49259       <section id="opacbarcodesfaq">
49260         <title>Show patrons the barcodes of items they have checked
49261         out</title>
49262
49263         <para><emphasis role="bold">Question</emphasis>: Can patrons see the
49264         barcodes for the items they have checked out.</para>
49265
49266         <para><emphasis role="bold">Answer</emphasis>: Not by default, but
49267         with a few edits to the patron record you can make a barcode column
49268         appear on the patron's check out summary in the OPAC. You can set up a
49269         <link linkend="patronattributetypes">patron attribute</link> with the
49270         value of SHOW_BCODE and <link linkend="authorizedvalues">authorized
49271         value</link> of YES_NO to make this happen.</para>
49272
49273         <screenshot>
49274           <screeninfo>Add SHOW_BCODE patron attribute</screeninfo>
49275
49276           <mediaobject>
49277             <imageobject>
49278               <imagedata fileref="images/opac/SHOW_BCODEadd.png"/>
49279             </imageobject>
49280           </mediaobject>
49281         </screenshot>
49282
49283         <para>Then on the <link linkend="editpatrons">patron's record set the
49284         value</link> for SHOW_BCODE to yes.</para>
49285
49286         <screenshot>
49287           <screeninfo>Setting value for SHOW_BCODE on patron
49288           record</screeninfo>
49289
49290           <mediaobject>
49291             <imageobject>
49292               <imagedata fileref="images/opac/SHOW_BCODEattribute.png"/>
49293             </imageobject>
49294           </mediaobject>
49295         </screenshot>
49296
49297         <para>This will add a column to the check out summary in the OPAC that
49298         shows the patrons the barcodes of the items they have checked
49299         out.</para>
49300
49301         <screenshot>
49302           <screeninfo>Barcode number on checkout list in OPAC</screeninfo>
49303
49304           <mediaobject>
49305             <imageobject>
49306               <imagedata fileref="images/opac/barcodeoncheckouts.png"/>
49307             </imageobject>
49308           </mediaobject>
49309         </screenshot>
49310
49311         <para>Clicking on the 'Overdue' tab will show only the items that are
49312         overdue.</para>
49313       </section>
49314     </section>
49315
49316     <section id="circfaq">
49317       <title>Circulation/Notices</title>
49318
49319       <para/>
49320
49321       <section id="dropboxfaq">
49322         <title>Book drop Date</title>
49323
49324         <para><emphasis role="bold">Question</emphasis>: How is the book drop date is determined? Is
49325           it the last open date for the checkout branch? Is it today's date minus one? Can the book
49326           drop checkin date be set?</para>
49327
49328         <para><emphasis role="bold">Answer</emphasis>: If the library is closed for four days for
49329           renovations, for example, there would be more than one day needed for the book drop date.
49330           You will only have one book drop date and that will be the last day that the library open
49331           (determined by the holiday calendar) because there is no real way to know what day the
49332           books were dropped into the box during the 4 closed days. The only way to change the
49333           effective checkin date in book drop mode is to modify the calendar.</para>
49334       </section>
49335       <section id="holdsreportsfaq">
49336         <title>Holds to Pull and Holds Queue</title>
49337         <para><emphasis role="bold">Question</emphasis>: What is the difference between the <link linkend="holdsqueue">Holds Queue</link> and <link linkend="holdspull">Holds to
49338             Pull</link>?</para>
49339         <para><emphasis role="bold">Answer</emphasis>: The holds to pull report gives a simple list
49340           of what holds need to be filled with available items. It should only be used in Koha
49341           installations where there is only one library. </para>
49342         <para>The holds queue tries to do the same thing, but in a 'smarter' way. This allows it to
49343           split up the list by library, consult the <link linkend="transportcostmatrix">transport
49344             cost matrix</link> and refresh regularly to provide different pull lists to each
49345           library.</para>
49346       </section>
49347
49348       <section id="dupoverduefaq">
49349         <title>Duplicate Overdue Notices</title>
49350
49351         <para><emphasis role="bold">Question</emphasis>: Why are patrons
49352         getting two overdue notices?</para>
49353
49354         <para><emphasis role="bold">Answer</emphasis>: This tool takes all
49355         branches in the overdue rules and sent notifications to them. So, if
49356         you have a default rule &amp; a branch rule, the notification will be
49357         generated twice. A quick fix is to discard "default rule" for
49358         instance.</para>
49359       </section>
49360
49361       <section id="printoverduefaq">
49362         <title>Printing Overdue Notices</title>
49363
49364         <para><emphasis role="bold">Question</emphasis>: Can I print overdue
49365         notices for patrons without email addresses on file?</para>
49366
49367         <para><emphasis role="bold">Answer</emphasis>: Yes. The <link linkend="overduenoticecron">overdue notice cron job</link> has a
49368         setting to generate the overdue notices as HTML for printing. An
49369         example of this usage would be:</para>
49370
49371         <para><programlisting>overdue_notices.pl -t -html /tmp/noticedir -itemscontent issuedate,date_due,title,barcode,author </programlisting>In
49372         this example, we wanted to use only certain item fields in our
49373         notices, so we specified itemscontent fields in the cron entry; that's
49374         not a requirement for the feature.</para>
49375
49376         <para>The command line needs to specify a web-accessible directory
49377         where the print notices will go -- they get a filename like
49378         notices-2009-11-24.html (or holdnotices-2009-11-24.html). The overdue
49379         notice itself can be formatted to fit a Z-mailer. Within the notice
49380         file, the text is spaced down or over to where it will print properly
49381         on the form. The script has code that wraps around the notice file to
49382         tell the HTML to obey the formatting, and to do a page break between
49383         notices. That's so that when staff print it out, they get one per
49384         page. We had to add an extra syspref (<link linkend="PrintNoticesMaxLines">PrintNoticesMaxLines</link>) to specify
49385         page length because our client allows a _lot_ of checkouts which meant
49386         some notices were running onto multiple pages. That syspref says to
49387         truncate the print notice at that page length and put in a message
49388         about go check your OPAC account for the full list.</para>
49389
49390         <para>The print and email overdues use the same notice file. The print
49391         notices for holds are different -- there's a separate HOLD_PRINT
49392         notice file and the system uses it if there's no email address. Then a
49393         nightly cron job runs to gather those up from the message queue and
49394         put them in an HTML file in the notice directory, as above.</para>
49395
49396         <para>The cron entry is gather_print_notices.pl /tmp/noticedir</para>
49397       </section>
49398
49399       <section id="renewfaq">
49400         <title>Unable to Renew Items</title>
49401
49402         <para><emphasis role="bold">Question</emphasis>: We're trying to renew
49403         some items for our patron. One of the items is on hold and ineligible
49404         for renewal, but the other two items refuse to renew even though they
49405         should be eligible. When I try to use the override renewal limit, it
49406         just returns a little message that says "renewal failed". Any idea
49407         what's going on here?</para>
49408
49409         <para><emphasis role="bold">Answer</emphasis>: At the very least you will need to set an
49410           absolute <link linkend="circfinerules">default circulation rule</link>. This rule should
49411           be set for the default itemtype, default branchcode and default patron category. That will
49412           catch anyone who doesn't match a specific rule. Patrons who do not match a specific rule
49413           will get blocked from placing holds or renewing items, since there was no baseline number
49414           of holds or renewals to utilize.</para>
49415       </section>
49416
49417       <section id="holdsfaq">
49418         <title>Unable to Place Holds</title>
49419
49420         <para><emphasis role="bold">Question</emphasis>: Why can't I place
49421         holds when I have all of the preferences turned on.</para>
49422
49423         <para><emphasis role="bold">Answer</emphasis>: You probably need to
49424         set a default circulation rule. At the very least you will need to set
49425         an default circulation rule. This rule should be set for all item
49426         types, all branches and all patron categories. That will catch all
49427         instances that do not match a specific rule. When checking out if you
49428         do not have a rule for the default branch, default item and default
49429         patron category then you may see patrons getting blocked from placing
49430         holds.</para>
49431       </section>
49432
49433       <section id="keyboardshort">
49434         <title>Keyboard Shortcuts</title>
49435
49436         <para><emphasis role="bold">Question</emphasis>: Do I have to use my
49437         mouse to access the checkout, checkin and cataloging tabs at the top
49438         of the circulation pages?</para>
49439
49440         <para><emphasis role="bold">Answer</emphasis>: You can jump between
49441         the tabs on the quick search box at the top of the screen by using the
49442         following hot keys (if the tab is available):</para>
49443
49444         <itemizedlist>
49445           <listitem>
49446             <para>jump to the catalog search with Alt+Q</para>
49447           </listitem>
49448
49449           <listitem>
49450             <para>jump to the checkout with Alt+U</para>
49451
49452             <itemizedlist>
49453               <listitem>
49454                 <para>this will not work for Mac user</para>
49455               </listitem>
49456             </itemizedlist>
49457           </listitem>
49458
49459           <listitem>
49460             <para>jump to the checkin with Alt+R</para>
49461           </listitem>
49462         </itemizedlist>
49463
49464         <para><note>
49465             <para>Mac users use the OPTION button in place of ALT</para>
49466           </note></para>
49467       </section>
49468
49469       <section id="smsnoticefaq">
49470         <title>SMS Notices/Messages</title>
49471
49472         <para><emphasis role="bold">Question</emphasis>: I want Koha to send
49473         notices via SMS, what do I need to do?</para>
49474
49475         <para><emphasis role="bold">Answer</emphasis>: First you need to
49476         choose a SMS service to use with Koha. There is a list available here:
49477         <ulink url="http://search.cpan.org/search?query=sms%3A%3Asend&amp;mode=all">http://search.cpan.org/search?query=sms%3A%3Asend&amp;mode=all</ulink>
49478         Not all SMS services available to libraries have Perl drivers, so be
49479         sure to check this list to see if the provider you're considering is
49480         listed. If not you want to ask your provider if they have a Perl
49481         module, if not you should consider another service. Some common
49482         options in the US (that have Perl drivers) are:</para>
49483
49484         <itemizedlist>
49485           <listitem>
49486             <para>AQL (<ulink url="http://www.aql.com">www.aql.com</ulink>)</para>
49487           </listitem>
49488
49489           <listitem>
49490             <para>Wadja (<ulink url="http://wadja.com">wadja.com</ulink>)</para>
49491           </listitem>
49492
49493           <listitem>
49494             <para>Ipipi (<ulink url="http://ipipi.com">ipipi.com</ulink>)</para>
49495           </listitem>
49496
49497           <listitem>
49498             <para>T-mobile</para>
49499           </listitem>
49500
49501           <listitem>
49502             <para>SMSDiscount (<ulink url="http://smsdiscount.com">smsdiscount.com</ulink>)</para>
49503           </listitem>
49504
49505           <listitem>
49506             <para>Clickatell</para>
49507           </listitem>
49508         </itemizedlist>
49509         <para><emphasis role="bold">Question</emphasis>: What about in India?</para>
49510
49511         <para><emphasis role="bold">Answer</emphasis>: India does not yet have too many options
49512           here. This is partly due to the Telecom regulatory authority's (TRAI) stipulations about
49513           transactional SMSes and limits on the number of SMSes that may be sent / received per
49514           users per day. India specific drivers include: <itemizedlist>
49515             <listitem>
49516               <para>Unicel Technologies Pvt Ltd (<ulink url="http://unicel.in"
49517                 >unicel.in</ulink>)</para>
49518             </listitem>
49519           </itemizedlist></para>
49520       </section>
49521     </section>
49522
49523     <section id="catfaq">
49524       <title>Cataloging</title>
49525
49526       <para/>
49527
49528       <section id="authorityfaq">
49529         <title>Authority Fields</title>
49530
49531         <para><emphasis role="bold">Question: </emphasis>Why can't I edit 1xx,
49532         6xx, or 7xx fields in my catalog record?</para>
49533
49534         <para><emphasis role="bold">Answer:</emphasis> These fields are authority controlled and you
49535           probably have the <link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> set
49536           to "Don't allow". When it is set to "Don't allow" these fields will be locked and require
49537           you to search for an existing authority record to populate the field with. To allow typing
49538           in these authority fields set <link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> to 'Allow'.<note>
49539             <para>Fields affected by this preference will show a lock symbol in them</para>
49540           </note></para>
49541
49542         <screenshot>
49543           <screeninfo>Fields affected by this preference show a lock in the field</screeninfo>
49544
49545           <mediaobject>
49546             <imageobject>
49547               <imagedata fileref="images/cataloging/lockedauthority.png"/>
49548             </imageobject>
49549           </mediaobject>
49550         </screenshot>
49551       </section>
49552
49553       <section id="kohamarcfaq">
49554         <title>Koha to MARC Mapping</title>
49555
49556         <para><emphasis role="bold">Question</emphasis>: What's the
49557         relationship between 'Koha to MARC Mapping' and 'MARC Bibliographic
49558         Frameworks'?</para>
49559
49560         <para><emphasis role="bold">Answer</emphasis>: Mapping can be defined
49561         through 'MARC Bibliographic Frameworks' OR 'Koha to MARC Mapping'.
49562         'Koha to MARC Mapping' is just a shortcut to speed up linkage. If you
49563         change a mapping in one of these modules, the mapping will change in
49564         the other as well. (In other words, the two modules 'overwrite' each
49565         other in order to prevent conflicts from existing in Koha).</para>
49566       </section>
49567
49568       <section id="itemsperbibfaq">
49569         <title>Number of Items Per Bib Record</title>
49570
49571         <para><emphasis role="bold">Question</emphasis>: Is there a limit on
49572         the number of items I can attach to a bib record?</para>
49573
49574         <para><emphasis role="bold">Answer</emphasis>: There is no explicit limit to the number of
49575           items you can attach to a bibliographic record, but if you attach enough of them, your
49576           MARC record will exceed the maximum file size limit for the ISO 2709 standard, which
49577           breaks indexing for that record. I've found this occurs somewhere between 600 and 1000
49578           items on a 'normal' bibliographic record.</para>
49579       </section>
49580
49581       <section id="analyticsfaq">
49582         <title>Analytics</title>
49583
49584         <para><emphasis role="bold">Question</emphasis>: I am using the <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> feature,
49585         but my links in the OPAC and Staff Client to 'Show Analytics' are not
49586         working.</para>
49587
49588         <para><emphasis role="bold">Answer</emphasis>: If you plan on using
49589         <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> you
49590         will want to make sure to set your <link linkend="UseControlNumber">UseControlNumber</link> preference to
49591         "Don't use," this will prevent broken links.</para>
49592       </section>
49593     </section>
49594
49595     <section id="acqfaq">
49596       <title>Acquisitions</title>
49597
49598       <para/>
49599
49600       <section id="planningcatfaq">
49601         <title>Planning Categories</title>
49602
49603         <para><emphasis role="bold">Question</emphasis>: What is a planning
49604         category?</para>
49605
49606         <para><emphasis role="bold">Answer</emphasis>: When you plan in
49607         advance for the way your budget is going to be spent, you initially
49608         plan for how it's going to be spent over time, that's the most natural
49609         thing to do.</para>
49610
49611         <para>So you plan for $1000 in Jan. $1000 in Feb., $3000 in March,
49612         etc. You can basically do the same thing with a list of values in lieu
49613         of the months.</para>
49614
49615         <para>Say you have a list like this one:</para>
49616
49617         <itemizedlist>
49618           <listitem>
49619             <para>&lt; 1 month</para>
49620           </listitem>
49621
49622           <listitem>
49623             <para>&lt; 6 months</para>
49624           </listitem>
49625
49626           <listitem>
49627             <para>&lt; 1 year</para>
49628           </listitem>
49629
49630           <listitem>
49631             <para>&lt; 3 years</para>
49632           </listitem>
49633
49634           <listitem>
49635             <para>&lt; 10 years</para>
49636           </listitem>
49637
49638           <listitem>
49639             <para>&gt; 10 years</para>
49640           </listitem>
49641         </itemizedlist>
49642
49643         <para>The list is meant to represent when the books acquired where
49644         published. Then you plan for it, saying: we went to spend at list 40%
49645         of our budgets on books published less than a year ago, 10% on books
49646         more than 10 years old, etc.</para>
49647
49648         <para>Upon acquiring new material, you'll be able to select, for a
49649         given item, a value from this list in a drop down. Then, after the
49650         material has been acquired, at the end of the year, you'll be able to
49651         compare the goals set, with what's been achieved.</para>
49652       </section>
49653     </section>
49654
49655     <section id="serialsfaq">
49656       <title>Serials</title>
49657
49658       <para/>
49659
49660       <section id="advancedpatternfaq">
49661         <title>Advanced Patterns</title>
49662
49663         <para><emphasis role="bold">Question</emphasis>: What is the 'inner
49664         counter' on the advanced serials pattern interface?</para>
49665
49666         <para><emphasis role="bold">Answer</emphasis>: I think it is better to
49667         give an example to understand this :</para>
49668
49669         <para>Example for a monthly subscription :</para>
49670
49671         <itemizedlist>
49672           <listitem>
49673             <para>First issue publication date : April 2010</para>
49674           </listitem>
49675
49676           <listitem>
49677             <para>Numbering : No {X}, year {Y}</para>
49678           </listitem>
49679
49680           <listitem>
49681             <para>First issue : No 4, year 2010</para>
49682           </listitem>
49683         </itemizedlist>
49684
49685         <para>For the year Y : you will want the year change on January
49686         2011</para>
49687
49688         <para>So, the advanced pattern for Y will be :</para>
49689
49690         <itemizedlist>
49691           <listitem>
49692             <para>Add : 1</para>
49693           </listitem>
49694
49695           <listitem>
49696             <para>once every : 12</para>
49697           </listitem>
49698
49699           <listitem>
49700             <para>When more than 9999999</para>
49701           </listitem>
49702
49703           <listitem>
49704             <para>inner counter : 3</para>
49705           </listitem>
49706
49707           <listitem>
49708             <para>Set back to 0</para>
49709           </listitem>
49710
49711           <listitem>
49712             <para>Begins with 2010</para>
49713           </listitem>
49714         </itemizedlist>
49715
49716         <para>Year is going to change after 12 received issues from April
49717         2010, that is in April 2011 if you don't set inner counter. Set inner
49718         counter to 3 will say to Koha : change year after 12-3 = 9 received
49719         issues.</para>
49720
49721         <para>Inner counter says to Koha to take into account the first issues
49722         of the year, even if they are not received with Koha. If you begin
49723         with first issue of the year write nothing or 0.</para>
49724       </section>
49725     </section>
49726
49727     <section id="reportsfaq">
49728       <title>Reports</title>
49729
49730       <para/>
49731
49732       <section id="accounttypefaq">
49733         <title>Define Codes Stored in DB</title>
49734
49735         <para/>
49736
49737         <section id="finescodefaq">
49738           <title>Fines Table</title>
49739
49740           <para><emphasis role="bold">Question:</emphasis> What do the codes
49741           in the accounttype field in the accountlines table stand for?</para>
49742
49743           <para><emphasis role="bold">Answer:</emphasis></para>
49744
49745           <itemizedlist>
49746             <listitem>
49747               <para>A = Account management fee</para>
49748             </listitem>
49749
49750             <listitem>
49751               <para>C = Credit</para>
49752             </listitem>
49753
49754             <listitem>
49755               <para>F = Overdue fine</para>
49756             </listitem>
49757
49758             <listitem>
49759               <para>FOR = Forgiven</para>
49760             </listitem>
49761
49762             <listitem>
49763               <para>FU = Overdue, still acccruing</para>
49764             </listitem>
49765
49766             <listitem>
49767               <para>L = Lost item</para>
49768             </listitem>
49769             <listitem>
49770               <para>LR = Lost item returned/refunded</para>
49771             </listitem>
49772
49773             <listitem>
49774               <para>M = Sundry</para>
49775             </listitem>
49776
49777             <listitem>
49778               <para>N = New card</para>
49779             </listitem>
49780
49781             <listitem>
49782               <para>PAY = Payment</para>
49783             </listitem>
49784
49785             <listitem>
49786               <para>W = Writeoff</para>
49787             </listitem>
49788           </itemizedlist>
49789         </section>
49790
49791         <section id="statscodefaq">
49792           <title>Statistics Table</title>
49793
49794           <para><emphasis role="bold">Question: </emphasis>What are the
49795           possible codes for the type field in the statistics table?</para>
49796
49797           <para><emphasis role="bold">Answer:</emphasis></para>
49798
49799           <itemizedlist>
49800             <listitem>
49801               <para>localuse</para>
49802
49803               <itemizedlist>
49804                 <listitem>
49805                   <para>Registers if an item that had been checked out to a
49806                   statistics patron (category type = 'X') is returned</para>
49807                 </listitem>
49808               </itemizedlist>
49809             </listitem>
49810
49811             <listitem>
49812               <para>issue</para>
49813             </listitem>
49814
49815             <listitem>
49816               <para>return</para>
49817             </listitem>
49818
49819             <listitem>
49820               <para>renew</para>
49821             </listitem>
49822
49823             <listitem>
49824               <para>writeoff</para>
49825             </listitem>
49826
49827             <listitem>
49828               <para>payment</para>
49829             </listitem>
49830
49831             <listitem>
49832               <para>CreditXXX</para>
49833
49834               <itemizedlist>
49835                 <listitem>
49836                   <para>The XXX stores different types of fee credits, so a query to catch them all
49837                     would include a clause like "type LIKE 'Credit%'"</para>
49838                 </listitem>
49839               </itemizedlist>
49840             </listitem>
49841           </itemizedlist>
49842         </section>
49843
49844         <section id="rescodefaq">
49845           <title>Reserves Table</title>
49846
49847           <para><emphasis role="bold">Question</emphasis>: What are the
49848           possible codes for the found field in the reserves and old_reserves
49849           tables?</para>
49850
49851           <para><emphasis role="bold">Answer</emphasis>:</para>
49852
49853           <itemizedlist>
49854             <listitem>
49855               <para>NULL: means the patron requested the 1st available, and we
49856               haven't chosen the item</para>
49857             </listitem>
49858
49859             <listitem>
49860               <para>T = Transit: the reserve is linked to an item but is in
49861               transit to the pickup branch</para>
49862             </listitem>
49863
49864             <listitem>
49865               <para>W = Waiting: the reserve is linked to an item, is at the pickup branch, and is
49866                 waiting on the hold shelf</para>
49867             </listitem>
49868
49869             <listitem>
49870               <para>F = Finished: the reserve has been completed, and is
49871               done</para>
49872             </listitem>
49873           </itemizedlist>
49874         </section>
49875
49876         <section id="reportdicfaq">
49877           <title>Reports Dictionary Table</title>
49878
49879           <para><emphasis role="bold">Question</emphasis>: What are the
49880           possible codes for the area field in the reports_dictionary
49881           table?</para>
49882
49883           <para><emphasis role="bold">Answer</emphasis>:</para>
49884
49885           <itemizedlist>
49886             <listitem>
49887               <para>1 = Circulation</para>
49888             </listitem>
49889
49890             <listitem>
49891               <para>2 = Catalog</para>
49892             </listitem>
49893
49894             <listitem>
49895               <para>3 = Patrons</para>
49896             </listitem>
49897
49898             <listitem>
49899               <para>4 = Acquisitions</para>
49900             </listitem>
49901
49902             <listitem>
49903               <para>5 = Accounts</para>
49904             </listitem>
49905           </itemizedlist>
49906         </section>
49907
49908         <section id="msgtablefaq">
49909           <title>Messages Table</title>
49910
49911           <para><emphasis role="bold">Question</emphasis>: What are the
49912           possible codes for the message_type field in the messages
49913           table?</para>
49914
49915           <para><emphasis role="bold">Answer</emphasis>:</para>
49916
49917           <itemizedlist>
49918             <listitem>
49919               <para>L = For Librarians</para>
49920             </listitem>
49921
49922             <listitem>
49923               <para>B = For Patrons/Borrowers</para>
49924             </listitem>
49925           </itemizedlist>
49926         </section>
49927
49928         <section id="serialtablefaq">
49929           <title>Serial Table</title>
49930
49931           <para><emphasis role="bold">Question</emphasis>: What are the possible codes for the
49932             status field in the serial table?</para>
49933
49934           <para><emphasis role="bold">Answer</emphasis>:</para>
49935
49936           <itemizedlist>
49937             <listitem>
49938               <para>1 = Expected </para>
49939             </listitem>
49940             <listitem>
49941               <para>2 = Arrived </para>
49942             </listitem>
49943             <listitem>
49944               <para>3 = Late </para>
49945             </listitem>
49946             <listitem>
49947               <para>4 = Missing </para>
49948             </listitem>
49949             <listitem>
49950               <para>5 = Not available </para>
49951             </listitem>
49952             <listitem>
49953               <para>7 = Claimed </para>
49954             </listitem>
49955             <listitem>
49956               <para>41 = Missing (not received) </para>
49957             </listitem>
49958             <listitem>
49959               <para>42 = Missing (sold out) </para>
49960             </listitem>
49961             <listitem>
49962               <para>43 = Missing (damaged) </para>
49963             </listitem>
49964             <listitem>
49965               <para>44 = Missing (lost)</para>
49966             </listitem>
49967           </itemizedlist>
49968         </section>
49969         <section id="borrowerprivacyvalues">
49970           <title>Borrowers Table</title>
49971           <para><emphasis role="bold">Question</emphasis>: What are the possible codes for the
49972             privacy field in the borrowers table?</para>
49973           <para><emphasis role="bold">Answer</emphasis>:<itemizedlist>
49974               <listitem>
49975                 <para>0 = Forever</para>
49976               </listitem>
49977               <listitem>
49978                 <para>1 = Default</para>
49979               </listitem>
49980               <listitem>
49981                 <para>2 = Never</para>
49982               </listitem>
49983             </itemizedlist></para>
49984         </section>
49985         <section id="messpreffaq">
49986           <title>Messaging Preferences</title>
49987           <para><emphasis role="bold">Question</emphasis>: What are the possible codes in the
49988             message_attribute_id field in the borrower_message_preferences table?</para>
49989           <para><emphasis role="bold">Answer</emphasis>:<itemizedlist>
49990               <listitem>
49991                 <para>2 = advanced notice </para>
49992               </listitem>
49993               <listitem>
49994                 <para>6 = item checkout </para>
49995               </listitem>
49996               <listitem>
49997                 <para>4 = hold filled </para>
49998               </listitem>
49999               <listitem>
50000                 <para>1 = item due </para>
50001               </listitem>
50002               <listitem>
50003                 <para>5 = item check in</para>
50004               </listitem>
50005             </itemizedlist></para>
50006         </section>
50007       </section>
50008
50009       <section id="runtimefaq">
50010         <title>Runtime Parameters</title>
50011
50012         <para><emphasis role="bold">Question</emphasis>: Is there a way to
50013         filter my custom SQL reports before they run?</para>
50014
50015         <para><emphasis role="bold">Answer</emphasis>: If you feel that your
50016         report might be too resource intensive you might want to consider
50017         using runtime parameters to your query. Runtime parameters basically
50018         make a filter appear before the report is run to save your system
50019         resources.</para>
50020
50021         <para>There is a specific syntax that Koha will understand as 'ask for
50022         values when running the report'. The syntax is &lt;&lt;Question to
50023         ask|authorized_value&gt;&gt;.</para>
50024
50025         <itemizedlist>
50026           <listitem>
50027             <para>The &lt;&lt; and &gt;&gt; are just delimiters. You must put
50028             &lt;&lt; at the beginning and &gt;&gt; at the end of your
50029             parameter</para>
50030           </listitem>
50031
50032           <listitem>
50033             <para>The 'Question to ask' will be displayed on the left of the
50034             string to enter.</para>
50035           </listitem>
50036
50037           <listitem>
50038             <para>The authorized_value can be omitted if not applicable. If it contains an
50039               authorized value category, or branches or itemtype or categorycode or
50040               biblio_framework, a list with the Koha authorized values will be displayed instead of
50041               a free field Note that you can have more than one parameter in a given SQL Note that
50042               entering nothing at run time won't probably work as you expect. It will be considered
50043               as "value empty" not as "ignore this parameter". For example entering nothing for :
50044               "title=&lt;&lt;Enter title&gt;&gt;" will display results with title='' (no title). If
50045               you want to have to have something not mandatory, use "title like &lt;&lt;Enter
50046               title&gt;&gt;" and enter a % at run time instead of nothing</para>
50047           </listitem>
50048         </itemizedlist>
50049
50050         <para>Examples:</para>
50051
50052         <itemizedlist>
50053           <listitem>
50054             <para>SELECT surname,firstname FROM borrowers WHERE
50055             branchcode=&lt;&lt;Enter patrons library|branches&gt;&gt; AND
50056             surname like &lt;&lt;Enter filter for patron surname (% if
50057             none)&gt;&gt;</para>
50058           </listitem>
50059
50060           <listitem>
50061             <para>SELECT * FROM items WHERE homebranch = &lt;&lt;Pick your branch|branches&gt;&gt;
50062               and barcode like &lt;&lt;Partial barcode value here&gt;&gt;</para>
50063           </listitem>
50064           <listitem>
50065             <para>SELECT title , author FROM biblio WHERE frameworkcode=&lt;&lt;Enter the
50066               frameworkcode|biblio_framework>> </para>
50067           </listitem>
50068         </itemizedlist>
50069
50070         <note>
50071           <para>To generate a date picker calendar to the right of the field
50072           when running a report you can use the 'date' keyword like this:
50073           &lt;&lt;Enter Date|date&gt;&gt;</para>
50074
50075           <screenshot>
50076             <screeninfo>Date Picker</screeninfo>
50077
50078             <mediaobject>
50079               <imageobject>
50080                 <imagedata fileref="images/reports/datepicker.png"/>
50081               </imageobject>
50082             </mediaobject>
50083           </screenshot>
50084         </note>
50085
50086         <note>
50087           <para>You have to put "%" in a text box to 'leave it blank'.
50088           Otherwise, it literally looks for "" (empty string) as the value for
50089           the field.</para>
50090         </note>
50091
50092         <para><important>
50093             <para>In addition to using any authorized value code to generate a dropdown, you can use
50094               the following values as well: Framework codes (biblio_framework), Branches (branches),
50095               Item Types (itemtypes) and Patron Categories (categorycode). For example a branch pull
50096               down would be generated like this &lt;&lt;Branch|branches&gt;&gt;</para>
50097
50098             <screenshot>
50099               <screeninfo>Branch pull down</screeninfo>
50100
50101               <mediaobject>
50102                 <imageobject>
50103                   <imagedata fileref="images/reports/branchpulldown.png"/>
50104                 </imageobject>
50105               </mediaobject>
50106             </screenshot>
50107           </important></para>
50108       </section>
50109
50110       <section id="reportlimitfaq">
50111         <title>Results Limited</title>
50112
50113         <para><emphasis role="bold">Question</emphasis>: When I download my
50114         report it's limited to 10,000 results, how do I get all of the results
50115         to download?</para>
50116
50117         <para><emphasis role="bold">Answer</emphasis>: There is a limit of
50118         10,000 records put on SQL statements entered in Koha. To get around
50119         this you want to add 'LIMIT 100000' to the end of your SQL statement
50120         (or any other number above 10,000.</para>
50121       </section>
50122     </section>
50123
50124     <section id="searchfaq">
50125       <title>Searching</title>
50126
50127       <para/>
50128
50129       <section id="advancedsearchfaq">
50130         <title>Advanced Search</title>
50131
50132         <para/>
50133
50134         <section id="scanindexfaq">
50135           <title>Scan Indexes</title>
50136
50137           <para><emphasis role="bold">Question</emphasis>: What does 'scan
50138           indexes' on the advanced search page mean?</para>
50139
50140           <para><emphasis role="bold">Answer</emphasis>: When you choose an
50141           index, enter a term, click 'scan indexes' and do the search, Koha
50142           displays the searched term and the following terms found in this
50143           index with the number of corresponding records That is search is not
50144           made directly in the catalog, but first in the indexes It works only
50145           for one index at once, and only with no limit in Location (All
50146           libraries needed)</para>
50147         </section>
50148
50149         <section id="searchstartswith">
50150           <title>Searching for Terms that Start With a Character</title>
50151
50152           <para><emphasis role="bold">Question</emphasis>: How do I search for
50153           all titles that start with the letter 'C'?</para>
50154
50155           <para><emphasis role="bold">Answer</emphasis>: You can choose to
50156           search for things that start with a character or series of
50157           characters by using the CCL 'first-in-subfield'</para>
50158
50159           <itemizedlist>
50160             <listitem>
50161               <para>example: ti,first-in-subfield=C</para>
50162             </listitem>
50163           </itemizedlist>
50164         </section>
50165       </section>
50166
50167       <section id="wildcardsearchfaq">
50168         <title>Wildcard Searching</title>
50169
50170         <para><emphasis role="bold">Question</emphasis>:What is the difference
50171         between a keyword search using the '*' (asterisk) versus a keyword
50172         search using the '%' (percent)? Both work in the catalog, but return
50173         different sets. Why?</para>
50174
50175         <para><emphasis role="bold">Answer</emphasis>: A wildcard is a
50176         character (*,?,%,.) that can be used to represent one or more
50177         characters in a word. Two of the wildcard characters that can be used
50178         in Koha searches are the asterisk ('*') and the percent sign ('%').
50179         However, these two characters act differently when used in
50180         searching.</para>
50181
50182         <para>The '*' is going to force a more exact search of the first few
50183         characters you enter prior to the '*'. The asterisk will allow for an
50184         infinite number of characters in the search as long as the first few
50185         characters designated by your search remain the same. For example,
50186         searching for authors using the term, Smi*, will return a list that
50187         may include Smith, Smithers, Smithfield, Smiley, etc depending on the
50188         authors in your database.</para>
50189
50190         <para>The '%' will treat the words you enter in the terms of "is
50191         like". So a search of Smi% will search for words like Smi. This
50192         results in a much more varied results list. For example, a search on
50193         Smi% will return a list containing Smothers, Smith, Smelley,
50194         Smithfield and many others depending on what is your database.</para>
50195
50196         <para>The bottom line in searching with wildcards: '*' is more exact
50197         while '%' searches for like terms.</para>
50198       </section>
50199       <section id="titlesearchingfaq">
50200         <title>Title Searching</title>
50201         <para><emphasis role="bold">Question</emphasis>: Why does my Zebra title search for 'Help'
50202           not turn up 'The help' in the first pages of results?</para>
50203         <para><emphasis role="bold">Answer</emphasis>: When doing a title search, you actually want
50204           to search for the title (i.e., 'the help' rather than just 'help'), and it will bubble
50205           right up to the top. If you're just searching for 'help' then the relevance ranking is
50206           going to affect the results you see. </para>
50207         <para>When it comes to relevance in Zebra, here's what's happening. First, the search is
50208           done. If you search for the title "help", then any title that has "help" in it comes back.
50209           Then from those records, separately, it does relevance on the *whole* record. The more
50210           your word appears, the more relevant, and some MARC tags are worth more points than
50211           others. So a self-help book with 505 notes where "help" appears a *lot* will be at the
50212           top, regardless of keyword or title.</para>
50213         <para>But when you add a *second word*, that helps it figure things out, as it's weighing
50214           the relevance of both words and the phrase. Because of the way relevance works, if you
50215           search "the help", then "the help" or "the help I need" are more relevant than "the way to
50216           help", because they appear together in order. Likewise, "help the girl" would be lower
50217           relevance, because it's out of order, and "help for the homeless" would be lower still, as
50218           they're out of order, and apart.</para>
50219         <para>The moral of the story is that single word searches, particularly on common words,
50220           will always struggle a bit; it can't evaluate relevance well, because you've not given it
50221           enough input.</para>
50222       </section>
50223     </section>
50224
50225     <section id="enhancedcontentfaq">
50226       <title>Enhanced Content</title>
50227
50228       <para/>
50229
50230       <section id="frbrfaq">
50231         <title>FRBRizing Content</title>
50232
50233         <para><emphasis role="bold">Question: </emphasis>At our public library
50234         we are running a Koha installation and we've tried to turn on all the
50235         nice functionalities in Koha such as the frbrising tool, but do not
50236         get the same result as Nelsonville public library.</para>
50237
50238         <para><emphasis role="bold">Answer: </emphasis>In fact, this feature
50239         is quite tricky to make that right. First it looks at XISBN service.
50240         And then search in your database for that ISBN. So both XISBN and your
50241         internal ISBN (in biblio table) have to be normalized. You could
50242         therefore use the script misc/batchupdateISBNs.pl (it removes all the
50243         - in your local ISBNs)</para>
50244       </section>
50245
50246       <section id="amzfaq">
50247         <title>Amazon</title>
50248
50249         <para/>
50250
50251         <section id="amazonfaq">
50252           <title>All Amazon Content</title>
50253
50254           <para><emphasis role="bold">Question</emphasis>: I have all of the
50255           Amazon preferences turned on and have entered both of my keys, but
50256           none of the content appears in my system, why is that?</para>
50257
50258           <para><emphasis role="bold">Answer</emphasis>: Amazon's API checks
50259           your server time on all requests and if your server time is not set
50260           properly requests will be denied. To resolve this issue be sure to
50261           set your system time appropriately. Once that change in made Amazon
50262           content should appear immediately.</para>
50263
50264           <para>On Debian the the command is <emphasis>date -s "2010-06-30
50265           17:21"</emphasis> (with the proper date and time for your
50266           timezone).</para>
50267         </section>
50268       </section>
50269     </section>
50270
50271     <section id="systemfaq">
50272       <title>System Administration</title>
50273
50274       <para/>
50275
50276       <section id="zebracronfaq">
50277         <title>Errors in Zebra Cron</title>
50278
50279         <para><emphasis role="bold">Question</emphasis>: I am noticing some
50280         errors in the koha-zebradaemon-output.log file. When new records are
50281         added it takes a bit longer to index than we think they should.
50282         Running rebuild zebra is often faster. Zebra ends up indexing and
50283         search works, but I am concerned about the errors. Any ideas?</para>
50284
50285         <para><emphasis role="bold">Answer</emphasis>: Rebuild_zebra.pl -r
50286         deletes all of the files in the Zebra db directories (such as
50287         reci-0.mf) and then recreates them. Thus, permissions will be lost,
50288         and the files will be owned by the user who ran rebuild_zebra.pl. If
50289         one rebuilds the zebra indexes as root, the daemons, which typically
50290         run under the user Koha, will not be able to update the indexes. Thus,
50291         it's important then that the zebra rebuilds are put in the cronjob
50292         file of the user Koha, and not root. Also important is that other
50293         users, such as root, don't manually execute rebuilds.</para>
50294
50295         <para>If one desires that another user be able to execute
50296         rebuild_zebra.pl, he should be given the permission to execute 'sudo
50297         -u Koha .../rebuild_zebra.pl,' (if you want to do this, you also have
50298         to edit the sudoers file to pass the PERL5LIB variable with the
50299         env_keep option as by default sudo strips away almost all environment
50300         variables). Or, as root user, one can use a simple 'su koha' and then
50301         the rebuild_zebra.pl command.</para>
50302
50303         <para>I've also tried to set the sticky bit on rebuild_zebra.pl, but
50304         for whatever reason it didn't seem to work due to some problem with
50305         the PERL5LIB variable that I wasn't able to figure. That seems to me
50306         the easiest thing to do, if anybody has any idea how to make it work.
50307         If it worked and were the default, I think it would help folks to
50308         avoid a great deal of the problems that come up with zebra.</para>
50309       </section>
50310
50311       <section id="publicztarget">
50312         <title>Making Z39.50 Target Public</title>
50313
50314         <para><emphasis role="bold">Question</emphasis>: Could someone tell me
50315         the exact steps I need to take to configure Zebra to expose my Koha 3
50316         db as a public Z39.50 service?</para>
50317
50318         <para><emphasis role="bold">Answer</emphasis>: Edit the KOHA_CONF file
50319         that your Koha is using. Uncomment the publicserver line like:</para>
50320
50321         <para>&lt;!-- &lt;listen id="publicserver"
50322         &gt;tcp:@:9999&lt;/listen&gt; --&gt;</para>
50323
50324         <para>to be:</para>
50325
50326         <para>&lt;listen id="publicserver"
50327         &gt;tcp:@:9999&lt;/listen&gt;</para>
50328
50329         <para>Then restart zebasrv and connect on the port specified
50330         (9999).</para>
50331       </section>
50332
50333       <section id="authvalfaq">
50334         <title>Shelving Location Authorized Values</title>
50335
50336         <para><emphasis role="bold">Question</emphasis>: When editing an item,
50337         the new shelving location I created is not showing up by default in
50338         the items where I assigned it to.</para>
50339
50340         <para><emphasis role="bold">Answer</emphasis>: This is because you
50341         created the new shelving location with a code value of 0 (zero) Just
50342         FYI the system interprets authorized values of 0 as equaling a null so
50343         when you edit a record in cataloging where the authorized value in a
50344         field was assigned where the code was 0, the value displays as null in
50345         the item editor (or MARC editor) instead of the value the library
50346         meant it to be.</para>
50347       </section>
50348
50349       <section id="whyauthvals">
50350         <title>Why do I need Authorized Values?</title>
50351
50352         <para><emphasis role="bold">Question</emphasis>: Why would I want to
50353         define authorized values for MARC tags?</para>
50354
50355         <para><emphasis role="bold">Answer</emphasis>: Authorized Values
50356         create a 'controlled vocabulary' for your staff. As an example, let us
50357         assume that your Koha installation is used by several libraries, and
50358         you use MARC 21. You might want to restrict the 850a MARC subfield to
50359         the institution codes for just those libraries. In that case, you
50360         could define an authorized values category (perhaps called "INST") and
50361         enter the institution codes as the authorized values for that
50362         category.</para>
50363
50364         <note>
50365           <para>Koha automatically sets up authorized value categories for
50366           your item types and branch codes, and you can link these authorized
50367           values to MARC subfields when you set up your MARC tag
50368           structure.</para>
50369         </note>
50370       </section>
50371
50372       <section id="sessionstblfaq">
50373         <title>How do I clean up the sessions table?</title>
50374
50375         <para><emphasis role="bold">Question</emphasis>: Is there a periodic
50376         job that can be run to cull old sessions from the table? We don't want
50377         to backup all the useless session data every night.</para>
50378
50379         <para><emphasis role="bold">Answer</emphasis>: You can run <link linkend="cleandbcron">cleanup database cron job</link>.</para>
50380
50381         <para>Or just before doing a backup command (mysqldump), you can
50382         truncate session table:  </para>
50383
50384         <para><programlisting>mysql -u&lt;kohauser -p&lt;password &lt;koha-db-name -e 'TRUNCATE TABLE sessions'</programlisting></para>
50385       </section>
50386     </section>
50387
50388     <section id="hardwarefaq">
50389       <title>Hardware</title>
50390
50391       <para/>
50392
50393       <section id="barcodefaq">
50394         <title>Barcode Scanners</title>
50395
50396         <para><emphasis role="bold">Question</emphasis>: What barcode scanners
50397         have been known to work with Koha?</para>
50398
50399         <para><emphasis role="bold">Answer</emphasis>: The simple rule of
50400         thumb is, does it act like a keyboard device?, if so, it will work.
50401         (i.e. can you take the scanner, scan a barcode and have it show up in
50402         a text editor, if so, it will work.)</para>
50403
50404         <para>The main points to check are that it connects to your PC
50405         conveniently (can be USB or "keyboard wedge" which means it connects
50406         in line with the keyboard, which is useful with older computers), and
50407         that it scans the barcode type that you are using.</para>
50408
50409         <para>It is a good idea to test some 'used' barcodes if you have any,
50410         to see whether the scanner can read scuffed or slightly wrinkled ones
50411         successfully. Most scanners are capable of reading several barcode
50412         types - there are many, and the specification should list the ones it
50413         can read. You may need to adjust settings slightly, such as prefix and
50414         suffix characters, or whether you want to send an 'enter' character or
50415         not.</para>
50416
50417         <para>One more tip - some can be set 'always on' and may come with a
50418         stand, some have triggers under the handle, some have buttons on top,
50419         some are held like a pen. Think about the staff working with the
50420         hardware before choosing, as a button in the wrong place can be very
50421         awkward to use.</para>
50422       </section>
50423
50424       <section id="printersfaq">
50425         <title>Printers</title>
50426
50427         <para/>
50428
50429         <section id="kohaprinters">
50430           <title>Printers used by Koha libraries</title>
50431
50432           <itemizedlist>
50433             <listitem>
50434               <para>POS-X receipt printer</para>
50435             </listitem>
50436
50437             <listitem>
50438               <para>Star Micronics printer (exact model unknown) with a
50439               generic/plain text driver.</para>
50440             </listitem>
50441
50442             <listitem>
50443               <para>Star SP2000 (Nelsonville)</para>
50444             </listitem>
50445
50446             <listitem>
50447               <para>Star TSP-100 futurePRINT (Geauga)</para>
50448
50449               <itemizedlist>
50450                 <listitem>
50451                   <para>"I know there have been a lot of questions on receipt
50452                   printers so I thought I'd pass on my findings. We have been
50453                   testing the Star TSP-100 futurePRINT. I found this print to
50454                   be VERY easy to configure for Koha. I was even able to
50455                   customize the print job by adding our system logo (a .gif)
50456                   to the top of every receipt. Also with a bitmap created in
50457                   Paint was able to add a message at the bottom of each
50458                   receipt with the contact information, hours and website for
50459                   the library that the materials were checked out at."</para>
50460                 </listitem>
50461               </itemizedlist>
50462             </listitem>
50463
50464             <listitem>
50465               <para>Epson TM 88 IIIP thermal receipt printers</para>
50466             </listitem>
50467
50468             <listitem>
50469               <para>Epson TM-T88IV</para>
50470             </listitem>
50471
50472             <listitem>
50473               <para>1x1 labels using a Dymolabelwriter printer</para>
50474             </listitem>
50475           </itemizedlist>
50476         </section>
50477
50478         <section id="braillefaq">
50479           <title>Braille Support</title>
50480
50481           <para><emphasis role="bold">Question</emphasis>: Are there any
50482           braille embosser or printer which has inbuilt braille converter and
50483           it is accessible with UNIX environment?</para>
50484
50485           <para><emphasis role="bold">Answer</emphasis>: You may want to look
50486           into BRLTTY (<ulink url="http://www.emptech.info/product_details.php?ID=1232">http://www.emptech.info/product_details.php?ID=1232</ulink>).</para>
50487         </section>
50488
50489         <section id="hardwaresupport">
50490           <title>Additional Support</title>
50491
50492           <itemizedlist>
50493             <listitem>
50494               <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>
50495             </listitem>
50496           </itemizedlist>
50497         </section>
50498       </section>
50499     </section>
50500   </appendix>
50501
50502   <appendix id="extending">
50503     <title>Extending Koha</title>
50504
50505     <section id="amzlookup">
50506       <sectioninfo>
50507         <authorgroup>
50508           <author>
50509             <firstname>Cab</firstname>
50510             <surname>Vinton</surname>
50511             <affiliation>
50512               <orgname>Sanbornton Public Library</orgname>
50513             </affiliation>
50514           </author>
50515           <editor>
50516             <firstname>Nicole C.</firstname>
50517             <surname>Engard</surname>
50518           </editor>
50519         </authorgroup>
50520
50521         <pubdate>September 2009</pubdate>
50522
50523         <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>
50524       </sectioninfo>
50525       <title>Amazon lookup script for Koha libraries</title>
50526
50527       <para>We order most of our materials from Amazon, so I've been looking
50528       for a convenient way to tell if a book under consideration is in our
50529       catalog already.</para>
50530
50531       <para>Greasemonkey &amp; a custom user script fit the bill
50532       nicely:</para>
50533
50534       <itemizedlist>
50535         <listitem>
50536           <para><ulink url="https://addons.mozilla.org/en-US/firefox/addon/748">https://addons.mozilla.org/en-US/firefox/addon/748</ulink></para>
50537         </listitem>
50538
50539         <listitem>
50540           <para><ulink url="http://userscripts.org/scripts/show/56847">http://userscripts.org/scripts/show/56847</ulink></para>
50541         </listitem>
50542       </itemizedlist>
50543
50544       <para>A few caveats:</para>
50545
50546       <itemizedlist>
50547         <listitem>
50548           <para>Like most scripts, this one was designed to work with Firefox;
50549           I haven't explored getting it to work with other browsers.</para>
50550         </listitem>
50551
50552         <listitem>
50553           <para>I'm not a JavaScript programmer -- this was adapted from
50554           others' work. Just a few lines would have to be changed to get the
50555           script to work with your catalog.</para>
50556         </listitem>
50557
50558         <listitem>
50559           <para>It depends on the existence of ISBN for the item in question,
50560           so movies, older books, etc. would not work.</para>
50561         </listitem>
50562       </itemizedlist>
50563
50564       <para>Others have added all sorts of bells &amp; whistles: XISBN lookups
50565       to search for related titles, custom messages based on the status of
50566       items (on order, on hold, etc.), ... just search the UserScripts site
50567       for Amazon + library. For a later date!</para>
50568     </section>
50569
50570     <section id="extendkeywordclouds">
50571       <title>Keyword Clouds</title>
50572
50573       <para>In addition to the traditional tag cloud available in Koha, there
50574       is a way to generate clouds for popular subjects within Koha.</para>
50575
50576       <para>The <link linkend="keywordclouds">Author/Subject Cloud cron
50577       job</link> is used to help with this process. This cron job sends its
50578       output to files.</para>
50579
50580       <itemizedlist>
50581         <listitem>
50582           <para>/home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html</para>
50583         </listitem>
50584
50585         <listitem>
50586           <para>/home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html</para>
50587         </listitem>
50588       </itemizedlist>
50589
50590       <para>This means that you can produce clouds for authors, collective
50591       author, all kind of subjects, classifications, etc. And since it works
50592       on zebra indexes, it is quick, even on large DBs. Tags clouds are sent
50593       to files. It's up to library webmaster to deal with those files in order
50594       to include them in <link linkend="OpacMainUserBlock">OPACMainUserBlock</link>, or include them
50595       into their library CMS.</para>
50596
50597       <para>Some libraries even send the file into a Samba shared folder where
50598       webmaster take them, eventually clean them a little bit before
50599       integrating them into navigation widgets or pages.</para>
50600     </section>
50601
50602     <section id="newtitlesoption">
50603       <title>Newest Titles Pulldown</title>
50604
50605       <para>Often we want to add a way for our patrons to do searches for the
50606       newest items. In this example I'll show you how to create a pull down
50607       menu of the newest items by item type. These tips will work (with a
50608       couple changes) for collection codes or shelving locations as
50609       well.</para>
50610
50611       <para>First, it's important to note that every link in Koha is a
50612       permanent link. This means if I do a search for everything of a specific
50613       item type sorted by the acquisitions date and bookmark that URL,
50614       whenever I click it I'll see the newest items of that type on the first
50615       few pages of the results.</para>
50616
50617       <para>I took this knowledge and wrote a form takes this functionality in
50618       to consideration. It basically just does a search of your Koha catalog
50619       for a specific item type and sorts the results by acquisitions
50620       date.</para>
50621
50622       <para>The first thing I did was write a MySQL statement to generate a
50623       list of item types for me - why copy and paste when you can use the
50624       power of MySQL?</para>
50625
50626       <para><programlisting>select concat('&lt;option value=\"mc-itype:', itemtype, '\"&gt;',description,'&lt;/option&gt;') from itemtypes</programlisting></para>
50627
50628       <para>The above looks at the itemtypes table and slaps the necessary
50629       HTML around each item type for me. I then exported that to CSV and
50630       opened it in my text editor and added the other parts of the
50631       form.</para>
50632
50633       <para><programlisting>&lt;p&gt;&lt;strong&gt;New Items&lt;/strong&gt;&lt;/p&gt;
50634 &lt;p&gt;&lt;form name="searchform" method="get" action="/cgi-bin/koha/opac-search.pl"&gt;
50635 &lt;input name="idx" value="kw" type="hidden"&gt;
50636 &lt;input name="sort_by" value="acqdate_dsc" type="hidden"&gt;
50637 &lt;input name="do" value="OK" type="hidden"&gt;
50638 &lt;select name="limit" onchange="this.form.submit()"&gt;
50639 &lt;option&gt;-- Please choose --&lt;/option&gt;
50640 &lt;option value="mc-itype:BOOK"&gt;Book&lt;/option&gt;
50641 &lt;option value="mc-itype:BOOKCD"&gt;Book on CD&lt;/option&gt;
50642 &lt;option value="mc-itype:DVD"&gt;DVD&lt;/option&gt;
50643 &lt;option value="mc-itype:LRG_PRINT"&gt;Large print book&lt;/option&gt;
50644 &lt;option value="mc-itype:MAGAZINE"&gt;Magazine&lt;/option&gt;
50645 &lt;option value="mc-itype:NEWSPAPER"&gt;Newspaper&lt;/option&gt;
50646 &lt;option value="mc-itype:VIDEO"&gt;Videocassette&lt;/option&gt;
50647 &lt;/select&gt;
50648 &lt;/form&gt;
50649 &lt;/p&gt;</programlisting></para>
50650
50651       <para>Now, what does all of that mean? The important bits are
50652       these:</para>
50653
50654       <para>First the starting of the form.</para>
50655
50656       <para><programlisting>&lt;p&gt;&lt;form name="searchform" method="get" action="/cgi-bin/koha/opac-search.pl"&gt;</programlisting></para>
50657
50658       <para>This tells the browser to take any value selected and put it at
50659       the end of this http://YOURSITE/cgi-bin/koha/opac-search.pl. If you want
50660       to embed this form on your library website (and not on your OPAC) you
50661       can put the full OPAC URL in there.</para>
50662
50663       <para>Next, there is a hidden value that is telling the search to sort
50664       by acquisitions date descending (newest items at the top):</para>
50665
50666       <para><programlisting>&lt;input name="sort_by" value="acqdate_dsc" type="hidden"&gt;</programlisting></para>
50667
50668       <para>And finally you have an option for each item type you want people
50669       to search.<programlisting>&lt;option value="mc-itype:BOOK"&gt;Book&lt;/option&gt;</programlisting></para>
50670
50671       <para>These options each include the string "mc-itype:" which tells Koha
50672       to do an item type search.</para>
50673
50674       <para>Once you have all of that in place you can copy and paste the form
50675       to somewhere on your OPAC. The <ulink url="http://catalog.farmingtonlibraries.org">Farmington Public Libraries
50676       OPAC</ulink> has a few examples of this on the left.</para>
50677     </section>
50678
50679     <section id="colorsearch">
50680       <title>Cataloging and Searching by Color</title>
50681
50682       <para>One of the icon sets installed in Koha includes a series of
50683       colors. This set can be used to catalog and search by color if you'd
50684       like. This guide will walk you use changing collection code to color in
50685       Koha so that you can do this.</para>
50686
50687       <para>The following SQL could be used to add these colors to the CCODE
50688       authorized value category in a batch. If you wanted to use these colors
50689       for another authorized value you'd have to edit this to use that
50690       category:</para>
50691
50692       <programlisting>    insert into authorised_values (category, authorised_value, lib,
50693      lib_opac, imageurl) values ('CCODE','000000','Black','','colors/000000.png');
50694     insert into authorised_values (category, authorised_value, lib,
50695      lib_opac, imageurl) values ('CCODE','66cc66','Bright Green','','colors/66cc66.png');
50696     insert into authorised_values (category, authorised_value, lib,
50697      lib_opac, imageurl) values ('CCODE','99cc33','Olive','','colors/99cc33.png');
50698     insert into authorised_values (category, authorised_value, lib,
50699      lib_opac, imageurl) values ('CCODE','3333cc','Dark Blue','','colors/3333cc.png');
50700     insert into authorised_values (category, authorised_value, lib,
50701      lib_opac, imageurl) values ('CCODE','006600' ,'Dark Green','','colors/006600.png');
50702     insert into authorised_values (category, authorised_value, lib,
50703      lib_opac, imageurl) values ('CCODE','6600cc','Plum','','colors/6600cc.png');
50704     insert into authorised_values (category, authorised_value, lib,
50705      lib_opac, imageurl) values ('CCODE','6666cc','Purple','','colors/6666cc.png');
50706     insert into authorised_values (category, authorised_value, lib,
50707      lib_opac, imageurl) values ('CCODE','9999cc','Light Purple','','colors/9999cc.png');
50708     insert into authorised_values (category, authorised_value, lib,
50709      lib_opac, imageurl) values ('CCODE','660000' ,'Burgundy','','colors/660000.png');
50710     insert into authorised_values (category, authorised_value, lib,
50711      lib_opac, imageurl) values ('CCODE','663333' ,'Brown','','colors/663333.png');
50712     insert into authorised_values (category, authorised_value, lib,
50713      lib_opac, imageurl) values ('CCODE','990000' ,'Red','','colors/990000.png');
50714     insert into authorised_values (category, authorised_value, lib,
50715      lib_opac, imageurl) values ('CCODE','996633' ,'Tan','','colors/996633.png');
50716     insert into authorised_values (category, authorised_value, lib,
50717      lib_opac, imageurl) values ('CCODE','999999' ,'Gray','','colors/999999.png');
50718     insert into authorised_values (category, authorised_value, lib,
50719      lib_opac, imageurl) values ('CCODE','cc66cc','Pink','','colors/cc66cc.png');
50720     insert into authorised_values (category, authorised_value, lib,
50721      lib_opac, imageurl) values ('CCODE','cc99cc','Bubble Gum','','colors/cc99cc.png');
50722     insert into authorised_values (category, authorised_value, lib,
50723      lib_opac, imageurl) values ('CCODE','cc3333' ,'Orange','','colors/cc3333.png');
50724     insert into authorised_values (category, authorised_value, lib,
50725      lib_opac, imageurl) values ('CCODE','cc6666' ,'Peach','','colors/cc6666.png');
50726     insert into authorised_values (category, authorised_value, lib,
50727      lib_opac, imageurl) values ('CCODE','cc9999' ,'Rose','','colors/cc9999.png');
50728     insert into authorised_values (category, authorised_value, lib,
50729      lib_opac, imageurl) values ('CCODE','cccc00' ,'Gold','','colors/cccc00.png');
50730     insert into authorised_values (category, authorised_value, lib,
50731      lib_opac, imageurl) values ('CCODE','ffff33' ,'Yellow','','colors/ffff33.png');
50732     insert into authorised_values (category, authorised_value, lib,
50733      lib_opac, imageurl) values ('CCODE','ffffcc','Cream','','colors/ffffcc.png');
50734     insert into authorised_values (category, authorised_value, lib,
50735      lib_opac, imageurl) values ('CCODE','ffffff','White','','colors/ffffff.png');</programlisting>
50736
50737       <para>If you would like to choose the colors manually you can do that
50738       via the <link linkend="authorizedvalues">Authorized Values</link>
50739       administration area.</para>
50740
50741       <screenshot>
50742         <screeninfo>Colors for CCODE</screeninfo>
50743
50744         <mediaobject>
50745           <imageobject>
50746             <imagedata fileref="images/appendix-extending/colorccode.png"/>
50747           </imageobject>
50748         </mediaobject>
50749       </screenshot>
50750
50751       <para>Next you'll want to <link linkend="marcbibframeworks">update the
50752       frameworks</link> so that the 952$8 (if you're using collection code)
50753       label to says Color.</para>
50754
50755       <para>Once you have that in place you can start to catalog items by
50756       color.</para>
50757
50758       <para>Finally you'll want to add the following JQuery to your
50759       preferences so that it will relabel 'Collection' to 'Color'</para>
50760
50761       <para><link linkend="intranetuserjs">intranetuserjs</link></para>
50762
50763       <programlisting>$(document).ready(function(){
50764     $("#advsearch-tab-ccode a:contains('Collection')").text("Color");
50765     $("#holdings th:contains('Collection')").text("Color");
50766     });</programlisting>
50767
50768       <para><link linkend="opacuserjs">opacuserjs</link></para>
50769
50770       <programlisting>$(document).ready(function(){
50771     $("#advsearch-tab-ccode a:contains('Collection')").text("Color");
50772     $('#item_ccode').text("Color");
50773     });</programlisting>
50774
50775       <para/>
50776     </section>
50777   </appendix>
50778
50779   <appendix id="siteintegration">
50780     <title>Koha and Your Website</title>
50781
50782     <para>This appendix will include tips for integrating Koha in to your
50783     library website.</para>
50784
50785     <section id="embedsearch">
50786       <title>Koha search on your site</title>
50787
50788       <para>Often you'll want to add a Koha search box to your library
50789       website. To do so, just copy and paste the following code in to your
50790       library website and update the YOURCATALOG bit with your catalog's URL
50791       and you're set to go.</para>
50792
50793       <para><programlisting>
50794 &lt;form name="searchform" method="get" action="http://YOURCATLOG/cgi-bin/koha/opac-search.pl" id="searchform"&gt;
50795 &lt;input id="transl1" name="q" type="text"&gt;&lt;p&gt;
50796 &lt;select name="idx" id="masthead_search"&gt;
50797 &lt;option value="kw"&gt;Keyword&lt;/option&gt;
50798 &lt;option value="ti"&gt;Title&lt;/option&gt;
50799 &lt;option value="au"&gt;Author&lt;/option&gt;
50800 &lt;option value="su"&gt;Subject&lt;/option&gt;
50801 &lt;option value="nb"&gt;ISBN&lt;/option&gt;
50802 &lt;option value="se"&gt;Series&lt;/option&gt;
50803 &lt;option value="callnum"&gt;Call Number&lt;/option&gt;
50804 &lt;/select&gt;
50805 &lt;input value="Search" id="searchsubmit" type="submit"&gt;
50806 &lt;/p&gt;&lt;/form&gt;
50807       </programlisting></para>
50808     </section>
50809   </appendix>
50810
50811   <appendix id="gpl">
50812     <title><acronym>GNU</acronym> General Public License version 3</title>
50813
50814     <para>Version 3, 29 June 2007</para>
50815
50816     <para>Copyright © 2007 Free Software Foundation, Inc. <ulink url="http://fsf.org/">http://fsf.org/</ulink></para>
50817
50818     <para>Everyone is permitted to copy and distribute verbatim copies of this
50819     license document, but changing it is not allowed.</para>
50820
50821     <bridgehead id="Preamble" renderas="sect1">Preamble</bridgehead>
50822
50823     <para>The <acronym>GNU</acronym> General Public License is a free,
50824     copyleft license for software and other kinds of works.</para>
50825
50826     <para>The licenses for most software and other practical works are
50827     designed to take away your freedom to share and change the works. By
50828     contrast, the <acronym>GNU</acronym> General Public License is intended to
50829     guarantee your freedom to share and change all versions of a program--to
50830     make sure it remains free software for all its users. We, the Free
50831     Software Foundation, use the <acronym>GNU</acronym> General Public License
50832     for most of our software; it applies also to any other work released this
50833     way by its authors. You can apply it to your programs, too.</para>
50834
50835     <para>When we speak of free software, we are referring to freedom, not
50836     price. Our General Public Licenses are designed to make sure that you have
50837     the freedom to distribute copies of free software (and charge for them if
50838     you wish), that you receive source code or can get it if you want it, that
50839     you can change the software or use pieces of it in new free programs, and
50840     that you know you can do these things.</para>
50841
50842     <para>To protect your rights, we need to prevent others from denying you
50843     these rights or asking you to surrender the rights. Therefore, you have
50844     certain responsibilities if you distribute copies of the software, or if
50845     you modify it: responsibilities to respect the freedom of others.</para>
50846
50847     <para>For example, if you distribute copies of such a program, whether
50848     gratis or for a fee, you must pass on to the recipients the same freedoms
50849     that you received. You must make sure that they, too, receive or can get
50850     the source code. And you must show them these terms so they know their
50851     rights.</para>
50852
50853     <para>Developers that use the <acronym>GNU</acronym>
50854     <acronym>GPL</acronym> protect your rights with two steps: (1) assert
50855     copyright on the software, and (2) offer you this License giving you legal
50856     permission to copy, distribute and/or modify it.</para>
50857
50858     <para>For the developers' and authors' protection, the
50859     <acronym>GPL</acronym> clearly explains that there is no warranty for this
50860     free software. For both users' and authors' sake, the
50861     <acronym>GPL</acronym> requires that modified versions be marked as
50862     changed, so that their problems will not be attributed erroneously to
50863     authors of previous versions.</para>
50864
50865     <para>Some devices are designed to deny users access to install or run
50866     modified versions of the software inside them, although the manufacturer
50867     can do so. This is fundamentally incompatible with the aim of protecting
50868     users' freedom to change the software. The systematic pattern of such
50869     abuse occurs in the area of products for individuals to use, which is
50870     precisely where it is most unacceptable. Therefore, we have designed this
50871     version of the <acronym>GPL</acronym> to prohibit the practice for those
50872     products. If such problems arise substantially in other domains, we stand
50873     ready to extend this provision to those domains in future versions of the
50874     <acronym>GPL</acronym>, as needed to protect the freedom of users.</para>
50875
50876     <para>Finally, every program is threatened constantly by software patents.
50877     States should not allow patents to restrict development and use of
50878     software on general-purpose computers, but in those that do, we wish to
50879     avoid the special danger that patents applied to a free program could make
50880     it effectively proprietary. To prevent this, the <acronym>GPL</acronym>
50881     assures that patents cannot be used to render the program non-free.</para>
50882
50883     <para>The precise terms and conditions for copying, distribution and
50884     modification follow.</para>
50885
50886     <bridgehead>TERMS AND CONDITIONS</bridgehead>
50887
50888     <bridgehead id="Definitions" renderas="sect1">0. Definitions.</bridgehead>
50889
50890     <para>"This License" refers to version 3 of the <acronym>GNU</acronym>
50891     General Public License.</para>
50892
50893     <para>"Copyright" also means copyright-like laws that apply to other kinds
50894     of works, such as semiconductor masks.</para>
50895
50896     <para>"The Program" refers to any copyrightable work licensed under this
50897     License. Each licensee is addressed as "you". "Licensees" and "recipients"
50898     may be individuals or organizations.</para>
50899
50900     <para>To "modify" a work means to copy from or adapt all or part of the
50901     work in a fashion requiring copyright permission, other than the making of
50902     an exact copy. The resulting work is called a "modified version" of the
50903     earlier work or a work "based on" the earlier work.</para>
50904
50905     <para>A "covered work" means either the unmodified Program or a work based
50906     on the Program.</para>
50907
50908     <para>To "propagate" a work means to do anything with it that, without
50909     permission, would make you directly or secondarily liable for infringement
50910     under applicable copyright law, except executing it on a computer or
50911     modifying a private copy. Propagation includes copying, distribution (with
50912     or without modification), making available to the public, and in some
50913     countries other activities as well.</para>
50914
50915     <para>To "convey" a work means any kind of propagation that enables other
50916     parties to make or receive copies. Mere interaction with a user through a
50917     computer network, with no transfer of a copy, is not conveying.</para>
50918
50919     <para>An interactive user interface displays "Appropriate Legal Notices"
50920     to the extent that it includes a convenient and prominently visible
50921     feature that (1) displays an appropriate copyright notice, and (2) tells
50922     the user that there is no warranty for the work (except to the extent that
50923     warranties are provided), that licensees may convey the work under this
50924     License, and how to view a copy of this License. If the interface presents
50925     a list of user commands or options, such as a menu, a prominent item in
50926     the list meets this criterion.</para>
50927
50928     <bridgehead id="SourceCode" renderas="sect1">1. Source Code.</bridgehead>
50929
50930     <para>The "source code" for a work means the preferred form of the work
50931     for making modifications to it. "Object code" means any non-source form of
50932     a work.</para>
50933
50934     <para>A "Standard Interface" means an interface that either is an official
50935     standard defined by a recognized standards body, or, in the case of
50936     interfaces specified for a particular programming language, one that is
50937     widely used among developers working in that language.</para>
50938
50939     <para>The "System Libraries" of an executable work include anything, other
50940     than the work as a whole, that (a) is included in the normal form of
50941     packaging a Major Component, but which is not part of that Major
50942     Component, and (b) serves only to enable use of the work with that Major
50943     Component, or to implement a Standard Interface for which an
50944     implementation is available to the public in source code form. A "Major
50945     Component", in this context, means a major essential component (kernel,
50946     window system, and so on) of the specific operating system (if any) on
50947     which the executable work runs, or a compiler used to produce the work, or
50948     an object code interpreter used to run it.</para>
50949
50950     <para>The "Corresponding Source" for a work in object code form means all
50951     the source code needed to generate, install, and (for an executable work)
50952     run the object code and to modify the work, including scripts to control
50953     those activities. However, it does not include the work's System
50954     Libraries, or general-purpose tools or generally available free programs
50955     which are used unmodified in performing those activities but which are not
50956     part of the work. For example, Corresponding Source includes interface
50957     definition files associated with source files for the work, and the source
50958     code for shared libraries and dynamically linked subprograms that the work
50959     is specifically designed to require, such as by intimate data
50960     communication or control flow between those subprograms and other parts of
50961     the work.</para>
50962
50963     <para>The Corresponding Source need not include anything that users can
50964     regenerate automatically from other parts of the Corresponding
50965     Source.</para>
50966
50967     <para>The Corresponding Source for a work in source code form is that same
50968     work.</para>
50969
50970     <bridgehead id="BasicPermissions" renderas="sect1">2. Basic
50971     Permissions.</bridgehead>
50972
50973     <para>All rights granted under this License are granted for the term of
50974     copyright on the Program, and are irrevocable provided the stated
50975     conditions are met. This License explicitly affirms your unlimited
50976     permission to run the unmodified Program. The output from running a
50977     covered work is covered by this License only if the output, given its
50978     content, constitutes a covered work. This License acknowledges your rights
50979     of fair use or other equivalent, as provided by copyright law.</para>
50980
50981     <para>You may make, run and propagate covered works that you do not
50982     convey, without conditions so long as your license otherwise remains in
50983     force. You may convey covered works to others for the sole purpose of
50984     having them make modifications exclusively for you, or provide you with
50985     facilities for running those works, provided that you comply with the
50986     terms of this License in conveying all material for which you do not
50987     control copyright. Those thus making or running the covered works for you
50988     must do so exclusively on your behalf, under your direction and control,
50989     on terms that prohibit them from making any copies of your copyrighted
50990     material outside their relationship with you.</para>
50991
50992     <para>Conveying under any other circumstances is permitted solely under
50993     the conditions stated below. Sublicensing is not allowed; section 10 makes
50994     it unnecessary.</para>
50995
50996     <bridgehead id="Protecting" renderas="sect1">3. Protecting Users' Legal
50997     Rights From Anti-Circumvention Law.</bridgehead>
50998
50999     <para>No covered work shall be deemed part of an effective technological
51000     measure under any applicable law fulfilling obligations under article 11
51001     of the WIPO copyright treaty adopted on 20 December 1996, or similar laws
51002     prohibiting or restricting circumvention of such measures.</para>
51003
51004     <para>When you convey a covered work, you waive any legal power to forbid
51005     circumvention of technological measures to the extent such circumvention
51006     is effected by exercising rights under this License with respect to the
51007     covered work, and you disclaim any intention to limit operation or
51008     modification of the work as a means of enforcing, against the work's
51009     users, your or third parties' legal rights to forbid circumvention of
51010     technological measures.</para>
51011
51012     <bridgehead id="ConveyingVerbatim" renderas="sect1">4. Conveying Verbatim
51013     Copies.</bridgehead>
51014
51015     <para>You may convey verbatim copies of the Program's source code as you
51016     receive it, in any medium, provided that you conspicuously and
51017     appropriately publish on each copy an appropriate copyright notice; keep
51018     intact all notices stating that this License and any non-permissive terms
51019     added in accord with section 7 apply to the code; keep intact all notices
51020     of the absence of any warranty; and give all recipients a copy of this
51021     License along with the Program.</para>
51022
51023     <para>You may charge any price or no price for each copy that you convey,
51024     and you may offer support or warranty protection for a fee.</para>
51025
51026     <bridgehead id="ConveyingModified" renderas="sect1">5. Conveying Modified
51027     Source Versions.</bridgehead>
51028
51029     <para>You may convey a work based on the Program, or the modifications to
51030     produce it from the Program, in the form of source code under the terms of
51031     section 4, provided that you also meet all of these conditions:</para>
51032
51033     <orderedlist numeration="loweralpha">
51034       <listitem>
51035         <para>The work must carry prominent notices stating that you modified
51036         it, and giving a relevant date.</para>
51037       </listitem>
51038
51039       <listitem>
51040         <para>The work must carry prominent notices stating that it is
51041         released under this License and any conditions added under section 7.
51042         This requirement modifies the requirement in section 4 to "keep intact
51043         all notices".</para>
51044       </listitem>
51045
51046       <listitem>
51047         <para>You must license the entire work, as a whole, under this License
51048         to anyone who comes into possession of a copy. This License will
51049         therefore apply, along with any applicable section 7 additional terms,
51050         to the whole of the work, and all its parts, regardless of how they
51051         are packaged. This License gives no permission to license the work in
51052         any other way, but it does not invalidate such permission if you have
51053         separately received it.</para>
51054       </listitem>
51055
51056       <listitem>
51057         <para>If the work has interactive user interfaces, each must display
51058         Appropriate Legal Notices; however, if the Program has interactive
51059         interfaces that do not display Appropriate Legal Notices, your work
51060         need not make them do so.</para>
51061       </listitem>
51062     </orderedlist>
51063
51064     <para>A compilation of a covered work with other separate and independent
51065     works, which are not by their nature extensions of the covered work, and
51066     which are not combined with it such as to form a larger program, in or on
51067     a volume of a storage or distribution medium, is called an "aggregate" if
51068     the compilation and its resulting copyright are not used to limit the
51069     access or legal rights of the compilation's users beyond what the
51070     individual works permit. Inclusion of a covered work in an aggregate does
51071     not cause this License to apply to the other parts of the
51072     aggregate.</para>
51073
51074     <bridgehead id="ConveyingNonSource" renderas="sect1">6. Conveying
51075     Non-Source Forms.</bridgehead>
51076
51077     <para>You may convey a covered work in object code form under the terms of
51078     sections 4 and 5, provided that you also convey the machine-readable
51079     Corresponding Source under the terms of this License, in one of these
51080     ways:</para>
51081
51082     <orderedlist numeration="loweralpha">
51083       <listitem>
51084         <para>Convey the object code in, or embodied in, a physical product
51085         (including a physical distribution medium), accompanied by the
51086         Corresponding Source fixed on a durable physical medium customarily
51087         used for software interchange.</para>
51088       </listitem>
51089
51090       <listitem>
51091         <para>Convey the object code in, or embodied in, a physical product
51092         (including a physical distribution medium), accompanied by a written
51093         offer, valid for at least three years and valid for as long as you
51094         offer spare parts or customer support for that product model, to give
51095         anyone who possesses the object code either (1) a copy of the
51096         Corresponding Source for all the software in the product that is
51097         covered by this License, on a durable physical medium customarily used
51098         for software interchange, for a price no more than your reasonable
51099         cost of physically performing this conveying of source, or (2) access
51100         to copy the Corresponding Source from a network server at no
51101         charge.</para>
51102       </listitem>
51103
51104       <listitem>
51105         <para>Convey individual copies of the object code with a copy of the
51106         written offer to provide the Corresponding Source. This alternative is
51107         allowed only occasionally and noncommercially, and only if you
51108         received the object code with such an offer, in accord with subsection
51109         6b.</para>
51110       </listitem>
51111
51112       <listitem>
51113         <para>Convey the object code by offering access from a designated
51114         place (gratis or for a charge), and offer equivalent access to the
51115         Corresponding Source in the same way through the same place at no
51116         further charge. You need not require recipients to copy the
51117         Corresponding Source along with the object code. If the place to copy
51118         the object code is a network server, the Corresponding Source may be
51119         on a different server (operated by you or a third party) that supports
51120         equivalent copying facilities, provided you maintain clear directions
51121         next to the object code saying where to find the Corresponding Source.
51122         Regardless of what server hosts the Corresponding Source, you remain
51123         obligated to ensure that it is available for as long as needed to
51124         satisfy these requirements.</para>
51125       </listitem>
51126
51127       <listitem>
51128         <para>Convey the object code using peer-to-peer transmission, provided
51129         you inform other peers where the object code and Corresponding Source
51130         of the work are being offered to the general public at no charge under
51131         subsection 6d.</para>
51132       </listitem>
51133     </orderedlist>
51134
51135     <para>A separable portion of the object code, whose source code is
51136     excluded from the Corresponding Source as a System Library, need not be
51137     included in conveying the object code work.</para>
51138
51139     <para>A "User Product" is either (1) a "consumer product", which means any
51140     tangible personal property which is normally used for personal, family, or
51141     household purposes, or (2) anything designed or sold for incorporation
51142     into a dwelling. In determining whether a product is a consumer product,
51143     doubtful cases shall be resolved in favor of coverage. For a particular
51144     product received by a particular user, "normally used" refers to a typical
51145     or common use of that class of product, regardless of the status of the
51146     particular user or of the way in which the particular user actually uses,
51147     or expects or is expected to use, the product. A product is a consumer
51148     product regardless of whether the product has substantial commercial,
51149     industrial or non-consumer uses, unless such uses represent the only
51150     significant mode of use of the product.</para>
51151
51152     <para>"Installation Information" for a User Product means any methods,
51153     procedures, authorization keys, or other information required to install
51154     and execute modified versions of a covered work in that User Product from
51155     a modified version of its Corresponding Source. The information must
51156     suffice to ensure that the continued functioning of the modified object
51157     code is in no case prevented or interfered with solely because
51158     modification has been made.</para>
51159
51160     <para>If you convey an object code work under this section in, or with, or
51161     specifically for use in, a User Product, and the conveying occurs as part
51162     of a transaction in which the right of possession and use of the User
51163     Product is transferred to the recipient in perpetuity or for a fixed term
51164     (regardless of how the transaction is characterized), the Corresponding
51165     Source conveyed under this section must be accompanied by the Installation
51166     Information. But this requirement does not apply if neither you nor any
51167     third party retains the ability to install modified object code on the
51168     User Product (for example, the work has been installed in
51169     <acronym>ROM</acronym>).</para>
51170
51171     <para>The requirement to provide Installation Information does not include
51172     a requirement to continue to provide support service, warranty, or updates
51173     for a work that has been modified or installed by the recipient, or for
51174     the User Product in which it has been modified or installed. Access to a
51175     network may be denied when the modification itself materially and
51176     adversely affects the operation of the network or violates the rules and
51177     protocols for communication across the network.</para>
51178
51179     <para>Corresponding Source conveyed, and Installation Information
51180     provided, in accord with this section must be in a format that is publicly
51181     documented (and with an implementation available to the public in source
51182     code form), and must require no special password or key for unpacking,
51183     reading or copying.</para>
51184
51185     <bridgehead id="AdditionalTerms" renderas="sect1">7. Additional
51186     Terms.</bridgehead>
51187
51188     <para>"Additional permissions" are terms that supplement the terms of this
51189     License by making exceptions from one or more of its conditions.
51190     Additional permissions that are applicable to the entire Program shall be
51191     treated as though they were included in this License, to the extent that
51192     they are valid under applicable law. If additional permissions apply only
51193     to part of the Program, that part may be used separately under those
51194     permissions, but the entire Program remains governed by this License
51195     without regard to the additional permissions.</para>
51196
51197     <para>When you convey a copy of a covered work, you may at your option
51198     remove any additional permissions from that copy, or from any part of it.
51199     (Additional permissions may be written to require their own removal in
51200     certain cases when you modify the work.) You may place additional
51201     permissions on material, added by you to a covered work, for which you
51202     have or can give appropriate copyright permission.</para>
51203
51204     <para>Notwithstanding any other provision of this License, for material
51205     you add to a covered work, you may (if authorized by the copyright holders
51206     of that material) supplement the terms of this License with terms:</para>
51207
51208     <orderedlist numeration="loweralpha">
51209       <listitem>
51210         <para>Disclaiming warranty or limiting liability differently from the
51211         terms of sections 15 and 16 of this License; or</para>
51212       </listitem>
51213
51214       <listitem>
51215         <para>Requiring preservation of specified reasonable legal notices or
51216         author attributions in that material or in the Appropriate Legal
51217         Notices displayed by works containing it; or</para>
51218       </listitem>
51219
51220       <listitem>
51221         <para>Prohibiting misrepresentation of the origin of that material, or
51222         requiring that modified versions of such material be marked in
51223         reasonable ways as different from the original version; or</para>
51224       </listitem>
51225
51226       <listitem>
51227         <para>Limiting the use for publicity purposes of names of licensors or
51228         authors of the material; or</para>
51229       </listitem>
51230
51231       <listitem>
51232         <para>Declining to grant rights under trademark law for use of some
51233         trade names, trademarks, or service marks; or</para>
51234       </listitem>
51235
51236       <listitem>
51237         <para>Requiring indemnification of licensors and authors of that
51238         material by anyone who conveys the material (or modified versions of
51239         it) with contractual assumptions of liability to the recipient, for
51240         any liability that these contractual assumptions directly impose on
51241         those licensors and authors.</para>
51242       </listitem>
51243     </orderedlist>
51244
51245     <para>All other non-permissive additional terms are considered "further
51246     restrictions" within the meaning of section 10. If the Program as you
51247     received it, or any part of it, contains a notice stating that it is
51248     governed by this License along with a term that is a further restriction,
51249     you may remove that term. If a license document contains a further
51250     restriction but permits relicensing or conveying under this License, you
51251     may add to a covered work material governed by the terms of that license
51252     document, provided that the further restriction does not survive such
51253     relicensing or conveying.</para>
51254
51255     <para>If you add terms to a covered work in accord with this section, you
51256     must place, in the relevant source files, a statement of the additional
51257     terms that apply to those files, or a notice indicating where to find the
51258     applicable terms.</para>
51259
51260     <para>Additional terms, permissive or non-permissive, may be stated in the
51261     form of a separately written license, or stated as exceptions; the above
51262     requirements apply either way.</para>
51263
51264     <bridgehead id="Termination" renderas="sect1">8. Termination.</bridgehead>
51265
51266     <para>You may not propagate or modify a covered work except as expressly
51267     provided under this License. Any attempt otherwise to propagate or modify
51268     it is void, and will automatically terminate your rights under this
51269     License (including any patent licenses granted under the third paragraph
51270     of section 11).</para>
51271
51272     <para>However, if you cease all violation of this License, then your
51273     license from a particular copyright holder is reinstated (a)
51274     provisionally, unless and until the copyright holder explicitly and
51275     finally terminates your license, and (b) permanently, if the copyright
51276     holder fails to notify you of the violation by some reasonable means prior
51277     to 60 days after the cessation.</para>
51278
51279     <para>Moreover, your license from a particular copyright holder is
51280     reinstated permanently if the copyright holder notifies you of the
51281     violation by some reasonable means, this is the first time you have
51282     received notice of violation of this License (for any work) from that
51283     copyright holder, and you cure the violation prior to 30 days after your
51284     receipt of the notice.</para>
51285
51286     <para>Termination of your rights under this section does not terminate the
51287     licenses of parties who have received copies or rights from you under this
51288     License. If your rights have been terminated and not permanently
51289     reinstated, you do not qualify to receive new licenses for the same
51290     material under section 10.</para>
51291
51292     <bridgehead id="AcceptanceNotRequired" renderas="sect1">9. Acceptance Not
51293     Required for Having Copies.</bridgehead>
51294
51295     <para>You are not required to accept this License in order to receive or
51296     run a copy of the Program. Ancillary propagation of a covered work
51297     occurring solely as a consequence of using peer-to-peer transmission to
51298     receive a copy likewise does not require acceptance. However, nothing
51299     other than this License grants you permission to propagate or modify any
51300     covered work. These actions infringe copyright if you do not accept this
51301     License. Therefore, by modifying or propagating a covered work, you
51302     indicate your acceptance of this License to do so.</para>
51303
51304     <bridgehead id="AutomaticDownstream" renderas="sect1">10. Automatic
51305     Licensing of Downstream Recipients.</bridgehead>
51306
51307     <para>Each time you convey a covered work, the recipient automatically
51308     receives a license from the original licensors, to run, modify and
51309     propagate that work, subject to this License. You are not responsible for
51310     enforcing compliance by third parties with this License.</para>
51311
51312     <para>An "entity transaction" is a transaction transferring control of an
51313     organization, or substantially all assets of one, or subdividing an
51314     organization, or merging organizations. If propagation of a covered work
51315     results from an entity transaction, each party to that transaction who
51316     receives a copy of the work also receives whatever licenses to the work
51317     the party's predecessor in interest had or could give under the previous
51318     paragraph, plus a right to possession of the Corresponding Source of the
51319     work from the predecessor in interest, if the predecessor has it or can
51320     get it with reasonable efforts.</para>
51321
51322     <para>You may not impose any further restrictions on the exercise of the
51323     rights granted or affirmed under this License. For example, you may not
51324     impose a license fee, royalty, or other charge for exercise of rights
51325     granted under this License, and you may not initiate litigation (including
51326     a cross-claim or counterclaim in a lawsuit) alleging that any patent claim
51327     is infringed by making, using, selling, offering for sale, or importing
51328     the Program or any portion of it.</para>
51329
51330     <bridgehead id="Patents" renderas="sect1">11. Patents.</bridgehead>
51331
51332     <para>A "contributor" is a copyright holder who authorizes use under this
51333     License of the Program or a work on which the Program is based. The work
51334     thus licensed is called the contributor's "contributor version".</para>
51335
51336     <para>A contributor's "essential patent claims" are all patent claims
51337     owned or controlled by the contributor, whether already acquired or
51338     hereafter acquired, that would be infringed by some manner, permitted by
51339     this License, of making, using, or selling its contributor version, but do
51340     not include claims that would be infringed only as a consequence of
51341     further modification of the contributor version. For purposes of this
51342     definition, "control" includes the right to grant patent sublicenses in a
51343     manner consistent with the requirements of this License.</para>
51344
51345     <para>Each contributor grants you a non-exclusive, worldwide, royalty-free
51346     patent license under the contributor's essential patent claims, to make,
51347     use, sell, offer for sale, import and otherwise run, modify and propagate
51348     the contents of its contributor version.</para>
51349
51350     <para>In the following three paragraphs, a "patent license" is any express
51351     agreement or commitment, however denominated, not to enforce a patent
51352     (such as an express permission to practice a patent or covenant not to sue
51353     for patent infringement). To "grant" such a patent license to a party
51354     means to make such an agreement or commitment not to enforce a patent
51355     against the party.</para>
51356
51357     <para>If you convey a covered work, knowingly relying on a patent license,
51358     and the Corresponding Source of the work is not available for anyone to
51359     copy, free of charge and under the terms of this License, through a
51360     publicly available network server or other readily accessible means, then
51361     you must either (1) cause the Corresponding Source to be so available, or
51362     (2) arrange to deprive yourself of the benefit of the patent license for
51363     this particular work, or (3) arrange, in a manner consistent with the
51364     requirements of this License, to extend the patent license to downstream
51365     recipients. "Knowingly relying" means you have actual knowledge that, but
51366     for the patent license, your conveying the covered work in a country, or
51367     your recipient's use of the covered work in a country, would infringe one
51368     or more identifiable patents in that country that you have reason to
51369     believe are valid.</para>
51370
51371     <para>If, pursuant to or in connection with a single transaction or
51372     arrangement, you convey, or propagate by procuring conveyance of, a
51373     covered work, and grant a patent license to some of the parties receiving
51374     the covered work authorizing them to use, propagate, modify or convey a
51375     specific copy of the covered work, then the patent license you grant is
51376     automatically extended to all recipients of the covered work and works
51377     based on it.</para>
51378
51379     <para>A patent license is "discriminatory" if it does not include within
51380     the scope of its coverage, prohibits the exercise of, or is conditioned on
51381     the non-exercise of one or more of the rights that are specifically
51382     granted under this License. You may not convey a covered work if you are a
51383     party to an arrangement with a third party that is in the business of
51384     distributing software, under which you make payment to the third party
51385     based on the extent of your activity of conveying the work, and under
51386     which the third party grants, to any of the parties who would receive the
51387     covered work from you, a discriminatory patent license (a) in connection
51388     with copies of the covered work conveyed by you (or copies made from those
51389     copies), or (b) primarily for and in connection with specific products or
51390     compilations that contain the covered work, unless you entered into that
51391     arrangement, or that patent license was granted, prior to 28 March
51392     2007.</para>
51393
51394     <para>Nothing in this License shall be construed as excluding or limiting
51395     any implied license or other defenses to infringement that may otherwise
51396     be available to you under applicable patent law.</para>
51397
51398     <bridgehead id="NoSurrender" renderas="sect1">12. No Surrender of Others'
51399     Freedom.</bridgehead>
51400
51401     <para>If conditions are imposed on you (whether by court order, agreement
51402     or otherwise) that contradict the conditions of this License, they do not
51403     excuse you from the conditions of this License. If you cannot convey a
51404     covered work so as to satisfy simultaneously your obligations under this
51405     License and any other pertinent obligations, then as a consequence you may
51406     not convey it at all. For example, if you agree to terms that obligate you
51407     to collect a royalty for further conveying from those to whom you convey
51408     the Program, the only way you could satisfy both those terms and this
51409     License would be to refrain entirely from conveying the Program.</para>
51410
51411     <bridgehead id="UsedWithAGPL" renderas="sect1">13. Use with the
51412     <acronym>GNU</acronym> Affero General Public License.</bridgehead>
51413
51414     <para>Notwithstanding any other provision of this License, you have
51415     permission to link or combine any covered work with a work licensed under
51416     version 3 of the <acronym>GNU</acronym> Affero General Public License into
51417     a single combined work, and to convey the resulting work. The terms of
51418     this License will continue to apply to the part which is the covered work,
51419     but the special requirements of the <acronym>GNU</acronym> Affero General
51420     Public License, section 13, concerning interaction through a network will
51421     apply to the combination as such.</para>
51422
51423     <bridgehead id="RevisedVersions" renderas="sect1">14. Revised Versions of
51424     this License.</bridgehead>
51425
51426     <para>The Free Software Foundation may publish revised and/or new versions
51427     of the <acronym>GNU</acronym> General Public License from time to time.
51428     Such new versions will be similar in spirit to the present version, but
51429     may differ in detail to address new problems or concerns.</para>
51430
51431     <para>Each version is given a distinguishing version number. If the
51432     Program specifies that a certain numbered version of the
51433     <acronym>GNU</acronym> General Public License "or any later version"
51434     applies to it, you have the option of following the terms and conditions
51435     either of that numbered version or of any later version published by the
51436     Free Software Foundation. If the Program does not specify a version number
51437     of the <acronym>GNU</acronym> General Public License, you may choose any
51438     version ever published by the Free Software Foundation.</para>
51439
51440     <para>If the Program specifies that a proxy can decide which future
51441     versions of the <acronym>GNU</acronym> General Public License can be used,
51442     that proxy's public statement of acceptance of a version permanently
51443     authorizes you to choose that version for the Program.</para>
51444
51445     <para>Later license versions may give you additional or different
51446     permissions. However, no additional obligations are imposed on any author
51447     or copyright holder as a result of your choosing to follow a later
51448     version.</para>
51449
51450     <bridgehead id="WarrantyDisclaimer" renderas="sect1">15. Disclaimer of
51451     Warranty.</bridgehead>
51452
51453     <para>THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
51454     APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
51455     HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
51456     OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
51457     THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
51458     PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
51459     IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
51460     ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</para>
51461
51462     <bridgehead id="LiabilityLimitation" renderas="sect1">16. Limitation of
51463     Liability.</bridgehead>
51464
51465     <para>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
51466     WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
51467     CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
51468     INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
51469     ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT
51470     LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES
51471     SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE
51472     WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
51473     ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</para>
51474
51475     <bridgehead id="InterpretationSecs1516" renderas="sect1">17.
51476     Interpretation of Sections 15 and 16.</bridgehead>
51477
51478     <para>If the disclaimer of warranty and limitation of liability provided
51479     above cannot be given local legal effect according to their terms,
51480     reviewing courts shall apply local law that most closely approximates an
51481     absolute waiver of all civil liability in connection with the Program,
51482     unless a warranty or assumption of liability accompanies a copy of the
51483     Program in return for a fee.</para>
51484
51485     <bridgehead>END OF TERMS AND CONDITIONS</bridgehead>
51486
51487     <bridgehead id="HowToApply" renderas="sect1">How to Apply These Terms to
51488     Your New Programs</bridgehead>
51489
51490     <para>If you develop a new program, and you want it to be of the greatest
51491     possible use to the public, the best way to achieve this is to make it
51492     free software which everyone can redistribute and change under these
51493     terms.</para>
51494
51495     <para>To do so, attach the following notices to the program. It is safest
51496     to attach them to the start of each source file to most effectively state
51497     the exclusion of warranty; and each file should have at least the
51498     "copyright" line and a pointer to where the full notice is found.</para>
51499
51500     <screen>
51501 <replaceable>one line to give the program's name and a brief idea of what it does.</replaceable>
51502 Copyright (C) <replaceable>year</replaceable> <replaceable>name of author</replaceable>
51503
51504 This program is free software: you can redistribute it and/or modify
51505 it under the terms of the <acronym>GNU</acronym> General Public License as published by
51506 the Free Software Foundation, either version 3 of the License, or
51507 (at your option) any later version.
51508
51509 This program is distributed in the hope that it will be useful,
51510 but WITHOUT ANY WARRANTY; without even the implied warranty of
51511 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
51512 <acronym>GNU</acronym> General Public License for more details.
51513
51514 You should have received a copy of the <acronym>GNU</acronym> General Public License
51515 along with this program.  If not, see <ulink url="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</ulink>.
51516   </screen>
51517
51518     <para>Also add information on how to contact you by electronic and paper
51519     mail.</para>
51520
51521     <para>If the program does terminal interaction, make it output a short
51522     notice like this when it starts in an interactive mode:</para>
51523
51524     <screen>
51525 <replaceable>program</replaceable> Copyright (C) <replaceable>year</replaceable> <replaceable>name of author</replaceable>
51526 This program comes with ABSOLUTELY NO WARRANTY; for details type `<literal>show w</literal>'.
51527 This is free software, and you are welcome to redistribute it
51528 under certain conditions; type `<literal>show c</literal>' for details.
51529   </screen>
51530
51531     <para>The hypothetical commands `<literal>show w</literal>' and
51532     `<literal>show c</literal>' should show the appropriate parts of the
51533     General Public License. Of course, your program's commands might be
51534     different; for a GUI interface, you would use an "about box".</para>
51535
51536     <para>You should also get your employer (if you work as a programmer) or
51537     school, if any, to sign a "copyright disclaimer" for the program, if
51538     necessary. For more information on this, and how to apply and follow the
51539     <acronym>GNU</acronym> <acronym>GPL</acronym>, see <ulink url="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</ulink>.</para>
51540
51541     <para>The <acronym>GNU</acronym> General Public License does not permit
51542     incorporating your program into proprietary programs. If your program is a
51543     subroutine library, you may consider it more useful to permit linking
51544     proprietary applications with the library. If this is what you want to do,
51545     use the <acronym>GNU</acronym> Lesser General Public License instead of
51546     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>
51547   </appendix>
51548 </book>