koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/letter.tt

   1 [% INCLUDE 'help-top.inc' %]
   2
   3 <h1>Notices & Slips</h1>
   4
   5 <p>All notices and circulation receipts (or slips) generated by Koha can be customized using the Notices &amp; Slips Tool. The system comes with several predefined templates that will appear when you first visit this tool.</p>
   6
   7 <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>
   8
   9 <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>
  10
  11 <h3>Adding Notices & Slips</h3>
  12
  13 <p>To add a new notice or slip
  14
  15 <ul>
  16         <li>Click 'New Notice'</li>
  17     <li>Choose which library this notice or slip is for</li>
  18         <li>Choose the module this notice is related to</li>
  19         <li>The Code is limited to 20 characters</li>
  20         <li>Use the name field to expand on your Code</li>
  21     <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>
  22         <li>Message Subject is what will appear in the subject line of the email</li>
  23         <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.
  24 <ul>
  25     <li style="color: #990000;">Important: Overdue notices can use &lt;&lt;items.content&gt;&gt; tags by themselves, or use &lt;item&gt;&lt;/item&gt; to span all of the tags. Learn more about the Overdue Notice Markup</li>
  26 <ul>
  27     <li>On overdue notices make sure to use &lt;&lt;items.content&gt;&gt; tags to print out the data related to all items that are overdue.</li>
  28 </ul>
  29 <ul>
  30     <li>The other option, only for overdue notices, is to use the &lt;item&gt;&lt;/item&gt; tags to span the line so that it will print out multiple lines One example for the &lt;item&gt;&lt;/item&gt; tag option is:&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; , Checkout date: &lt;&lt;issues.issuedate&gt;&gt;, Due date: &lt;&lt;issues.date_due&gt;&gt; Fine: &lt;fine&gt;USD&lt;/fine&gt; Due date: &lt;&lt;issues.date_due&gt;&gt; &lt;/item&gt;</li>
  31 </ul>
  32 </ul>
  33 </li>
  34     <li style="color: #990000;">Important: Only the overdue notices take advantage of the &lt;item&gt;&lt;/item&gt; tags, all other notices referencing items need to use &lt;&lt;items.content&gt;&gt;</li>
  35 </ul>
  36
  37 <h4>Overdue Notice Markup</h4>
  38
  39 <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>
  40
  41 <p style="color: #990000;">Important These new tags only work on the overdue notices, not other circulation related notices at this time.</p>
  42
  43 <ul>
  44         <li>&lt;item&gt;&lt;/item&gt; which should enclose all fields from the biblio, biblioitems, and items tables.</li>
  45         <li>&lt;fine&gt;&lt;/fine&gt; 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.
  46 <ul>
  47     <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 &lt;tnguyen at cpan doe org&gt;</li>
  48 </ul>
  49 </li>
  50 </ul>
  51
  52 <p>An example of using these two tags in a notice template might be like:</p>
  53
  54 <pre class="programlisting">   The following item(s) is/are currently overdue:
  55
  56    &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;fine&gt;GBP&lt;/fine&gt;&lt;/item&gt;</pre>
  57 Which, assuming two items were overdue, would result in a notice like:
  58 <pre class="programlisting">   The following item(s) is/are currently overdue:
  59
  60    "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: £3.50
  61    "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: £3.50</pre>
  62
  63 <h3>Existing Notices & Slips</h3>
  64
  65 <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 &amp; Slips tool and their style using the NoticeCSS preference to define a stylesheet. Here are some of what those notices do</p>
  66
  67 <ul>
  68         <li>ACCTDETAILS
  69 <ul>
  70         <li>Sent to patrons when their account is set up if the AutoEmailOPACUser preference is set to 'Send'</li>
  71 </ul>
  72 </li>
  73         <li>ACQCLAIM (Acquisition Claim)
  74 <ul>
  75         <li>Used in the claim acquisition module</li>
  76     <li><span class="emphasis"><em>Get there:</em></span> More &gt; Acquisitions &gt; Late issues</li>
  77 </ul>
  78 </li>
  79         <li>HOLD (Hold Available for Pickup)
  80 <ul>
  81         <li>This notice is used if two criteria are met:
  82 <div class="orderedlist">
  83 <ol type="1">
  84     <li>The <span class="link">EnhancedMessagingPreferences</span> is set to 'Allow'</li>
  85         <li>The patron has requested to receive this notice
  86 <ul>
  87     <li><span class="emphasis"><em>Get there: </em></span>OPAC &gt; Login &gt; my messaging</li>
  88     <li><span class="emphasis"><em>Get there: </em></span>Staff Client &gt; Patron Record &gt; Notices</li>
  89 </ul>
  90 </li>
  91 </ol>
  92 </div></li>
  93     <li>When this notice references the branches table it is referring to the pickup branch information.</li>
  94 </ul>
  95 </li>
  96         <li>HOLDPLACED (a notice to the library staff that a hold has been placed)
  97 <ul>
  98         <li>This notice requires the emailLibrarianWhenHoldIsPlaced system preference to be set to 'Enable'</li>
  99     <li>When this notice references the branches table it is referring to the pickup branch information.</li>
 100 </ul>
 101 </li>
 102         <li>HOLD_PRINT (Printed notice when hold available for pickup)
 103 <ul>
 104         <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>
 105     <li>When this notice references the branches table it is referring to the pickup branch information.</li>
 106 </ul>
 107 </li>
 108         <li>ODUE (Overdue Notice)
 109 <ul>
 110         <li>This notice is used to send Overdue Notices to Patrons</li>
 111     <li>See a <span class="link">Sample Overdue Notice</span></li>
 112     <li>Requires that you set <span class="link">Overdue Notice/Status Triggers</span></li>
 113 </ul>
 114 </li>
 115         <li>RLIST (Routing List)
 116 <ul>
 117         <li>Used in the serials module to notify patrons/staff of new issues of a serial
 118 <ul>
 119     <li><span class="emphasis"><em>Get there:</em></span> More &gt; Serials &gt; <span class="link">New Subscription</span></li>
 120 </ul>
 121 </li>
 122         <li>You have the option to select the 'Routing List' notice when creating a new subscription (Choose from the 'Patron notification' drop down).</li>
 123     <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>
 124 </ul>
 125 </li>
 126 </ul>
 127
 128 <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 &amp; Slips tool and their style using the <span class="link">SlipCSS</span> preference to define a stylesheet.</p>
 129
 130 <p>Here is what those slips are used for:</p>
 131
 132 <ul>
 133     <li>ISSUEQSLIP
 134 <ul>
 135     <li>Used to print the quick slip in circulation</li>
 136     <li>The quick slip only includes items that were checked out today</li>
 137 </ul>
 138 </li>
 139     <li>ISSUESLIP
 140 <ul>
 141     <li>Used to print a full slip in circulation</li>
 142     <li>The slip or receipt will show items checked out today as well as items that are still checked out</li>
 143 </ul>
 144 </li>
 145     <li>RESERVESLIP
 146 <ul>
 147     <li>Used to print a holds slip</li>
 148     <li>The holds slip is generated when a hold is confirmed</li>
 149 </ul>
 150 </li>
 151     <li>TRANSFERSLIP
 152 <ul>
 153     <li>Used to print a transfer slip</li>
 154     <li>The transfer sliip is printed when you confirm a transfer from one branch to another in your system</li>
 155 </ul>
 156 </li>
 157 </ul>
 158
 159 <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>
 160
 161 [% INCLUDE 'help-bottom.inc' %]