[% INCLUDE 'help-top.inc' %]
-<h1>Notices</h1>
+<h1>Notices & Slips</h1>
-<p>All notices sent by Koha can be customized using the Notices Tool. The system comes with several predefined templates that will appear when you first visit the Notices Tool</p>
+<p>All notices and circulation receipts (or slips) generated by Koha can be customized using the Notices & Slips Tool. The system comes with several predefined templates that will appear when you first visit this tool.</p>
-<p>Each notice can be edited, but only a few can be deleted, this is to prevent system errors should a message try to send without a template.</p>
+<p>Each notice can be edited, but only a few can be deleted, this is to prevent system errors should a message try to send without a template. Each notice and slip can be edited on a per library basis, by default you will see the notices for all libraries.</p>
-<h2>Adding Notices</h2>
+<p>If you have a style you'd like applied to all slips you can point the SlipCSS preference to a stylesheet. The same is true for notices, using the NoticeCSS preference to define a stylesheet.</p>
-<p>To add a new notice</p>
+<h3>Adding Notices & Slips</h3>
+
+<p>To add a new notice or slip
<ul>
<li>Click 'New Notice'</li>
+ <li>Choose which library this notice or slip is for</li>
<li>Choose the module this notice is related to</li>
<li>The Code is limited to 20 characters</li>
<li>Use the name field to expand on your Code</li>
+ <li>If you plan on writing the notice or slip in HTML check the 'HTML Message' box, otherwise the content will be generated as plain text</li>
<li>Message Subject is what will appear in the subject line of the email</li>
<li>In the message body feel free to type whatever message you feel is best, use the fields on the left hand side to enter individualized data from the from database.
<ul>
- <li style="color: #990000;">Important: On overdue notices make sure to use <<items.content>> to print out the data related to all items that are overdue. The other option is to use the <item></item> tags to span the line so that it will print out multiple lines</li>
- <li style="color: #990000;">Important: Only the overdue notices take advantage of the <item></item> tags, all other notices referencing items need to use <<items.content>></li>
+ <li style="color: #990000;">Important: Overdue notices can use <<items.content>> tags by themselves, or use <item></item> to span all of the tags. Learn more about the Overdue Notice Markup</li>
+<ul>
+ <li>On overdue notices make sure to use <<items.content>> tags to print out the data related to all items that are overdue.</li>
+</ul>
+<ul>
+ <li>The other option, only for overdue notices, is to use the <item></item> tags to span the line so that it will print out multiple lines One example for the <item></item> tag option is:<item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> , Checkout date: <<issues.issuedate>>, Due date: <<issues.date_due>> Fine: <fine>USD</fine> Due date: <<issues.date_due>> </item></li>
+</ul>
</ul>
</li>
+ <li style="color: #990000;">Important: Only the overdue notices take advantage of the <item></item> tags, all other notices referencing items need to use <<items.content>></li>
</ul>
-<h3>Notice Markup</h3>
+<h4>Overdue Notice Markup</h4>
<p>When creating your overdue notices there are two tags in addition to the various database fields that you can use in your notices.</p>
-<p style="color: #990000;">Important: These new tags only work on the overdue notices, not other circulation related notices at this time.</p>
+<p style="color: #990000;">Important These new tags only work on the overdue notices, not other circulation related notices at this time.</p>
<ul>
<li><item></item> which should enclose all fields from the biblio, biblioitems, and items tables.</li>
<li><fine></fine> which should be enclosed by the item tag and should enclose a currency identifier per ISO 4217. If this tag is present with a proper identifier, the fine for that item will be displayed in the proper currency format.
<ul>
- <li>Note: ISO 4217 changes from time to time therefore all currencies may not be supported. If you find one that is not supported, please file a bug with the Locale::Currency::Format author Tan D Nguyen <tnguyen at cpan doe org>.</li>
+ <li>Note: ISO 4217 changes from time to time therefore all currencies may not be supported. If you find one that is not supported, please file a bug with the Locale::Currency::Format author Tan D Nguyen <tnguyen at cpan doe org></li>
</ul>
</li>
</ul>
-<p>An example of using these two tags in a notice template might be like:
+<p>An example of using these two tags in a notice template might be like:</p>
-<blockquote>
-<pre>The following item(s) is/are currently overdue:
- <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <fine>GBP</fine></item></pre>
-</blockquote>
+<pre class="programlisting"> The following item(s) is/are currently overdue:
-<p>Which, assuming two items were overdue, would result in a notice like:</p>
+ <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <fine>GBP</fine></item></pre>
+Which, assuming two items were overdue, would result in a notice like:
+<pre class="programlisting"> The following item(s) is/are currently overdue:
-<blockquote>
-<pre>The following item(s) is/are currently overdue:
-"A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: £3.50
-"History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: £3.50</pre>
-</blockquote>
+ "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: £3.50
+ "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: £3.50</pre>
-<h2>Existing Notices</h2>
+<h3>Existing Notices & Slips</h3>
-<p>Among the default notices are notices for several common actions within Koha, here are some of what those notices do</p>
+<p>Among the default notices are notices for several common actions within Koha. All of these notices can be customized by altering their text via the Notices & Slips tool and their style using the NoticeCSS preference to define a stylesheet. Here are some of what those notices do</p>
<ul>
<li>ACCTDETAILS
<li>ACQCLAIM (Acquisition Claim)
<ul>
<li>Used in the claim acquisition module</li>
- <li>Get there: More > Acquisitions > Late issues</li>
+ <li><span class="emphasis"><em>Get there:</em></span> More > Acquisitions > Late issues</li>
</ul>
</li>
<li>HOLD (Hold Available for Pickup)
<ul>
<li>This notice is used if two criteria are met:
-<ul>
- <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
+<div class="orderedlist">
+<ol type="1">
+ <li>The <span class="link">EnhancedMessagingPreferences</span> is set to 'Allow'</li>
<li>The patron has requested to receive this notice
<ul>
- <li>Get there: OPAC > Login > my messaging</li>
- <li>Get there: Staff Client > Patron Record > Notices</li>
-</ul>
-</li>
+ <li><span class="emphasis"><em>Get there: </em></span>OPAC > Login > my messaging</li>
+ <li><span class="emphasis"><em>Get there: </em></span>Staff Client > Patron Record > Notices</li>
</ul>
</li>
+</ol>
+</div></li>
+ <li>When this notice references the branches table it is referring to the pickup branch information.</li>
</ul>
</li>
<li>HOLDPLACED (a notice to the library staff that a hold has been placed)
<ul>
<li>This notice requires the emailLibrarianWhenHoldIsPlaced system preference to be set to 'Enable'</li>
+ <li>When this notice references the branches table it is referring to the pickup branch information.</li>
</ul>
</li>
<li>HOLD_PRINT (Printed notice when hold available for pickup)
<ul>
<li>This notice is used for hold confirmation notices that are sent out in print format. This will not effect what the email notice looks like.</li>
+ <li>When this notice references the branches table it is referring to the pickup branch information.</li>
</ul>
</li>
<li>ODUE (Overdue Notice)
<ul>
<li>This notice is used to send Overdue Notices to Patrons</li>
- <li>Requires that you set Overdue Notice/Status Triggers</li>
+ <li>See a <span class="link">Sample Overdue Notice</span></li>
+ <li>Requires that you set <span class="link">Overdue Notice/Status Triggers</span></li>
</ul>
</li>
<li>RLIST (Routing List)
<ul>
<li>Used in the serials module to notify patrons/staff of new issues of a serial
<ul>
- <li>Get there: More > Serials > New Subscription</li>
+ <li><span class="emphasis"><em>Get there:</em></span> More > Serials > <span class="link">New Subscription</span></li>
</ul>
</li>
<li>You have the option to select the 'Routing List' notice when creating a new subscription (Choose from the 'Patron notification' drop down).</li>
- <li style="background-color: #ffe599">Tip: Notice also that if you'd like to notify patrons of new serial issues, you can click on 'define a notice' which will take you to the 'Notices' tool</li>
+ <li style="background-color: #ffe599;">Tip: Notice also that if you'd like to notify patrons of new serial issues, you can click on 'define a notice' which will take you to the 'Notices' tool</li>
+</ul>
+</li>
+</ul>
+
+<p>There are also a set of predefined slips (or receipts) listed on this page. All of these slips can be customized by altering their text via the Notices & Slips tool and their style using the <span class="link">SlipCSS</span> preference to define a stylesheet.</p>
+
+<p>Here is what those slips are used for:</p>
+
+<ul>
+ <li>ISSUEQSLIP
+<ul>
+ <li>Used to print the quick slip in circulation</li>
+ <li>The quick slip only includes items that were checked out today</li>
+</ul>
+</li>
+ <li>ISSUESLIP
+<ul>
+ <li>Used to print a full slip in circulation</li>
+ <li>The slip or receipt will show items checked out today as well as items that are still checked out</li>
+</ul>
+</li>
+ <li>RESERVESLIP
+<ul>
+ <li>Used to print a holds slip</li>
+ <li>The holds slip is generated when a hold is confirmed</li>
+</ul>
+</li>
+ <li>TRANSFERSLIP
+<ul>
+ <li>Used to print a transfer slip</li>
+ <li>The transfer sliip is printed when you confirm a transfer from one branch to another in your system</li>
</ul>
</li>
</ul>
-<p><strong>See the full documentation for Notices in the <a href="http://manual.koha-community.org/3.6/en/notices.html">manual</a> (online).</strong></p>
+<p><strong>See the full documentation for Notices in the <a href="http://manual.koha-community.org/3.8/en/notices.html">manual</a> (online).</strong></p>
[% INCLUDE 'help-bottom.inc' %]
\ No newline at end of file
projects / koha.git / blobdiff