Add file for 1.6 branch.
[Evergreen-DocBook.git] / admin / admin-survey.xml
diff --git a/admin/admin-survey.xml b/admin/admin-survey.xml
new file mode 100644 (file)
index 0000000..b84e95c
--- /dev/null
@@ -0,0 +1,194 @@
+<?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
+       <indexterm><primary>surveys</primary></indexterm>\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