Koha-community/Koha
13
7
Fork 0
Code Issues Releases Wiki Activity

Bug 6966: Circulation Help Files

Browse source 
This patch updates the help files in the circ folder.
It also adds links to manual pages where needed.
This commit is contained in:
Nicole C. Engard 2011-10-06 11:29:17 -04:00 committed by Chris Cormack
parent 0f6e7d5eb4
commit ab55e630a8
12 changed files with 69 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/branchoverdues.tt
View file

@ -1,6 +1,6 @@
[% INCLUDE 'help-top.inc' %]
<h3>Overdue fines</h3>
<h1>Overdues with Fines</h1>
<p>This report shows items that:
<ul>
@ -13,3 +13,6 @@
<p>Once open the report can be filtered by the shelving location.</p>
<p><strong>See the full documentation for Overdues with Fines in the <a href="http://manual.koha-community.org/3.6/en/circreports.html#overduesfines">manual</a> (online).</strong></p>
[% INCLUDE 'help-bottom.inc' %]

4
koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/branchtransfers.tt
View file

@ -20,5 +20,7 @@
</ul>
</li>
</ul>
<p><strong>See the full documentation for Transfers in the <a href="http://manual.koha-community.org/3.6/en/transfers.html">manual</a> (online).</strong></p>
[% INCLUDE 'help-bottom.inc' %]

26
koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/circulation-home.tt
View file

@ -1,14 +1,13 @@
[% INCLUDE 'help-top.inc' %]
[% INCLUDE 'help-top.inc' %]
<h1>Circulation</h1>
<p>
Circulation functions can be accessed in several different ways. On the main page of the staff client there are some quick links in the center of the page to check items out, in or transfer them. For a complete listing of Circulation functions you can visit the Circulation page which is linked from the top left of every page or from the center of the main page.
</p>
<p>
Before circulating your collection you will want to set your Global System Preferences, Basic Parameters and Patrons &amp; Circulation Rules.
</p>
<p>
While in Circulation you can jump between the tabs on the quick search box at the top of the screen by using the following hot keys:
</p>
<p>Circulation functions can be accessed in several different ways. On the main page of the staff client there are some quick links in the center of the page to check items out, in or transfer them. For a complete listing of Circulation functions you can visit the Circulation page which is linked from the top left of every page or from the center of the main page.</p>
<p>Before circulating your collection you will want to set your Global System Preferences, Basic Parameters and Patrons &amp; Circulation Rules.</p>
<p>While in Circulation you can jump between the tabs on the quick search box at the top of the screen by using the following hot keys:</p>
<ul>
<li>jump to the catalog search with Alt+Q</li>
<li>jump to the checkout with Alt+U
@ -18,8 +17,9 @@ While in Circulation you can jump between the tabs on the quick search box at th
</li>
<li>jump to the checkin with Alt+R</li>
</ul>
<p style="background-color: #ffe599">
Tip: Mac users use the OPTION button in place of ALT
</p>
<p style="background-color: #ffe599">Tip: Mac users use the OPTION button in place of ALT</p>
<p><strong>See the full documentation for Circulation in the <a href="http://manual.koha-community.org/3.6/en/circulation.html">manual</a> (online).</strong></p>
[% INCLUDE 'help-bottom.inc' %]

24
koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/circulation.tt
View file

@ -17,7 +17,8 @@
<p>At the top of the Check Out screen is a box for you to type or scan the item's barcode into.</p>
<ul>
<li>Many modern barcode scanners will send a 'return' to the browser, making it so that the 'Check Out' button is automatically clicked</li>
<li style="color: #990000;">Important: Many modern barcode scanners will send a 'return' to the browser, making it so that the 'Check Out' button is automatically clicked</li>
<li>If the barcode is not found you will be prompted to use fast cataloging to add the item. Learn more about fast cataloging later in this manual.</li>
</ul>
<p>Below the box for the barcode there may be options for you to override the default due date for the item.</p>
@ -30,13 +31,20 @@
<ul>
<li>This screen will show whether an item is renewable and if not, why not.</li>
<li>To override the renewal limits you can set the AllowRenewalLimitOverride system preference to allow overrides and a checkbox will appear below the list of checkouts that reads 'Override Renewal Limit'</li>
<li>To override the renewal limits you can set the AllowRenewalLimitOverride system preference to allow overrides and a checkbox will appear below the list of checkouts that reads 'Override Renewal Limit'
<ul>
<li>Checking that box will add checkboxes in the renew column above where before the item was not renewable.</li>
</ul>
</li>
</ul>
<p>Also at the bottom of the page is the list of items the patron has on hold</p>
<p>Also at the bottom of the page is the list of items the patron has on hold
<p>Once you have checked out all of the items for the patron you can print them a receipt by clicking the Print button at the top of the screen and choosing 'Print Slip' or 'Quick Slip'.</p>
<p>Once you have checked out all of the items for the patron you can print them a receipt by choosing one of two methods.</p>
<p>The first is that you can simply hit enter on your keyboard or scan a blank piece of paper with your barcode scanner. The idea being that you're "checking out" a blank barcode which triggers Koha to print the 'Quick Slip.'</p>
<p>The second is that you can click the Print button at the top of the screen and choosing 'Print Slip' or 'Quick Slip'.</p>
<p>If you choose 'Print Slip' it will print all of the items the patron has checked out, including those they checked out at an earlier date. Choosing 'Quick Slip' will print only the items that were checked out today.</p>
@ -44,10 +52,14 @@
<p>If the patron has a hold waiting at the library that too will appear to the right of the check out box making it easy for the circulation librarian to see that there is another item to give the patron</p>
<p>When you're done checking an item out if you have the DisplayClearScreenButton preference set to 'Show' you can clear the current patron by clicking the X in the top right of the patron's info to remove the current patron from the screen and start over.</p>
<h2>Check Out Messages</h2>
<p>There are times when Koha will prevent the librarian from being able to check out items to a patron. When this happens a warning will appear notifying the librarian of why the patron cannot check items out.</p>
<p>These are the possible messages you might see:</p>
<ul>
<li>Patron owes too much in fines
<ul>
@ -75,6 +87,8 @@
<p>Sometimes checkouts will trigger warning messages that will appear in a yellow box above the check out field. These warnings need to be acknowledged before you will be able to continue checking items out.</p>
<p>These are the possible warnings you might see:</p>
<ul>
<li>Patron has outstanding fines</li>
<li>Item on hold for someone else</li>
@ -91,4 +105,6 @@
<li>Barcode not found</li>
</ul>
<p><strong>See the full documentation for Checking Out in the <a href="http://manual.koha-community.org/3.6/en/circulation.html#checkingout">manual</a> (online).</strong></p>
[% INCLUDE 'help-bottom.inc' %]

2
koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/overdue.tt
View file

@ -11,4 +11,6 @@
<li style="background-color: #ffe599">Tip: Large libraries can choose to filter the report before it runs by setting the FilterBeforeOverdueReport system preference to 'Require'.</li>
</ul>
<p><strong>See the full documentation for Overdues in the <a href="http://manual.koha-community.org/3.6/en/circreports.html#overduesreport">manual</a> (online).</strong></p>
[% INCLUDE 'help-bottom.inc' %]

2
koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/pendingreserves.tt
View file

@ -23,4 +23,6 @@
<p>You can limit the results you see by using the Refine box on the left side of the page</p>
<p><strong>See the full documentation for Holds to Pull in the <a href="http://manual.koha-community.org/3.6/en/circreports.html#holdspull">manual</a> (online).</strong></p>
[% INCLUDE 'help-bottom.inc' %]

2
koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/reserveratios.tt
View file

@ -4,5 +4,7 @@
<p>Hold ratios help with collection development. Using this report you will be able to see how many of your patrons have holds on items and whether you should buy more. By default it will be set to the library needing 3 items per hold that has been placed. The report will tell you how many additional items need to be purchased to meet this quota.</p>
<p><strong>See the full documentation for Hold Ratios in the <a href="http://manual.koha-community.org/3.6/en/circreports.html#holdratios">manual</a> (online).</strong></p>
[% INCLUDE 'help-bottom.inc' %]

12
koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/returns.tt
View file

@ -5,8 +5,8 @@
<p>Checking in items can be performed from various different locations</p>
<ul>
<li>The check in link on main staff client&nbsp;</li>
<li>The check in option on the quick search bar on the Circulation page&nbsp;</li>
<li>The check in box on main staff client</li>
<li>The check in option on the quick search bar on the Circulation page</li>
<li>The check in link on the patron's checkout summary (and on the checkout summary page)</li>
</ul>
@ -29,7 +29,7 @@
<ul>
<li>If you are checking an item in at a library other than the home branch, a message will appear asking you to transfer the book to the home library
<ul>
<li>After this item is checked in the status of the item will be changed in the catalog to 'in transit'&nbsp;</li>
<li>After this item is checked in the status of the item will be changed in the catalog to 'in transit'</li>
<li>To mark an item as back at the home branch, check the item in at the home branch
<ul>
<li>A message will appear tell you that the item is not checked out, but the status will now say available in the catalog. This step is necessary to mark items as received by the home branch.</li>
@ -39,18 +39,20 @@
</li>
<li>If you're checking an item in that has a hold on it, you will be prompted to confirm the hold
<ul>
<li>Clicking the Confirm hold button will mark the item as waiting for pickup from the library&nbsp;</li>
<li>Clicking the Confirm hold button will mark the item as waiting for pickup from the library</li>
<li>Clicking the Print Slip and Confirm button will mark the item as waiting for pickup at the library and present the library with a receipt to print and place on the book with the patron's information</li>
<li>Ignoring the hold will leave the item on hold, but leave its status as Available (it will not cancel the hold)</li>
</ul>
</li>
<li>If you're checking in an item that has a hold on it at another branch you will be prompted to confirm and transfer the item
<ul>
<li>Clicking the Confirm hold and Transfer button will mark the item as in transit to the library where the hold was placed&nbsp;</li>
<li>Clicking the Confirm hold and Transfer button will mark the item as in transit to the library where the hold was placed</li>
<li>Clicking the Print Slip, Transfer and Confirm button will mark the item as in transit to the library where the hold was placed and present the library with a receipt to print and place on the book with the patron's information</li>
<li>Ignoring the hold will leave the item on hold, but leave its status as Available (it will not cancel the hold)</li>
</ul>
</li>
</ul>
<p><strong>See the full documentation for Checking In in the <a href="http://manual.koha-community.org/3.6/en/checkingin.html">manual</a> (online).</strong></p>
[% INCLUDE 'help-bottom.inc' %]

38
koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/selectbranchprinter.tt
View file

@ -1,35 +1,13 @@
[% INCLUDE 'help-top.inc' %]
<h1>Set Library:</h1>
<h1>Set Library</h1>
<p>There are three ways to set your home branch.</p>
<p style="color: #ff0000">
IMPORTANT: You will not be able to perform circulation functions without first setting a library.</p>
<ul>
<li>
Most commonly the home branch is set when adding a staff patron. (See the Adding Staff Patrons part of this manual). When staff members login their home branch will be set automatically. You can see that branch in the top right of the staff client</li>
<li>
If a library is not set you will see a notice to that affect.</li>
<li>
To set the library you can click '(Set)' to the right of the 'NO_LIBRARY_SET' label</li>
<li>
The other way to set the library is to click 'Set library' on the main circulation page</li>
<li>
Choose your home branch from the menu you are presented with</li>
<li>
Click 'Submit'</li>
</ul>
<h2>What is a home branch?</h2>
<p>
The home branch is the branch you want recorded as the origination of circulation functions while you are logged in.</p>
<p>
For example, if your home branch is set to 'Main Library', any items checked out to a patron on your terminal will be considered by Koha to be checked out from the
'Main Library'
branch. An item transferred on that computer will be recorded as transferred from the 'Main Library' branch.</p>
<h2>Why would I want to set a home branch?</h2>
<p>
Setting your home branch is critical. It enables Koha to accurately record statistics, circulation (what branch an item has been checked out from or returned to), and transfers.</p>
<p>By default you will enter the staff client as if you are at your home library. This library will appear in the top right of the Staff Client.</p>
<p>This is the library that all circulation transactions will take place at. If you are at another library (or on a bookmobile) you will want to set your library before you start circulating items. To do this you can click 'Set' at the top right or on the Circulation page.</p>
<p>Once you have saved your changes you new library will appear in the top right.</p>
<p><strong>See the full documentation for Setting your Library in the <a href="http://manual.koha-community.org/3.6/en/setlibrary.html">manual</a> (online).</strong></p>
[% INCLUDE 'help-bottom.inc' %]

2
koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/transferstoreceive.tt
View file

@ -8,4 +8,6 @@
<p style="color: #990000">Important: An item is considered late based on the number of days you have entered in the TransfersMaxDaysWarning system preference.</p>
<p><strong>See the full documentation for Transfers to Receive in the <a href="http://manual.koha-community.org/3.6/en/circreports.html#transferstoreceive">manual</a> (online).</strong></p>
[% INCLUDE 'help-bottom.inc' %]

2
koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/view_holdsqueue.tt
View file

@ -4,4 +4,6 @@
<p>This report will show you all of the holds at your library. To generate this report, you must have the Build Holds Queue cron job running.</p>
<p><strong>See the full documentation for the Holds Queue in the <a href="http://manual.koha-community.org/3.6/en/circreports.html#holdsqueue">manual</a> (online).</strong></p>
[% INCLUDE 'help-bottom.inc' %]

4
koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/waitingreserves.tt
View file

@ -4,4 +4,8 @@
<p>This report will show all of the holds that are waiting for patrons to pick them up.</p>
<p>Items that have been on the hold shelf longer than you normally allow (based on the ReservesMaxPickUpDelay preference value) will appear on the 'Holds Over' tab, they will not automatically be cancelled.</p>
<p><strong>See the full documentation for Holds Awaiting Pickup in the <a href="http://manual.koha-community.org/3.6/en/circreports.html#holdspickup">manual</a> (online).</strong></p>
[% INCLUDE 'help-bottom.inc' %]