@@ -, +, @@
---
.../prog/en/modules/help/tools/letter.tt | 131 +++++++++++++++-----
1 files changed, 100 insertions(+), 31 deletions(-)
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/letter.tt
+++ a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/letter.tt
@@ -1,35 +1,104 @@
[% INCLUDE 'help-top.inc' %]
Notices
+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
-Notices are messages sent to patrons, vendors and staff to notify them at key times.
-Add a new notice
-
- - Click 'New Notice'
- - Choose a 'Koha Module' to associate your notice with from the dropdown box
- - Enter a 'Code' abbreviation for your new notice (for example: 'ODUE' for Overdue Notice)
- - Enter a 'Name' for your new notice (for example 'Overdue Notice')
- - Enter a 'Message Subject' (for example 'Item Overdue')
- - Design your 'Message Body'
-
-
- -
-
- - Choose a field from the scroll down menu on the left side
-
- -
-
-TIP: For help with what each field is, see the Notices: Database Fields section of this manual
-
- - Click the '>>' button to insert that field into your text message where you'd like it to appear in the notice.
- - Continue adding 'field's and clicking '>>' to insert them into the notice until your message is completed.
- - Then, click 'Submit'
-
- -
-
-IMPORTANT: Currently, Koha can not reference multiple biblios in a single notice (in other words--in the example below-- there is not just ONE email sent that describes ALL currently overdue items, but an email sent for EACH overdue item)
-
- How do I schedule overdue notices?
To schedule overdue notices, you must use Koha's 'Notice/Status Trigger' tool.
-
- - Get there: More > Tools > Overdue notice/status triggers
-
[% INCLUDE 'help-bottom.inc' %]
+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.
+Adding Notices
+
+ - To add a new notice
+
+ - Click 'New Notice'
+ - Choose the module this notice is related to
+ - The Code is limited to 20 characters
+ - Use the name field to expand on your Code
+ - Message Subject is what will appear in the subject line of the email
+ - 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.
+
+ - 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
+ - Important: Only the overdue notices take advantage of the <item></item> tags, all other notices referencing items need to use <<items.content>>
+
+
+
+
+
+Notice Markup
+When creating your overdue notices there are two tags in addition to the various database fields that you can use in your notices.
+Important: These new tags only work on the overdue notices, not other circulation related notices at this time.
+
+
+ - <item></item> which should enclose all fields from the biblio, biblioitems, and items tables.
+ - <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.
+
+ - 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>.
+
+
+
+An example of using these two tags in a notice template might be like:
+The following item(s) is/are currently overdue:
+
+ <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <fine>GBP</fine></item>
+Which, assuming two items were overdue, would result in a notice like:
+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
+Existing Notices
+Among the default notices are notices for several common actions within Koha, here are some of what those notices do
+
+ - ACCTDETAILS
+
+ - Sent to patrons when their account is set up if the AutoEmailOPACUser preference is set to 'Send'
+
+
+ - ACQCLAIM (Acquisition Claim)
+
+ - Used in the claim acquisition module
+ - Get there: More > Acquisitions > Late issues
+
+
+ - HOLD (Hold Available for Pickup)
+
+ - This notice is used if two criteria are met:
+
+ - The EnhancedMessagingPreferences is set to 'Allow'
+ - The patron has requested to receive this notice
+
+ - Get there: OPAC > Login > my messaging
+ - Get there: Staff Client > Patron Record > Messaging
+
+
+
+
+
+
+ - HOLDPLACED (a notice to the library staff that a hold has been placed)
+
+ - This notice requires the emailLibrarianWhenHoldIsPlaced system preference to be set to 'Enable'
+
+
+ - HOLD_PRINT (Printed notice when hold available for pickup)
+
+ - 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.
+
+
+ - ODUE (Overdue Notice)
+
+ - This notice is used to send Overdue Notices to Patrons
+ - See a Sample Overdue Notice
+ - Requires that you set Overdue Notice/Status Triggers
+
+
+ - RLIST (Routing List)
+
+ - Used in the serials module to notify patrons/staff of new issues of a serial
+
+ - Get there: More > Serials > New Subscription
+
+
+ - You have the option to select the 'Routing List' notice when creating a new subscription (Choose from the 'Patron notification' drop down).
+ - 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
+
+
+
+[% INCLUDE 'help-bottom.inc' %]
--