From 561066a168a80cd64764fe3a8ffa6ec12c602485 Mon Sep 17 00:00:00 2001
From: Nicole Engard <nengard@gmail.com>
Date: Tue, 8 Dec 2009 20:59:44 -0500
Subject: [PATCH] updated help files with new documentation

---
 .../modules/help/circ/circulation-home.tmpl   | 16 +++-
 .../en/modules/help/circ/circulation.tmpl     | 86 ++++++++---------
 .../prog/en/modules/help/circ/returns.tmpl    | 94 +++++--------------
 .../en/modules/help/tools/csv-profiles.tmpl   | 24 +++++
 4 files changed, 98 insertions(+), 122 deletions(-)
 create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/csv-profiles.tmpl

diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/circulation-home.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/circulation-home.tmpl
index 86221f699b..df1f7e8fcf 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/circulation-home.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/circulation-home.tmpl
@@ -1,8 +1,18 @@
 <!-- TMPL_INCLUDE NAME="help-top.inc" -->
 
-<h1>Circulation Help</h1><h2>What can I do in Circulation?</h2>
+<h1>Circulation Help</h1>
+<h2>What can I do in Circulation?</h2>
+
+<p>Circulation is where items are check out and in to patrons. Some libraries use different nomeclature for these functions.</p>
+<p>Koha uses the following terms:</p>
+<ul>
+<li><strong>Check Out </strong>= issue an item to a patron</li>
+<li><strong>Check In</strong> = return an item from a patron</li>
+<li><strong>Transfer</strong> = used to change the holding branch of an item</li>
+<li><strong>Holds</strong> = items that patrons have placed a request on (called &quot;reserves&quot; in some libraries - not to be confused with &quot;Course Reserves&quot; used in academimc libraries)</li>
+<li><strong>Fast Cataloging</strong> = used for quick cataloging of a small record done at the time of circulation</li>
+</ul><br />
+
 
-<p>Circulation is where items are check out and in to patrons. Some libraries use different nomeclature for these functions.</p><p>Koha uses the following terms:</p><ul><li><strong>Check Out </strong>= issue an item to a patron</li><li><strong>Check In</strong> = return an item from a patron</li><li><strong>Transfer</strong> = used to change the holding branch of an item </li><li><strong>Holds</strong> = items that patrons have placed a request on (called &quot;reserves&quot; in some libraries - not to be confused with &quot;Course Reserves&quot; used in academimc libraries)</li></ul><br /><h3>INFORMATION: BRANCH AND PRINTER SETTINGS.
-</h3> Before you begin, it is very important that you take note of the branch and printer settings and change them if necessary. This should only have to be done the first time you do circulations from a workstation, after which a browser cookie will remember the correct settings. If you do circulations under the wrong branch settings then Koha will reset the location of all items scanned to the incorrect branch and the statistical reports will credit all circulations to the wrong branch     
 
 <!-- TMPL_INCLUDE name="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/circulation.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/circulation.tmpl
index bd9056b33b..6ae8ff29fd 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/circulation.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/circulation.tmpl
@@ -2,55 +2,45 @@
 
 <h1>Check Out (Issues)</h1>
 
+<p>To check an item out to a patron, first search for that patron using one of the many options.</p
+
+<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 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>
+</ul>
+<p>Below the box for the barcode there may be options for you to override the default due date for the item.</p>
+<ul>
+<li>This option will only appear if you have set the SpecifyDueDate system preference to allow staff to override the due date</li>
+</ul>
+<p>At the bottom of the page there is a summary of the patron's current checked out items along with the due date and the list of items the patron has on hold</p>
+<p>Once you have checked out all of the items for the patron you can print them a receipt by clicking the Print buton at the top of the screen and choosing 'Print Slip'</p>
+<p>If there are notes on the patron record these will appear to the right of the checkout box</p>
+<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>
+
+<h2>Check Out Warnings</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>
 <ul>
-	<li>Type or scan item barcodes in the 'Check out' field.<br />
-	<ul>
-		<li style="color: #990000">IMPORTANT: Depending on your barcode scanner's settings you may have to click 'Submit' after scanning the barcode</li>
-		<li style="background-color: #ffe599">TIP: You can use the 'Specify Due Date' field to change the programmed due date if you want to offer an exception. <br />
-		</li>
-	</ul>
-	</li>
-	<li>Click 'Check out'</li>
-	<li>If
-	the patron has overdue items a note will appear on the patron record to
-	that affect so that the circulation staff can manage the situation
-	while the patron is present<br />
-	</li>
-	<li>If the patron has any outstanding fines it will also appear on the patron record<br />
-	</li>
-	<li>Once you have finished checking out items, you can print a receipt by clicking Print &gt; Print Slip<br />
-	
-	<ul>
-		<li style="background-color: #ffe599">TIP: Find out more about printing to your receipt printer here: <a id="au6g" href="http://wiki.koha.org/doku.php?id=receipt_printing" title="http://wiki.koha.org/doku.php?id=receipt_printing">http://wiki.koha.org/doku.php?id=receipt_printing</a>  <br />
-		</li>
-	</ul>
-	</li>
-	<li>If a patron has reached the max fine amount, check out will be disabled<br />
-	
-	<ul>
-		<li style="background-color: #ffe599">TIP: The noissuescharge system preference defines when checkouts will be disabled
-		<ul>
-			<li><em>Get there: </em>More &gt; Administration &gt; Circulation &gt; noissuescharge</li>
-		</ul>
-		</li>
-	</ul>
-	</li>
-	<li>If a circulation librarian marks a patron as 'Gone no Address', then the patron will be unable to check items out<br />
-	
-	<ul>
-		<li>A warning will appear if a librarian tries to check an item out to a patron who has been marked as 'Gone no Address'<br />
-		</li>
-	</ul>
-	</li>
-	<li>If a patron has been 'Debarred' you will not be able to check out items<br />
-	
-	<ul>
-		<li>A warning will appear if a librarian tries to check an item out to a patron who has been marked as 'Debarred'<br />
-		</li>
-		<li>A warning will appear if a librarian tries to check an item out to a patron who has expired<br />
-		</li>
-	</ul>
-	</li>
+<li>Patron owes too much in fines
+<ul><li>You can set the amount at which patron checkouts are blocked with the noissuescharge system preference</li></ul>
+</li>
+<li>Patron has been barred from the library
+<ul><li>This can be set by the librarian editing a patron record and adding a flag or by the Overdue/Notice Status Triggers</li></ul>
+</li>
+<li>Patron needs to confirm their address
+<ul><li>This can be set by the librarian editing a patron record and adding a flag</li></ul>
+</li>
+<li>Patron has lost their library card
+<ul><li>This can be set by the librarian editing a patron record and adding a flag</li></ul>
+</li>
 </ul>
 
+<h2>Circulation Messages</h2>
+<p>Circulation messages are short messages that librarians can leave for their patrons or their colleagues that will appear at the time of circulation.</p>
+<p>Circulation messages are set up as Authorized Values. To add or edit Circulation Messages you want to work with the BOR_NOTES value.</p>
+<p>To add a message, visit the patron's record.  When on the patron's check out tab you will see a link to 'Add a new message' to the right of the check out box.</p>
+<p>When you click 'Add a new message' you will be asked to choose if the message is for the librarians or the patron and the message you would like to leave.</p>
+<p>Circulation messages meant for the staff will appear on the patron's checkout screen.</p>
+<p>Circulation messages meant for the patron will appear when they log into the OPAC.</p>
+
+
 <!-- TMPL_INCLUDE name="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/returns.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/returns.tmpl
index df7a2d3b09..e1cedd6aeb 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/returns.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/returns.tmpl
@@ -2,78 +2,30 @@
 
 <h1>Circulation Check In (Returns)</h1>
 
-
+<p>To check an item in scan the barcode for the item into the box provided. A summary of all items checked in will appear below the checkin box</p>
+<p>If you are checking items in that were put in the dropbox while the library was closed you can check the 'Dropbox mode' box before scanning items. This will effectively roll back the returned date to the last date the library was open.</p>
 <ul>
-	<li>Click 'Check In' on your global navigation bar.<br />
-	<ul>
-		<li style="background-color: #ffe599">TIP:
-		Do not use this method to check items in if you want to forgive fines
-		or use dropbox mode, instead use the check in form found under
-		Circulation.
-		<ul>
-			<li><em>Get there:</em> Circulation &gt; Check In</li>
-		</ul>
-		</li>
-	</ul>
-	</li>
-	<li>Type or scan the item barcode into the 'check in' box.
-	<ul>
-		<li style="color: #990000">IMPORTANT: Depending on your barcode scanner's settings you may have to click 'Submit' after scanning the barcode</li>
-	</ul>
-	</li>
-	<li>You will be brought to a confirmation page for the checked in item.<br />
-	<ul>
-		<li style="background-color: #ffe599">TIP: When you have multiple
-		branches in your system, Koha will notify you when a book needs
-		returned to its home branch. </li>
-	</ul>
-	</li>
-	<li>To
-	check in additional items enter the barcodes into the field at the top
-	of the screen or the field above your list of checked in items
-	<ul>
-		<li style="background-color: #ffe599">TIP:
-		The only difference between these fields is that the quick check-in box
-		at the top will produce a confirmation for one book at a time, the box
-		above the list of 'Checked-In items' will continue to update the list.</li>
-	</ul>
-	</li>
-	<li>If checking in a book from the 'Check In' page you will have two options to choose from before checking the item in</li>
-	<li>Should you want to forgive any overdue fines on the item you're checking in, you can click the 'Forgive overdue charges' box.</li>
-	<li>If
-	you are checking in items returned after the library closed the
-	previous night (or after a holiday closing) you can check the 'Dropbox
-	mode' option to have the system ignore any fines that may have been
-	accrued while the library was closed.
-	<ul>
-		<li style="background-color: #ffe599">TIP: Dropbox mode will check the calendar and assume that the book was returned on the last day that the library was open.</li>
-	</ul>
-	</li>
+<li>This requires that you have your closings added to the Holidays & Calendar Tool</li>
 </ul>
-<h2>Questions</h2>
-<h3>What happens if I check in an item that was thought to be lost? <br />
-</h3>
-<p>
-When you check it in you will get a message telling you that the book has been marked as found.&nbsp; 
-</p>
-<p>
-This means that the Lost status is changed on the item back to available.
-</p>
-<h3>How is the dropbox date is determined? <br />
-</h3>
-<p>
-Is it the last open date for the
-checkout branch? Is it today's date minus one? Can the dropbox checkin
-date be set? If the library is closed for four days for repairs, for
-example, there would be more than one day needed for the dropbox date.
-</p>
-<p>
-You will only have one dropbox date and that will be the last day that
-the library open (determined by the holiday calendar) because there is
-no real way to know what day the
-books were dropped into the box during the 4 closed days. The only way
-to change the effective checkin date in dropbox mode is to modify the
-calendar.
-</p>
+<p>You can also choose to forgive all overdue charges for items you are checking in by checking the 'Forgive overdue charges' box before scanning items.</p>
+
+<h2>Check In Warnings</h2>
+<p>There are several messages that can appear when checking items in:</p>
+<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'</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 receieved by the home branch.</li></ul></li>
+</li></ul>
+<li>If you're checking an item in that has a hold on it, you will be prompted to confirm the hold</li>
+<ul><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</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>
+
 
 <!-- TMPL_INCLUDE name="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/csv-profiles.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/csv-profiles.tmpl
new file mode 100644
index 0000000000..a27ddc0a8f
--- /dev/null
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/csv-profiles.tmpl
@@ -0,0 +1,24 @@
+<!-- TMPL_INCLUDE NAME="help-top.inc" -->
+
+<h1>CSV Profiles</h1>
+
+<p>CSV Profiles are created to define how you would like your cart or list to export.</p>
+
+<p>To add a CSV Profile enter the following info:</p>
+<ul>
+<li>The 'Profile name' will appear on the export pull down list when choosing 'Download' from your cart or list</li>
+<li>The 'Profile description' is for your own benefit</li>
+<li>Finally format your CSV file using the 'Profile marcfields' fields
+<ul><li>Define which fields or subfields you want to export, separated by pipes. Example : 200|210$a|301</li></ul>
+</li>
+</ul>
+
+<p>Once you have created at least one CSV Profile an option to 'Modify CSV Profiles' will appear below the Add form
+<ul><li>Choose the profile you would like to edit and alter the necessary fields.</li>
+<li>To delete a profile, check the 'Delete selelcted profile' option before clicking 'Submit Query'</li></ul>
+
+<h2>Using CSV Profiles</h2>
+<p>Your CSV Profiles will appear on the export list or cart menu under the 'Download' button</p>
+
+
+<!-- TMPL_INCLUDE name="help-bottom.inc" -->
\ No newline at end of file
-- 
2.39.5