[Koha-patches] [PATCH] [BUG 12244] Update Notices Help Files
Nicole C. Engard
nengard at bywatersolutions.com
Tue May 13 15:21:26 CEST 2014
Updates the 2 notices help files with new info.
To test:
* Visit Tools > Notices & Slips
* Click help and confirm it's there and right
* Visit Tools > Overdue notices/status triggers
* Click help and confirm it's there and right
---
.../prog/en/modules/help/tools/letter.tt | 248 +++++++++++++++-----
.../prog/en/modules/help/tools/overduerules.tt | 6 +-
2 files changed, 200 insertions(+), 54 deletions(-)
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/letter.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/letter.tt
index 18d90a1..312b852 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/letter.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/letter.tt
@@ -10,62 +10,82 @@
<h3>Adding Notices & Slips</h3>
-<p>To add a new notice or slip
+<p>To add a new notice or slip</p>
<ul>
<li>Click 'New Notice'</li>
- <li>Choose which library this notice or slip is for</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>The Code is limited to 20 characters
+<ul>
+ <li style="color: #990000;">Important: When working with the overdue notices you want each notice at each branch to have a unique code. Think about using the branch code in front of the notice code for each branch.</li>
+</ul>
+</li>
+ <li>Use the name field to expand on your Code
+<ul>
+ <li style="background-color: #ffe599;">Tip: With overdue notices, be sure to put your branch name in the description as well so that it will be visible when setting up your triggers.</li>
+</ul>
+</li>
+ <li>Next you can customize the notice for every possible delivery method
+<ul>
+ <li>Every notice should have an Email template set for it</li>
+ <li>Next, you can set up a Feed template</li>
+ <li>If you're using the TalkingTechItivaPhoneNotification service you can set up a Phone notification</li>
+ <li>If you plan on printing this notice you can set the Print template next</li>
+ <li>If you have enabled SMS notices with the SMSSendDriver preference you can set the text for your SMS notices next</li>
+</ul>
+</li>
+ <li>Each notice offers you the same options
+<ul>
+ <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: 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>
+ <li><span style="color: #990000;">Important: Overdue notices can use <<items.content>> tags by themselves, or use <item></item> to span all of the tags.</span>
<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>
+ <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: <<items.fine>> Due date: <<issues.date_due>> </item></li>
+ <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: <<items.fine>> Due date:
+<<issues.date_due>> </item></li>
</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>
+ <li style="background-color: #ffe599;">Tip: To add today's date you can use the <<today>> syntax</li>
+</ul>
+</li>
</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>
-<h4>Overdue Notice Markup</h4>
+<h5>Overdue Notice Markup</h5>
<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>
-</ul>
-</li>
-</ul>
+<p>These tags are <item> and </item> which should enclose all fields from the biblio, biblioitems, and items tables.</p>
-<p>An example of using these two tags in a notice template might be like:</p>
+<p>An example of using these tags in a notice template might be like:</p>
-<pre>The following item(s) is/are currently overdue:
+<p>The following item(s) is/are currently overdue:</p>
- <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <<items.fine>> </item></pre>
+<p> <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <<items.fine>></item></p>
<p>Which, assuming two items were overdue, would result in a notice like:</p>
-<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>
+<p>The following item(s) is/are currently overdue:</p>
-<h3>Existing Notices & Slips</h3>
+<p> "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: 3.50<br />
+ "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: 3.50</p>
+
+<h4>Existing Notices & Slips</h4>
<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
<ul>
@@ -75,78 +95,200 @@
<li>ACQCLAIM (Acquisition Claim)
<ul>
<li>Used in the claim acquisition module</li>
- <li><em>Get there:</em> More > Acquisitions > Late issues</li>
+ <li><em>Get there:</em> More > Acquisitions > Late issues</li>
+</ul>
+</li>
+ <li>CHECKIN
+<ul>
+ <li>This notice is sent as the 'Check in' notice for all items that are checked in</li>
+ <li>This notice is used if two criteria are met:
+<ol>
+ <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
+ <li>The patron has requested to receive this notice
+<ul>
+ <li><em>Get there: </em>OPAC > Login > my messaging</li>
+ <li><em>Get there: </em>Staff Client > Patron Record > Notices</li>
+</ul>
+</li>
+</ol>
+</li>
+</ul>
+</li>
+ <li>CHECKOUT
+<ul>
+ <li>This notice is sent as the 'Check out' notice for all items that are checked out</li>
+ <li>This notice is used if two criteria are met:
+<ol>
+ <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
+ <li>The patron has requested to receive this notice
+<ul>
+ <li><em>Get there: </em>OPAC > Login > my messaging</li>
+ <li><em>Get there: </em>Staff Client > Patron Record > Notices</li>
+</ul>
+</li>
+</ol>
+</li>
+</ul>
+</li>
+ <li>DUE
+<ul>
+ <li>This notice is sent as the 'Item due' for an item is due</li>
+ <li>This notice is used if two criteria are met:
+<ol>
+ <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
+ <li>The patron has requested to receive this notice
+<ul>
+ <li><em>Get there: </em>OPAC > Login > my messaging</li>
+ <li><em>Get there: </em>Staff Client > Patron Record > Notices</li>
+</ul>
+</li>
+</ol>
+</li>
+</ul>
+</li>
+ <li>DUEDGST
+<ul>
+ <li>This notice is sent as the 'Item due' for all items that are due</li>
+ <li>This notice is used if two criteria are met:
+<ol>
+ <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
+ <li>The patron has requested to receive this notice as a digest
+<ul>
+ <li><em>Get there: </em>OPAC > Login > my messaging</li>
+ <li><em>Get there: </em>Staff Client > Patron Record > Notices</li>
+</ul>
+</li>
+</ol>
+</li>
</ul>
</li>
<li>HOLD (Hold Available for Pickup)
<ul>
<li>This notice is used if two criteria are met:
<ol>
- <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
+ <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
<li>The patron has requested to receive this notice
<ul>
- <li><em>Get there: </em>OPAC > Login > my messaging</li>
- <li><em>Get there: </em>Staff Client > Patron Record > Notices</li>
+ <li><em>Get there: </em>OPAC > Login > my messaging</li>
+ <li><em>Get there: </em>Staff Client > Patron Record > Notices</li>
</ul>
</li>
</ol>
</li>
- <li>When this notice references the branches table it is referring to the pickup library information.</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 library information.</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>See a Sample Overdue Notice</li>
- <li>Requires that you set Overdue Notice/Status Triggers</li>
+ <li>Requires that you set Overdue Notice/Status Triggers</li>
+</ul>
+</li>
+ <li>PREDUE
+<ul>
+ <li>This notice is sent as the 'Advanced notice' for an item is due</li>
+ <li>This notice is used if two criteria are met:
+<ol>
+ <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
+ <li>The patron has requested to receive this notice
+<ul>
+ <li><em>Get there: </em>OPAC > Login > my messaging</li>
+ <li><em>Get there: </em>Staff Client > Patron Record > Notices</li>
+</ul>
+</li>
+</ol>
+</li>
+</ul>
+</li>
+ <li>PREDUEDGST
+<ul>
+ <li>This notice is sent as the 'Advanced notice' for all items that are due</li>
+ <li>This notice is used if two criteria are met:
+<ol>
+ <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
+ <li>The patron has requested to receive this notice as a digest
+<ul>
+ <li><em>Get there: </em>OPAC > Login > my messaging</li>
+ <li><em>Get there: </em>Staff Client > Patron Record > Notices</li>
+</ul>
+</li>
+</ol>
+</li>
+</ul>
+</li>
+ <li>RENEWAL
+<ul>
+ <li>This notice is sent as the 'Check out' notice for all items that are renewed</li>
+ <li>This notice is used if three criteria are met:
+<ol>
+ <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
+ <li>The RenewalSendNotice preference is set to 'Send'</li>
+ <li>The patron has requested to receive the checkout notice
+<ul>
+ <li><em>Get there: </em>OPAC > Login > my messaging</li>
+ <li><em>Get there: </em>Staff Client > Patron Record > Notices</li>
+</ul>
+</li>
+</ol>
+</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><em>Get there:</em> More > Serials > New Subscription</li>
+ <li><em>Get there:</em> More > Serials > New Subscription</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>
+ <li>SHARE_ACCEPT
+<ul>
+ <li>Used to notify a patron when another patron has accepted their shared list.</li>
+ <li>Requires that you set OpacAllowSharingPrivateLists to 'Allow'</li>
+</ul>
+</li>
+ <li>SHARE_INVITE
+<ul>
+ <li>Used to notify a patron that another patron would like to share a list with them.</li>
+ <li>Requires that you set OpacAllowSharingPrivateLists to 'Allow'</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 SlipCSS preference to define a stylesheet.</p>
-
-<p>Here is what those slips are used for:</p>
+<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 SlipCSS preference to define a stylesheet. Here is what those slips are used for:</p>
<ul>
- <li>ISSUEQSLIP
+ <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>
+ <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
+ <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>
+ <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
+ <li>RESERVESLIP
<ul>
- <li>Used to print a holds slip</li>
- <li>The holds slip is generated when a hold is confirmed</li>
+ <li>Used to print a holds slip</li>
+ <li>The holds slip is generated when a hold is confirmed</li>
</ul>
</li>
- <li>TRANSFERSLIP
+ <li>TRANSFERSLIP
<ul>
- <li>Used to print a transfer slip</li>
- <li>The transfer slip is printed when you confirm a transfer from one library to another in your system</li>
+ <li>Used to print a transfer slip</li>
+ <li>The transfer slip is printed when you confirm a transfer from one branch to another in your system</li>
</ul>
</li>
</ul>
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/overduerules.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/overduerules.tt
index f2b7f7c..83c3d71 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/overduerules.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/overduerules.tt
@@ -15,7 +15,11 @@
</ul>
</li>
<li>To send additional notices, click on the tabs for 'Second' and 'Third' notice</li>
- <li>If you would like to prevent a patron from checking items out because of their overdue items, check the 'Restrict' box, this will put a notice on the patron's record at checkout informing the librarian that the patron cannot check out due to overdue items.</li>
+ <li>If you would like to prevent a patron from checking items out because of their overdue items, check the 'Restrict' box, this will put a notice on the patron's record at checkout informing the librarian that the patron cannot check out due to overdue items.
+ <ul>
+ <li> If you choose to restrict a patron in this way you can also have Koha automatically remove that restriction with the AutoRemoveOverduesRestrictions preference.</li>
+ </ul></li>
+ <li>Next you can choose the delivery method for the overdue notice. You can choose from Email, Feed, Phone (if you are using the iTiva Talking Tech service), Print and SMS (if you have set your SMSSendDriver). </li>
<li>See a Sample Overdue Notice</li>
</ul>
--
1.7.2.3
More information about the Koha-patches
mailing list