Docs: Update to template receipt docs
authorLynn Floyd <alynn2671@gmail.com>
Mon, 10 Nov 2014 18:29:31 +0000 (13:29 -0500)
committerYamil Suarez <yamil@yamil.com>
Wed, 26 Nov 2014 21:33:05 +0000 (16:33 -0500)
Thanks to Lynn Floyd. When adding the new content I ended up splitting new and old content into three files.

Signed-off-by: Yamil Suarez <yamil@yamil.com>
docs/admin/workstation_admin.txt
docs/admin/workstation_admin_customizable_toolbar.txt [new file with mode: 0644]
docs/admin/workstation_admin_receipt_template_editor.txt [new file with mode: 0644]
docs/root.txt

index 215b512..98ffb9b 100644 (file)
@@ -133,223 +133,3 @@ driver is the only one available try one of the alternate print strategies
 instead.
 ====================================
 
-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.
-
-. Select *Admin -> Workstation Administration -> Receipt Template Editor*.
-. Select the _checkout_ template from the dropdown menu.
-+    
-image::media/receipt-2.png[select checkout]
-+
-. This is what the default checkout template looks like.  The template preview is
-on the left hand side.  You can edit the _Header_, _Line Item_ or _Footer_ on the 
-right hand side.  
-+    
-image::media/receipt-3.jpg[receipt-3]
-+
-. In the upper right hand corner you can see the available macros by clicking on
-the *Macros* button.  A macro prints a real value from the database.  In this
-example, the macro _%LIBRARY%_ prints ``Prince Rupert Library''.  The macros that
-are available vary slightly between types of receipt templates (i.e. bills,
-holds, items). 
-+
-[TIP]
-===============================
-Receipt templates are marked up with HTML tags. You may use most HTML tags.
-See http://www.w3schools.com/html/ for more information on HTML tags.  
-
-You may insert a link to an image, e.g. your library's logo, that exists on the
-web. For example, to include the white Evergreen logo from this document, enter tag <img
-src=http://docs.evergreen-ils.org/2.3/media/small_logo_white.jpg>. in the
-receipt template.
-
-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.
-
-* %INCLUDE(notice_text)%
-* %INCLUDE(alert_text)%
-* %INCLUDE(event_text)%
-* %INCLUDE(footer_text)%%
-* %INCLUDE(header_text)%
-==============================
-+
-. Below are some example edits:
-+    
-image::media/receipt-11.jpg[receipt-11]
-+
-The above is the default _Line Item_ in Checkout template. The macro _%barcode%_
-prints the item barcodes of the books that were checked out.  The macro
-_%due_date%_ prints the due date for each item that was checked out. You may add a
-line break between them: Barcode: _%barcode%_ </br> Due: _%due_date%_
-+
-The receipt preview will look like this:
-+    
-image::media/receipt-11a.png[receipt-11a]
-+
-[NOTE]
-==========================
-The due date can only be printed in the _YYYY-MM-DD_ format. 
-==========================  
-+
-. Once you have the checkout template how you want it, click *Save Locally* to
-save the template to your computer. 
-
-image::media/receipt-15.jpg[receipt-15]
-
-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] 
-
-Exporting Templates
-^^^^^^^^^^^^^^^^^^^
-
-indexterm:[receipt template editor, exporting]
-
-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 (e.g. more than one computers on the circulation desk, or another
-computer in the workroom that you use to checkin items or capture holds with).
-
-. Click on *Export*.
-+
-image::media/receipt-17.jpg[receipt-17]
-+
-. Select the location to save the template to, name the template, and click
-*Save*.
-. Click *OK* to confirm.
-
-Importing Templates
-^^^^^^^^^^^^^^^^^^^
-
-indexterm:[receipt template editor, importing]
-
-. Send the exported templates file to the workstation to which you want to import
-the templates. You may do it using memory stick or email, etc.
-. On _Receipt Template Editor_, Click *Import*. 
-+ 
-image::media/receipt-20.jpg[receipt-20]
-+
-. Navigate to and select the template file that you want to import.  Click
-*Open*.
-+ 
-image::media/receipt-21.jpg[receipt-21]
-+
-. Click *OK* to confirm on the prompt.
-+
-. Click *Save Locally*.
-
-image::media/receipt-23.jpg[receipts-23]
-
-[TIP]
-=================
-By default all libraries use shared and hard-coded templates for Hold Slip and
-Transit Slip. Libraries can switch to using their own templates by setting up a
-library setting: Use legacy hardcoded receipts/slips. Details see <<library_settings_editor, Library Settings>>. 
-=================
-
-
-Customizable Toolbar
-~~~~~~~~~~~~~~~~~~~~
-
-By default, two toolbars are available in the staff client: circulation and
-cataloging. This feature enables you to customize toolbars in the staff client.
-You can create toolbars for specific org unit(s), workstation(s), or login(s).
-
-Configure Toolbar
-^^^^^^^^^^^^^^^^^
-
-. Click *Admin* -> *Workstation Administration* -> *Toolbars* -> *Configure
-Toolbars*.
-
-. Click *New Toolbar*.
-
-. Enter label for toolbar.
-+
-image::media/Customizable_Toolbar1.jpg[Customizable_Toolbar1]
-+
-. Click *Ok*.
-
-. Select one of the buttons in the *Available* panel.  The *Button ID* describes
-that action that the button will take, and the *Label* will display in the
-toolbar.
-
-. Click the `--> (A)` button to add the selected function to the
-*Selected* panel on the bottom right side of the screen.  To remove a button,
-click the `<-- (R)` button.
-+
-image::media/Customizable_Toolbar2.jpg[Customizable_Toolbar2]
-+
-. Continue adding buttons if desired.  The buttons will display in the order that you add
-them.  If you want to reorder the buttons, click the *Up* or *Down* buttons.
-
-. To separate buttons onto left and right sides of the screen on the same
-toolbar, select *toolbarspacer*, and click `--> (A)`.
-+
-image::media/Customizable_Toolbar3.jpg[Customizable_Toolbar3]
-+
-. To add a dividing line between buttons that appear on the same side of the
-screen, select *toolbarseparator*, and click `--> (A)`.
-+
-image::media/Customizable_Toolbar4.jpg[Customizable_Toolbar4]
-+
-. At the bottom of the screen, choose the owner of this toolbar.
-If you click *Owning Org Unit*, then the owning org unit that you specify will display this
-toolbar.  Select the owning org unit from the drop down menu.  The rule of
-parental inheritance applies, so all child units will inherit the toolbars of
-their parental units.
-If you click *Owning Workstation*, then the workstation to which you are logged
-in when you created the toolbar will display this toolbar.
-If you select *Owning User*, then your login has access to that toolbar.
-
-. When you are finished creating the toolbar, click *Save Toolbar*.  Any
-toolbar to which you have access displays under *Admin -> Workstation
-Administration -> Toolbars -> Current*.
-
-*Permissions*
-
-ADMIN_TOOLBAR - Allow a user to create, edit, and delete custom toolbars
diff --git a/docs/admin/workstation_admin_customizable_toolbar.txt b/docs/admin/workstation_admin_customizable_toolbar.txt
new file mode 100644 (file)
index 0000000..f60d3c8
--- /dev/null
@@ -0,0 +1,60 @@
+Customizable Toolbar
+~~~~~~~~~~~~~~~~~~~~
+
+By default, two toolbars are available in the staff client: circulation and
+cataloging. This feature enables you to customize toolbars in the staff client.
+You can create toolbars for specific org unit(s), workstation(s), or login(s).
+
+Configure Toolbar
+^^^^^^^^^^^^^^^^^
+
+. Click *Admin* -> *Workstation Administration* -> *Toolbars* -> *Configure
+Toolbars*.
+
+. Click *New Toolbar*.
+
+. Enter label for toolbar.
++
+image::media/Customizable_Toolbar1.jpg[Customizable_Toolbar1]
++
+. Click *Ok*.
+
+. Select one of the buttons in the *Available* panel.  The *Button ID* describes
+that action that the button will take, and the *Label* will display in the
+toolbar.
+
+. Click the `--> (A)` button to add the selected function to the
+*Selected* panel on the bottom right side of the screen.  To remove a button,
+click the `<-- (R)` button.
++
+image::media/Customizable_Toolbar2.jpg[Customizable_Toolbar2]
++
+. Continue adding buttons if desired.  The buttons will display in the order that you add
+them.  If you want to reorder the buttons, click the *Up* or *Down* buttons.
+
+. To separate buttons onto left and right sides of the screen on the same
+toolbar, select *toolbarspacer*, and click `--> (A)`.
++
+image::media/Customizable_Toolbar3.jpg[Customizable_Toolbar3]
++
+. To add a dividing line between buttons that appear on the same side of the
+screen, select *toolbarseparator*, and click `--> (A)`.
++
+image::media/Customizable_Toolbar4.jpg[Customizable_Toolbar4]
++
+. At the bottom of the screen, choose the owner of this toolbar.
+If you click *Owning Org Unit*, then the owning org unit that you specify will display this
+toolbar.  Select the owning org unit from the drop down menu.  The rule of
+parental inheritance applies, so all child units will inherit the toolbars of
+their parental units.
+If you click *Owning Workstation*, then the workstation to which you are logged
+in when you created the toolbar will display this toolbar.
+If you select *Owning User*, then your login has access to that toolbar.
+
+. When you are finished creating the toolbar, click *Save Toolbar*.  Any
+toolbar to which you have access displays under *Admin -> Workstation
+Administration -> Toolbars -> Current*.
+
+*Permissions*
+
+ADMIN_TOOLBAR - Allow a user to create, edit, and delete custom toolbars
diff --git a/docs/admin/workstation_admin_receipt_template_editor.txt b/docs/admin/workstation_admin_receipt_template_editor.txt
new file mode 100644 (file)
index 0000000..47482d3
--- /dev/null
@@ -0,0 +1,633 @@
+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: *Admin -> 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 *Admin -> 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 is 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: formated 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 Biil
+%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 Biil
+%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 intransit
+%transit_dest_lib%:: Destination Library
+%transit_source_send_time%:: Time item was sent intransit
+%transit_source%:: Library that placed the item intransit.
+
+
+.*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
index 4d7579c..2cb10e5 100644 (file)
@@ -190,6 +190,16 @@ include::admin/staff_client-return_to_results_from_marc.txt[]
 
 include::admin/workstation_admin.txt[]
 
+// Push titles down one level.
+:leveloffset: 1
+
+include::admin/workstation_admin_receipt_template_editor.txt[]
+
+// Return to normal title levels.
+:leveloffset: 0
+
+include::admin/workstation_admin_customizable_toolbar.txt[]
+
 System Administration From the Staff Client
 ===========================================