From 98b0b66a7bbf5c8b370639b8249fcba90e7a5a44 Mon Sep 17 00:00:00 2001
From: Galen Charlton <gmc@equinoxinitiative.org>
Date: Tue, 14 Mar 2017 18:05:45 -0400
Subject: [PATCH] webstaff: add more comments to print templates

Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Mike Rylander <mrylander@gmail.com>
---
 .../share/print_templates/t_bill_payment.tt2  | 11 +++++++++
 .../share/print_templates/t_bills_current.tt2 | 10 ++++++++
 .../print_templates/t_bills_historical.tt2    | 10 ++++++++
 .../staff/share/print_templates/t_checkin.tt2 | 12 ++++++++++
 .../share/print_templates/t_checkout.tt2      | 11 +++++++++
 .../print_templates/t_hold_pull_list.tt2      | 12 ++++++++++
 .../print_templates/t_hold_shelf_list.tt2     | 15 ++++++++++++
 .../print_templates/t_hold_shelf_slip.tt2     | 16 +++++++++++++
 .../print_templates/t_hold_transit_slip.tt2   | 23 +++++++++++++++++++
 .../share/print_templates/t_holds_for_bib.tt2 | 13 +++++++++++
 .../print_templates/t_holds_for_patron.tt2    |  8 +++++++
 .../share/print_templates/t_items_out.tt2     | 11 +++++++++
 .../print_templates/t_patron_address.tt2      | 13 +++++++++++
 .../share/print_templates/t_patron_note.tt2   | 10 ++++++++
 .../staff/share/print_templates/t_renew.tt2   | 10 ++++++++
 .../share/print_templates/t_transit_slip.tt2  | 14 +++++++++++
 16 files changed, 199 insertions(+)

diff --git a/Open-ILS/src/templates/staff/share/print_templates/t_bill_payment.tt2 b/Open-ILS/src/templates/staff/share/print_templates/t_bill_payment.tt2
index fe6851ab98..e3bb24ed5c 100644
--- a/Open-ILS/src/templates/staff/share/print_templates/t_bill_payment.tt2
+++ b/Open-ILS/src/templates/staff/share/print_templates/t_bill_payment.tt2
@@ -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/>
 
diff --git a/Open-ILS/src/templates/staff/share/print_templates/t_bills_current.tt2 b/Open-ILS/src/templates/staff/share/print_templates/t_bills_current.tt2
index c99cb4d1ee..21b53c22ee 100644
--- a/Open-ILS/src/templates/staff/share/print_templates/t_bills_current.tt2
+++ b/Open-ILS/src/templates/staff/share/print_templates/t_bills_current.tt2
@@ -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/>
diff --git a/Open-ILS/src/templates/staff/share/print_templates/t_bills_historical.tt2 b/Open-ILS/src/templates/staff/share/print_templates/t_bills_historical.tt2
index d8871fe686..44fcd57b39 100644
--- a/Open-ILS/src/templates/staff/share/print_templates/t_bills_historical.tt2
+++ b/Open-ILS/src/templates/staff/share/print_templates/t_bills_historical.tt2
@@ -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/>
diff --git a/Open-ILS/src/templates/staff/share/print_templates/t_checkin.tt2 b/Open-ILS/src/templates/staff/share/print_templates/t_checkin.tt2
index 7bc56e4b32..3aa276c25a 100644
--- a/Open-ILS/src/templates/staff/share/print_templates/t_checkin.tt2
+++ b/Open-ILS/src/templates/staff/share/print_templates/t_checkin.tt2
@@ -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>
diff --git a/Open-ILS/src/templates/staff/share/print_templates/t_checkout.tt2 b/Open-ILS/src/templates/staff/share/print_templates/t_checkout.tt2
index 1f1218e8d3..dc884466f7 100644
--- a/Open-ILS/src/templates/staff/share/print_templates/t_checkout.tt2
+++ b/Open-ILS/src/templates/staff/share/print_templates/t_checkout.tt2
@@ -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>
diff --git a/Open-ILS/src/templates/staff/share/print_templates/t_hold_pull_list.tt2 b/Open-ILS/src/templates/staff/share/print_templates/t_hold_pull_list.tt2
index ce23fe4993..47be206f7a 100644
--- a/Open-ILS/src/templates/staff/share/print_templates/t_hold_pull_list.tt2
+++ b/Open-ILS/src/templates/staff/share/print_templates/t_hold_pull_list.tt2
@@ -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,
diff --git a/Open-ILS/src/templates/staff/share/print_templates/t_hold_shelf_list.tt2 b/Open-ILS/src/templates/staff/share/print_templates/t_hold_shelf_list.tt2
index c95fb3e806..375e9b90c5 100644
--- a/Open-ILS/src/templates/staff/share/print_templates/t_hold_shelf_list.tt2
+++ b/Open-ILS/src/templates/staff/share/print_templates/t_hold_shelf_list.tt2
@@ -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,
diff --git a/Open-ILS/src/templates/staff/share/print_templates/t_hold_shelf_slip.tt2 b/Open-ILS/src/templates/staff/share/print_templates/t_hold_shelf_slip.tt2
index 590e00be93..aef5b8a7f1 100644
--- a/Open-ILS/src/templates/staff/share/print_templates/t_hold_shelf_slip.tt2
+++ b/Open-ILS/src/templates/staff/share/print_templates/t_hold_shelf_slip.tt2
@@ -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">
diff --git a/Open-ILS/src/templates/staff/share/print_templates/t_hold_transit_slip.tt2 b/Open-ILS/src/templates/staff/share/print_templates/t_hold_transit_slip.tt2
index 64a213d364..eb002b893e 100644
--- a/Open-ILS/src/templates/staff/share/print_templates/t_hold_transit_slip.tt2
+++ b/Open-ILS/src/templates/staff/share/print_templates/t_hold_transit_slip.tt2
@@ -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>
diff --git a/Open-ILS/src/templates/staff/share/print_templates/t_holds_for_bib.tt2 b/Open-ILS/src/templates/staff/share/print_templates/t_holds_for_bib.tt2
index 8d3061cb31..2a2f9657b0 100644
--- a/Open-ILS/src/templates/staff/share/print_templates/t_holds_for_bib.tt2
+++ b/Open-ILS/src/templates/staff/share/print_templates/t_holds_for_bib.tt2
@@ -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/>
diff --git a/Open-ILS/src/templates/staff/share/print_templates/t_holds_for_patron.tt2 b/Open-ILS/src/templates/staff/share/print_templates/t_holds_for_patron.tt2
index 492454c7c1..0f3a5dadfa 100644
--- a/Open-ILS/src/templates/staff/share/print_templates/t_holds_for_patron.tt2
+++ b/Open-ILS/src/templates/staff/share/print_templates/t_holds_for_patron.tt2
@@ -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>
diff --git a/Open-ILS/src/templates/staff/share/print_templates/t_items_out.tt2 b/Open-ILS/src/templates/staff/share/print_templates/t_items_out.tt2
index fee903b86a..10564b16e3 100644
--- a/Open-ILS/src/templates/staff/share/print_templates/t_items_out.tt2
+++ b/Open-ILS/src/templates/staff/share/print_templates/t_items_out.tt2
@@ -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>
diff --git a/Open-ILS/src/templates/staff/share/print_templates/t_patron_address.tt2 b/Open-ILS/src/templates/staff/share/print_templates/t_patron_address.tt2
index c1a3e37951..55996b2758 100644
--- a/Open-ILS/src/templates/staff/share/print_templates/t_patron_address.tt2
+++ b/Open-ILS/src/templates/staff/share/print_templates/t_patron_address.tt2
@@ -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}} 
diff --git a/Open-ILS/src/templates/staff/share/print_templates/t_patron_note.tt2 b/Open-ILS/src/templates/staff/share/print_templates/t_patron_note.tt2
index 5b9868397b..da75ec4f3a 100644
--- a/Open-ILS/src/templates/staff/share/print_templates/t_patron_note.tt2
+++ b/Open-ILS/src/templates/staff/share/print_templates/t_patron_note.tt2
@@ -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}}',
diff --git a/Open-ILS/src/templates/staff/share/print_templates/t_renew.tt2 b/Open-ILS/src/templates/staff/share/print_templates/t_renew.tt2
index 8e964454d5..d5046b2561 100644
--- a/Open-ILS/src/templates/staff/share/print_templates/t_renew.tt2
+++ b/Open-ILS/src/templates/staff/share/print_templates/t_renew.tt2
@@ -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>
diff --git a/Open-ILS/src/templates/staff/share/print_templates/t_transit_slip.tt2 b/Open-ILS/src/templates/staff/share/print_templates/t_transit_slip.tt2
index 324ad5e1eb..afd5aabfd8 100644
--- a/Open-ILS/src/templates/staff/share/print_templates/t_transit_slip.tt2
+++ b/Open-ILS/src/templates/staff/share/print_templates/t_transit_slip.tt2
@@ -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>
-- 
2.43.2