Re-add admin receipt and survey files. They are includes of included chapters.
authorRobert Soulliere <rsoulliere@libdog.mohawkcollege.ca>
Sun, 12 Sep 2010 21:21:22 +0000 (17:21 -0400)
committerRobert Soulliere <rsoulliere@libdog.mohawkcollege.ca>
Sun, 12 Sep 2010 21:21:22 +0000 (17:21 -0400)
1.6/admin/admin-receipt.xml [new file with mode: 0644]
1.6/admin/admin-survey.xml [new file with mode: 0644]

diff --git a/1.6/admin/admin-receipt.xml b/1.6/admin/admin-receipt.xml
new file mode 100644 (file)
index 0000000..50f8b46
--- /dev/null
@@ -0,0 +1,335 @@
+<?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
+   </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
diff --git a/1.6/admin/admin-survey.xml b/1.6/admin/admin-survey.xml
new file mode 100644 (file)
index 0000000..d7309af
--- /dev/null
@@ -0,0 +1,193 @@
+<?xml version="1.0" encoding="utf-8"?>\r
+<section xml:id="lsa-survey" 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
+    <info>\r
+        <title>Surveys</title>\r
+    </info>\r
+    <para>This section illustrates how to create a survey, shows where the survey responses are saved\r
+        in the patron record, and explains how to report on surveys.</para>\r
+\r
+    <para>Survey questions show up on the 6th patron registration screen, or on the 6th patron edit\r
+        screen. Surveys questions can be optional or required. Some examples of survey questions\r
+        might include: <emphasis>Would you use the library if it were open on a Sunday?</emphasis> \r
+            <emphasis>Would you like to be contacted by the library to learn about new\r
+            services?</emphasis>  <emphasis>Do you attend library programs?</emphasis></para>\r
+\r
+    <para>Surveys come up when a patron is first registered. If you would like staff to ask the\r
+        survey questions when the patron’s library card is renewed, you’ll need to make that part of\r
+        local procedure.</para>\r
+\r
+    <para>It is possible to run reports on survey questions. For example, you could find out how\r
+        many people say they would use the library if it were open on a Sunday, or you could get a\r
+        list of patrons who say they would like to receive marketing material from the library.\r
+       </para>\r
+    <procedure>\r
+        <step>\r
+            <informalfigure>\r
+                <para>From the <guimenu>Admin (-)</guimenu> menu, select <menuchoice>\r
+                        <guimenu>Local Administration</guimenu>\r
+                        <guimenuitem>Surveys</guimenuitem>\r
+                    </menuchoice>.</para>\r
+                <para>\r
+                    <mediaobject>\r
+                        <alt>surveys interface</alt>\r
+                        <imageobject>\r
+                            <imagedata scalefit="0" fileref="../media/survey-1.png"/>\r
+                        </imageobject>\r
+\r
+                    </mediaobject>\r
+                </para>\r
+            </informalfigure>\r
+\r
+        </step>\r
+\r
+        <step>\r
+            <informalfigure>\r
+                <para>The <guilabel>Survey List</guilabel> will open. In this example the table is\r
+                    empty because no surveys have been created. Click <guibutton>Add New\r
+                        Survey</guibutton>. </para>\r
+                <para>\r
+                    <mediaobject>\r
+                        <alt>surveys interface</alt>\r
+                        <imageobject>\r
+                            <imagedata width="100%" scalefit="1" fileref="../media/survey-2.png"/>\r
+                        </imageobject>\r
+\r
+                    </mediaobject>\r
+                </para>\r
+            </informalfigure>\r
+\r
+        </step>\r
+\r
+        <step>\r
+            <informalfigure>\r
+                <para>Fill out the <guilabel>New Survey</guilabel> form, then click <guibutton>Save\r
+                        Changes</guibutton>. </para>\r
+                <para>\r
+                    <mediaobject>\r
+                        <alt>surveys interface</alt>\r
+                        <imageobject>\r
+                            <imagedata scalefit="0" fileref="../media/survey-3.png"/>\r
+                        </imageobject>\r
+\r
+                    </mediaobject>\r
+                </para>\r
+            </informalfigure>\r
+            <para>A few tips when creating a new survey:</para>\r
+            <itemizedlist>\r
+                <listitem>\r
+                    <para><guilabel>Start Date</guilabel> must always be in the future. It is not\r
+                        possible to add questions to a survey after the start date.</para>\r
+                </listitem>\r
+                <listitem>\r
+                    <para>Dates should be in YYYY-MM-DD format</para>\r
+                </listitem>\r
+                <listitem>\r
+                    <para><guilabel>OPAC Survey?</guilabel> and <guilabel>Poll Style?</guilabel> are\r
+                        not yet implemented - leave unchecked</para>\r
+                </listitem>\r
+                <listitem>\r
+                    <para>Check <guilabel>Is Required</guilabel> if the survey should be mandatory\r
+                        for all new patrons</para>\r
+                </listitem>\r
+                <listitem>\r
+                    <para>Check <guilabel>Display in User Summary</guilabel> to make survey answers\r
+                        visible from patron records</para>\r
+                </listitem>\r
+            </itemizedlist>\r
+\r
+        </step>\r
+\r
+        <step>\r
+            <informalfigure>\r
+                <para>A summary of your new survey will appear. Type the first survey question in\r
+                    the <guilabel>Question</guilabel> field, then click <guibutton>Save Question\r
+                        &amp; Add Answer</guibutton>. Survey questions are multiple\r
+                    choice.</para>\r
+\r
+                <para>\r
+                    <mediaobject>\r
+                        <alt>surveys interface</alt>\r
+                        <imageobject>\r
+                            <imagedata scalefit="0" fileref="../media/survey-4.png"/>\r
+                        </imageobject>\r
+\r
+                    </mediaobject>\r
+                </para>\r
+            </informalfigure>\r
+\r
+\r
+        </step>\r
+\r
+        <step>\r
+            <informalfigure>\r
+                <para>Enter possible multiple choice answers and click <guibutton>Add\r
+                        Answer</guibutton>. Each question may have as many answers as you\r
+                    like.</para>\r
+                <para>\r
+                    <mediaobject>\r
+                        <alt>surveys interface</alt>\r
+                        <imageobject>\r
+                            <imagedata scalefit="0" fileref="../media/survey-5.png"/>\r
+                        </imageobject>\r
+\r
+                    </mediaobject>\r
+                </para>\r
+            </informalfigure>\r
+\r
+        </step>\r
+\r
+        <step>\r
+          <informalfigure>  <para>Repeat the steps above to add as many questions and answers as you wish. When\r
+                finished click <guibutton>Save</guibutton>, then <guilabel>Go Back</guilabel> to\r
+                return to the survey list.</para>\r
+            <para><mediaobject>\r
+                <alt>surveys interface</alt>\r
+                <imageobject>\r
+                    <imagedata scalefit="0" fileref="../media/survey-6.png"/>\r
+                </imageobject>\r
+                \r
+            </mediaobject></para></informalfigure>\r
+            \r
+        </step>\r
+        <step>\r
+            <informalfigure><para>Your new survey will appear in the <guilabel>Survey List</guilabel> table.  To make further changes click the survey name to open the detailed view.</para>\r
+       \r
+            <para><mediaobject>\r
+                <alt>surveys interface</alt>\r
+                <imageobject>\r
+                    <imagedata width="100%" scalefit="1" fileref="../media/survey-7.png"/>\r
+                </imageobject>\r
+                \r
+            </mediaobject></para></informalfigure>\r
+                \r
+        </step>\r
+    </procedure>\r
+    <informalfigure><para>This is what the survey looks like in the patron registration/edit screen. Note that in\r
+        this example this survey question appears in red and is required as the\r
+            <guilabel>Is Required</guilabel> box was checked when creating the survey.</para>\r
+    \r
+    <para><mediaobject>\r
+        <alt>surveys interface</alt>\r
+        <imageobject>\r
+            <imagedata width="100%" scalefit="1" fileref="../media/survey-8.png"/>\r
+        </imageobject>\r
+        \r
+    </mediaobject></para></informalfigure>\r
+    \r
+    <informalfigure><para>To see a patron’s response to a survey, retrieve the patron record. Click <menuchoice><guimenu>Other</guimenu><guimenuitem>Surveys</guimenuitem></menuchoice> to see the response.</para>\r
+    <para><mediaobject>\r
+        <alt>surveys interface</alt>\r
+        <imageobject>\r
+            <imagedata scalefit="0" fileref="../media/survey-9.png"/>\r
+        </imageobject>\r
+        \r
+    </mediaobject>\r
+       <mediaobject>\r
+            <alt>surveys interface</alt>\r
+            <imageobject>\r
+                <imagedata scalefit="0" fileref="../media/survey-10.png"/>\r
+            </imageobject>\r
+            \r
+        </mediaobject></para></informalfigure>\r
+</section>\r