webstaff: add more comments to print templates
authorGalen Charlton <gmc@equinoxinitiative.org>
Tue, 14 Mar 2017 22:05:45 +0000 (18:05 -0400)
committerMike Rylander <mrylander@gmail.com>
Mon, 17 Apr 2017 19:11:40 +0000 (15:11 -0400)
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Mike Rylander <mrylander@gmail.com>
16 files changed:
Open-ILS/src/templates/staff/share/print_templates/t_bill_payment.tt2
Open-ILS/src/templates/staff/share/print_templates/t_bills_current.tt2
Open-ILS/src/templates/staff/share/print_templates/t_bills_historical.tt2
Open-ILS/src/templates/staff/share/print_templates/t_checkin.tt2
Open-ILS/src/templates/staff/share/print_templates/t_checkout.tt2
Open-ILS/src/templates/staff/share/print_templates/t_hold_pull_list.tt2
Open-ILS/src/templates/staff/share/print_templates/t_hold_shelf_list.tt2
Open-ILS/src/templates/staff/share/print_templates/t_hold_shelf_slip.tt2
Open-ILS/src/templates/staff/share/print_templates/t_hold_transit_slip.tt2
Open-ILS/src/templates/staff/share/print_templates/t_holds_for_bib.tt2
Open-ILS/src/templates/staff/share/print_templates/t_holds_for_patron.tt2
Open-ILS/src/templates/staff/share/print_templates/t_items_out.tt2
Open-ILS/src/templates/staff/share/print_templates/t_patron_address.tt2
Open-ILS/src/templates/staff/share/print_templates/t_patron_note.tt2
Open-ILS/src/templates/staff/share/print_templates/t_renew.tt2
Open-ILS/src/templates/staff/share/print_templates/t_transit_slip.tt2

index fe6851a..e3bb24e 100644 (file)
@@ -1,3 +1,14 @@
+<!--
+Template for bill payment recepts. Data specific to this template
+includes:
+
+* current_location.name - name of workstation location
+* payment_type
+* payment_total - total paid
+* new_balance - balance after the payments were applied
+* payments - list of specific payments
+
+-->
 Welcome to {{current_location.name}}!<br/>
 A receipt of your  transaction:<hr/>
 
index c99cb4d..21b53c2 100644 (file)
@@ -1,3 +1,13 @@
+<!-
+Template for printing a list of current bills. Data specific
+to this template includes:
+
+* transasctions - a list of transactions, each of which
+  contains:
+
+  summary - information about the transaction
+
+-->
 Welcome to {{current_location.name}}!<br/>
 You have the following bills:
 <hr/>
index d8871fe..44fcd57 100644 (file)
@@ -1,3 +1,13 @@
+<!-
+Template for printing a list of past bills. Data specific
+to this template includes:
+
+* transasctions - a list of transactions, each of which
+  contains:
+
+  summary - information about the transaction
+
+-->
 Welcome to {{current_location.name}}!<br/>
 You had the following bills:
 <hr/>
index 7bc56e4..3aa276c 100644 (file)
@@ -1,3 +1,15 @@
+<!--
+Template for printing a checkin receipt. Data specific to this
+template includes:
+
+* checkins - list of checkins recorded during the session. Each
+  includes:
+
+  * title
+  * copy_barcode
+  * call_number.label
+
+-->
 <div>
   <div>[% l('Welcome to [_1]', '{{current_location.name}}') %]</div>
   <div>[% l('You checked in the following items:') %]</div>
index 1f1218e..dc88446 100644 (file)
@@ -1,3 +1,14 @@
+<!--
+Template for printing checkout receipts; fields available include:
+
+* circulations - list of loans made during this session. Each
+  includes:
+
+  * title
+  * copy_barcode
+  * due_date
+
+-->
 <div>
   <div>[% l('Welcome to [_1]', '{{current_location.name}}') %]</div>
   <div>[% l('You checked out the following items:') %]</div>
index ce23fe4..47be206 100644 (file)
@@ -1,3 +1,15 @@
+<!--
+Template for printing a table of holds to pull. Fields include:
+
+* holds - list of holds, each of which includes:
+
+  * title
+  * author
+  * hold.hold_type
+  * copy.location_name
+  * volume.label - call number
+  * copy.barcode
+-->
 <table id='pull-list-template-table'>
   <style>
     #pull-list-template-table td,
index c95fb3e..375e9b9 100644 (file)
@@ -1,3 +1,18 @@
+<!--
+Template for printing a list of items on the hold shelf. Fields include:
+
+* holds - list of hold requests, including
+
+  * patron_alias
+  * patron_last
+  * patron_first
+  * hold.hold_type
+  * title
+  * author
+  * volume.label
+  * copy.barcode
+
+-->
 <table id='shelf-list-template-table'>
   <style>
     #pull-list-template-table td,
index 590e00b..aef5b8a 100644 (file)
@@ -1,3 +1,19 @@
+<!--
+Template for printing hold request slips. Fields include:
+
+* hold.behind_desk
+* copy.barcode
+* title
+* patron.family_name
+* patron.first_given_name
+* patron.second_given_name
+* patron.card.barcode
+* hold.request_time
+* hold.phone_notify
+* hold.sms_notify
+* hold.email_notify
+
+-->
 <div>
   <div ng-switch on="hold.behind_desk">
     <div ng-switch-when="t">
index 64a213d..eb002b8 100644 (file)
@@ -1,3 +1,26 @@
+<!--
+Template for printing hold transit slips. Fields include:
+
+* dest_location.name - name of destination library
+* dest_location.shortname
+* dest_address.street1
+* dest_address.street2
+* dest_address.city
+* dest_address.state
+* dest_address.post_code
+* hold.behind_desk
+* copy.barcode
+* title
+* patron.family_name
+* patron.first_given_name
+* patron.second_given_name
+* patron.card.barcode
+* hold.request_time
+* hold.phone_notify
+* hold.sms_notify
+* hold.email_notify
+
+-->
 <div>
   <div>[% l('This item needs to be routed to [_1]', '<b>{{dest_location.shortname}}</b>') %]</div>
   <div>{{dest_location.name}}</div>
index 8d3061c..2a2f965 100644 (file)
@@ -1,3 +1,16 @@
+<!--
+Template for printing a list of holds associated with a
+bib record. Fields include:
+
+* holds - list of holds, including
+
+  * hold.request_time
+  * patron_barcode
+  * patron_last - patron surname
+  * patron_alias - hold alias for the patorn
+  * copy.barcode
+
+-->
 <div>
   <div>[% l('Holds for record: [_1]', '{{holds[0].title}}') %]</div>
   <hr/>
index 492454c..0f3a5da 100644 (file)
@@ -1,3 +1,11 @@
+<!--
+Template for printing a list of hold requests for a patron. Fields include:
+
+* holds - a list of hold request, each of which includes
+  * title
+
+-->
 <div>
   <div>[% l('Welcome to [_1]', '{{current_location.name}}') %]</div>
   <div>[% l('You have the following title on hold:') %]</div>
index fee903b..10564b1 100644 (file)
@@ -1,3 +1,14 @@
+<!--
+Template for printing a list of items that a patron has checked out.
+Fields include:
+
+* circulations - list of current loans, including
+
+  * copy.barcode
+  * circ.due_date
+  * title
+
+-->
 <div>
   <div>[% l('Welcome to [_1]', '{{current_location.name}}') %]</div>
   <div>[% l('You have the following items:') %]</div>
index c1a3e37..55996b2 100644 (file)
@@ -1,3 +1,16 @@
+<!--
+Template for printing a patron address. Fields include:
+
+* first_given_name
+* second_given_name
+* family_name
+* address.street1
+* address.street2
+* address.city
+* address.state
+* address.post_code
+
+-->
 <div>
   <div>
     {{patron.first_given_name}} 
index 5b98683..da75ec4 100644 (file)
@@ -1,3 +1,13 @@
+<!--
+Template for printing a patron note. Fields include:
+
+* note.usr.family_name
+* note.usr.first_name
+* note.usr.second_given_name
+* note.usr.card.barcode
+* note.create_date
+
+-->
 <h3>[% l(
   'Pertaining to [_1], [_2] [_3] : [_4]',
   '{{note.usr.family_name}}',
index 8e96445..d5046b2 100644 (file)
@@ -1,3 +1,13 @@
+<!--
+Template for printing a renewal receipt. Fields include:
+
+* circulations - list of renewals made during the session, including
+
+  * title
+  * copy.barcode
+  * circ.due_date
+
+-->
 <div>
   <div>[% l('Welcome to [_1]', '{{current_location.name}}') %]</div>
   <div>[% l('You renewed the following items:') %]</div>
index 324ad5e..afd5aab 100644 (file)
@@ -1,3 +1,17 @@
+<!--
+Template for printing a transit slip. Fields include:
+
+* dest_location.name - name of destination library
+* dest_location.shortname
+* dest_address.street1
+* dest_address.street2
+* dest_address.city
+* dest_address.state
+* dest_address.post_code
+* copy.barcode
+* title
+* author
+-->
 <div>
   <div>[% l('This item needs to be routed to [_1]', '<b>{{dest_location.shortname}}</b>') %]</div>
   <div>{{dest_location.name}}</div>