Added additional informatin on Receipts
authorlfloyd <lfloyd@library.in.gov>
Fri, 20 Dec 2019 20:15:58 +0000 (15:15 -0500)
committerlfloyd <lfloyd@library.in.gov>
Fri, 20 Dec 2019 20:15:58 +0000 (15:15 -0500)
docs/admin/receipt_template_editor.adoc
master.code-workspace [new file with mode: 0644]

index e4ed2db..a8d74f2 100644 (file)
@@ -45,6 +45,10 @@ This is a complete list of the receipts currently in use in Evergreen.
 *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.
+*Offline Checkout*::A basic checkout receipt for Offline use. 
+*Offline Checkin*::A basic listing of times checked in Offline.
+*Offline Renew*::A basic listing of items renewed in Offline.
+*Offline In-House Use*::Listing of items used in house in Offline. 
 
 
 Editing Receipts
@@ -77,15 +81,17 @@ 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}}`.
+templates with curly brackets '{{term}}'.
 
-Example: `{{checkout.title}}`
+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. 
 
+<<recipt_contents_reference.adoc, Receipt Contents Reference>> is a list of most of the variables that you can use in your receipts.
+
 ------
 <ol>
 <li ng-repeat="checkout in circulations">
@@ -119,6 +125,10 @@ easily readable.
 |{{today}}                     | 2017-08-01T14:18:51.445Z
 |{{today \| date:'short'}}     | 8/1/17 10:18 AM
 |{{today \| date:'M/d/yyyy'}}  | 8/1/2017
+|{{today \| date:'shortDate'}} | 4/24/19
+|{{today \| date:‘shortTime'}} | 9:43 AM
+|{{today \| date:'longDate'}}  |April 24, 2019
+|{{today \| date:‘medium'}}    |April 24, 2019 8:30:01 AM
 |===================================================
 
 Currency Formatting
@@ -127,7 +137,7 @@ 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`
+'{{xact.summary.balance_owed | currency}}' prints as '$2.50'
 
 
 Conditional Formatting
@@ -135,7 +145,7 @@ 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>`
+'<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.
@@ -143,8 +153,8 @@ 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>`
+'<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
 
@@ -152,12 +162,12 @@ 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
+'{{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".
+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
@@ -174,9 +184,9 @@ 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
+'<img
 src="https://evergreen-ils.org/wp-content/uploads/2013/09/copy-Evergreen_Logo_sm072.jpg"
-style="width:150px;padding:5px;">`
+style="width:150px;padding:5px;">'
 
 Sort Order
 ^^^^^^^^^^
@@ -185,8 +195,7 @@ 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']">`
+'<tr ng-repeat="hold_data in holds | orderBy : ['copy.location.name','volume.label']">'
 
 Subtotals
 ^^^^^^^^^
@@ -228,15 +237,14 @@ 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
+As you can only save a template on to the computer you are working (*Save Locally*) 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. 
+. Export Customized Templates.
+. Saves a “print_templates.json” file in the downloads folder.
+NOTE: You can rename a the file to better track your changes.
 
 Importing Templates
 ^^^^^^^^^^^^^^^^^^^
diff --git a/master.code-workspace b/master.code-workspace
new file mode 100644 (file)
index 0000000..362d7c2
--- /dev/null
@@ -0,0 +1,7 @@
+{
+       "folders": [
+               {
+                       "path": "."
+               }
+       ]
+}
\ No newline at end of file