Adding test file, LocalAdmin.xml
authorkgs <kgs@dcc99617-32d9-48b4-a31d-7c20da2025e4>
Fri, 6 Mar 2009 17:40:21 +0000 (17:40 +0000)
committerkgs <kgs@dcc99617-32d9-48b4-a31d-7c20da2025e4>
Fri, 6 Mar 2009 17:40:21 +0000 (17:40 +0000)
git-svn-id: svn://svn.open-ils.org/ILS/trunk@12441 dcc99617-32d9-48b4-a31d-7c20da2025e4

docs/LocalAdmin.xml [new file with mode: 0644]

diff --git a/docs/LocalAdmin.xml b/docs/LocalAdmin.xml
new file mode 100644 (file)
index 0000000..a315621
--- /dev/null
@@ -0,0 +1,506 @@
+<?xml version="1.0" encoding="UTF-8"?>
+ <chapter xmlns='http://docbook.org/ns/docbook'
+ xml:id="sample_chapter" version="5.0"
+                xmlns:xlink="http://www.w3.org/1999/xlink/"
+         xmlns:xi="http://www.w3.org/2001/XInclude"
+         xmlns:ns6="http://www.w3.org/1999/xlink"
+         xmlns:ns5="http://www.w3.org/2000/svg"
+         xmlns:ns4="http://www.w3.org/1998/Math/MathML"
+         xmlns:ns3="http://www.w3.org/1999/xhtml"
+         xmlns:ns="http://docbook.org/ns/docbook" >            
+<!-- <chapter xmlns='http://docbook.org/ns/docbook'
+ xml:id="sample_chapter" version="5.0"> -->
+<!-- The following declarations have been removed from the <chapter> tag:
+               scratch pad for swapping namespace xmlns declarations in and out to debug warning 
+               ("cannot add @xml.base to node set root element. Relative paths may not work.)
+
+
+-->
+                
+  <title>Administration</title>
+
+  <para>This chapter describes administrative features on the staff
+    client. They include:</para>
+  
+      <orderedlist>
+      <listitem>
+        <para>Operator Change</para>
+      </listitem>
+         
+      <listitem>
+        <para>Offline Transaction Management</para>
+      </listitem>        
+         
+      <listitem>
+        <para>Download Offline Patron List</para>
+               <!--Why is there a download command among editing features? It is generating an Alert in a pop-up window with the following message: "There was a problem with the download. The server returned a status of 404:Not Found"-->
+      </listitem>
+
+      <listitem>
+               <para>Local System Administration</para>
+         
+<!-- Need to find the correct syntax for <link>. Cf. Library Configuration in the Local System Admin.
+         
+        <para><link linkend="local_system_admin">Local System Administration</link></para> 
+-->    
+      </listitem>
+       
+      <listitem>
+        <para>Server Settings</para>
+      </listitem>
+
+      <listitem>
+        <para>User Permission Editor</para>
+      </listitem>
+
+      <listitem>
+        <para>Receipt Template Editor</para>
+      </listitem>
+
+      <listitem>
+        <para>Survey Wizard</para>
+      </listitem>      
+         
+        <listitem>
+        <para>For developers (-)...</para>
+      </listitem>
+    </orderedlist>
+       
+  
+                                                                                                       <!-- Local System Administration -->
+  
+  <section>
+    <title>Local System Administration</title>
+
+    <para>The following administrative functions are available:</para>
+
+    <orderedlist>
+      <listitem>
+        <para>Workstation Configuration</para>
+      </listitem>
+
+      <listitem>
+        <para><link linkend="library_settings">Library
+        Configuration</link></para>
+      </listitem>
+
+      <listitem>
+        <para>Maintenance Reports</para>
+      </listitem>
+    </orderedlist>
+
+    <section xml:id="library_configuration">
+      <title>Library Configuration</title>
+
+      <para>The following configuration editors are available:</para>
+
+      <orderedlist>
+        <listitem>
+          <para>Closed Dates Editor</para>
+        </listitem>
+
+        <listitem>
+          <para>Copy Locations Editor</para>
+        </listitem>
+               
+        <listitem>
+          <para>Library Settings Editor</para>
+               </listitem>             
+               
+        <listitem>
+          <para>Non-cataloged Types Editor</para>
+        </listitem>            
+               
+        <listitem>
+          <para>Statistical Categories Editor</para>
+        </listitem>            
+               
+          </orderedlist>
+
+               
+          <section xml:id="closed_dates">
+               <title>Closed Dates</title>             
+               <para></para>
+          </section>
+
+          <section xml:id="copy_locations">
+               <title>Copy Locations</title>           
+               <para></para>
+          </section>
+
+                                                                                                       <!-- Library Settings -->                 
+          
+          <section xml:id="library_settings">
+               <title>Library Settings</title>
+               
+               
+               
+<!-- Alert on Empty Bib Records -->            
+               
+                       <section xml:id="alert_empty_bib_records">
+                               <title>Alert on Empty Bib Records</title>
+                                       
+                               <section xml:id="alert_empty_bib_records_concept">
+                                 <title>Introduction to Alert on Empty Bib Records</title>
+
+                                 <para>This setting is used to alert staff when the last copy for a record is being deleted. The setting consists of two fields: Context and Value. The Context field refers to either all the branches of a system or a specific branch within a system, with a default of??? The Value field refers to the status of Alert on Empty Bib Records, which can be either True or False, with a default of??? </para>
+                                 
+<!--   "last copy for a record" is coming from the GUI, but should it be "last copy of a record???" 
+-->                              
+                                 
+                               </section>
+
+                               <section xml:id="alert_empty_bib_records_task">
+                                 <title>Changing the status of Alert on Empty Bib Records</title>
+
+                                 <para>To change the status of Alert on Empty Bib Records, do the following:</para>
+
+                                 <orderedlist>
+                                       <listitem>
+                                         <para>On the Local System Administration screen, click the <guilabel>Library Settings Editor</guilabel> link, which opens the Organization Unit Settings screen.</para>
+<!--
+                                         Are we keeping these link and screen names??? Will there be any confusion for library staff who might be expecting a Library Settings screen, rather than the Organization Unit Setting screen, which is more accurate from the developer's point of view??? 
+--> 
+                                       </listitem>
+                                       
+                                       <listitem>
+                                         <para>On the Organization Unit Settings screen, click the <guibutton>Context Location</guibutton> arrow to see more options. In the Context Location box, select a location.</para>
+
+<!--
+                                         Is this the location that will be passed to all the Organization Unit settings??? If so, why is there still a drop-down combo box for Context selection???   
+-->                                      
+                                                                               
+                                       </listitem>
+                                       
+
+                                       <listitem>
+                                         <para>On the Organization Unit Settings screen, click the <guibutton>Edit</guibutton> button beside the <guilabel>Alert on Empty Bib Records</guilabel> setting.</para>
+                                       </listitem>
+
+                                       <listitem>
+                                         <para>In the Edit Setting pop-up window, click the <guimenu>Context</guimenu> arrow for more options. In the Context box, select a location.</para>
+                                       </listitem>
+                                       
+<!--
+                               What is the effect of te Context Location not being inherited from the parent org unit at run time??? Does this mean that the user is free to select any location and change the corresponding Value??? As a test, I tried changing the Context in the Edit Setting pop-up window for Alert on Empty Bib Records, and I was not able to see the new Value after clicking the Update Setting button.  Why???                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          
+                                       
+-->
+                                       <listitem>
+                                         <para>In the Edit Setting pop-up window, click the <guilabel>Value</guilabel> arrow for more options. In the Value box, select a status.</para>
+                                       </listitem>
+                                       
+                                       <listitem>
+                                         <para>To view the new data for Context and Value, in the Edit Setting pop-up window, click the <guibutton>Update Setting</guibutton> button.</para>
+                                       </listitem>                                     
+                                       
+                                       <listitem>
+                                         <para>On the Organization Unit Settings screen, on the Alert on Empty Bib Records row, you see the current selected location under the Context column and the current selected status under the Value column.</para>
+                                        </listitem>                                                    
+
+                                       <listitem>
+                                         <para>To delete the data for both Context and Value on the Alert on Empty Bib Records row, click the <guibutton>Delete Setting</guibutton> button.</para> 
+                                       </listitem>                                     
+                                                               
+                                       
+                                 </orderedlist>
+                                 
+                                 <example>
+                                 <title>Example of Alert on Empty Bib Records</title>
+                                         
+                                       <para>To change Value to
+                                         False, in the <guimenu>Value</guimenu> box, select <userinput>False</userinput>.</para>
+
+                                       <para>To view the change, click the <guibutton>Update Setting</guibutton> button.</para>                                          
+                                  </example>
+                                 
+                               </section>
+
+                               <section xml:id="alert_empty_bib_records__ref">                                                                                                                                                                                                               
+                                 <title>References for the Alert on Empty Bib Records</title>
+                                 
+                                 <para>http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list</para>
+       <!--                            
+                                 <itemizedlist>
+                                       <listitem>
+                                         <para><link linkend="permissions">http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list</link></para>
+                                       </listitem>
+
+                                 </itemizedlist>
+       -->                       
+                               </section>
+                               
+                       </section>
+
+
+<!-- Credit Card Payments -->                          
+               
+                       <section xml:id="credit_card_payments">
+                               <title>Allow Credit Card Payments</title>
+                               
+                               <section xml:id="credit_card_payments_concept">
+                                 <title>Introduction to Allow Credit Card Payments</title>
+
+                                 <para>If enabled, patrons will be able to pay fines accrued at this location via credit card. The default value is True??? It can be changed through the <guimenu>Local System
+                                 Administration</guimenu> menu.</para>
+                               </section>
+
+                               <section xml:id="credit_card_payments_task">
+                                 <title>Allow Credit Card Payments</title>
+
+                                 <para>To allow credit card payments, do the following:</para>
+
+                                 <orderedlist>
+                                       <listitem>
+                                         <para>On the Local System Administration screen, click the
+                                         <guilabel>Library Settings Editor</guilabel> link.</para>
+                                       </listitem>
+
+                                       <listitem>
+                                         <para>On the Organization Unit Settings screen, click the <guibutton>Edit</guibutton> button beside the <guilabel>Allow Credit Card Payments</guilabel> setting.</para>
+                                       </listitem>                                     
+                                               
+                                       <listitem>
+                                         <para>In the Edit Setting pop-up window, select a location from the
+                                         <guimenu>Context</guimenu> box.</para>
+                                       </listitem>
+
+                                       <listitem>
+                                         <para>In the <guilabel>Value</guilabel> box, select a value.</para>
+
+                                       </listitem>
+                                 </orderedlist>
+                                 
+                                 <example>
+                                 <title>Example of Allow Credit Card Payments</title>                    
+                                 
+                                         <para>To change the credit card payment status to
+                                         false, select <userinput>False</userinput> from the
+                                         <guilabel>Value</guilabel> list.</para>                                 
+                                 </example>                              
+                                 
+                               </section>
+
+                               <section xml:id="credit_card_payments_ref">
+                                 <title>References for Credit Card Payments</title>
+
+                                         <para>http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list</para>
+                               
+                               </section>                              
+                               
+                                       
+                       </section>
+
+
+
+<!-- Change Reshelving Status Interval -->                     
+          
+                       <section xml:id="reshelving">
+                               <title>Change Reshelving Status Interval</title>
+
+                               <section xml:id="reshelving_concept">
+                                 <title>Introduction to Change Reshelving Status Interval</title>
+
+                                       <para>What kind of preamble do we need here???</para>
+
+                               </section>
+<!--
+                               <section xml:id="reshelving_task">
+                                 <title>Change Reshelving Status Interval</title>
+
+                                 <para>To change the reshelving status interval, the following fields are available:</para>
+                                       <segmentedlist>
+                                       <title>Fields in the Edit Setting pop-up window</title>
+                                       <?dbhtml list-presentation="table"?>
+                                       <segtitle>Context</segtitle>
+                                       <segtitle>Value</segtitle>
+                                       <seglistitem><seg>System</seg><seg>Status (True or False)</seg></seglistitem>
+                                       <seglistitem><seg>Branch</seg><seg>Status (True or False)</seg></seglistitem>                                   
+                                       </segmentedlist>
+                                 </para>
+                                </section>
+-->                             
+                                <section xml:id="change_reshelving_status_interval_task">
+                                 <title>Change Reshelving Status Interval</title>
+
+                                 <para>To change the reshelving status interval, do the following:</para>
+
+                                 <orderedlist>
+                                       <listitem>
+                                         <para>On the Local System Administration screen, click the
+                                         <guilabel>Library Settings Editor</guilabel> link.</para>
+                                       </listitem>
+
+                                       <listitem>
+                                         <para>On the Organization Unit Settings screen, find the setting <guilabel>Change reshelving status
+                                         interval</guilabel>, and click
+                                         <guibutton>Edit</guibutton>.</para>
+                                       </listitem>
+
+                                       <listitem>
+                                         <para>In the Edit Setting pop-up window, select a location from the
+                                         <guimenu>Context</guimenu> box.</para>
+                                       </listitem>
+
+                                       <listitem>
+                                         <para>In the <guilabel>Value</guilabel> box, enter a value in
+                                         seconds, hours, or days. The value cannot be zero; however, a value of 1 second is valid.</para>
+       <!--    
+                What are the default units when none are entered with the value???
+       -->     
+                                       </listitem>
+                                       
+                                       <listitem>
+                                         <para>Click the <guibutton>Update Setting</guibutton> button.</para>
+                                       </listitem>                                     
+                                       
+                                       <listitem>
+                                         <para>On the Organization Unit Settings screen, you can see the selected organization unit under the Context column and the reshelving status interval  under the Value column.</para>
+                                        </listitem>                                                    
+
+                                       <listitem>
+                                         <para>To delete both Context and Value for the reshelving status interval, click on <guibutton>Delete Setting</guibutton>.</para> 
+                                       </listitem>                                     
+                                                                        
+                                 </orderedlist>
+                                                 
+                                 <example>
+                                 <title>Example of Change Reshelving Status Interval</title>                     
+                                 
+                                         <para>For example, to change the reshelving status interval to
+                                         four hours, enter <userinput>4 hours</userinput> in the
+                                         <guilabel>Value</guilabel> box.</para>                          
+                                 </example>                      
+                                                                        
+                               </section>
+                               
+                               <section xml:id="reshelving_ref">
+                                 <title>References for Change Reshelving Status Interval</title>
+                                                                 
+                                 <para>http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list</para>
+                                 
+       <!--                              
+                                 <itemizedlist>
+                                       <listitem>
+                                         <para><link linkend="permissions">http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list</link></para>
+                                       
+                                        
+                                        <xref xlink:href="http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list"/>
+                                        
+                                       </listitem>
+                                 </itemizedlist>
+       -->                       
+                                 
+                               </section>
+
+                                <section> 
+                                       <title>Notes for Change Reshelving Status Interval</title>
+                                 
+                                   <note>
+                                         <para>The reshelving status interval is not inherited from the
+                                 parent organizational unit at run time. The default value is 24
+                                 hours??? and can be changed through the <guimenu>Local System
+                                 Administration</guimenu> menu.</para>
+                               
+                                       <para>  Permissions for organization unit settings are not automatically created at install time, which means the permission will have to be created before it can be applied.</para>                             
+                                 
+                                  </note>
+                               </section>  
+                                 
+                       </section>
+
+
+                       
+                                                         
+                       <section xml:id="default_item_price">
+                               <title>Default Item Price</title>
+                               <para></para>
+                       </section>      
+
+                       <section xml:id="default_locale">
+                               <title>Default Locale</title>
+                               <para></para>
+                       </section>      
+                       
+                       <section xml:id="no_auto_deletion_empty_bib_records">
+                               <title>Do not Automatically Delete Empty Bib Records</title>
+                               <para></para>
+                       </section>                              
+                       
+                       <section xml:id="holds_expire_alert_interval">
+                               <title>Holds: Expire Alert Interval</title>
+                               <para></para>
+                       </section>                              
+                       
+                       <section xml:id="holds_expire_interval">
+                               <title>Holds: Expire Interval</title>
+                               <para></para>
+                       </section>                              
+       
+                       <section xml:id="holds_hard">
+                               <title>Holds: Hard Boundary</title>
+                               <para></para>
+                       </section>
+                       
+                       <section xml:id="holds_soft">
+                               <title>Holds: Soft Boundary</title>
+                               <para></para>
+                       </section>
+                       
+                       <section xml:id="lost_materials_proc_fee">
+                               <title>Lost Materials Processing Fee</title>
+                               <para></para>
+                       </section>      
+
+                       <section xml:id="max_prev_checkouts">
+                               <title>Maximum Previous Checkouts Displayed</title>
+                               <para></para>
+                       </section>                              
+                       
+                       <section xml:id="OPAC_inactivity_timeout">
+                               <title>OPAC Inactivity Timeout</title>
+                               <para></para>
+                       </section>                              
+                       
+                       <section xml:id="patron_barcode">
+                               <title>Patron Barcode Format</title>
+                               <para></para>
+                       </section>
+
+                       <section xml:id="patron_login">
+                               <title>Selfcheck: Patron Login Timeout (in seconds)</title>
+                               <para></para>
+                       </section>      
+
+                       <section xml:id="pop_up_alert">
+                               <title>Selfcheck: Pop-up Alert for Errors</title>
+                               <para></para>
+                       </section>      
+
+                       <section xml:id="patron_password">
+                               <title>Selfcheck: Require Patron Password</title>
+                               <para></para>
+                       </section>      
+
+                       <section xml:id="email_addr_for_patron_notices">
+                               <title>Sending Email Address for Patron Notices</title>
+                               <para></para>
+                       </section>      
+
+                       <section xml:id="staff_login_inactivity_timeout">
+                               <title>Staff Login Inactivity Timeout (in seconds)</title>
+                               <para></para>
+                       </section>      
+
+                       <section xml:id="void_overdue_fines">
+                               <title>Void Overdue Fines When Items are Marked Lost</title>
+                               <para></para>
+                       </section>      
+                               
+      </section>
+    </section>
+  </section>
+</chapter>