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