Add file for 1.6 branch.
[Evergreen-DocBook.git] / admin / admin-receipt.xml
diff --git a/admin/admin-receipt.xml b/admin/admin-receipt.xml
new file mode 100644 (file)
index 0000000..4c4b843
--- /dev/null
@@ -0,0 +1,336 @@
+<?xml version="1.0" encoding="utf-8"?>\r
+<section xml:id="lsa-receipt" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
+   xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
+\r
+   <info>\r
+      <title>Receipt Template Editor</title>\r
+       <indexterm><primary>receipt template editor</primary></indexterm>\r
+   </info>\r
+\r
+   <para>This tip sheet will show you how to customize your receipts.  This example will walk you\r
+      through how to customize the receipt that is printed on checkout.  </para>\r
+\r
+   <para>Receipt templates are saved on the workstation, but it is possible to export the templates\r
+      to import to other workstations.  </para>\r
+\r
+<procedure>\r
+\r
+   <step>\r
+               <para>Select <menuchoice><guimenu>Admin (-)</guimenu><guisubmenu>Local Administration</guisubmenu><guimenuitem>Receipt Template Editor</guimenuitem></menuchoice>.  </para>\r
+   </step>\r
+\r
+\r
+   <step>\r
+     \r
+         <para>Select the <guimenuitem>checkout</guimenuitem> template from the dropdown menu.\r
+             </para>\r
+   </step>\r
+\r
+\r
+   <step>\r
+         <para>You can edit the <guilabel>Header</guilabel>, <guilabel>Line\r
+               Item</guilabel> or <guilabel>Footer</guilabel> on the right hand side.  </para>  \r
+   </step>\r
+\r
+  \r
+        <step><para>In the upper right hand corner you can see the available macros by clicking on the\r
+               <guibutton>Macros</guibutton> button.  A macro prints a real value from the database.\r
+            The macros that are available\r
+            vary slightly between types of receipt templates (i.e. bills, holds, items). </para>\r
+    </step>\r
+\r
+   \r
+       <step><informalfigure>  <para>Here are the available macros for an item receipt, like a checkout receipt.  </para>\r
+       <para>\r
+      <mediaobject>\r
+         <alt>screenshot of staff client</alt>\r
+         <imageobject role="html">\r
+            <imagedata scalefit="0" fileref="../media/receipt-5.jpg"/>\r
+         </imageobject>\r
+         <imageobject role="fo">\r
+            <imagedata scale="80" fileref="../media/receipt-5.jpg"/>\r
+         </imageobject>\r
+      </mediaobject>\r
+   </para></informalfigure></step>\r
+   \r
+  </procedure>\r
+   \r
+   <simplesect>\r
+      <info>\r
+         <title>Adding an image</title>\r
+      </info>\r
+\r
+<procedure>    \r
+           <step><para>You can edit the <guilabel>Header</guilabel> to have an image.  This is the default checkout <guilabel>Header</guilabel>.\r
+                </para>\r
+     </step>\r
+\r
+     \r
+            <step><para>Using HTML tags you can insert a link to an image that exists on the web.  The\r
+               link will end in <emphasis>.jpg</emphasis> or possibly <emphasis>.gif</emphasis>.  To\r
+               get this link you can right click on the image and choose <guimenuitem>Copy Image\r
+                  Location</guimenuitem> (<application>Firefox</application>).  </para>\r
+        \r
+<para>If you are using <application>Internet Explorer</application> right click and select <guimenuitem>Save Picture\r
+            As…</guimenuitem>\r
+      </para>\r
+\r
+  </step>\r
+\r
+           <step> <para>Enter the URL of the\r
+               link for the image that you just copied off a website. </para>\r
+         \r
+<para>By clicking outside the <guilabel>Header</guilabel> box the <guilabel>Preview</guilabel> will update to reflect the edit you just\r
+         made.  </para>\r
+\r
+      </step>\r
+  \r
+           <step><para>If the image runs into the text, add a &lt;br/&gt; after the\r
+               image to add a line break.</para>\r
+     </step></procedure>   \r
+      <tip><para>You may use most HTML tags.  See <link xlink:title="http://www.w3schools.com/html/" xlink:href="http://www.w3schools.com/html/">http://www.w3schools.com/html/</link> for more information on HTML tags.  </para></tip>\r
+   </simplesect>\r
+   <simplesect>\r
+      <info>\r
+         <title>Line Item</title>\r
+      </info>\r
+\r
+          <informalfigure>  <para>This is what the default <guilabel>Line Item</guilabel> looks like:</para>\r
+        \r
+      <para>\r
+         <mediaobject>\r
+            <alt>screenshot of staff client</alt>\r
+            <imageobject role="html">\r
+               <imagedata scalefit="1" fileref="../media/receipt-11.jpg"/>\r
+            </imageobject>\r
+            <imageobject role="fo">\r
+               <imagedata scalefit="1" width="100%" contentdepth="100%"\r
+                  fileref="../media/receipt-11.jpg"/>\r
+            </imageobject>\r
+         </mediaobject>\r
+      </para></informalfigure>\r
+\r
+      <para>In this example, the macro %barcode% prints the item barcodes of the books that were\r
+         checked out.  The macro %due_date% prints the due date for each item that was checked out.\r
+          </para>\r
+\r
+      <para>In this example, we will not make any changes to the <guilabel>Line Item</guilabel></para>\r
+\r
+      \r
+     <note> <para>The due date can only be printed in the YYYY-MM-DD format. </para></note>\r
+\r
+   </simplesect>\r
+   <simplesect>\r
+      <info>\r
+         <title>Editing the footer</title>\r
+      </info>\r
+\r
+     \r
+<procedure>          <step><informalfigure>  <para>This is what the default <guilabel>Footer</guilabel> looks like:</para>\r
+        \r
+      <para>\r
+         <mediaobject>\r
+            <alt>screenshot of staff client</alt>\r
+            <imageobject role="html">\r
+               <imagedata scalefit="1" fileref="../media/receipt-12.jpg"/>\r
+            </imageobject>\r
+            <imageobject role="fo">\r
+               <imagedata scalefit="1" width="100%" contentdepth="100%"\r
+                  fileref="../media/receipt-12.jpg"/>\r
+            </imageobject>\r
+         </mediaobject>\r
+      </para></informalfigure></step>\r
+\r
+     \r
+            <step><informalfigure><para>Remove the “You were helped by %STAFF_FIRSTNAME% &lt;br/&gt;”.  As many\r
+               libraries use a generic circulation login on the circulation desk, the “You were\r
+               helped by…” note isn’t meaningful.  </para>\r
+        \r
+      <para>\r
+         <mediaobject>\r
+            <alt>screenshot of staff client</alt>\r
+            <imageobject role="html">\r
+               <imagedata scalefit="1" fileref="../media/receipt-13.jpg"/>\r
+            </imageobject>\r
+            <imageobject role="fo">\r
+               <imagedata scalefit="1" width="100%" contentdepth="100%"\r
+                  fileref="../media/receipt-13.jpg"/>\r
+            </imageobject>\r
+         </mediaobject>\r
+      </para></informalfigure></step>\r
+\r
+          <step><informalfigure>  <para>Once you have the checkout template how you want it, click <guibutton>Save Locally</guibutton> to save\r
+               the template to your computer.  </para>\r
+       \r
+\r
+      <para>\r
+         <mediaobject>\r
+            <alt>screenshot of staff client</alt>\r
+            <imageobject>\r
+               <imagedata scalefit="0" fileref="../media/receipt-15.jpg"/>\r
+            </imageobject>\r
+            \r
+         </mediaobject>\r
+      </para></informalfigure></step>\r
+\r
+     \r
+            <step><informalfigure><para>Click OK.</para>\r
+       \r
+\r
+      <para>\r
+         <mediaobject>\r
+            <alt>screenshot of staff client</alt>\r
+            <imageobject role="html">\r
+               <imagedata scalefit="0" fileref="../media/receipt-16.png"/>\r
+            </imageobject>\r
+            <imageobject role="fo">\r
+               <imagedata scale="80" fileref="../media/receipt-16.png"/>\r
+            </imageobject>\r
+         </mediaobject>\r
+      </para></informalfigure></step></procedure>\r
+      \r
+     <tip> <para>The footer is a good place to advertise upcoming library programs or events.  </para></tip>\r
+      \r
+   </simplesect>\r
+   <simplesect>\r
+      <info>\r
+         <title>Exporting templates</title>\r
+      </info>\r
+\r
+      <para>As you can only save a template on to the computer you are working on you will need to\r
+         export the template if you have more than one computer that prints out receipts (i.e., more\r
+         than one computer on the circulation desk, or another computer in the workroom that you use\r
+         to checkin items or capture holds with).</para>\r
+\r
+      \r
+<procedure>           <step><informalfigure> <para>Click on <guilabel>Export</guilabel>.  </para>\r
+        \r
+\r
+      <para>\r
+         <mediaobject>\r
+            <alt>screenshot of staff client</alt>\r
+            <imageobject role="html">\r
+               <imagedata scalefit="0" fileref="../media/receipt-17.jpg"/>\r
+            </imageobject>\r
+            <imageobject role="fo">\r
+               <imagedata scale="80" fileref="../media/receipt-17.jpg"/>\r
+            </imageobject>\r
+         </mediaobject>\r
+      </para>\r
+</informalfigure></step>\r
+     \r
+     \r
+     \r
+            <step><informalfigure><para>Select the location to save the template to, name the template, and click <guibutton>Save</guibutton>.\r
+                </para>\r
+              <para>\r
+         <mediaobject>\r
+            <alt>screenshot of staff client</alt>\r
+            <imageobject role="html">\r
+               <imagedata scalefit="0" fileref="../media/receipt-18.jpg"/>\r
+            </imageobject>\r
+            <imageobject role="fo">\r
+               <imagedata scale="80" fileref="../media/receipt-18.jpg"/>\r
+            </imageobject>\r
+         </mediaobject>\r
+      </para>\r
+</informalfigure></step>\r
+      \r
+      \r
+      \r
+            <step><informalfigure><para>Click <guibutton>OK</guibutton>.  </para>\r
+               <para>\r
+         <mediaobject>\r
+            <alt>screenshot of staff client</alt>\r
+            <imageobject role="html">\r
+               <imagedata scalefit="0" fileref="../media/receipt-19.jpg"/>\r
+            </imageobject>\r
+            <imageobject role="fo">\r
+               <imagedata scale="80" fileref="../media/receipt-19.jpg"/>\r
+            </imageobject>\r
+         </mediaobject>\r
+      </para></informalfigure></step></procedure>\r
+\r
+   </simplesect>\r
+   <simplesect>\r
+      <info>\r
+         <title>Importing Templates</title>\r
+      </info>\r
+<procedure>\r
+     \r
+           <step><informalfigure> <para>Click <guibutton>Import</guibutton>.</para>\r
+        \r
+      <para>\r
+         <mediaobject>\r
+            <alt>screenshot of staff client</alt>\r
+            <imageobject role="html">\r
+               <imagedata scalefit="0" fileref="../media/receipt-20.jpg"/>\r
+            </imageobject>\r
+            <imageobject role="fo">\r
+               <imagedata scale="80" fileref="../media/receipt-20.jpg"/>\r
+            </imageobject>\r
+         </mediaobject>\r
+      </para></informalfigure></step>\r
+\r
+      \r
+            <step><informalfigure><para>Navigate to and select the template that you want to import.  Click <guibutton>Open</guibutton>. </para>\r
+        \r
+      <para>\r
+         <mediaobject>\r
+            <alt>screenshot of staff client</alt>\r
+            <imageobject role="html">\r
+               <imagedata scalefit="0" fileref="../media/receipt-21.jpg"/>\r
+            </imageobject>\r
+            <imageobject role="fo">\r
+               <imagedata scale="80" fileref="../media/receipt-21.jpg"/>\r
+            </imageobject>\r
+         </mediaobject>\r
+      </para></informalfigure></step>\r
+\r
+      \r
+         <step><informalfigure>   <para>Click <guibutton>OK</guibutton>.</para>\r
+        \r
+      <para>\r
+         <mediaobject>\r
+            <alt>screenshot of staff client</alt>\r
+            <imageobject role="html">\r
+               <imagedata scalefit="0" fileref="../media/receipt-22.jpg"/>\r
+            </imageobject>\r
+            <imageobject role="fo">\r
+               <imagedata scale="80" fileref="../media/receipt-22.jpg"/>\r
+            </imageobject>\r
+         </mediaobject>\r
+      </para></informalfigure></step>\r
+\r
+    \r
+    \r
+            <step><informalfigure><para>Click <guibutton>Save Locally</guibutton>.</para>\r
+             <para>\r
+         <mediaobject>\r
+            <alt>screenshot of staff client</alt>\r
+            <imageobject role="html">\r
+               <imagedata scalefit="0" fileref="../media/receipt-23.jpg"/>\r
+            </imageobject>\r
+            <imageobject role="fo">\r
+               <imagedata scale="80" fileref="../media/receipt-23.jpg"/>\r
+            </imageobject>\r
+         </mediaobject>\r
+      </para></informalfigure></step>\r
+\r
+    \r
+            <step><informalfigure><para>Click <guibutton>OK</guibutton>.</para>\r
+        \r
+\r
+      <para>\r
+         <mediaobject>\r
+            <alt>screenshot of staff client</alt>\r
+            <imageobject role="html">\r
+               <imagedata scalefit="0" fileref="../media/receipt-24.jpg"/>\r
+            </imageobject>\r
+            <imageobject role="fo">\r
+               <imagedata scale="80" fileref="../media/receipt-24.jpg"/>\r
+            </imageobject>\r
+         </mediaobject>\r
+      </para></informalfigure></step></procedure>\r
+   </simplesect>\r
+</section>\r