change xml:id for chapter to "staffclientinstallation";
authorSteve Sheppard <ssheps@gmail.com>
Sun, 3 Oct 2010 01:57:54 +0000 (21:57 -0400)
committerSteve Sheppard <ssheps@gmail.com>
Sun, 3 Oct 2010 01:57:54 +0000 (21:57 -0400)
rename all .PNG files from "serversideinstallation-*.png" to "staffclientinstallation-*.png";
correct all local <xref/> links to read "staffclientinstallation-*" instead of "serversideinstallation-*";

1.6/admin/staffclientinstallation.xml

index fcf7809..6ec8a72 100644 (file)
@@ -1,17 +1,17 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<chapter xml:id="serversideinstallation-staffclient" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xl="http://www.w3.org/1999/xlink">
+<chapter xml:id="staffclientinstallation" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xl="http://www.w3.org/1999/xlink">
        <info>
                <title>Installation of Evergreen Staff Client Software</title>
                <abstract>
                        <para>This section describes installation of the Evergreen Staff Client software.</para>
                </abstract>
        </info>
-       <section xml:id="serversideinstallation-installing-staffclient">
+       <section xml:id="staffclientinstallation-installing-staffclient">
                <title>Installing the Staff Client</title>
-               <para>The Staff Client is automatically built by default as part of the normal <emphasis>make install</emphasis> process for Evergreen server-side software. See the section <xref linkend="serversideinstallation-compilingevergreen"/> to review details related to building the Staff Client in the final compile/link/install phase of the default Evergreen build process. See the section <xref linkend="serversideinstallation-building-staffclient"/> for help on manually building the Staff Client. Otherwise, continue with the following sections to install a pre-built Staff Client.</para>
-               <simplesect xml:id="serversideinstallation-prebuilt-staffclient">
+               <para>The Staff Client is automatically built by default as part of the normal <emphasis>make install</emphasis> process for Evergreen server-side software. See the section <xref linkend="serversideinstallation-compilingevergreen"/> to review details related to building the Staff Client in the final compile/link/install phase of the default Evergreen build process. See the section <xref linkend="staffclientinstallation-building-staffclient"/> for help on manually building the Staff Client. Otherwise, continue with the following sections to install a pre-built Staff Client.</para>
+               <simplesect xml:id="staffclientinstallation-prebuilt-staffclient">
                        <title>Installing a Pre-Built Staff Client</title>
-                       <para>You can install the Staff Client from pre-built images and packages without actually having to first build it. Pre-built packages are currently available for Windows, MAC OS X, and Linux. If you need to manually build the Staff Client, see the section <xref linkend="serversideinstallation-building-staffclient"/>.</para>
+                       <para>You can install the Staff Client from pre-built images and packages without actually having to first build it. Pre-built packages are currently available for Windows, MAC OS X, and Linux. If you need to manually build the Staff Client, see the section <xref linkend="staffclientinstallation-building-staffclient"/>.</para>
                        <section>
                                <title>Installing on Windows</title>
                                <para>A standard Microsoft Windows installer that contains the current version of the Staff Client is available from the downloads section of the Evergreen website at <ulink url="http://www.evergreen-ils.org/downloads.php">http://www.evergreen-ils.org/downloads.php</ulink>. Download the staff client installer, then run it. A screen that looks similar to this should appear:</para>
@@ -19,7 +19,7 @@
                                        <title>Running the Staff Client installer</title>
                                        <mediaobject>
                                                <imageobject>
-                                                       <imagedata fileref="../media/serversideinstallation-staffclient-1.png" scalefit="1" width="70%"/>
+                                                       <imagedata fileref="../media/staffclientinstallation-staffclient-1.png" scalefit="1" width="70%"/>
                                                </imageobject>
                                        </mediaobject>
                                </figure>
                                        <title>Running the Staff Client for the first time</title>
                                        <mediaobject>
                                                <imageobject>
-                                                       <imagedata fileref="../media/serversideinstallation-staffclient-2.png" scalefit="1" width="70%"/>
+                                                       <imagedata fileref="../media/staffclientinstallation-staffclient-2.png" scalefit="1" width="70%"/>
                                                </imageobject>
                                        </mediaobject>
                                </figure>
                                <para>First, configure the server you would like to connect to in the <emphasis role="bold">Server</emphasis> section. For example, the PINES demo system is <emphasis role="bold">demo.gapines.org</emphasis>. After selecting a server, click the <emphasis role="bold">Re-Test Server</emphasis> button.</para>
-                               <para>Because this is the initial run of the staff client, the <emphasis role="bold">Workstation</emphasis> section in the upper-right states: <emphasis role="bold">Not yet configured for the specified server</emphasis>. The first thing that must be done to the Staff Client on every workstation is to assign it a workstation name. This is covered in the section <xref linkend="serversideinstallation-workstationnames"/>.</para>
+                               <para>Because this is the initial run of the staff client, the <emphasis role="bold">Workstation</emphasis> section in the upper-right states: <emphasis role="bold">Not yet configured for the specified server</emphasis>. The first thing that must be done to the Staff Client on every workstation is to assign it a workstation name. This is covered in the section <xref linkend="staffclientinstallation-workstationnames"/>.</para>
                        </section>
                        <section>
                                <title>Installing on Mac OS X</title>
@@ -54,7 +54,7 @@
                                                        <title>Running the Staff Client installer</title>
                                                        <mediaobject>
                                                                <imageobject>
-                                                                       <imagedata fileref="../media/serversideinstallation-staffclient-3.png" scalefit="1" width="20%"/>
+                                                                       <imagedata fileref="../media/staffclientinstallation-staffclient-3.png" scalefit="1" width="20%"/>
                                                                </imageobject>
                                                        </mediaobject>
                                                </figure>
@@ -64,7 +64,7 @@
                                                        <title>Finishing the installation</title>
                                                        <mediaobject>
                                                                <imageobject>
-                                                                       <imagedata fileref="../media/serversideinstallation-staffclient-4.png" scalefit="1" width="20%"/>
+                                                                       <imagedata fileref="../media/staffclientinstallation-staffclient-4.png" scalefit="1" width="20%"/>
                                                                </imageobject>
                                                        </mediaobject>
                                                </figure>
@@ -94,7 +94,7 @@
                                                                </tbody>
                                                        </tgroup>
                                                </table>
-                                               <note>If you have issues removing previously installed XULRunner versions see <xref linkend="serversideinstallation-staffclient-remove-xulrunner"/> for information on removing previous XULRunner versions.</note>
+                                               <note>If you have issues removing previously installed XULRunner versions see <xref linkend="staffclientinstallation-remove-xulrunner"/> for information on removing previous XULRunner versions.</note>
                                                <para>The staff client data from the <emphasis>./staff_client/build</emphasis> directory must be placed somewhere on the machine (e.g. <emphasis>~/Desktop/Evergreen_Staff_Client</emphasis>). Remember to call XULRunner with the full path to the binary, followed by the install command and the path to the client data. See the following command:</para>
                                                <figure>
                                                        <title>Executing XULRunner</title>
                                        </listitem>
                                        <listitem>
                                                <para>Removing previously installed XULRunner versions</para>
-                                               <section xml:id="serversideinstallation-staffclient-remove-xulrunner">
+                                               <section xml:id="staffclientinstallation-remove-xulrunner">
                                                        <para>If you already have a newer version installed, per the release notes, you will need to remove the entire directory <emphasis>/Library/Frameworks/XUL.framework</emphasis> before downgrading.</para>
                                                        <para>In addition, you may also need to remove the previous file <emphasis>/Library/Receipts/xulrunner-ver-mak.pkg</emphasis>.</para>
                                                        <para>If there is no file <emphasis>/Library/Receipts/xulrunner-ver-mak.pkg</emphasis> (possibly in newer OSX releases) you need to flush the <emphasis>receiptdb</emphasis> file.</para>
                                        </listitem>
                                </itemizedlist>
                        </section>
-                       <section xml:id="serversideinstallation-staffclient-linux">
+                       <section xml:id="staffclientinstallation-staffclient-linux">
                                <title>Installing on Linux</title>
                                <section>
                                        <title>Quick Upgrade of the Staff Client</title>
                                                </listitem>
                                        </orderedlist>
                                </section>
-                               <section xml:id="serversideinstallation-workstationnames">
+                               <section xml:id="staffclientinstallation-workstationnames">
                                        <title>Assigning Workstation Names</title>
                                        <para>The Staff Client must be assigned to a library and given a unique name before it will connect fully to the Evergreen server. The only restriction is that the workstation's name must be unique within the assigned library. Make sure to select a workstation name that you will remember later, and reflects the role, purpose, and/or location of a particular computer. These names will come up later in statistical reporting, and can also be handy when troubleshooting.</para>
                                        <figure>
                                                <title>Example of unconfigured Staff Client</title>
                                                <mediaobject>
                                                        <imageobject>
-                                                               <imagedata fileref="../media/serversideinstallation-staffclient-workstationnames-1.png" scalefit="1" width="70%"/>
+                                                               <imagedata fileref="../media/staffclientinstallation-staffclient-workstationnames-1.png" scalefit="1" width="70%"/>
                                                        </imageobject>
                                                </mediaobject>
                                        </figure>
                                                <title>Example of configured Staff Client</title>
                                                <mediaobject>
                                                        <imageobject>
-                                                               <imagedata fileref="../media/serversideinstallation-staffclient-workstationnames-2.png" scalefit="1" width="70%"/>
+                                                               <imagedata fileref="../media/staffclientinstallation-staffclient-workstationnames-2.png" scalefit="1" width="70%"/>
                                                        </imageobject>
                                                </mediaobject>
                                        </figure>
                                                <title>Example of registered Staff Client</title>
                                                <mediaobject>
                                                        <imageobject>
-                                                               <imagedata fileref="../media/serversideinstallation-staffclient-workstationnames-3.png" scalefit="1" width="70%"/>
+                                                               <imagedata fileref="../media/staffclientinstallation-staffclient-workstationnames-3.png" scalefit="1" width="70%"/>
                                                        </imageobject>
                                                </mediaobject>
                                        </figure>
                                </section>
                        </section>
                </simplesect>
-               <simplesect xml:id="serversideinstallation-building-staffclient">
+               <simplesect xml:id="staffclientinstallation-building-staffclient">
                        <title>Manually Building the Staff Client</title>
                        <para>The Staff Client is automatically built by default as part of the normal <emphasis>make install</emphasis> process for Evergreen server-side software. See the section <xref linkend="serversideinstallation-compilingevergreen"/> to review details related to building the Staff Client in the final compile/link/install phase of the default Evergreen build process.</para>
                        <section>
                                                        ...
                                                        </screen>
                                                </figure>
-                                               <para>For more information on Automatic Updates, see the section <xref linkend="serversideinstallation-staffclient-autoupdate"/>.</para>
+                                               <para>For more information on Automatic Updates, see the section <xref linkend="staffclientinstallation-autoupdate"/>.</para>
                                        </listitem>
                                </itemizedlist>
                        </section>
                                        </listitem>
                                </itemizedlist>
                        </section>
-                       <section xml:id="serversideinstallation-staffclient-autoupdate">
+                       <section xml:id="staffclientinstallation-autoupdate">
                                <title>Staff Client Automatic Updates</title>
                                <para>It is possible to set up support for automatic Staff Client updates, either during the normal Evergreen server-side build process, or by manually building the Staff Client with certain special options.</para>
                                <section>
                        </section>
                </simplesect>
        </section>
-       <section xml:id="serversideinstallation-running-staffclient">
+       <section xml:id="staffclientinstallation-running-staffclient">
                <title>Running the Staff Client</title>
                <para>Run the Staff Client on a Linux system by using the application <emphasis>XULRunner</emphasis> (installed automatically and by default with Firefox version 3.0 and later on Ubuntu and Debian distributions).</para>
                <para>For example, if the source files for the Evergreen installation are in the directory <emphasis>/home/opensrf/Evergreen-ILS-1.6.0.7/</emphasis>, start the Staff Client as shown in the following command example:</para>
                        $ xulrunner /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client/build/application.ini
                        </screen>
                </figure>
-               <simplesect xml:id="serversideinstallation-proxy">
+               <simplesect xml:id="staffclientinstallation-proxy">
                        <title>Running the Staff Client over an SSH Tunnel</title>
                        <para>The Staff Client can use an SSH tunnel as a SOCKS 5 proxy.</para>
                        <section>
                                        <title>Setting up an SSH tunnel in PuTTY</title>
                                        <mediaobject>
                                                <imageobject>
-                                                       <imagedata fileref="../media/serversideinstallation-proxy-putty.png" scalefit="1" width="70%"/>
+                                                       <imagedata fileref="../media/staffclientinstallation-proxy-putty.png" scalefit="1" width="70%"/>
                                                </imageobject>
                                        </mediaobject>
                                </figure>
                                        <title>The SOCKS section of "all.js" before changes</title>
                                        <mediaobject>
                                                <imageobject>
-                                                       <imagedata fileref="../media/serversideinstallation-proxy-socks-1.png" scalefit="1" width="70%"/>
+                                                       <imagedata fileref="../media/staffclientinstallation-proxy-socks-1.png" scalefit="1" width="70%"/>
                                                </imageobject>
                                        </mediaobject>
                                </figure>
                                        <listitem>Change the value of <emphasis>network.proxy.socks</emphasis>  from <emphasis role="bold">""</emphasis> to <emphasis role="bold">"localhost"</emphasis>.</listitem>
                                        <listitem>Change the value of <emphasis>network.proxy.socks_port</emphasis> from <emphasis role="bold">"0"</emphasis> to <emphasis role="bold">9999</emphasis>.</listitem>
                                </itemizedlist>
-                               <figure xml:id="serversideinstallation-socks-figure">
+                               <figure xml:id="staffclientinstallation-socks-figure">
                                        <title>The SOCKS section of "all.js" after changes</title>
                                        <mediaobject>
                                                <imageobject>
-                                                       <imagedata fileref="../media/serversideinstallation-proxy-socks-2.png" scalefit="1" width="70%"/>
+                                                       <imagedata fileref="../media/staffclientinstallation-proxy-socks-2.png" scalefit="1" width="70%"/>
                                                </imageobject>
                                        </mediaobject>
                                </figure>