Docs: Update "Receipt Template Editor" for Web Client
authorLynn Floyd <alynn2671@gmail.com>
Mon, 30 Apr 2018 22:45:41 +0000 (18:45 -0400)
committerRemington Steed <rjs7@calvin.edu>
Mon, 21 May 2018 12:44:48 +0000 (08:44 -0400)
Completely rewritten chapter. Many thanks to Terran McCanna, as much
was borrowed from her wiki pages.

Signed-off-by: Lynn Floyd <alynn2671@gmail.com>
Signed-off-by: Remington Steed <rjs7@calvin.edu>
docs/admin/receipt_template_editor.adoc [new file with mode: 0644]
docs/admin/workstation_admin_receipt_template_editor.adoc [deleted file]
docs/media/receipt1.png [new file with mode: 0644]
docs/media/receipt2.png [new file with mode: 0644]
docs/root.adoc
docs/root_staff_client_admin.adoc

diff --git a/docs/admin/receipt_template_editor.adoc b/docs/admin/receipt_template_editor.adoc
new file mode 100644 (file)
index 0000000..a71d456
--- /dev/null
@@ -0,0 +1,257 @@
+Receipt Template Editor
+-----------------------
+indexterm:[web client, receipt template editor]
+indexterm:[receipt template editor]
+indexterm:[receipt template editor, macros]
+indexterm:[receipt template editor, checkout]
+
+The print templates follow W3C HTML standards (see
+http://w3schools.com/html/default.asp) and can make use of CSS and
+https://angularjs.org[Angular JS] to a certain extent.
+
+The Receipt Template Editor can be found at: *Administration -> Workstation ->
+Print Templates*
+
+The Editor can also be found on the default home page of the staff client.
+
+Receipts come in various types: Bills, checkout, items, holds, transits and
+Payments.
+
+Receipt Templates
+~~~~~~~~~~~~~~~~~
+This is a complete list of the receipts currently in use in Evergreen.
+
+[horizontal]
+.List of Receipts
+*Bills, Current*:: Listing of current bills on an account.
+*Bills, Historic*:: Listing of bills that have had payments made on them. This
+   used on the Bill History Transaction screen.
+*Bills, Payment*:: Patron payment receipt
+*Checkin*:: List of items that have been entered in to the check-in screen.
+*Checkout*:: List of items currently checked out by a patron during the transaction.
+*Hold Transit Slip*:: This is printed when a hold goes in-transit to another library.
+*Hold Shelf Slip*:: This prints when a hold is fulfilled.
+*Holds for Bib Record*:: Prints a list of holds on a Title record.
+*Holds for Patron*:: Prints a list of holds on a patron record.
+*Hold Pull List*:: Prints the Holds Pull List.
+*Hold Shelf List*:: Prints a list of hold that are waiting to be picked up.
+*In-House Use List*:: Prints a list of items imputed into In-house use.
+*Item Status*:: Prints a list of items imputed into Item Status.
+*Items Out*:: Prints the list of items a patron has checked out.
+*Patron Address*:: Prints the current patrons address.
+*Patron Note*:: Prints a note on a patron's record.
+*Renew*:: List of items that have been renewed using the Renew Item Screen.
+*Transit List*:: Prints the list of items in-transit from the Transit List.
+*Transit Slip*:: This is printed when an items goes in-transit to another location.
+
+
+Editing Receipts
+~~~~~~~~~~~~~~~~
+
+To edit a Receipt:
+
+. Select *Administration -> Workstation -> Print Templates*.
+
+. Choose the Receipt in the drop down list.
+. If you are using Hatch, you can choose different printers for different types
+  of receipts with the Force Content field. If not, leave that field blank.
+  Printer Settings can be set at *Administration -> Workstation -> Printer
+  Settings*.
++    
+image::media/receipt1.png[select checkout]
++
+. Make edits to the Receipt on the right hand side.
++    
+image::media/receipt2.png[receipt screen]
++
+. Click out of the section you are editing to see what your changes will look
+  right on the Left hand side. 
+. Click *Save Locally* in the Upper right hand corner.
+
+
+Formatting Receipts
+^^^^^^^^^^^^^^^^^^^
+
+Print templates use variables for various pieces of information coming from the
+Evergreen database.  These variables deal with everything from the library name
+to the due date of an item. Information from the database is entered in the
+templates with curly brackets `{{term}}`.
+
+Example: `{{checkout.title}}`
+
+Some print templates have sections that are repeated for each item in a list.
+For example, the portion of the Checkout print template below repeats every item
+that is checked out in HTML list format by means of the 'ng-repeat' in the li
+tag. 
+
+------
+<ol>
+<li ng-repeat="checkout in circulations">
+<b>{{checkout.title}}</b><br/>
+Barcode: {{checkout.copy.barcode}}<br/>
+Due: {{checkout.circ.due_date | date:"short"}}<br/>
+</li>
+</ol>
+------
+
+Text Formatting
+^^^^^^^^^^^^^^^
+
+General text formatting
+|========================================================================================
+| Goal         | Original     | Code                                            | Result 
+| Bold (HTML)  | hello        | <b>hello</b>                                    | *hello*
+| Bold (CSS)   | hello        | <span style="font-weight:bold;">hello</span>    | *hello*
+| Capitalize   | circulation  | <span style="text-transform:capitalize;">circulation</span> | Circulation
+| Currency     | 1            | {{1 \| currency}}                               | $1.00
+|========================================================================================
+
+Date Formatting
+^^^^^^^^^^^^^^^
+
+If you do not format dates, they will appear in a system format which isn't
+easily readable.
+
+|===================================================
+| Code                         | Result
+|{{today}}                     | 2017-08-01T14:18:51.445Z
+|{{today \| date:'short'}}     | 8/1/17 10:18 AM
+|{{today \| date:'M/d/yyyy'}}  | 8/1/2017
+|===================================================
+
+Currency Formatting
+^^^^^^^^^^^^^^^^^^^
+
+Add " | currency" after any dollar amount that you wish to display as currency.
+
+Example:
+`{{xact.summary.balance_owed | currency}}` prints as `$2.50`
+
+
+Conditional Formatting
+^^^^^^^^^^^^^^^^^^^^^^
+
+You can use Angular JS to only print a line if the data matches. For example:
+
+`<div ng-if="hold.email_notify == 't'">Notify by email: {{patron.email}}</div>`
+
+This will only print the "Notify by email:" line if email notification is
+enabled for that hold.
+
+Example for checkout print template that will only print the amount a patron
+owes if there is a balance:
+
+`<span ng-if="patron_money.balance_owed">You owe the library
+${{patron_money.balance_owed}}</span>`
+
+See also: https://docs.angularjs.org/api/ng/directive/ngIf
+
+Substrings
+^^^^^^^^^^
+
+To print just a sub-string of a variable, you can use a *limitTo* function.
+`{{variable | limitTo:limit:begin}}` where *limit* is the number of characters
+you are wanting, and *begin* (optional) is where you want to start printing
+those characters. To limit the variable to the first four characters, you can
+use `{{variable | limitTo:4}}` to get "vari". To limit to the last five
+characters you can use `{{variable | limitTo:-5}}` to get "iable". And
+`{{variable | limitTo:3:3}}` will produce "ria".
+
+|========================================================================================
+| Original                               | Code                                   | Result
+| The Sisterhood of the Traveling Pants  | {{checkout.title \| limitTo:10}}       | The Sisterhood of th
+| 123456789                              | {{patron.card.barcode \| limitTo:-5}}  | 56789
+| Roberts                                | {{patron.family_name \| limitTo:3:3}}  | ber
+|========================================================================================
+
+
+Images
+^^^^^^
+
+You can use HTML and CSS to add an image to your print template if you have the
+image uploaded onto a publicly available web server. (It will currently only
+work with images on a secure (https) site.) For example:
+
+`<img
+src="https://evergreen-ils.org/wp-content/uploads/2013/09/copy-Evergreen_Logo_sm072.jpg"
+style="width:150px;padding:5px;">`
+
+Sort Order
+^^^^^^^^^^
+
+You can sort the items in an ng-repeat block using orderBy. For example, the
+following will sort a list of holds by the shelving location first, then by the
+call number:
+
+`<tr ng-repeat="hold_data in holds | orderBy :
+['copy.location.name','volume.label']">`
+
+Subtotals
+^^^^^^^^^
+
+You can use Angular JS to add information from each iteration of a loop together
+to create a subtotal. This involves setting an initial variable before the
+ng-repeat loop begins, adding an amount to that variable from within each loop,
+and then displaying the final amount at the end. 
+
+------
+<div>You checked out the following items:</div>
+<br/>
+<div ng-init="transactions.subtotal=0">                <!-- <1> -->
+<ol>
+<div ng-repeat="checkout in circulations">
+  <li ng-init="transactions.subtotal=transactions.subtotal -- checkout.copy.price"> <!-- <2> -->
+     <b>{{checkout.title}}</b><br/>
+     Barcode: {{checkout.copy.barcode}}<br/>
+     Due: {{checkout.circ.due_date | date:"M/d/yyyy"}}
+  </li>
+</div>
+</ol>
+<div style="font-weight:bold;">Total Amount Owed: {{patron_money.balance_owed | currency}}</div>
+<div style="font-weight:bold;border:1px dotted black; padding:5px;text-align:center;">
+You Saved<br/>
+{{transactions.subtotal | currency}}<br/>              <!-- <3> -->
+by borrowing from the library!</div>
+------
+<1> This line sets the variable.
+<2> This adds the list item's price to the variable.
+<3> This prints the total of the variable.
+
+Exporting and importing Customized Receipts
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+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.
+
+Exporting templates
+^^^^^^^^^^^^^^^^^^^
+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)
+
+. Export.  
+. Select the location to save the template to, name the template, and click
+*Save*.
+. Click OK. 
+
+Importing Templates
+^^^^^^^^^^^^^^^^^^^
+
+. Click Import.
+. Navigate to and select the template that you want to import.  Click Open. 
+. Click OK.
+. Click *Save Locally*.
+. Click OK.
+
+
+WARNING: Clearing your browser's cache/temporary files will clear any print
+template customizations that you make unless you are using Hatch to store your
+customizations. Be sure to export a copy of your customizations as a backup so
+that you can import it as needed.
+
+TIP: If you are modifying your templates and you do not see the updates appear
+on your printed receipt, you may need to go into *Administration -> Workstation
+-> Stored Preferences* and delete the stored preferences related to the print
+template that you modified (for example, eg.print.template_context.bills_current).
diff --git a/docs/admin/workstation_admin_receipt_template_editor.adoc b/docs/admin/workstation_admin_receipt_template_editor.adoc
deleted file mode 100644 (file)
index 70a2ecd..0000000
+++ /dev/null
@@ -1,628 +0,0 @@
-Receipt Template Editor
------------------------
-indexterm:[receipt template editor]
-indexterm:[receipt template editor, macros]
-indexterm:[receipt template editor, checkout]
-
-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.
-
-All receipts in Evergreen follow a basic format of a _Header_, _Line item_ and _Footer_. 
-
-The receipt templates follow full W3C html.  http://w3schools.com/html/default.asp.
-
-The Receipt Template Editor can be found at: *Administration -> Workstation Administration ->  Receipt Template Editor*
-
-The Editor can also be found on the default home page of the staff client.
-
-Receipts come in various types: Bills, checkout, items, holds, transits and Payments. 
-
-To edit a Receipt:
-
-. Select *Administration -> Workstation Administration ->  Receipt Template Editor*.
-
-. Choose the Receipt in the drop down list.
-+    
-image::media/receipt-2.png[select checkout]
-+
-. Make edits to the Receipt on the right hand side.
-+    
-image::media/receipt-3.jpg[receipt-3]
-+
-. Click out of the section you are editing to see what your changes will look right on the Left hand side.
-+    
-image::media/receipt-3.jpg[receipt-3]
-+
-. Click ''Save Locally'' in the Upper right hand corner.
-+
-image::media/receipt-15.jpg[receipt-15]
-
-
-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.  
-
-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.
-
-Exporting and importing Customized Receipts
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-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.
-
-Exporting templates
-^^^^^^^^^^^^^^^^^^^
-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)
-
-. Export.  
-. Select the location to save the template to, name the template, and click Save.
-. Click OK. 
-+
-image::media/receipt-17.jpg[receipt-17]
-
-
-Importing Templates
-^^^^^^^^^^^^^^^^^^^
-
-. Click Import.
-+ 
-image::media/receipt-20.jpg[receipt-20]
-+
-. Navigate to and select the template that you want to import.  Click Open. 
-+ 
-image::media/receipt-21.jpg[receipt-21]
-+
-. Click OK.
-. Click Save Locally.
-. Click OK.
-+
-image::media/receipt-23.jpg[receipts-23]
-
-Receipt Customizations
-~~~~~~~~~~~~~~~~~~~~~~
-
-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.  
-
-TIP: Always remember to ''Save Locally''.
-
-Print Holds Slip with Landscape Layout
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-indexterm:[receipt template editor, holds receipt, layout]
-
-This feature enables you to use Mozilla-specific CSS to print holds with a landscape layout. To use the landscape layout:
-
-. Click *Admin* -> *Workstation Administration* -> *Receipt Template Editor*.
-. Select *hold transit slip* from the *Template Name* drop down menu.
-. Enter <div> before and after the block of text that you wish to rotate.
-. Enter the stylesheet text in the <div> bracket that appears before the block of text that you wish to rotate:  
-+
-[source, html]
-------------------------
-<div style="moz-transform: rotate(90deg);">
-------------------------
-. 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.
-. 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. 
-+
-For example, you could add the following height and width to your rotated text:
-+
-[source, html]
-------------------------
-<div style="moz-transform: rotate(90deg);height: 300px; width: 200px;">
-------------------------
-+
-image::media/Print_Holds_Slip1.jpg[Print_Holds_Slip1]
-+
-. The holds slip will print with the configured text in a landscape layout:
-+
-image::media/Print_Holds_Slip2.jpg[Print_Holds_Slip2] 
-
-Checkout
-^^^^^^^^
-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.
-
-Header
-[source,html]
-----------------------------------------------------------------------------------
-<img align="center" src="http://www.library.org/images/logo.jpg"><br/>
-Welcome to %LIBRARY%!<br/>
-You checked out the following items:
-<hr/>
-<ol>
-----------------------------------------------------------------------------------
-Line Item
-[source,html]
-----------------------------------------------------------------------------------
-<li>%title%<br/>
-By: %author%<br/>
-Barcode: %barcode%<br/>
-Due: %due_date%
-----------------------------------------------------------------------------------
-Footer
-[source,html]
-----------------------------------------------------------------------------------
-</ol>
-<hr />
-%SHORTNAME% %TODAY_TRIM%<br/>
-You were helped by %STAFF_FIRSTNAME%<br/>
-<br/>
-<center>If you want to renew your materials please visit<br/>
-www.library.org<br/>
-or call us at ###-###-####</center>
-<br/>
-<br/>
-.<br/>
-----------------------------------------------------------------------------------
-Hold_Slip  #1
-^^^^^^^^^^^^^
-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. 
-
-Header
-[source,html]
-----------------------------------------------------------------------------------
-<font size="6"><b>%PATRON_LASTNAME%, %PATRON_FIRSTNAME%</b>
-</font><br/><br/><br/><br/>
-This item needs to be routed to <b>%route_to%</b>:<br/>
-Barcode: %item_barcode%<br/>
-Title: %item_title%<br/>
-<br/>
-<b>%hold_for_msg%</b><br/>
-Barcode: %PATRON_BARCODE%<br/>
-Notify by phone: %notify_by_phone%<br/>
-Notify by email: %notify_by_email%<br/>
-----------------------------------------------------------------------------------
-Line Item
-[source,html]
-----------------------------------------------------------------------------------
-<em>%formatted_note%</em><br/>
-----------------------------------------------------------------------------------
-Footer
-[source,html]
-----------------------------------------------------------------------------------
-Request date: %request_date%<br/>
-<br/>
-Slip Date: %TODAY_D% %TODAY_I%:%TODAY_M%<br/>
-Printed by %STAFF_FIRSTNAME% at %SHORTNAME%<br/>.<br/>
-----------------------------------------------------------------------------------
-
-Hold_Slip  #2
-^^^^^^^^^^^^^
-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. 
-
-Header
-[source,html]
-----------------------------------------------------------------------------------
-<p style="padding-top:80px; padding-bottom:80px">
-<font size="6"><b>
-%SUBSTR(0,4)%%PATRON_LASTNAME%%SUBSTR_END%
-&nbsp;%SUBSTR(-5)%%PATRON_BARCODE%%SUBSTR_END%
-</b></font></p>
-</font><br/><br/><br/><br/>
-This item needs to be routed to <b>%route_to%</b>:<br/>
-Barcode: %item_barcode%<br/>
-Title: %item_title%<br/>
-<br/>
-Notify by phone: %notify_by_phone%<br/>
-----------------------------------------------------------------------------------
-Line Item
-[source,html]
-----------------------------------------------------------------------------------
-<em>%formatted_note%</em><br/>
-----------------------------------------------------------------------------------
-Footer
-[source,html]
-----------------------------------------------------------------------------------
-Request date: %request_date%<br/>
-<hr style="border: 1px dotted"/><br/>
-Slip Date: %TODAY_TRIM%<br/>
-Printed by %STAFF_FIRSTNAME% at %SHORTNAME%<br/>.<br/>
-----------------------------------------------------------------------------------
-
-Hold_transit_slip
-^^^^^^^^^^^^^^^^^^
-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.
-
-Header
-[source,html]
-----------------------------------------------------------------------------------
-<font size="5">Route to %route_to%</font><br/><br/><br/>
-This item needs to be routed to <b>%route_to%</b>:<br/>
-%route_to_org_fullname%<br/><br/>
-Barcode: %item_barcode%<br/>
-Title: %item_title%<br/>
-Author: %item_author%<br><br/>
-%hold_for_msg%<br/>
-Barcode: %PATRON_BARCODE%<br/>
-----------------------------------------------------------------------------------
-Line Item
-[source,html]
-----------------------------------------------------------------------------------
-<em>%formatted_note%</em><br/>
-----------------------------------------------------------------------------------
-Footer
-[source,html]
-----------------------------------------------------------------------------------
-<br/>Request date: %request_date%<br/>
-Slip Date: %TODAY_TRIM%<br/>
-Printed at %SHORTNAME%<br/>
-<br/><br/>.<br/>
-----------------------------------------------------------------------------------
-
-Receipt Templates
-~~~~~~~~~~~~~~~~~
-This is a complete list of all the receipts currently in use in Evergreen.
-
-[horizontal]
-*item_status*::
-type::: items
-description::: Listing of items inputted in to Item Status.
-default format:::  
-header::::  The following items have been examined:<hr/><ol>  
-line_item:::: <li>%title%<br/>Barcode: %barcode%  
-footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> 
-
-*transit_list*:: 
-type::: transits
-description::: List of items in transit.
-default format:::
-header::::  Transits:<hr/><ol>
-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/> 
-footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> 
-
-*items_out*:: 
-type::: items
-description:::  List of items a patron has checked out.
-default format:::
-header::::  Welcome to %LIBRARY%!<br/>You have the following items:<hr/><ol>  
-line_item:::: <li>%title%<br/>Barcode: %barcode% Due: %due_date%  
-footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> 
-
-*renew*:: 
-type::: items
-description:::  List of items that have been renewed using the renew item screen
-default format:::
-header::::  Welcome to %LIBRARY%!<br/>You have renewed the following items::<hr/><ol>  
-line_item:::: <li>%title%<br/>Barcode: %barcode% Due: %due_date%  
-footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> 
-
-*checkout*:: 
-type::: items
-description::: List of items currently checked out to the patron during this transaction.
-default format:::
-header::::  Welcome to %LIBRARY%!<br/>You checked out the following items::<hr/><ol>  
-line_item:::: <li>%title%<br/>Barcode: %barcode% Due: %due_date%  
-footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> 
-
-*offline_checkout*:: 
-type::: offline_checkout
-description::: List of items checked out via the Standalone interface.  Remember that Standalone interface does not have access to the database.
-default format:::
-header::::  Patron %patron_barcode%<br/>You checked out the following items::<hr/><ol>  
-line_item:::: <li>Barcode: %barcode%<br/>Due: %due_date%  
-footer::::  </ol><hr />%TODAY_TRIM%<br/><br/> 
-
-*checkin*:: 
-type::: items
-description::: List of items that have just been entered in to the check-in screens.
-default format:::
-header::::  You checked in the following items:<hr/><ol>  
-line_item:::: <li>%title%<br/>Barcode: %barcode%  Call Number: %call_number%  
-footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> 
-
-*bill_payment*:: 
-type::: payment
-description::: Patron payment receipt
-default format:::
-header:::: 
-Welcome to %LIBRARY%!<br/>
-A receipt of your  transaction:
-<hr/> <table width="100%"> 
-<tr> <td>Original Balance:</td> <td align="right">$%original_balance%</td> </tr> 
-<tr> <td>Payment Method:</td> <td align="right">%payment_type%</td> </tr> 
-<tr> <td>Payment Received:</td> <td align="right">$%payment_received%</td> </tr> 
-<tr> <td>Payment Applied:</td> <td align="right">$%payment_applied%</td> </tr> 
-<tr> <td>Billings Voided:</td> <td align="right">%voided_balance%</td> </tr> 
-<tr> <td>Change Given:</td> <td align="right">$%change_given%</td> </tr> 
-<tr> <td>New Balance:</td> <td align="right">$%new_balance%</td> </tr> </table> 
-<p> Note: %note% </p> <p> Specific bills: <blockquote>
-line_item::::
-Bill #%bill_id%  %last_billing_type% Received: $%payment%<br />%barcode% %title%<br /><br />  
-footer::::
-</blockquote> </p> <hr />%SHORTNAME% %TODAY_TRIM%<br/> <br/>
-
-*bills_historical*:: 
-type::: bills
-description::: Listing of bills that have had payments made on them.  This is used on the Bill History Transaction screen.
-default format:::
-header::::  Welcome to %LIBRARY%!<br/>You had the following bills:<hr/><ol>  
-line_item:::: <dt><b>Bill #%mbts_id%</b> %title% </dt> <dd>
-<table> <tr valign="top"><td>Date::</td><td>%mbts_xact_start%</td></tr>
-<tr valign="top"><td>Type:</td><td>%xact_type%</td></tr>
-<tr valign="top"><td>Last Billing:</td><td>%last_billing_type%<br/>%last_billing_note%</td></tr>
-<tr valign="top"><td>Total Billed::</td><td>$%total_owed%</td></tr>
-<tr valign="top"><td>Last Payment::</td><td>%last_payment_type%<br/>%last_payment_note%</td></tr>
-<tr valign="top"><td>Total Paid::</td><td>$%total_paid%</td></tr>
-<tr valign="top"><td><b>Balance::</b></td><td><b>$%balance_owed%</b></td></tr> </table><br/>
-footer:::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> 
-
-*bills_current*:: 
-type::: bills
-description:::  Listing of current bills for a patron.
-default format:::
-header::::  
-Welcome to %LIBRARY%!<br/>
-You have the following bills:<hr/><ol>  
-line_item:::: <dt><b>Bill #%mbts_id%</b></dt> <dd> 
-<table> <tr valign="top"><td>Date:</td><td>%mbts_xact_start%</td></tr> 
-<tr valign="top"><td>Type:</td><td>%xact_type%</td></tr> 
-<tr valign="top"><td>Last Billing:</td><td>%last_billing_type%<br/>%last_billing_note%</td></tr> 
-<tr valign="top"><td>Total Billed:</td><td>$%total_owed%</td></tr> 
-<tr valign="top"><td>Last Payment:</td><td>%last_payment_type%<br/>%last_payment_note%</td></tr> 
-<tr valign="top"><td>Total Paid:</td><td>$%total_paid%</td></tr> 
-<tr valign="top"><td><b>Balance:</b></td><td><b>$%balance_owed%</b></td></tr> </table><br/>  
-footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> 
-
-*offline_checkin*:: 
-type::: offline_checkin
-description::: List of item checked in via Standalone interface. Remember that Standalone interface does not have access to the database.
-default format:::
-header::::  You checked in the following items:<hr/><ol>  
-line_item:::: <li>Barcode: %barcode%  
-footer::::  </ol><hr />%TODAY_TRIM%<br/><br/> 
-
-*offline_renew*:: 
-type::: offline_renew
-description::: List of items renewed via Standalone interface. Remember that Standalone interface does not have access to the database.
-default format:::
-header::::  You renewed the following items:<hr/><ol>  
-line_item:::: <li>Barcode: %barcode%  
-footer::::  </ol><hr />%TODAY_TRIM%<br/><br/> 
-
-*offline_inhouse_use*:: 
-type::: offline_inhouse_use
-description::: List of item marked in-house use via Standalone interface. Remember that Standalone interface does not have access to the database.
-default format:::
-header::::  You marked the following in-house items used:<hr/><ol>  
-line_item:::: <li>Barcode: %barcode%Uses: %count%  
-footer::::  </ol><hr />%TODAY_TRIM%<br/><br/> 
-
-*in_house_use*:: 
-type::: items
-description::: List of items inputted in to the In-house use.
-default format:::
-header::::  You marked the following in-house items used:<hr/><ol>  
-line_item:::: <li>Barcode: %barcode%Uses: %uses%<br />%alert_message%  
-footer::::  </ol><hr />%TODAY_TRIM%<br/><br/> 
-
-*holds*:: 
-type::: holds
-description::: List of items on hold for a patron.
-default format:::
-header::::  Welcome to %LIBRARY%!<br/>You have the following titles on hold:<hr/><ol>  
-line_item:::: <li>%title%  
-footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> 
-
-*holds_on_bib*:: 
-type::: holds  
-description::: This list is used to print the holds on a title record.
-default format:::
-header::::  Welcome to %LIBRARY%!<br/>You have the following titles on hold:<hr/><ol>  
-line_item:::: <li>%title%  
-footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> 
-
-*holds_for_patron*:: 
-description::: This list is used to print the holds on a patron record.
-type::: holds  
-default format:::
-header::::  Welcome to %LIBRARY%!<br/>You have the following titles on hold:<hr/><ol>  
-line_item:::: <li>%title%  
-footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> 
-
-*holds_shelf*:: 
-type::: holds  
-description::: This list is used to print the holds on the holds shelf.
-default format:::
-header::::  Welcome to %LIBRARY%!<br/>You have the following titles on hold:<hr/><ol>  
-line_item:::: <li>%title%  
-footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> 
-
-*holds_pull_list*:: 
-type::: holds  
-description::: This list is used to print the holds on the holds pull list.
-default format:::
-header::::  Welcome to %LIBRARY%!<br/>You have the following titles on hold:<hr/><ol>  
-line_item:::: <li>%title%  
-footer::::  </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> 
-
-*hold_slip*:: 
-type::: holds
-description::: This is printed when a hold is fulfilled.
-default format:::
-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/>  
-line_item:::: %formatted_note%<br/>  
-footer:::: <br/>Request date: %request_date%<br/>Slip Date: %TODAY_TRIM%<br/>Printed by %STAFF_FIRSTNAME% at %SHORTNAME%<br/><br/> 
-
-*transit_slip*:: 
-type::: transits
-description::: This is printed when a item goes into transit.
-default format:::
-header::::  
-This item needs to be routed to <b>%route_to%</b>:<br/>%route_to_org_fullname%<br/>
-%street1%<br/>%street2%<br/>
-%city_state_zip%<br/><br/>
-Barcode: %item_barcode%<br/>
-Title: %item_title%<br/>
-Author: %item_author%<br><br/>  
-line_item::::  (Intentionally left blank) 
-footer::::  Slip Date: %TODAY_TRIM%<br/>Printed by %STAFF_FIRSTNAME% at %SHORTNAME%<br/><br/> 
-
-*hold_transit_slip*:: 
-type::: transits
-description::: This is printed when a hold goes in-transit to another library.
-default format:::
-header::::  
-This item needs to be routed to <b>%route_to%</b>:<br/>%route_to_org_fullname%<br/>
-%street1%<br/>%street2%<br/>%city_state_zip%<br/><br/>
-Barcode: %item_barcode%<br/>
-Title: %item_title%<br/>
-Author: %item_author%<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/>  
-line_item:::: %formatted_note%<br/>  
-footer::::  <br/>Request date: %request_date%<br/>Slip Date: %TODAY_TRIM%<br/>Printed by %STAFF_FIRSTNAME% at %SHORTNAME%<br/><br/> 
-
-*holdings_maintenance*:: 
-type::: items
-description::: This is printed from holding maintenance.
-default format:::
-header::::  
-Title: %title%<br/>
-Author: %author%<br/>
-ISBN: %isbn% Edition: %edition% PubDate: %pubdate%<br/>
-TCN: %tcn_value% Record ID: %mvr_doc_id%<br/>
-Creator: %creator% Create Date: %create_date%<br/>
-Editor: %editor% Edit Date: %edit_date%<hr/>
-line_item:::: %prefix% %tree_location% %suffix% %parts% %acp_status%<br/>
-footer::::  <hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> 
-
-[[macros]]
-
-Receipt Template Editor Macros
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-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.   
-
-General Macros
-^^^^^^^^^^^^^^
-indexterm:[receipt template editor, macros]
-
-[horizontal]
-%LIBRARY%:: Library full name
-%SHORTNAME%:: Library Policy Name
-%STAFF_FIRSTNAME%:: First name of Staff login account
-%STAFF_LASTNAME%:: Last name of Staff login account
-%STAFF_BARCODE%:: Barcode of Staff login account
-%STAFF_PROFILE%:: Profile of Staff login account
-%PATRON_FIRSTNAME%:: First name of Patron
-%PATRON_LASTNAME%:: Last name of Patron
-%PATRON_BARCODE% or %patron_barcode%:: Patron Barcode
-%TODAY%:: Full Date and time in the format: Wed Sep 21 2011 13:20:44 GMT-0400 (Eastern Daylight Time)
-%TODAY_TRIM%:: Date and time in a shorted format: 2011-09-21 13:21
-%TODAY_m%:: Two digit Month: 09
-%TODAY_d%:: Two digit Day: 21
-%TODAY_Y%:: Year: 2011
-%TODAY_H%:: Hour in 24 hour day: 13
-%TODAY_I%:: Hour in 12 hour format: 1
-%TODAY_M%:: Minutes of the Hour: 24
-%TODAY_D%:: date in standard US format: 09/21/11
-%TODAY_F%:: date in International Standard: 2011-09-21
-%-TRIM%::   Trims white space before the macro
-%TRIM-%::  Trims white space after the macro
-%SUBSTR(#)%...%SUBSTR_END%:: Take substring starting at position # to end of string. If # is negative count backwards from end of string.
-%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.
-
-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.
-
-indexterm:[receipt template editor, includes]
-
-* %INCLUDE(notice_text)%
-* %INCLUDE(alert_text)%
-* %INCLUDE(event_text)%
-* %INCLUDE(footer_text)%%
-* %INCLUDE(header_text)%
-
-Additional Macros for various slip types
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-*Holds*
-
-[horizontal]
-%ROUTE_TO%:: It should say Hold Shelf if it is a hold being fulfilled
-%item_barcode%:: Item Barcode
-%item_title%:: Item Title
-%hold_for_msg%:: Hold for Message: this gives the patron's Name
-%PATRON_BARCODE%:: Patron's Barcode
-%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.
-%notify_by_email%:: Email listed in Hold Database.  Same as phone number
-%request_date%:: The date that the Request was originally placed.
-%formatted_note%:: Hold Notes (new to 2.1)
-%notify_by_text%:: SMS contact number (new to 2.2)
-
-*Check out*
-
-[horizontal]
-%title%:: Title
-%author%:: Author
-%barcode%:: Item Barcode
-%due_date%:: Due Date: formatted by the date field in the library settings editor
-
-*Payment*
-
-[horizontal]
-%original_balance%:: The original balance the patron owes
-%payment_received%:: How much was received from the patron
-%payment_applied%:: How much of the payment was applied
-%payment_type%:: What type of payment was applied: IE Cash
-%voided_balance%:: Any Voided balance
-%change_given%:: How much change was given
-%new_balance%:: The new balance on the account
-%note%:: Any notes on the annotated payment
-%bill_id% or %mbts_id%:: The id for the bill in the bill database
-%payment%:: How much of the payment that was applied was applied to this title
-%title%:: Title that the payment was applied to.
-%last_billing_type%:: The type of bill that was last charged to the patron for this title
-%last_billing_note%:: Notes on the last bill
-%last_payment_type%:: The type of payment that was last used to pay the bill
-%mbts_xact_start%:: The date that the bill was started
-%last_payment_note%:: Notes on last payment
-%xact_type%:: Type of Bill
-%barcode%:: Item barcode
-%title%:: title of item
-
-*Bills*
-
-[horizontal]
-%mbts_id%:: The id for the bill in the bill database
-%title%:: Title that the payment was applied to.
-%last_billing_type%:: The type of bill that was last charged to the patron for this bill
-%last_billing_note%:: Notes on the last bill
-%last_billing_ts%:: The time stamp for the last billing
-%last_payment_type%:: The type of payment that was last used to pay the bill
-%last_payment_note%:: Notes on last payment
-%last_payment_ts%:: The time stamp for the last payment
-%mbts_xact_start%:: The date that the bill was started (currently not working)
-%xact_type%:: Type of Bill
-%title%:: title of item
-
-*Transit*
-
-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.  
-
-.*General Transits*
-
-[horizontal]
-%transit_item_author%:: Item author
-%transit_item_barcode%:: Barcode of item in transit
-%transit_item_callnumber%:: Call number of item in transit
-%transit_item_title%:: Title of Item in transit
-%transit_dest_lib%:: Destination Library
-%transit_source_send_time%:: Time item was sent in transit
-%transit_source%:: Library that placed the item in transit.
-
-
-.*Transit Slip*
-
-[horizontal]
-%route_to%:: Library Policy Name that the item is in transit to
-%route_to_org_fullname%:: Library Full Name that the item is in transit to
-%street1%:: Library Street address Line 1 that the item is in transit to.
-%street2%:: Library Street address Line 2 that the item is in transit to.
-%city_state_zip%:: City, State, Zip of Library the Item is in transit to.
-%item_barcode%:: Item barcode
-%item_title%:: Item title
-%item_author%:: Item Author
-%hold_for_msg%:: Hold for Message: this gives the patron's name
-%PATRON_BARCODE%:: Patron's Barcode
-%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.
-%notify_by_email%:: Email listed in Hold Database.  Same as phone number
-%notify_by_text%:: SMS contact number (new to 2.2)
-%request_date%:: Date that the Request was originally placed
diff --git a/docs/media/receipt1.png b/docs/media/receipt1.png
new file mode 100644 (file)
index 0000000..1544c72
Binary files /dev/null and b/docs/media/receipt1.png differ
diff --git a/docs/media/receipt2.png b/docs/media/receipt2.png
new file mode 100644 (file)
index 0000000..3c53077
Binary files /dev/null and b/docs/media/receipt2.png differ
index 48f2fc0..f544e85 100644 (file)
@@ -208,7 +208,7 @@ include::admin/workstation_admin.adoc[]
 // Push titles down one level.
 :leveloffset: 1
 
 // Push titles down one level.
 :leveloffset: 1
 
-include::admin/workstation_admin_receipt_template_editor.adoc[]
+include::admin/receipt_template_editor.adoc[]
 
 // Return to normal title levels.
 :leveloffset: 0
 
 // Return to normal title levels.
 :leveloffset: 0
index 44a3dd1..f8e02f8 100644 (file)
@@ -182,7 +182,7 @@ include::admin_initial_setup/hard_due_dates.adoc[]
 
 include::admin/booking-admin.adoc[]
 
 
 include::admin/booking-admin.adoc[]
 
-include::admin/workstation_admin_receipt_template_editor.adoc[]
+include::admin/receipt_template_editor.adoc[]
 
 :leveloffset: 1
 
 
 :leveloffset: 1