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