From 508df9946c27b4a6f4cb87f96f0edd7519923867 Mon Sep 17 00:00:00 2001
From: Nicole Engard <nengard@gmail.com>
Date: Sat, 6 Feb 2010 00:40:54 -0500
Subject: [PATCH] add patron card help files

there are still more to add, but these are what I have written so far

Signed-off-by: Galen Charlton <gmcharlt@gmail.com>
---
 .../modules/help/patroncards/edit-layout.tmpl | 28 ++++++++++++++++++
 .../help/patroncards/edit-profile.tmpl        | 27 +++++++++++++++++
 .../help/patroncards/edit-template.tmpl       | 24 +++++++++++++++
 .../en/modules/help/patroncards/home.tmpl     | 17 +++++++++++
 .../en/modules/help/patroncards/manage.tmpl   | 29 +++++++++++++++++++
 5 files changed, 125 insertions(+)
 create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/edit-layout.tmpl
 create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/edit-profile.tmpl
 create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/edit-template.tmpl
 create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/home.tmpl
 create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/manage.tmpl

diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/edit-layout.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/edit-layout.tmpl
new file mode 100644
index 0000000000..081b170646
--- /dev/null
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/edit-layout.tmpl
@@ -0,0 +1,28 @@
+<!-- TMPL_INCLUDE NAME="help-top.inc" -->
+
+<h1>Layouts</h1>
+
+<p>A layout defines the text and images that will be printed on to the card and where it will appear.</p>
+
+<h3>Add a Layout</h3>
+
+<p>To add a new layout, you want to click on the 'Layouts' button at the top of your page and choose 'New Layout'</p>
+
+<p>Using the form that appears you can create a profile to fix any problems with your template.</p>
+
+<ul>
+<li>The name you assign to the layout is for your benefit, name it something that will be easy to identify at a later date</li>
+<li>The Units pull down is used to define what measurement scale you're going to be using for your layout.</li>
+<li>Next note if this layout is for the front or the back of the patron card</li>
+<ul><li>You will need a layout for both the front and back of your card if you have 2-sided library cards</li></ul>
+<li>You have the option of adding up to 3 lines of text to your card. Your text can be static text of your choosing and/or fields from the patron record. If you want to print fields from the patron record you want to put the field names in brackets like so - &lt;firstname&gt;</li>
+<li>For each line of text, you can choose your font, font size and the location of the text on the card using the lower X and Y coordinates</li>
+<li>In order to show the barcode and the patron card number you will need to check the 'Print Card Number as Barcode' option. This will turn the patron card number into a barcode. If you want the number to print in human readable format you will need to check the 'Print Card Number as Text Under Barcode' option.</li>
+<li>Finally you can choose up to two images to print on the card.</li>
+<ul><li>One can be the patron image which you can resize to meet your needs.</li>
+<li>The other image can be something like a library logo or symbol that you uploaded using the 'Manage Images' module of the Patron Card Creator Tool.</li></ul></ul>
+
+<p>After saving, your layouts will appear on the 'Manage Layouts' page.</p>
+
+
+<!-- TMPL_INCLUDE name="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/edit-profile.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/edit-profile.tmpl
new file mode 100644
index 0000000000..d9eff7cdca
--- /dev/null
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/edit-profile.tmpl
@@ -0,0 +1,27 @@
+<!-- TMPL_INCLUDE NAME="help-top.inc" -->
+
+<h1>Profiles</h1>
+
+<p>A profile is a set of “adjustments” applied to a given template  just prior to printing which compensates for anomalies unique and peculiar to a given printer (to which the profile is assigned). This means if you set a template up and then print a sample set of data and find that the items are not all aligned the same on each label, you need to set up a profile for each printer to make up for the differences in printing styles, such as the shifting of text to the left, right, top or bottom.</p>
+
+<p>If your cards are printing just the way you want, you will not need a profile.</p>
+
+<h3>Add a Profile</h3>
+
+<p>To add a new profile, you want to click on the 'Profiles' button at the top of your page and choose 'New Profile'</p>
+
+<p>Using the form that appears you can create a profile to fix any problems with your template.</p>
+
+<ul>
+<li>The Printer Name and Paper Bin do not have to match your printer exactly, they are for your reference so you can remember what printer you have set the profile for. So if you want to use the Printer model number in printer name or you can call it 'the printer on my desk'</li>
+<li>Template will be filled in once you have chosen which template to apply the profile to on the template edit form</li>
+<li>The Units pull down is used to define what measurement scale you're going to be using for your profile.</li>
+<li>Offset describes what happens when the entire image is off center either vertically or horzontally and creep describes a condition where the distance between the labels changes across the page or up and down the page</li>
+<ul><li>For these values, negative numbers move the error up and to the left and positive numbers move the error down and to the right</li>
+<li>Example: the text is .25” from the left edge of the first label, .28” from the left edge of the second label and .31” from the left edge of the third label. This means the horizontal creep should be set to .03" to make up for this difference.</li></ul></ul>
+
+<p>After saving, your profiles will appear on the 'Manage Profiles' page.</p>
+
+<p>Once you have saved your new profile, you can return to the list of templates and choose to edit the template that this profile is for.</p>
+
+<!-- TMPL_INCLUDE name="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/edit-template.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/edit-template.tmpl
new file mode 100644
index 0000000000..3a607aa358
--- /dev/null
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/edit-template.tmpl
@@ -0,0 +1,24 @@
+<!-- TMPL_INCLUDE NAME="help-top.inc" -->
+
+<h1>Templates</h1>
+
+<p>A template is the label/card stock you are using. This might be Avery 5160 for address labels, Gaylord 47-284 for spine labels or Avery 28371 for your patron cards, just to give a couple of examples. These labels will include all of the information you will need for setting up a Koha, this information may be on the packaging, and if not it can usually be found on the vendor's website.</p>
+
+<h3>Add a Template</h3>
+
+<p>To add a new template, you want to click on the 'Templates' button at the top of your page and choose 'New Template'</p>
+<p>Using the form that appears you can define the template for your sheet of labels or cards.</p>
+
+<ul>
+<li>Template ID will be automatically generated after saving your template, this is simply a system genereated unique id</li>
+<li>Template Code should be something you can use to identify your template on a list of templates</li>
+<li>You can use the Template Description to add additional information about the template</li>
+<li>The Units pull down is used to define what measurement scale you're going to be using for the template. This should probably match the unit of measurement used on the template description provided by the product vendor.</li>
+<li>The measurements can be found on the vendor product packaging or website.</li>
+<li>A profile is a set of “adjustments” applied to a given template just prior to printing which compensates for anomalies unique and peculiar to a given printer (to which the profile is assigned).
+<ul><li>Before picking a profile try printing some sample cards so that you can easily define a profile that is right for your printer/template combination.</li>
+<li>After finding any anomolies in the printed document, create a profile and assign it to the template.</li></ul></li></ul>
+
+<p>After saving, your templates will appear on the 'Manage Templates' page.</p>
+
+<!-- TMPL_INCLUDE name="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/home.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/home.tmpl
new file mode 100644
index 0000000000..14ba2e702e
--- /dev/null
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/home.tmpl
@@ -0,0 +1,17 @@
+<!-- TMPL_INCLUDE NAME="help-top.inc" -->
+
+<h1>Home</h1>
+
+<p>The Patron Card Creator allow you to use layouts and templates which you design to print a nearly unlimited variety of patron cards including barcodes. Here are some of the features of the Patron Card Creator module:</p>
+ <ul>
+     <li>Customize patron card layouts</li>
+     <li>Design custom card templates for printed patron cards</li>
+     <li>Build and manage batches of patron cards</li>
+     <li>Export single or multiple batches</li>
+     <li>Export single or multiple patron cards from within a batch</li>
+     <li>Export card data as a PDF readable by any standard PDF reader, making patron cards printable directly on a printer</li>
+ </ul>
+ <p>At the top of each screen within the Patron Card Creator, you will see a toolbar allowing quick access to relevant functions. The menu to the left of each screen also allows easy access to the different sections of the Patron Card Creator. The breadcrumb trail near the top of each screen will give specific indication as to where you are within the Patron Card Creator module and allow quick navigation to previously traversed sections. And finally, you can find more detailed information on each section of the Patron Card Creator by clicking the online help link at the upper left-hand corner of every page.</p>
+ <p>The developers of the Patron Card Creator module hope you will find this an extremely useful tool. You are encouraged to submit any enhancement requests as well as any bugs via <a href="http://bugs.koha.org/">Koha Project Bugzilla</a>.</p>
+
+<!-- TMPL_INCLUDE name="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/manage.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/manage.tmpl
new file mode 100644
index 0000000000..923551bb79
--- /dev/null
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/patroncards/manage.tmpl
@@ -0,0 +1,29 @@
+<!-- TMPL_INCLUDE NAME="help-top.inc" -->
+
+<h1>Templates</h1>
+
+<p>A template is the label/card stock you are using. This might be Avery 5160 for address labels, Gaylord 47-284 for spine labels or Avery 28371 for your patron cards, just to give a couple of examples. These labels will include all of the information you will need for setting up a Koha, this information may be on the packaging, and if not it can usually be found on the vendor's website.</p>
+
+<h1>Profiles</h1>
+
+<p>A profile is a set of “adjustments” applied to a given template just prior to printing which compensates for anomalies unique and peculiar to a given printer (to which the profile is assigned). This means if you set a template up and then print a sample set of data and find that the items are not all aligned the same on each label, you need to set up a profile for each printer to make up for the differences in printing styles, such as the shifting of text to the left, right, top or bottom.</p>
+
+<p>If your cards are printing just the way you want, you will not need a profile.</p>
+
+<h1>Layouts</h1>
+
+<p>A layout defines the text and images that will be printed on to the card and where it will appear.</p>
+
+<h1>Batches</h1>
+
+<p>A batch is a collection of patrons for whom you want to generate cards.</p>
+
+<h1>Manage Images</h1>
+
+<p>Images uploaded using this tool will appear on the menu when creating patron card layouts. You are limited in how many images you can upload (not counting patron images) by the ImageLimit  system preference.</p>
+
+<p style="color: #990000">IMPORTANT: Images must be under 500k in size.</p>
+
+<p style="background-color: #ffe599">TIP: Pictures uploaded with this tool should be at least 300dpi which is the minimum quality for a printable image.</p>
+
+<!-- TMPL_INCLUDE name="help-bottom.inc" -->
\ No newline at end of file
-- 
2.39.5