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

   1 [% INCLUDE 'help-top.inc' %]
   2
   3 <h1>Notices</h1>
   4
   5 <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>
   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.</p>
   8
   9 <h2>Adding Notices</h2>
  10
  11 <p>To add a new notice</p>
  12
  13 <ul>
  14         <li>Click 'New Notice'</li>
  15         <li>Choose the module this notice is related to</li>
  16         <li>The Code is limited to 20 characters</li>
  17         <li>Use the name field to expand on your Code</li>
  18         <li>Message Subject is what will appear in the subject line of the email</li>
  19         <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.
  20 <ul>
  21         <li style="color: #990000;">Important: On overdue notices make sure to use &lt;&lt;items.content&gt;&gt; to print out the data related to all items that are overdue. The other option is to use the &lt;item&gt;&lt;/item&gt; tags to span the line so that it will print out multiple lines</li>
  22         <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>
  23 </ul>
  24 </li>
  25 </ul>
  26
  27 <h3>Notice Markup</h3>
  28
  29 <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>
  30
  31 <p style="color: #990000;">Important: These new tags only work on the overdue notices, not other circulation related notices at this time.</p>
  32
  33 <ul>
  34         <li>&lt;item&gt;&lt;/item&gt; which should enclose all fields from the biblio, biblioitems, and items tables.</li>
  35         <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.
  36 <ul>
  37         <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>
  38 </ul>
  39 </li>
  40 </ul>
  41
  42 <p>An example of using these two tags in a notice template might be like:
  43
  44 <blockquote>
  45 <pre>The following item(s) is/are currently overdue:
  46    &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>
  47 </blockquote>
  48
  49 <p>Which, assuming two items were overdue, would result in a notice like:</p>
  50
  51 <blockquote>
  52 <pre>The following item(s) is/are currently overdue:
  53 "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: £3.50
  54 "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: £3.50</pre>
  55 </blockquote>
  56
  57 <h2>Existing Notices</h2>
  58
  59 <p>Among the default notices are notices for several common actions within Koha, here are some of what those notices do</p>
  60
  61 <ul>
  62         <li>ACCTDETAILS
  63 <ul>
  64         <li>Sent to patrons when their account is set up if the AutoEmailOPACUser preference is set to 'Send'</li>
  65 </ul>
  66 </li>
  67         <li>ACQCLAIM (Acquisition Claim)
  68 <ul>
  69         <li>Used in the claim acquisition module</li>
  70         <li>Get there: More &gt; Acquisitions &gt; Late issues</li>
  71 </ul>
  72 </li>
  73         <li>HOLD (Hold Available for Pickup)
  74 <ul>
  75         <li>This notice is used if two criteria are met:
  76 <ul>
  77         <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
  78         <li>The patron has requested to receive this notice
  79 <ul>
  80         <li>Get there: OPAC &gt; Login &gt; my messaging</li>
  81         <li>Get there: Staff Client &gt; Patron Record &gt; Notices</li>
  82 </ul>
  83 </li>
  84 </ul>
  85 </li>
  86 </ul>
  87 </li>
  88         <li>HOLDPLACED (a notice to the library staff that a hold has been placed)
  89 <ul>
  90         <li>This notice requires the emailLibrarianWhenHoldIsPlaced system preference to be set to 'Enable'</li>
  91 </ul>
  92 </li>
  93         <li>HOLD_PRINT (Printed notice when hold available for pickup)
  94 <ul>
  95         <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>
  96 </ul>
  97 </li>
  98         <li>ODUE (Overdue Notice)
  99 <ul>
 100         <li>This notice is used to send Overdue Notices to Patrons</li>
 101         <li>Requires that you set Overdue Notice/Status Triggers</li>
 102 </ul>
 103 </li>
 104         <li>RLIST (Routing List)
 105 <ul>
 106         <li>Used in the serials module to notify patrons/staff of new issues of a serial
 107 <ul>
 108         <li>Get there: More &gt; Serials &gt; New Subscription</li>
 109 </ul>
 110 </li>
 111         <li>You have the option to select the 'Routing List' notice when creating a new subscription (Choose from the 'Patron notification' drop down).</li>
 112         <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>
 113 </ul>
 114 </li>
 115 </ul>
 116
 117 <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>
 118
 119 [% INCLUDE 'help-bottom.inc' %]