Docs: Fix two minor typos
[working/Evergreen.git] / docs / admin / workstation_admin_receipt_template_editor.adoc
1 Receipt Template Editor
2 -----------------------
3 indexterm:[receipt template editor]
4 indexterm:[receipt template editor, macros]
5 indexterm:[receipt template editor, checkout]
6
7 There are many default receipt templates included with the Evergreen staff client. These templates are saved on individual workstations. Customization can be done workstation by workstation or by exporting the templates to import to other workstations.
8
9 All receipts in Evergreen follow a basic format of a _Header_, _Line item_ and _Footer_. 
10
11 The receipt templates follow full W3C html.  http://w3schools.com/html/default.asp.
12
13 The Receipt Template Editor can be found at: *Administration -> Workstation Administration ->  Receipt Template Editor*
14
15 The Editor can also be found on the default home page of the staff client.
16
17 Receipts come in various types: Bills, checkout, items, holds, transits and Payments. 
18
19 To edit a Receipt:
20
21 . Select *Administration -> Workstation Administration ->  Receipt Template Editor*.
22
23 . Choose the Receipt in the drop down list.
24 +    
25 image::media/receipt-2.png[select checkout]
26 +
27 . Make edits to the Receipt on the right hand side.
28 +    
29 image::media/receipt-3.jpg[receipt-3]
30 +
31 . Click out of the section you are editing to see what your changes will look right on the Left hand side.
32 +    
33 image::media/receipt-3.jpg[receipt-3]
34 +
35 . Click ''Save Locally'' in the Upper right hand corner.
36 +
37 image::media/receipt-15.jpg[receipt-15]
38
39
40 Receipt templates use macros for various pieces of information coming from the Evergreen database.  Macros deal with everything from the Library name to the due date of an item.  See list <<macros, Receipt Macros for the macros>>.  You can also click on MACROS on the screen to see the macros that are available for a given receipt.  
41
42 IMPORTANT: *Remember:* Not all Macros listed on the pop up screen will work.  The listing of macros are drawn from the table that the receipt pulls information from. Some of the tables will not have any data in some of the fields.  Example is the %mbts_xact_finish% on the Bills Current Slip, as this is a list of current bills, they would not have a finish date.
43
44 Exporting and importing Customized Receipts
45 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46
47 Once you have your receipts set up on one machine you can export your receipts, and then load them on to another machine.  Just remember to ''Save Locally'' once you import the receipts on the new machine.
48
49 Exporting templates
50 ^^^^^^^^^^^^^^^^^^^
51 As you can only save a template on to the computer you are working on you will need to export the template if you have more than one computer that prints out receipts (i.e., more than one computer on the circulation desk, or another computer in the workroom that you use to checkin items or capture holds with)
52
53 . Export.  
54 . Select the location to save the template to, name the template, and click Save.
55 . Click OK. 
56 +
57 image::media/receipt-17.jpg[receipt-17]
58
59
60 Importing Templates
61 ^^^^^^^^^^^^^^^^^^^
62
63 . Click Import.
64
65 image::media/receipt-20.jpg[receipt-20]
66 +
67 . Navigate to and select the template that you want to import.  Click Open. 
68
69 image::media/receipt-21.jpg[receipt-21]
70 +
71 . Click OK.
72 . Click Save Locally.
73 . Click OK.
74 +
75 image::media/receipt-23.jpg[receipts-23]
76
77 Receipt Customizations
78 ~~~~~~~~~~~~~~~~~~~~~~
79
80 Customizing the receipts is fairly simple once you realize what can be placed in each of the sections of the receipts.  One thing to remember when customizing receipts to always ''Save Locally''. Checkouts, Hold Slip, Hold Transit Slip are customized below.  
81
82 TIP: Always remember to ''Save Locally''.
83
84 Print Holds Slip with Landscape Layout
85 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
86
87 indexterm:[receipt template editor, holds receipt, layout]
88
89 This feature enables you to use Mozilla-specific CSS to print holds with a landscape layout. To use the landscape layout:
90
91 . Click *Admin* -> *Workstation Administration* -> *Receipt Template Editor*.
92 . Select *hold transit slip* from the *Template Name* drop down menu.
93 . Enter <div> before and after the block of text that you wish to rotate.
94 . Enter the stylesheet text in the <div> bracket that appears before the block of text that you wish to rotate:  
95 +
96 [source, html]
97 ------------------------
98 <div style="moz-transform: rotate(90deg);">
99 ------------------------
100 . When you click out of this box, notice that the text in the *Preview* box on the left side of the screen has rotated 90 degrees.
101 . You can further customize the look of the text by adjusting its height and width.  The height and width that you specify will be unique to your printer. 
102 +
103 For example, you could add the following height and width to your rotated text:
104 +
105 [source, html]
106 ------------------------
107 <div style="moz-transform: rotate(90deg);height: 300px; width: 200px;">
108 ------------------------
109 +
110 image::media/Print_Holds_Slip1.jpg[Print_Holds_Slip1]
111 +
112 . The holds slip will print with the configured text in a landscape layout:
113 +
114 image::media/Print_Holds_Slip2.jpg[Print_Holds_Slip2] 
115
116 Checkout
117 ^^^^^^^^
118 This is the receipt that prints when items are checked out to individuals.  Item you can customize are adding the library logo, adding information about renewals on the bottom of the receipt.  If you notice at the end of the Footer the <br/>.<br/>, the allows an auto cut printer a little extra room so it will not cut the phone number off.  The period is needed so the extra lines are added.
119
120 Header
121 [source,html]
122 ----------------------------------------------------------------------------------
123 <img align="center" src="http://www.library.org/images/logo.jpg"><br/>
124 Welcome to %LIBRARY%!<br/>
125 You checked out the following items:
126 <hr/>
127 <ol>
128 ----------------------------------------------------------------------------------
129 Line Item
130 [source,html]
131 ----------------------------------------------------------------------------------
132 <li>%title%<br/>
133 By: %author%<br/>
134 Barcode: %barcode%<br/>
135 Due: %due_date%
136 ----------------------------------------------------------------------------------
137 Footer
138 [source,html]
139 ----------------------------------------------------------------------------------
140 </ol>
141 <hr />
142 %SHORTNAME% %TODAY_TRIM%<br/>
143 You were helped by %STAFF_FIRSTNAME%<br/>
144 <br/>
145 <center>If you want to renew your materials please visit<br/>
146 www.library.org<br/>
147 or call us at ###-###-####</center>
148 <br/>
149 <br/>
150 .<br/>
151 ----------------------------------------------------------------------------------
152  
153 Hold_Slip  #1
154 ^^^^^^^^^^^^^
155 This is the slip that prints when a hold is fulfilled.  Things to customize are the patrons name at the top of the slip, Bold the %hold_for_msg%, among others. 
156
157 Header
158 [source,html]
159 ----------------------------------------------------------------------------------
160 <font size="6"><b>%PATRON_LASTNAME%, %PATRON_FIRSTNAME%</b>
161 </font><br/><br/><br/><br/>
162 This item needs to be routed to <b>%route_to%</b>:<br/>
163 Barcode: %item_barcode%<br/>
164 Title: %item_title%<br/>
165 <br/>
166 <b>%hold_for_msg%</b><br/>
167 Barcode: %PATRON_BARCODE%<br/>
168 Notify by phone: %notify_by_phone%<br/>
169 Notify by email: %notify_by_email%<br/>
170 ----------------------------------------------------------------------------------
171 Line Item
172 [source,html]
173 ----------------------------------------------------------------------------------
174 <em>%formatted_note%</em><br/>
175 ----------------------------------------------------------------------------------
176 Footer
177 [source,html]
178 ----------------------------------------------------------------------------------
179 Request date: %request_date%<br/>
180 <br/>
181 Slip Date: %TODAY_D% %TODAY_I%:%TODAY_M%<br/>
182 Printed by %STAFF_FIRSTNAME% at %SHORTNAME%<br/>.<br/>
183 ----------------------------------------------------------------------------------
184
185 Hold_Slip  #2
186 ^^^^^^^^^^^^^
187 This is the slip that prints when a hold is fulfilled.  This slip uses the SUBSTR macro to truncate the Patrons Last name to the first 4 characters and the patron's barcode to the last 5 digits.  This slip is designed for libraries that use self-serve holds.  So, you will notice a lot of information about the hold is left off of the receipt. 
188
189 Header
190 [source,html]
191 ----------------------------------------------------------------------------------
192 <p style="padding-top:80px; padding-bottom:80px">
193 <font size="6"><b>
194 %SUBSTR(0,4)%%PATRON_LASTNAME%%SUBSTR_END%
195 &nbsp;%SUBSTR(-5)%%PATRON_BARCODE%%SUBSTR_END%
196 </b></font></p>
197 </font><br/><br/><br/><br/>
198 This item needs to be routed to <b>%route_to%</b>:<br/>
199 Barcode: %item_barcode%<br/>
200 Title: %item_title%<br/>
201 <br/>
202 Notify by phone: %notify_by_phone%<br/>
203 ----------------------------------------------------------------------------------
204 Line Item
205 [source,html]
206 ----------------------------------------------------------------------------------
207 <em>%formatted_note%</em><br/>
208 ----------------------------------------------------------------------------------
209 Footer
210 [source,html]
211 ----------------------------------------------------------------------------------
212 Request date: %request_date%<br/>
213 <hr style="border: 1px dotted"/><br/>
214 Slip Date: %TODAY_TRIM%<br/>
215 Printed by %STAFF_FIRSTNAME% at %SHORTNAME%<br/>.<br/>
216 ----------------------------------------------------------------------------------
217
218 Hold_transit_slip
219 ^^^^^^^^^^^^^^^^^^
220 This is the slip that is printed when an Item is needed at another library for a hold.  In this customization, the address of the library is removed, The library's shortname size is increased, and made a little more notable at top, and the patron's phone number and email address is removed from the slip.
221
222 Header
223 [source,html]
224 ----------------------------------------------------------------------------------
225 <font size="5">Route to %route_to%</font><br/><br/><br/>
226 This item needs to be routed to <b>%route_to%</b>:<br/>
227 %route_to_org_fullname%<br/><br/>
228 Barcode: %item_barcode%<br/>
229 Title: %item_title%<br/>
230 Author: %item_author%<br><br/>
231 %hold_for_msg%<br/>
232 Barcode: %PATRON_BARCODE%<br/>
233 ----------------------------------------------------------------------------------
234 Line Item
235 [source,html]
236 ----------------------------------------------------------------------------------
237 <em>%formatted_note%</em><br/>
238 ----------------------------------------------------------------------------------
239 Footer
240 [source,html]
241 ----------------------------------------------------------------------------------
242 <br/>Request date: %request_date%<br/>
243 Slip Date: %TODAY_TRIM%<br/>
244 Printed at %SHORTNAME%<br/>
245 <br/><br/>.<br/>
246 ----------------------------------------------------------------------------------
247
248 Receipt Templates
249 ~~~~~~~~~~~~~~~~~
250 This is a complete list of all the receipts currently in use in Evergreen.
251
252 [horizontal]
253 *item_status*::
254 type::: items
255 description::: Listing of items inputted in to Item Status.
256 default format:::  
257 header::::  The following items have been examined:<hr/><ol>  
258 line_item:::: <li>%title%<br/>Barcode: %barcode%  
259 footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> 
260
261 *transit_list*:: 
262 type::: transits
263 description::: List of items in transit.
264 default format:::
265 header::::  Transits:<hr/><ol>
266 line_item:::: <li>From: %transit_source% To: %transit_dest_lib%<br/>When: %transit_source_send_time%<br />Barcode: %transit_item_barcode% Title: %transit_item_title%<br/> 
267 footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> 
268
269 *items_out*:: 
270 type::: items
271 description:::  List of items a patron has checked out.
272 default format:::
273 header::::  Welcome to %LIBRARY%!<br/>You have the following items:<hr/><ol>  
274 line_item:::: <li>%title%<br/>Barcode: %barcode% Due: %due_date%  
275 footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> 
276
277 *renew*:: 
278 type::: items
279 description:::  List of items that have been renewed using the renew item screen
280 default format:::
281 header::::  Welcome to %LIBRARY%!<br/>You have renewed the following items::<hr/><ol>  
282 line_item:::: <li>%title%<br/>Barcode: %barcode% Due: %due_date%  
283 footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> 
284
285 *checkout*:: 
286 type::: items
287 description::: List of items currently checked out to the patron during this transaction.
288 default format:::
289 header::::  Welcome to %LIBRARY%!<br/>You checked out the following items::<hr/><ol>  
290 line_item:::: <li>%title%<br/>Barcode: %barcode% Due: %due_date%  
291 footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> 
292
293 *offline_checkout*:: 
294 type::: offline_checkout
295 description::: List of items checked out via the Standalone interface.  Remember that Standalone interface does not have access to the database.
296 default format:::
297 header::::  Patron %patron_barcode%<br/>You checked out the following items::<hr/><ol>  
298 line_item:::: <li>Barcode: %barcode%<br/>Due: %due_date%  
299 footer::::  </ol><hr />%TODAY_TRIM%<br/><br/> 
300
301 *checkin*:: 
302 type::: items
303 description::: List of items that have just been entered in to the check-in screens.
304 default format:::
305 header::::  You checked in the following items:<hr/><ol>  
306 line_item:::: <li>%title%<br/>Barcode: %barcode%  Call Number: %call_number%  
307 footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> 
308
309 *bill_payment*:: 
310 type::: payment
311 description::: Patron payment receipt
312 default format:::
313 header:::: 
314 Welcome to %LIBRARY%!<br/>
315 A receipt of your  transaction:
316 <hr/> <table width="100%"> 
317 <tr> <td>Original Balance:</td> <td align="right">$%original_balance%</td> </tr> 
318 <tr> <td>Payment Method:</td> <td align="right">%payment_type%</td> </tr> 
319 <tr> <td>Payment Received:</td> <td align="right">$%payment_received%</td> </tr> 
320 <tr> <td>Payment Applied:</td> <td align="right">$%payment_applied%</td> </tr> 
321 <tr> <td>Billings Voided:</td> <td align="right">%voided_balance%</td> </tr> 
322 <tr> <td>Change Given:</td> <td align="right">$%change_given%</td> </tr> 
323 <tr> <td>New Balance:</td> <td align="right">$%new_balance%</td> </tr> </table> 
324 <p> Note: %note% </p> <p> Specific bills: <blockquote>
325 line_item::::
326 Bill #%bill_id%  %last_billing_type% Received: $%payment%<br />%barcode% %title%<br /><br />  
327 footer::::
328 </blockquote> </p> <hr />%SHORTNAME% %TODAY_TRIM%<br/> <br/>
329
330 *bills_historical*:: 
331 type::: bills
332 description::: Listing of bills that have had payments made on them.  This is used on the Bill History Transaction screen.
333 default format:::
334 header::::  Welcome to %LIBRARY%!<br/>You had the following bills:<hr/><ol>  
335 line_item:::: <dt><b>Bill #%mbts_id%</b> %title% </dt> <dd>
336 <table> <tr valign="top"><td>Date::</td><td>%mbts_xact_start%</td></tr>
337 <tr valign="top"><td>Type:</td><td>%xact_type%</td></tr>
338 <tr valign="top"><td>Last Billing:</td><td>%last_billing_type%<br/>%last_billing_note%</td></tr>
339 <tr valign="top"><td>Total Billed::</td><td>$%total_owed%</td></tr>
340 <tr valign="top"><td>Last Payment::</td><td>%last_payment_type%<br/>%last_payment_note%</td></tr>
341 <tr valign="top"><td>Total Paid::</td><td>$%total_paid%</td></tr>
342 <tr valign="top"><td><b>Balance::</b></td><td><b>$%balance_owed%</b></td></tr> </table><br/>
343 footer:::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> 
344
345 *bills_current*:: 
346 type::: bills
347 description:::  Listing of current bills for a patron.
348 default format:::
349 header::::  
350 Welcome to %LIBRARY%!<br/>
351 You have the following bills:<hr/><ol>  
352 line_item:::: <dt><b>Bill #%mbts_id%</b></dt> <dd> 
353 <table> <tr valign="top"><td>Date:</td><td>%mbts_xact_start%</td></tr> 
354 <tr valign="top"><td>Type:</td><td>%xact_type%</td></tr> 
355 <tr valign="top"><td>Last Billing:</td><td>%last_billing_type%<br/>%last_billing_note%</td></tr> 
356 <tr valign="top"><td>Total Billed:</td><td>$%total_owed%</td></tr> 
357 <tr valign="top"><td>Last Payment:</td><td>%last_payment_type%<br/>%last_payment_note%</td></tr> 
358 <tr valign="top"><td>Total Paid:</td><td>$%total_paid%</td></tr> 
359 <tr valign="top"><td><b>Balance:</b></td><td><b>$%balance_owed%</b></td></tr> </table><br/>  
360 footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> 
361
362 *offline_checkin*:: 
363 type::: offline_checkin
364 description::: List of item checked in via Standalone interface. Remember that Standalone interface does not have access to the database.
365 default format:::
366 header::::  You checked in the following items:<hr/><ol>  
367 line_item:::: <li>Barcode: %barcode%  
368 footer::::  </ol><hr />%TODAY_TRIM%<br/><br/> 
369
370 *offline_renew*:: 
371 type::: offline_renew
372 description::: List of items renewed via Standalone interface. Remember that Standalone interface does not have access to the database.
373 default format:::
374 header::::  You renewed the following items:<hr/><ol>  
375 line_item:::: <li>Barcode: %barcode%  
376 footer::::  </ol><hr />%TODAY_TRIM%<br/><br/> 
377
378 *offline_inhouse_use*:: 
379 type::: offline_inhouse_use
380 description::: List of item marked in-house use via Standalone interface. Remember that Standalone interface does not have access to the database.
381 default format:::
382 header::::  You marked the following in-house items used:<hr/><ol>  
383 line_item:::: <li>Barcode: %barcode%Uses: %count%  
384 footer::::  </ol><hr />%TODAY_TRIM%<br/><br/> 
385
386 *in_house_use*:: 
387 type::: items
388 description::: List of items inputted in to the In-house use.
389 default format:::
390 header::::  You marked the following in-house items used:<hr/><ol>  
391 line_item:::: <li>Barcode: %barcode%Uses: %uses%<br />%alert_message%  
392 footer::::  </ol><hr />%TODAY_TRIM%<br/><br/> 
393
394 *holds*:: 
395 type::: holds
396 description::: List of items on hold for a patron.
397 default format:::
398 header::::  Welcome to %LIBRARY%!<br/>You have the following titles on hold:<hr/><ol>  
399 line_item:::: <li>%title%  
400 footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> 
401
402 *holds_on_bib*:: 
403 type::: holds  
404 description::: This list is used to print the holds on a title record.
405 default format:::
406 header::::  Welcome to %LIBRARY%!<br/>You have the following titles on hold:<hr/><ol>  
407 line_item:::: <li>%title%  
408 footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> 
409
410 *holds_for_patron*:: 
411 description::: This list is used to print the holds on a patron record.
412 type::: holds  
413 default format:::
414 header::::  Welcome to %LIBRARY%!<br/>You have the following titles on hold:<hr/><ol>  
415 line_item:::: <li>%title%  
416 footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> 
417
418 *holds_shelf*:: 
419 type::: holds  
420 description::: This list is used to print the holds on the holds shelf.
421 default format:::
422 header::::  Welcome to %LIBRARY%!<br/>You have the following titles on hold:<hr/><ol>  
423 line_item:::: <li>%title%  
424 footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> 
425
426 *holds_pull_list*:: 
427 type::: holds  
428 description::: This list is used to print the holds on the holds pull list.
429 default format:::
430 header::::  Welcome to %LIBRARY%!<br/>You have the following titles on hold:<hr/><ol>  
431 line_item:::: <li>%title%  
432 footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> 
433
434 *hold_slip*:: 
435 type::: holds
436 description::: This is printed when a hold is fulfilled.
437 default format:::
438 header::::  This item needs to be routed to <b>%route_to%</b>:<br/>Barcode: %item_barcode%<br/>Title: %item_title%<br/><br/>%hold_for_msg%<br/>Barcode: %PATRON_BARCODE%<br/>Notify by phone: %notify_by_phone%<br/>Notified by text: %notify_by_text%<br/>Notified by email: %notify_by_email%<br/>  
439 line_item:::: %formatted_note%<br/>  
440 footer:::: <br/>Request date: %request_date%<br/>Slip Date: %TODAY_TRIM%<br/>Printed by %STAFF_FIRSTNAME% at %SHORTNAME%<br/><br/> 
441
442 *transit_slip*:: 
443 type::: transits
444 description::: This is printed when a item goes into transit.
445 default format:::
446 header::::  
447 This item needs to be routed to <b>%route_to%</b>:<br/>%route_to_org_fullname%<br/>
448 %street1%<br/>%street2%<br/>
449 %city_state_zip%<br/><br/>
450 Barcode: %item_barcode%<br/>
451 Title: %item_title%<br/>
452 Author: %item_author%<br><br/>  
453 line_item::::  (Intentionally left blank) 
454 footer::::  Slip Date: %TODAY_TRIM%<br/>Printed by %STAFF_FIRSTNAME% at %SHORTNAME%<br/><br/> 
455
456 *hold_transit_slip*:: 
457 type::: transits
458 description::: This is printed when a hold goes in-transit to another library.
459 default format:::
460 header::::  
461 This item needs to be routed to <b>%route_to%</b>:<br/>%route_to_org_fullname%<br/>
462 %street1%<br/>%street2%<br/>%city_state_zip%<br/><br/>
463 Barcode: %item_barcode%<br/>
464 Title: %item_title%<br/>
465 Author: %item_author%<br><br/>
466 %hold_for_msg%<br/>Barcode: %PATRON_BARCODE%<br/>
467 Notify by phone: %notify_by_phone%<br/>
468 Notified by text: %notify_by_text%<br/>
469 Notified by email: %notify_by_email%<br/>  
470 line_item:::: %formatted_note%<br/>  
471 footer::::  <br/>Request date: %request_date%<br/>Slip Date: %TODAY_TRIM%<br/>Printed by %STAFF_FIRSTNAME% at %SHORTNAME%<br/><br/> 
472
473 *holdings_maintenance*:: 
474 type::: items
475 description::: This is printed from holding maintenance.
476 default format:::
477 header::::  
478 Title: %title%<br/>
479 Author: %author%<br/>
480 ISBN: %isbn% Edition: %edition% PubDate: %pubdate%<br/>
481 TCN: %tcn_value% Record ID: %mvr_doc_id%<br/>
482 Creator: %creator% Create Date: %create_date%<br/>
483 Editor: %editor% Edit Date: %edit_date%<hr/>
484 line_item:::: %prefix% %tree_location% %suffix% %parts% %acp_status%<br/>
485 footer::::  <hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> 
486
487 [[macros]]
488
489 Receipt Template Editor Macros
490 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
491
492 Here is a list of the Receipt Template Macros that are in use on the receipts.  There are two types of macros General and type specific.  General Macros can be used on any of the receipts.  Type specific macros are available depending on the type of the receipt.   
493
494 General Macros
495 ^^^^^^^^^^^^^^
496 indexterm:[receipt template editor, macros]
497
498 [horizontal]
499 %LIBRARY%:: Library full name
500 %SHORTNAME%:: Library Policy Name
501 %STAFF_FIRSTNAME%:: First name of Staff login account
502 %STAFF_LASTNAME%:: Last name of Staff login account
503 %STAFF_BARCODE%:: Barcode of Staff login account
504 %STAFF_PROFILE%:: Profile of Staff login account
505 %PATRON_FIRSTNAME%:: First name of Patron
506 %PATRON_LASTNAME%:: Last name of Patron
507 %PATRON_BARCODE% or %patron_barcode%:: Patron Barcode
508 %TODAY%:: Full Date and time in the format: Wed Sep 21 2011 13:20:44 GMT-0400 (Eastern Daylight Time)
509 %TODAY_TRIM%:: Date and time in a shorted format: 2011-09-21 13:21
510 %TODAY_m%:: Two digit Month: 09
511 %TODAY_d%:: Two digit Day: 21
512 %TODAY_Y%:: Year: 2011
513 %TODAY_H%:: Hour in 24 hour day: 13
514 %TODAY_I%:: Hour in 12 hour format: 1
515 %TODAY_M%:: Minutes of the Hour: 24
516 %TODAY_D%:: date in standard US format: 09/21/11
517 %TODAY_F%:: date in International Standard: 2011-09-21
518 %-TRIM%::   Trims white space before the macro
519 %TRIM-%::  Trims white space after the macro
520 %SUBSTR(#)%...%SUBSTR_END%:: Take substring starting at position # to end of string. If # is negative count backwards from end of string.
521 %SUBSTR(#,#)%...%SUBSTR_END%:: Same as %SUBSTR(#)%, but limit to second provided number characters after start point. If second number is negative, count backwards instead of forwards.
522
523 There are several macros that can carry pre-built contents specific to individual libraries. The contents can be set up in local administration. For details see <<_library_settings_editor, Library Settings>>. Though text can be hard-coded in receipt templates, the pre-built contents will be automatically applied to receipts printed from all workstations without editing each template.
524
525 indexterm:[receipt template editor, includes]
526
527 * %INCLUDE(notice_text)%
528 * %INCLUDE(alert_text)%
529 * %INCLUDE(event_text)%
530 * %INCLUDE(footer_text)%%
531 * %INCLUDE(header_text)%
532
533 Additional Macros for various slip types
534 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
535
536 *Holds*
537
538 [horizontal]
539 %ROUTE_TO%:: It should say Hold Shelf if it is a hold being fulfilled
540 %item_barcode%:: Item Barcode
541 %item_title%:: Item Title
542 %hold_for_msg%:: Hold for Message: this gives the patron's Name
543 %PATRON_BARCODE%:: Patron's Barcode
544 %notify_by_phone%:: Phone number listed in the Hold Database.  This may not be the same as what is in the Patron's record, as they can list another number when placing the hold.
545 %notify_by_email%:: Email listed in Hold Database.  Same as phone number
546 %request_date%:: The date that the Request was originally placed.
547 %formatted_note%:: Hold Notes (new to 2.1)
548 %notify_by_text%:: SMS contact number (new to 2.2)
549
550 *Check out*
551
552 [horizontal]
553 %title%:: Title
554 %author%:: Author
555 %barcode%:: Item Barcode
556 %due_date%:: Due Date: formatted by the date field in the library settings editor
557
558 *Payment*
559
560 [horizontal]
561 %original_balance%:: The original balance the patron owes
562 %payment_received%:: How much was received from the patron
563 %payment_applied%:: How much of the payment was applied
564 %payment_type%:: What type of payment was applied: IE Cash
565 %voided_balance%:: Any Voided balance
566 %change_given%:: How much change was given
567 %new_balance%:: The new balance on the account
568 %note%:: Any notes on the annotated payment
569 %bill_id% or %mbts_id%:: The id for the bill in the bill database
570 %payment%:: How much of the payment that was applied was applied to this title
571 %title%:: Title that the payment was applied to.
572 %last_billing_type%:: The type of bill that was last charged to the patron for this title
573 %last_billing_note%:: Notes on the last bill
574 %last_payment_type%:: The type of payment that was last used to pay the bill
575 %mbts_xact_start%:: The date that the bill was started
576 %last_payment_note%:: Notes on last payment
577 %xact_type%:: Type of Bill
578 %barcode%:: Item barcode
579 %title%:: title of item
580
581 *Bills*
582
583 [horizontal]
584 %mbts_id%:: The id for the bill in the bill database
585 %title%:: Title that the payment was applied to.
586 %last_billing_type%:: The type of bill that was last charged to the patron for this bill
587 %last_billing_note%:: Notes on the last bill
588 %last_billing_ts%:: The time stamp for the last billing
589 %last_payment_type%:: The type of payment that was last used to pay the bill
590 %last_payment_note%:: Notes on last payment
591 %last_payment_ts%:: The time stamp for the last payment
592 %mbts_xact_start%:: The date that the bill was started (currently not working)
593 %xact_type%:: Type of Bill
594 %title%:: title of item
595
596 *Transit*
597
598 Transit receipts come into two types, general Transit receipts and Transit slips.  Transit receipts are listings of item that are in transits.  Transit slips are Slips telling the staff that this item is in transit to another location.  
599
600 .*General Transits*
601
602 [horizontal]
603 %transit_item_author%:: Item author
604 %transit_item_barcode%:: Barcode of item in transit
605 %transit_item_callnumber%:: Call number of item in transit
606 %transit_item_title%:: Title of Item in transit
607 %transit_dest_lib%:: Destination Library
608 %transit_source_send_time%:: Time item was sent in transit
609 %transit_source%:: Library that placed the item in transit.
610
611
612 .*Transit Slip*
613
614 [horizontal]
615 %route_to%:: Library Policy Name that the item is in transit to
616 %route_to_org_fullname%:: Library Full Name that the item is in transit to
617 %street1%:: Library Street address Line 1 that the item is in transit to.
618 %street2%:: Library Street address Line 2 that the item is in transit to.
619 %city_state_zip%:: City, State, Zip of Library the Item is in transit to.
620 %item_barcode%:: Item barcode
621 %item_title%:: Item title
622 %item_author%:: Item Author
623 %hold_for_msg%:: Hold for Message: this gives the patron's name
624 %PATRON_BARCODE%:: Patron's Barcode
625 %notify_by_phone%:: Phone number listed in the Hold Database.  This may not be the same as what is in the Patron's record, as they can list another number when placing the hold.
626 %notify_by_email%:: Email listed in Hold Database.  Same as phone number
627 %notify_by_text%:: SMS contact number (new to 2.2)
628 %request_date%:: Date that the Request was originally placed