Add staffclient docs to 2.1 branch sans staff client customization. Reviewed by Kathy...

diff --git a/media/staffclient-1.png b/media/staffclient-1.png
new file mode 100755 (executable)
index 0000000..3199d38
Binary files /dev/null and b/media/staffclient-1.png differ

diff --git a/media/staffclient-2.png b/media/staffclient-2.png
new file mode 100755 (executable)
index 0000000..98d168e
Binary files /dev/null and b/media/staffclient-2.png differ

diff --git a/media/staffclient-3.png b/media/staffclient-3.png
new file mode 100755 (executable)
index 0000000..f2d695d
Binary files /dev/null and b/media/staffclient-3.png differ

diff --git a/media/staffclient-4.png b/media/staffclient-4.png
new file mode 100755 (executable)
index 0000000..108afa9
Binary files /dev/null and b/media/staffclient-4.png differ

diff --git a/media/staffclient-5.png b/media/staffclient-5.png
new file mode 100755 (executable)
index 0000000..9451695
Binary files /dev/null and b/media/staffclient-5.png differ

diff --git a/media/staffclient-6.png b/media/staffclient-6.png
new file mode 100755 (executable)
index 0000000..8348e63
Binary files /dev/null and b/media/staffclient-6.png differ

diff --git a/media/staffclient-6a.png b/media/staffclient-6a.png
new file mode 100755 (executable)
index 0000000..02f6cef
Binary files /dev/null and b/media/staffclient-6a.png differ

diff --git a/media/staffclient-6b.png b/media/staffclient-6b.png
new file mode 100755 (executable)
index 0000000..f9ce683
Binary files /dev/null and b/media/staffclient-6b.png differ

diff --git a/media/staffclient-7.png b/media/staffclient-7.png
new file mode 100755 (executable)
index 0000000..4492a80
Binary files /dev/null and b/media/staffclient-7.png differ

diff --git a/media/staffclient-7a.png b/media/staffclient-7a.png
new file mode 100755 (executable)
index 0000000..ddc7e97
Binary files /dev/null and b/media/staffclient-7a.png differ

diff --git a/media/staffclient-8.png b/media/staffclient-8.png
new file mode 100755 (executable)
index 0000000..91154f0
Binary files /dev/null and b/media/staffclient-8.png differ

diff --git a/media/staffclient-9.png b/media/staffclient-9.png
new file mode 100755 (executable)
index 0000000..ecec7d8
Binary files /dev/null and b/media/staffclient-9.png differ

diff --git a/root.xml b/root.xml
index 5ad0984..4a73c75 100755 (executable)
--- a/root.xml
+++ b/root.xml
@@ -73,6 +73,7 @@
                        staff and catalogers among others. Some of these procedures should only be performed by Local System Administrators, but most of these sections will give \r
                        all staff a better understanding of the Evergreen system and its features.</para>\r
                </partintro>\r
+               <xi:include href="stafftasks/staffclient.xml"/>\r
        <xi:include href="stafftasks/circulation.xml"/>\r
        <!--    <xi:include href="stafftasks/acquisitions.xml"/>\r
                <xi:include href="stafftasks/alternate_serial_control.xml"/>-->\r

diff --git a/stafftasks/staffclient.xml b/stafftasks/staffclient.xml
new file mode 100644 (file)
index 0000000..2f1deb9
--- /dev/null
+++ b/stafftasks/staffclient.xml
@@ -0,0 +1,469 @@
+<?xml version="1.0" encoding="utf-8"?>\r
+<chapter xml:id="usingstaffclient" 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
+\r
+      <title>Using the Staff Client</title>\r
+\r
+   </info>\r
+\r
+   <section>\r
+      <info>\r
+         <title>Logging in to Evergreen</title><indexterm><primary>staff client</primary><secondary>logging into</secondary></indexterm>\r
+      </info>\r
+\r
+      <para>To log in you must first install the Evergreen Staff Client, available for download from\r
+         the Evergreen site at <link\r
+            xlink:href="http://downloads.open-ils.org/"\r
+            >http://downloads.open-ils.org/</link>.</para>\r
+\r
+      <para>Each staff member can have their own username and password, or generic logins can be\r
+         used.</para>\r
+      <para>\r
+\r
+\r
+\r
+         <mediaobject xml:id="staffclient-login">\r
+            <alt>screenshot of staff client login</alt>\r
+            <imageobject>\r
+               <imagedata scalefit="0" fileref="../media/staffclient-1.png"/>\r
+            </imageobject>\r
+\r
+         </mediaobject>\r
+      </para>\r
+\r
+\r
+\r
+\r
+      <para>\r
+         <inlinemediaobject>\r
+            <imageobject>\r
+               <imagedata scalefit="0" fileref="../media/1.png"/>\r
+            </imageobject>\r
+         </inlinemediaobject> Enter <guilabel>Username</guilabel> and <guilabel>Password</guilabel>\r
+         for your staff account, then click <guibutton>Login</guibutton>. Under normal circumstances\r
+         this is all that is required to login. </para>\r
+\r
+\r
+      <para>\r
+         <inlinemediaobject>\r
+            <imageobject>\r
+               <imagedata scalefit="0" fileref="../media/2.png"/>\r
+            </imageobject>\r
+         </inlinemediaobject> If the staff client can connect to Evergreen both\r
+            <guilabel>Status</guilabel> and <guilabel>Version</guilabel> display a green\r
+            <emphasis>200:OK</emphasis> message. If not, ensure the hostname is\r
+            correctly entered and click <guibutton>Re-Test\r
+            Server</guibutton>. If the error message persists make sure your are connected to the\r
+         internet.</para>\r
+\r
+\r
+      <para>\r
+         <inlinemediaobject>\r
+            <imageobject>\r
+               <imagedata scalefit="0" fileref="../media/3.png"/>\r
+            </imageobject>\r
+         </inlinemediaobject>\r
+         <guilabel>Locale</guilabel> sets the language preferences for the staff client.</para>\r
+\r
+      <para>\r
+         <inlinemediaobject>\r
+            <imageobject>\r
+               <imagedata  scalefit="0" fileref="../media/4.png"/>\r
+            </imageobject>\r
+         </inlinemediaobject>\r
+         <guilabel>Workstation</guilabel> identifies your physical computer location. Workstation registration is done by a Local System\r
+         Administrator when staff clients are first installed. </para>\r
+\r
+      <para>\r
+         <inlinemediaobject>\r
+            <imageobject>\r
+               <imagedata scalefit="0" fileref="../media/5.png"/>\r
+            </imageobject>\r
+         </inlinemediaobject> If your connection to Evergreen is lost during open hours, click\r
+            <guibutton>Standalone Interface</guibutton> to continue with check out and patron\r
+         registration functions until the connection is restored. </para>\r
+\r
+      <para>\r
+         <inlinemediaobject>\r
+            <imageobject>\r
+               <imagedata scalefit="0" fileref="../media/6.png"/>\r
+            </imageobject>\r
+         </inlinemediaobject>\r
+         <guilabel>Debug Options</guilabel> are for advanced troubleshooting and can be ignored in\r
+         normal use. </para>\r
+\r
+      <para>\r
+         <inlinemediaobject>\r
+            <imageobject>\r
+               <imagedata scalefit="0" fileref="../media/7.png"/>\r
+            </imageobject>\r
+         </inlinemediaobject> Click <guibutton>Clear Cache</guibutton> to remove the staff client's\r
+         locally cached files. This may be required to see recent changes to administrative settings.</para>\r
+\r
+\r
+\r
+\r
+   </section>\r
+   <section xml:id="staffclient-navigating" >\r
+      <info>\r
+         <title>Navigation</title><indexterm><primary>staff client</primary><secondary>navigating</secondary></indexterm>\r
+      </info>\r
+\r
+      <simplesect>\r
+         <info>\r
+            <title>Tabs</title>\r
+         </info>\r
+         <para><application>Evergreen</application> uses tabs to display functions. Tabs allow all\r
+            software functionality to be open in one window. You can have up to 9 tabs open at once\r
+            and you can have more than one tab of a single function open at the same time. You\r
+            simply move through the tabs to perform your work.</para>\r
+\r
+         <itemizedlist>\r
+            <title>Keyboard shortcuts for working with tabs:</title>\r
+            <listitem>\r
+               <para><keycombo>\r
+                     <keycap>Ctrl</keycap>\r
+                     <keycap>T</keycap>\r
+                  </keycombo> new tab</para>\r
+            </listitem>\r
+            <listitem>\r
+               <para><keycombo>\r
+                     <keycap>Ctrl</keycap>\r
+                     <keycap>W</keycap>\r
+                  </keycombo>   close tab</para>\r
+            </listitem>\r
+            <listitem>\r
+               <para><keycombo>\r
+                     <keycap>Ctrl</keycap>\r
+                     <keycap>Shift</keycap>\r
+                     <keycap>W</keycap>\r
+                  </keycombo>   close all tabs</para>\r
+            </listitem>\r
+            <listitem>\r
+               <para><keycombo>\r
+                     <keycap>Ctrl</keycap>\r
+                     <keycap>Tab</keycap>\r
+                  </keycombo>   tabs forward through open tabs</para>\r
+            </listitem>\r
+            <listitem>\r
+               <para><keycombo>\r
+                     <keycap>Ctrl</keycap>\r
+                     <keycap>Shift</keycap>\r
+                     <keycap>Tab</keycap>\r
+                  </keycombo>   tabs backward through open tabs</para>\r
+            </listitem>\r
+         </itemizedlist>\r
+         <informalfigure>\r
+            <para>In the example below, the <guilabel>MARC Template</guilabel> tab is active. Click\r
+               on any open tab to bring that screen to the front. You can also use <keycombo>\r
+                  <keycap>Ctrl</keycap>\r
+                  <keycap>Tab</keycap>\r
+               </keycombo> to move to the required tab</para>\r
+\r
+            <para><mediaobject>\r
+               <alt>staff client tabs</alt>\r
+               <imageobject>\r
+                  <imagedata scalefit="0" fileref="../media/staffclient-2.png"/>\r
+               </imageobject>\r
+            </mediaobject></para>\r
+         </informalfigure>\r
+         <informalfigure>\r
+            <para>Now the <guilabel>Check Out</guilabel> tab is the active screen.</para>\r
+            <para><mediaobject>\r
+               <alt>staff client tabs</alt>\r
+               <imageobject>\r
+                  <imagedata scalefit="0" fileref="../media/staffclient-3.png"/>\r
+               </imageobject>\r
+            </mediaobject></para>\r
+         </informalfigure>\r
+         <para>Once you are in the selected tab, you can use the drop down menus or keyboard\r
+            shortcuts to perform required functions. Menu functions and corresponding keyboard\r
+            shortcuts will be demonstrated throughout this manual.</para>\r
+      </simplesect>\r
+      <simplesect>\r
+         <info>\r
+            <title>Keyboard Shortcuts</title><indexterm><primary>staff client</primary><secondary>keyboard shortcuts</secondary></indexterm>\r
+         </info>\r
+         <para>Most menu items have keyboard shorcuts that can greatly increase efficiency. Below is\r
+            a selected list of commonly used shortcut keys:</para>\r
+         <informaltable>\r
+            <?dbfo keep-together="always" ?>\r
+            <tgroup cols="2" align="left" colsep="1" rowsep="1">\r
+               <colspec colnum="1" colname="key" colwidth="1.0*"/>\r
+               <colspec colnum="2" colname="function" colwidth="3.0*"/>\r
+               <thead>\r
+                  <row>\r
+                     <entry>Key</entry>\r
+                     <entry>Function</entry>\r
+                  </row>\r
+               </thead>\r
+               <tbody>\r
+                  <row>\r
+                     <entry>\r
+                        <keycap>F1</keycap>\r
+                     </entry>\r
+                     <entry>Checkout, or retrieve patron record by barcode</entry>\r
+                  </row>\r
+                  <row>\r
+                     <entry>\r
+                        <keycap>F2</keycap>\r
+                     </entry>\r
+                     <entry>Checkin</entry>\r
+                  </row>\r
+                  <row>\r
+                     <entry>\r
+                        <keycap>F3</keycap>\r
+                     </entry>\r
+                     <entry>Catalogue search</entry>\r
+                  </row>\r
+\r
+                  <row>\r
+                     <entry>\r
+                        <keycap>F4</keycap>\r
+                     </entry>\r
+                     <entry>Patron search</entry>\r
+                  </row>\r
+\r
+                  <row>\r
+                     <entry>\r
+                        <keycap>F5</keycap>\r
+                     </entry>\r
+                     <entry>Retrieve copy by barcode</entry>\r
+                  </row>\r
+\r
+                  <row>\r
+                     <entry>\r
+                        <keycap>F6</keycap>\r
+                     </entry>\r
+                     <entry>Record in house use</entry>\r
+                  </row>\r
+\r
+                  <row>\r
+                     <entry>\r
+                        <keycap>F8</keycap>\r
+                     </entry>\r
+                     <entry>Retreive last patron</entry>\r
+                  </row>\r
+\r
+                  <row>\r
+                     <entry>\r
+                        <keycap>F9</keycap>\r
+                     </entry>\r
+                     <entry>Re-print the last receipt</entry>\r
+                  </row>\r
+\r
+                  <row>\r
+                     <entry>\r
+                        <keycombo>\r
+                           <keycap>Shift</keycap>\r
+                           <keycap>F1</keycap>\r
+                        </keycombo>\r
+                     </entry>\r
+                     <entry>Register new patron</entry>\r
+                  </row>\r
+\r
+                  <row>\r
+                     <entry>\r
+                        <keycombo>\r
+                           <keycap>Shift</keycap>\r
+                           <keycap>F2</keycap>\r
+                        </keycombo>\r
+                     </entry>\r
+                     <entry>Capture holds</entry>\r
+                  </row>\r
+\r
+                  <row>\r
+                     <entry>\r
+                        <keycombo>\r
+                           <keycap>Shift</keycap>\r
+                           <keycap>F3</keycap>\r
+                        </keycombo>\r
+                     </entry>\r
+                     <entry>Retrieve record by TCN</entry>\r
+                  </row>\r
+\r
+                  <row>\r
+                     <entry>\r
+                        <keycombo>\r
+                           <keycap>Shift</keycap>\r
+                           <keycap>F8</keycap>\r
+                        </keycombo>\r
+                     </entry>\r
+                     <entry>Retreive last patron</entry>\r
+                  </row>\r
+\r
+                  <row>\r
+                     <entry>\r
+                        <keycombo>\r
+                           <keycap>Ctrl</keycap>\r
+                           <keycap>T</keycap>\r
+                        </keycombo>\r
+                     </entry>\r
+                     <entry>Open new tab</entry>\r
+                  </row>\r
+\r
+                  <row>\r
+                     <entry>\r
+                        <keycombo>\r
+                           <keycap>Ctrl</keycap>\r
+                           <keycap>W</keycap>\r
+                        </keycombo>\r
+                     </entry>\r
+                     <entry>Close current tab</entry>\r
+                  </row>\r
+\r
+                  <row>\r
+                     <entry>\r
+                        <keycombo>\r
+                           <keycap>Ctrl</keycap>\r
+                           <keycap>Tab</keycap>\r
+                        </keycombo>\r
+                     </entry>\r
+                     <entry>Move forward through tabs</entry>\r
+                  </row>\r
+\r
+                  <row>\r
+                     <entry>\r
+                        <keycombo>\r
+                           <keycap>Ctrl</keycap>\r
+                           <keycap>Shift</keycap>\r
+                           <keycap>Tab</keycap>\r
+                        </keycombo>\r
+                     </entry>\r
+                     <entry>Move back through tabs</entry>\r
+                  </row>\r
+                  <row>\r
+                     <entry>\r
+                        <keycombo>\r
+                           <keycap>Ctrl</keycap>\r
+                           <keycap>C</keycap>\r
+                        </keycombo>\r
+                     </entry>\r
+                     <entry>Copy</entry>\r
+                  </row>\r
+\r
+                  <row>\r
+                     <entry>\r
+                        <keycombo>\r
+                           <keycap>Ctrl</keycap>\r
+                           <keycap>V</keycap>\r
+                        </keycombo>\r
+                     </entry>\r
+                     <entry>Paste</entry>\r
+                  </row>\r
+               </tbody>\r
+            </tgroup>\r
+         </informaltable>\r
+      </simplesect>\r
+      <simplesect>\r
+         <info>\r
+            <title>Copy/Paste</title><indexterm><primary>staff client</primary><secondary>copy/paste</secondary></indexterm>\r
+         </info>\r
+\r
+         <para>There are several methods of copying and pasting text in Evergreen, depending on\r
+            where you are in the staff client and the type of information you are copying</para>\r
+         <orderedlist>\r
+            <listitem>\r
+               <informalfigure>\r
+                  <formalpara>\r
+                     <title>Underlined blue text</title>\r
+                     <para>Clicking on any of the blue links in the\r
+                           <application>Evergreen</application> client copies the data to the\r
+                        computer clipboard (left and right click work the same way for these links).\r
+                        To paste into another location, use <keycombo>\r
+                           <keycap>Ctrl</keycap>\r
+                           <keycap>V</keycap>\r
+                        </keycombo>.</para>\r
+                  </formalpara>\r
+                  <para>\r
+                     <mediaobject>\r
+                        <alt>copy/paste methods</alt>\r
+                        <imageobject>\r
+                           <imagedata scalefit="0" fileref="../media/staffclient-5.png"/>\r
+                        </imageobject>\r
+\r
+                     </mediaobject>\r
+                     <mediaobject>\r
+                        <alt>copy/paste methods </alt>\r
+                        <imageobject>\r
+                           <imagedata scalefit="0" fileref="../media/staffclient-6.png"/>\r
+                        </imageobject>\r
+                     </mediaobject>\r
+                  </para>\r
+               </informalfigure>\r
+            </listitem>\r
+\r
+            <listitem>\r
+               <informalfigure>\r
+                  <formalpara>\r
+                     <title>Text displayed in tables</title>\r
+                     <para>To copy information from a staff client table, first select the desired\r
+                        row then right-click and choose <guimenuitem>Copy to\r
+                        Clipboard</guimenuitem>; alternatively select <menuchoice>\r
+                           <guimenu>Actions for Selected Items</guimenu>\r
+                           <guimenuitem>Copy to Clipboard</guimenuitem>\r
+                        </menuchoice>.</para>\r
+\r
+                  </formalpara>\r
+\r
+                 <para> <mediaobject>\r
+                     <alt>copy/paste methods</alt>\r
+                     <imageobject>\r
+                        <imagedata scalefit="0" fileref="../media/staffclient-6a.png"/>\r
+                     </imageobject>\r
+\r
+                  </mediaobject></para>\r
+\r
+               </informalfigure>\r
+\r
+               <mediaobject>\r
+                  <alt>copy/paste methods</alt>\r
+                  <imageobject>\r
+                     <imagedata scalefit="0" fileref="../media/staffclient-6b.png"/>\r
+                  </imageobject>\r
+\r
+               </mediaobject>\r
+\r
+               <informalfigure>\r
+                  <para>Next click the desired information in the popup to copy it to the\r
+                     clipboard</para>\r
+                  <para>\r
+                     <mediaobject>\r
+                        <alt>copy/paste methods</alt>\r
+                        <imageobject>\r
+                           <imagedata scalefit="0" fileref="../media/staffclient-6c.png"/>\r
+                        </imageobject>\r
+\r
+                     </mediaobject>\r
+                  </para>\r
+               </informalfigure>\r
+            </listitem>\r
+\r
+            <listitem>\r
+               <informalfigure>\r
+                  <formalpara>\r
+                     <title>Text from catalogue search results</title>\r
+                     <para>There is no right-click menu for copying data from staff client search\r
+                        results. To copy the ISBN in the example below, highlight it and click <keycombo>\r
+                           <keycap>Ctrl</keycap>\r
+                           <keycap>C</keycap>\r
+                        </keycombo>. To paste into another location use <keycombo>\r
+                           <keycap>Ctrl</keycap>\r
+                           <keycap>V</keycap>\r
+                        </keycombo>.</para>\r
+                  </formalpara>\r
+                  <para><mediaobject>\r
+                     <alt>copy/paste methods</alt>\r
+                     <imageobject>\r
+                        <imagedata scalefit="0" fileref="../media/staffclient-6d.png"/>\r
+                     </imageobject>\r
+\r
+                  </mediaobject></para>\r
+               </informalfigure>\r
+\r
+            </listitem>\r
+         </orderedlist>\r
+      </simplesect>\r
+   </section>\r
+</chapter>\r