Print Templates for Receipts and Lists

v.3


About

When there is a print option within an Evergreen function, there is a corresponding print template that dictates the format, content, and printer used for that print request. In most cases, the screen display does NOT match the printed out.


stop Exported custom templates from the desktop client CANNOT be imported into the Web Client.

Printer Context

When using Hatch printing, different types of print requests can be configured for different printers. The Printer Contexts include Default, Receipt, Label, Mail, and Offline. The two most commonly used with be Default - your standard printer, and Receipt - your Star printer.

When editing your templates, set the printer context to match the tyype of printer you plan to use.

Then open the Administration > Workstation > Printer Settings interface to set printer defaults for the contexts used.

The most common printer settings to specify are:

  • Printer - Evergreen will automatically populate the list with available printers
  • Paper type - particularly important if you use a thermal printer
  • Margins - use "Equal" for narrow margins that maximize the width of text per line, particularly when printing bulleted lists. NOTE: Some printers do not accept the "Equal" setting - in these situations, receipts will not print. Try "Device Minimum" or "Equal Opposite" instead, and use the "Test Print" feature to check which option will work with your printer.

Force Printer Context

For each print template, you must specify the printer/print context. For example, checkout receipts will usually be printed by the receipt printer; set that template's "Force Printer Conext" value to Receipt.

If no printer context is set, receipts will print to the default printer.

Edit templates

  1. From the Administration Menu, select Workstation
  2. Click Print Templates
  3. From the Template Name list, select a template; example: Checkout
  4. The current template print view displays in the Preview Pane, the editable template code appears in the Template pane
    • The top part of the template pane includes explanatory text about the template and includes Evergreen code that can be inserted into the template to pull in pieces of Evergreen data. This explanatory text is marked by
      <!-- [text block] -->
      tags.
  5. Changes made in the Template pane will appear in the Preview pane, but are not saved until the "Save Locally" button is clicked
    • The "Reset to Default" button will undo ALL changes, saved or unsaved, and return the template to the default

General notes about editing templates

  • Print templates are created using a combination of basic HTML, CSS, and Evergreen code. Submit a help request for assistance with customizing your templates.
  • Examples of common customizations are provided in this document, with a preview image of the receipt and a text file that can be copied and pasted into the template edit window.
  • Templates must be saved for every web client where printing will occur. PLS recommends configuring templates on one workstation, then exporting a template file to a flash drive. The templates can then be imported from the flash drive to every other client.

Common edits

Images

Images to be added to a print template must be submitted to PLS to be stored on a secure server. The image can be added to the slip using the URL and an "<img>" tag. Submit your image file using this form.

Example code format: <div><img src="https://images.pls-net.org/mpl_logo_small_dither5.jpg"></div>

Format text

Font size

 <div style="font-size:150%">Welcome to {{current_location.name}}</div> 

Font emphasis

PLS recommends using CSS to make text bold, italic, etc., using the font-weight element:

<div style="font-weight:bold">Welcome to {{current_location.name}}</div>

HTML tags can also be used, but the tags must be closed:

 <div> <b>Title: {{title}}</b></div>

Font face/family

Specify a font family

<div><span style="font-size:600%;font-family:'Comic Sans MS', cursive, sans-serif">{{dest_location.shortname}}</span></div>

List of fonts/font families: https://www.w3schools.com/cssref/css_websafe_fonts.asp NOTE! These examples format multi-word font names within double quotes ("Comic Sans MS") but Evergreen does not support the double quotes. If you wish to use a multi-word font, enclose the name in single quotes ('Comic Sans MS')

Combine styles

<div style="font-weight:bold;font-size:150%;text-align:center;">Welcome to {{current_location.name}}</div>

Header and footer text

In the desktop client, default receipt headers and footers were included in all receipts. The text was set in the Evergreen configuration for each library, and a code was used to populate the receipt. In the web client, the code for headers and footers is not included in the receipt templates.

If libraries want to have address, contact information, URL, Facebook links, etc. included in their templates this information can be added using HTML to each relevant template.

Example:

<div>
Library Name <br/>
Address line 1 <br/>
City, State, ZIP <br/>
<br/>
Phone Number<br/>
</div>

Print limited characters

Print only the first # characters - i.e.: Nybody prints as Nybo

{{patron.family_name | limitTo:4}} 

Print only the last # characters - i.e.: 22111000148960 prints as 48960

{{patron.card.barcode | limitTo:-5}} 

Save Locally

Be sure to save any local customizations. Print templates are saved per computer. Use the Export and Import functions to save templates to a flash drive to install consistent templates on multiple workstations.

Export and Import

Available Templates - examples and customization text

Import all basic customizations

Download this file to import ALL basic customizations into your Evergreen templates.

  1. Click the link - a page of code text will open in the browser
  2. Anywhere in the browser page, right click
  3. In the menu pop up select "Save As..."
  4. In the Save As menu the File Name will automfill, and Save As Type JSON File will autofill, click Save
  5. In Administration > Workstation > Print Templates, click Import and navigate to the location where this file is saved
  6. After files are imported, click Save Locally
  7. Set any local preferences for Default or Receipt printer for individual templates

Bills, Current

Context: Receipt

Default Basic cusomization
WebClient_PrintTemplates_BillsCurrent_Default.png WebReceipts_BillsCurrent_Basic_20181205.png

Bills, Historical

Context: Receipt

Default Basic customization
WebReceipts_BillsHistorical_Default.png WebReceipts_BillsHistorical_Basic_20181205.png

Bills, Payment

Context: Receipt

Default Basic customization
WebReceipts_BillsPayment_Default.png WebReceipts_BillsPayment_Basic_20181205.png

Checkin

Context: Receipt

Default Basic customization
WebClient_PrintTemplates_Checkin_Default.png WebReceipts_Checkin_Basic_20181205.png

Checkout

Context: Receipt

Default Basic customization
WebClient_PrintTemplates_Checkout_Default.png WebReceipts_Checkout_Basic_20181205.png
"Fines owed" customization "You saved" customization
WebReceipts_Checkout_FinesOwed_20181205.png WebReceipts_Checkout_YouSavedToday_20181205.png

Hold Transit Slip

Context: Receipt

Default Basic customization
WebReceipts_HoldTransitSlip_Default.png WebReceipts_HoldTransitSlip_Basic_20181205.png

Hold Shelf Slip

Context: Receipt

Default Basic customization
WebReceipts_HoldShelfSlip_Default.png WebReceipts_HoldShelfSlip_Basic_20181205.png

Holds for Bib Record

Context: Default

Default Basic Customization
WebReceipts_HoldsForBibRecord_Default.png WebReceipts_HoldsForBibRecord_Basic_20181205.png

Holds for Patron

Default Basic customization
| WebReceipts_HoldsForPatron_Default.png| WebReceipts_HoldsForPatron_Basic_20181205.png

Hold Pull List

Context: Default

In the WebClientPullList, clicking "Print Full List" triggers this template.

Default Basic customization
WebReceipts_HoldPullList_Default.png WebReceipts_HoldsPullList_Basic_20181205.png

In-House Use List

Default Basic customization
WebReceipts_InHouseUseList_Default.png WebReceipts_InHouseUseList_Basic_20181205.png

Hold Shelf List

Default Basic customization
WebReceipts_HoldShelfList_Default.png WebReceipts_HoldShelfList_Basic_20181205.png
*txt Hold Shelf List - Basic customization code - text to copy and paste

Item Status

Default Basic customization
WebReceipts_ItemStatus_Default.png WebReceipts_ItemStatus_Basic_20181205.png

Items Out

Default Basic customization
WebReceipts_ItemsOut_Default.png WebReceipts_ItemsOut_Basic_20181205.png

Patron Address

Patron Note

Renew

Default Basic customization
WebReceipts_Renew_Default.png WebReceipts_Renew_Basic_20181205.png

Transit List

Default Basic customization
WebReceipts_TransitList_Default.png WebReceipts_TransitList_Basic_20181205.png

Transit Slip

Default Basic customization
WebReceipts_TransitSlip_default.png WebReceipts_TransitSlip_Basic_20181205.png

Offline Checkout

Offline Renew

Offline Checkin

Offline In-House Use

EvergreenWebForm
Topic Subject Web Client
Service Evergreen
Documentation type None
Year

Includes RT Form? No
Status

Topic revision: r28 - 12 Dec 2018 - 16:04:00 - LindsayStratton
 

This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding PLUM? Send feedback