expand glossary; tweak <screen/> sections in StaffclientInstallation;
authorSteve Sheppard <ssheps@gmail.com>
Fri, 7 Jan 2011 16:14:52 +0000 (11:14 -0500)
committerSteve Sheppard <ssheps@gmail.com>
Fri, 7 Jan 2011 16:14:52 +0000 (11:14 -0500)
1.6/admin/staffclientinstallation.xml
1.6/appendices/glossary.xml

index 009d089..f3bb9a1 100644 (file)
                                        <filename class="directory">~/Desktop/Evergreen_Staff_Client</filename>).</para>
                                        <para>Remember to call <application>XULrunner</application> with the full path to the
                                        binary, followed by the install command and the path to the client data:</para>
-                                       <screen>
-                                               <userinput>
-       /Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client
-       </userinput>
-                                       </screen>
+<screen>
+       <userinput>
+       /Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client</userinput>
+</screen>
                                        <para>The command should exit quietly and will create the folder 
                                        <filename class="directory">/Applications/OpenILS</filename>,
                                        containing a launcher named <application>open_ils_staff_client</application>.</para>
                                        <title>(OPTIONAL) Flush Receiptdb file:</title>
                                        <para>First, get the package identifier, then purge/forget the build that was
                                        initially installed:</para>
-                                       <screen>
-                                               <userinput>
+<screen>
+       <userinput>
        sudo pkgutil --pkgs > /tmp/pkgs.txt
-       sudo pkgutil --forget org.mozilla.xulrunner
-       </userinput>
-                                       </screen>
+       sudo pkgutil --forget org.mozilla.xulrunner</userinput>
+</screen>
                                        <note>It may not be necessary to edit the file
                                        <filename>/Library/Receipts/InstallHistory.plist</filename> after deleting the
                                        folder <filename class="directory">XUL.framework</filename>. See
                                <simplesect>
                                        <title>Creating an APP file: Staff Client and <application>XULrunner</application> Bundled</title>
                                        <para>An APP file is basically a folder. Start with a folder stucture like this:</para>
-                                       <screen>
-                                               <prompt>
+<screen>
+       <prompt>
        Evergreen.app
        __Contents
        ____Frameworks
        ____Resources
-       ____MacOS
-       </prompt>
-                                       </screen>
+       ____MacOS</prompt>
+</screen>
                                        <para>Create an APP folder structure with the following commands:</para>
-                                       <screen>
-                                               <userinput>
+<screen>
+       <userinput>
        mkdir -p Evergreen.app/Contents/Frameworks
        mkdir -p Evergreen.app/Contents/Resources
-       mkdir -p Evergreen.app/Contents/MacOS
-       </userinput>
-                                       </screen>
+       mkdir -p Evergreen.app/Contents/MacOS</userinput>
+</screen>
                                        <orderedlist>
                                                <listitem>
                                                        <para>Create a new file in the folder
                                                        <para>Make a copy of the folder
                                                        <filename class="directory">/Library/Frameworks/XUL.Framework</filename>
                                                        inside your APP file. It should look something like this:</para>
-                                                       <screen>
-                                                               <prompt>
+<screen>
+       <prompt>
        Evergreen.app/
        __Contents/
        ____Frameworks/
        ________1.9.1.3/
        ______XUL -> Versions/Current/XUL
        ______libxpcom.dylib -> Versions/Current/libxpcom.dylib
-       ______xulrunner-bin -> Versions/Current/xulrunner-bin
-       </prompt>
-                                                       </screen>
+       ______xulrunner-bin -> Versions/Current/xulrunner-bin</prompt>
+</screen>
                                                </listitem>
                                                <listitem>Copy
                                                <filename>XUL.Framework/Versions/Current/xulrunner</filename> into the
                                                <listitem>
                                                        <para>Make <filename>Evergreen.app/Resources</filename> the root
                                                        of your Evergreen application files like this:</para>
-                                                       <screen>
-                                                               <prompt>
+<screen>
+       <prompt>
        Evergreen.app/
        __Contents/
        ____Resources/
        ______application.ini
        ______chrome/
        ______components/
-       ______etc.
-       </prompt>
-                                                       </screen>
+       ______etc.</prompt>
+</screen>
                                                </listitem>
                                                <listitem>Put a <systemitem class="osname">Mac</systemitem> 
                                                format icon file named <filename>Evergreen.icns</filename> in 
                                        <para>Execute the following commands, replacing <literal>USER</literal>,
                                        <literal>WORKSTATION</literal>, and <literal>SOME_PATH</literal> with
                                        appropriate values:</para>
-                                       <screen>
-                                               <userinput>
+<screen>
+       <userinput>
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
-       scp -r ./build USER@WORKSTATION:/SOME_PATH/
-       </userinput>
-                                       </screen>
+       scp -r ./build USER@WORKSTATION:/SOME_PATH/</userinput>
+</screen>
                                        <para>You should test the newly copied Staff Client on the remote workstation.
                                        Log into the workstation and execute the following command:</para>
-                                       <screen>
-                                               <userinput>
-       xulrunner /SOME_PATH/build/application.ini
-       </userinput>
-                                       </screen>
+<screen>
+       <userinput>
+       xulrunner /SOME_PATH/build/application.ini</userinput>
+</screen>
                                </simplesect>
                                <simplesect>
                                        <title>Building the Staff Client on the Server</title>
                                        directory containing the server components of the Staff Client, or the name of a
                                        symbolic link to that directory. As the 
                                        <systemitem class="username">root</systemitem> user, make the changes as follows:</para>
-                                       <screen>
-                                               <userinput>
+<screen>
+       <userinput>
        # as the root user:
        cd /openils/var/web/xul
-       ln -s SERVER_BUILD_ID/ CLIENT_BUILD_ID
-       </userinput>
-                                       </screen>
+       ln -s SERVER_BUILD_ID/ CLIENT_BUILD_ID</userinput>
+</screen>
                                </simplesect>
                                <simplesect>
                                        <title>Building the Staff Client on a Client Machine</title>
                                                        <command>apt-get</command>. For <application>subversion</application>,
                                                        select the latest version; for <application>XULrunner</application>,
                                                        select version <emphasis>1.8.1.4-2ubuntu5</emphasis>.</para>
-                                                       <screen>
-                                                               <userinput>
+<screen>
+       <userinput>
        # as the root user:
        sudo apt-get install subversion
-       sudo apt-get install xulrunner
-       </userinput>
-                                                       </screen>
+       sudo apt-get install xulrunner</userinput>
+</screen>
                                                </step>
                                                <step>
                                                        <title>Download the Source Code</title>
                                                                        to the directory in which you wish to download the Staff
                                                                        Client. Use the following commands to download the proper
                                                                        version of the source code by tag name:</para>
-                                                                       <screen>
-                                                                               <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /DOWNLOAD/DIRECTORY
-       svn co rel_1_6_1_2/
-       </userinput>
-                                                                       </screen>
+       svn co rel_1_6_1_2/</userinput>
+</screen>
                                                                        <para>Remember to change "rel_1_6_1_2" to the appropriate
                                                                        tag for your installation.</para>
                                                                </listitem>
                                                        commands accordingly.</para>
                                                        <para>As the <systemitem class="username">opensrf</systemitem>
                                                        user, run the following commands to build the Staff Client:</para>
-                                                       <screen>
-                                                               <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.1.2.tar.gz
        tar xfz Evergreen-ILS-1.6.1.2.tar.gz
        cd /home/opensrf/Evergreen-ILS-1.6.1.2
        ./configure --prefix=/openils --sysconfdir=/openils/conf
        cd ./Open-ILS/xul/staff_client/
-       make STAFF_CLIENT_BUILD_ID='rel_1_6_1_2' install
-       </userinput>
-                                                       </screen>
+       make STAFF_CLIENT_BUILD_ID='rel_1_6_1_2' install</userinput>
+</screen>
                                                </step>
                                                <step>
                                                        <title>Run the Staff Client</title>
                                                        <para>As the <systemitem class="username">opensrf</systemitem> 
                                                        user, navigate to the <filename class="directory">build/</filename>
                                                        subdirectory and run the following command:</para>
-                                                       <screen>
-                                                               <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build
-       xulrunner application.ini
-       </userinput>
-                                                       </screen>
+       xulrunner application.ini</userinput>
+</screen>
                                                </step>
                                                <step>
                                                        <title>(OPTIONAL) Clean Up / Create Shortcuts</title>
                                                        to replace <emphasis>DOWNLOAD_DIRECTORY</emphasis> and
                                                        <emphasis>STAGING_DIRECTORY</emphasis> with the appropriate
                                                        paths):</para>
-                                                       <screen>
-                                                               <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        mkdir ~/STAGING_DIRECTORY
        cd ~/DOWNLOAD_DIRECTORY/Open-ILS/xul/
-       cp -r staff_client ~/STAGING_DIRECTORY
-       </userinput>
-                                                       </screen>
+       cp -r staff_client ~/STAGING_DIRECTORY</userinput>
+</screen>
                                                        <para>Test the Staff Client to verify that all necessary files
                                                        were copied to the staging directory:</para>
-                                                       <screen>
-                                                               <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd ~/STAGING_DIRECTORY/staff_client/build
-       xulrunner application.ini
-       </userinput>
-                                                       </screen>
+       xulrunner application.ini</userinput>
+</screen>
                                                        <para>If there were no problems, then finish the cleanup by
                                                        removing the original download directory as shown:</para>
-                                                       <screen>
-                                                               <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
-       rm -r -f ~/DOWNLOAD_DIRECTORY
-       </userinput>
-                                                       </screen>
+       rm -r -f ~/DOWNLOAD_DIRECTORY</userinput>
+</screen>
                                                        <para>Finally, the command:</para>
-                                                       <screen>
-                                                               <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
-       xulrunner ~/STAGING_DIRECTORY/staff_client/build/application.ini
-       </userinput>
-                                                       </screen>
+       xulrunner ~/STAGING_DIRECTORY/staff_client/build/application.ini</userinput>
+</screen>
                                                        <para>will now run the Staff Client. You may wish to create a
                                                        shortcut for the Staff Client. To do so, use the previous
                                                        command as the target for the shortcut:
-                                                       <menuchoice><guimenu>Desktop</guimenu><guimenuitem>StartMenu</guimenuitem><guimenuitem>K-Menu</guimenuitem></menuchoice></para>
+                                                       <menuchoice>
+                                                               <guimenu>Desktop</guimenu>
+                                                               <guimenuitem>StartMenu</guimenuitem>
+                                                               <guimenuitem>K-Menu</guimenuitem>
+                                                       </menuchoice></para>
                                                </step>
                                        </procedure>
                                </simplesect>
                                        <orderedlist>
                                                <listitem>
                                                        <para>Install wine:</para>
-                                                       <screen>
-                                                               <userinput>
+<screen>
+       <userinput>
        # as the root user:
-       sudo apt-get install wine
-       </userinput>
-                                                       </screen>
+       sudo apt-get install wine</userinput>
+</screen>
                                                </listitem>
                                                <listitem>
                                                        <para>Visit the downloads section of the Evergreen website at
                                                        file, then execute it with the <application>wine</application>
                                                        application (remember to replace <emphasis>VERSION</emphasis> with
                                                        the release number of the Staff Client you downloaded):</para>
-                                                       <screen>
-                                                               <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /TEMP_DIRECTORY
-       wine evergreen-setup-rel_VERSION.exe
-       </userinput>
-                                                       </screen>
+       wine evergreen-setup-rel_VERSION.exe</userinput>
+</screen>
                                                        <para>If this step fails, you may need to configure
                                                        <application>Wine</application> first to properly emulate 
                                                        <systemitem class="osname">Windows XP</systemitem>. To do so,
                                                        the Staff Client. To launch the Staff Client, visit the
                                                        <literal>All Applications</literal> menu on your desktop and
                                                        find the section similar to:</para>
-                                                       <para><menuchoice><guimenu>Wine</guimenu><guimenuitem>Program Files</guimenuitem><guimenuitem>Evergreen Staff Client</guimenuitem><guimenuitem>Evergreen Staff Client</guimenuitem></menuchoice>,
+                                                       <para>
+                                                               <menuchoice>
+                                                                       <guimenu>Wine</guimenu>
+                                                                       <guimenuitem>Program Files</guimenuitem>
+                                                                       <guimenuitem>Evergreen Staff Client</guimenuitem>
+                                                                       <guimenuitem>Evergreen Staff Client</guimenuitem>
+                                                               </menuchoice>,
                                                        </para>
                                                        <para>or else launch the Staff Client from the new desktop shortcut.</para>
                                                </listitem>
                                software build process, the variable defaults to an automatically generated
                                date/time string, but you can also override the value of <envar>BUILD_ID</envar>.</para>
                                <para>You could use the following commands during the normal install process:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the root user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2
-       make STAFF_CLIENT_BUILD_ID=1_6_1_2 install
-       </userinput>
-                               </screen>
+       make STAFF_CLIENT_BUILD_ID=1_6_1_2 install</userinput>
+</screen>
                                <para>You can also manually build the Staff Client in the Staff Client
                                source directory with a different <envar>BUILD_ID</envar>.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user,
                                execute the following commands to build the Staff Client (remember to replace
                                <emphasis>NEW_VERSION</emphasis> with an appropriate value):</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
-       make STAFF_CLIENT_BUILD_ID=NEW_VERSION  build
-       </userinput>
-                               </screen>
+       make STAFF_CLIENT_BUILD_ID=NEW_VERSION  build</userinput>
+</screen>
                        </simplesect>
                        <simplesect>
                                <title>
                                automatically generated. You can override the value of <envar>VERSION</envar>
                                similarly to the <envar>BUILD_ID</envar>.</para>
                                <para>You could use the following commands during the normal install process:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the root user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2
-       make STAFF_CLIENT_VERSION=0mytest.200 install
-       </userinput>
-                               </screen>
+       make STAFF_CLIENT_VERSION=0mytest.200 install</userinput>
+</screen>
                                <para>You can also manually build the Staff Client in the Staff Client
                                source directory with a different <envar>VERSION</envar>.</para>
                                <para>If you plan to make extensions update automatically, the 
                                versions.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user,
                                execute the following commands to build the Staff Client:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
-       make STAFF_CLIENT_VERSION=0mytest.200  build
-       </userinput>
-                               </screen>
+       make STAFF_CLIENT_VERSION=0mytest.200  build</userinput>
+</screen>
                        </simplesect>
                        <simplesect>
                                <title>
                                client-side customizations. You can override the value of
                                <envar>STAMP_ID</envar> similarly to the <envar>BUILD_ID</envar>.</para>
                                <para>You could use the following commands during the normal install process:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the root user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2
-       make STAFF_CLIENT_STAMP_ID=my_test_stamp install
-       </userinput>
-                               </screen>
+       make STAFF_CLIENT_STAMP_ID=my_test_stamp install</userinput>
+</screen>
                                <para>You can also manually build the Staff Client in the Staff Client
                                source directory with a different <envar>STAMP_ID</envar>.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user,
                                execute the following commands to build the Staff Client:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
-       make STAFF_CLIENT_STAMP_ID=my_test_stamp  build
-       </userinput>
-                               </screen>
+       make STAFF_CLIENT_STAMP_ID=my_test_stamp  build</userinput>
+</screen>
                        </simplesect>
                </section>
                <section>
                                extra configuration file that enables some developer options.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user, run
                                the following commands from the Staff Client source directory:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
-       make devbuild
-       </userinput>
-                               </screen>
+       make devbuild</userinput>
+</screen>
                        </simplesect>
                        <simplesect>
                                <title>Compressed Javascript</title>
                                http://code.google.com/closure/compiler</ulink>.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user, run
                                the following commands from the Staff Client source directory:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
-       make compress-javascript
-       </userinput>
-                               </screen>
+       make compress-javascript</userinput>
+</screen>
                                <para>You can also combine Javascript review and compression, and also perform a
                                <emphasis>developer build</emphasis>.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user, run 
                                the following <command>make</command> command from the Staff Client source directory
                                (the order of options is important):</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
-       make  devbuild  compress-javascript
-       </userinput>
-                               </screen>
+       make  devbuild  compress-javascript</userinput>
+</screen>
                        </simplesect>
                        <simplesect xml:id="staffclientinstallation-autoupdatehost">
                                <title>Automatic Update Host</title>
                                <para>You can override the host used to check for automatic Staff Client updates
                                by specifying the <option>AUTOUPDATE_HOST</option> option.</para>
                                <para>You could use the following commands during the normal install process:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the root user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2
-       make AUTOUPDATE_HOST=localhost install
-       </userinput>
-                               </screen>
+       make AUTOUPDATE_HOST=localhost install</userinput>
+</screen>
                                <para>You can manually build the Staff Client in the Staff Client
                                source directory and set <option>AUTOUPDATE_HOST</option> to enable automatic
                                update checking.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user,
                                execute the following commands to build the Staff Client:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
-       make AUTOUPDATE_HOST=localhost build
-       </userinput>
-                               </screen>
+       make AUTOUPDATE_HOST=localhost build</userinput>
+</screen>
                                <para>For more information on Automatic Updates, see
                                <xref linkend="staffclientinstallation-autoupdate"/>.</para>
                        </simplesect>
                        in the directory <filename class="directory">/openils/var/web/xul</filename>, as the
                        <systemitem class="username">opensrf</systemitem> user execute the following
                        commands:</para>
-                       <screen>
-                               <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
        mkdir -p "/openils/var/web/xul/$(cat build/BUILD_ID)"
-       cp -R build/server "/openils/var/web/xul/$(cat build/BUILD_ID)"
-       </userinput>
-                       </screen>
+       cp -R build/server "/openils/var/web/xul/$(cat build/BUILD_ID)"</userinput>
+</screen>
                </section>
                <section>
                        <title>Packaging the Staff Client</title>
                                installed on your system.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user, execute
                                the following commands:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
-       make generic-client
-       </userinput>
-                               </screen>
+       make generic-client</userinput>
+</screen>
                                <para>The output file <filename>evergreen_staff_client.xpi</filename> will be created.</para>
                        </simplesect>
                        <simplesect>
                                </table>
                                <para>As the <systemitem class="username">opensrf</systemitem> user
                                execute the following commands:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
-       make win-client
-       </userinput>
-                               </screen>
+       make win-client</userinput>
+</screen>
                                <para>The output file <filename>evergreen_staff_client_setup.exe</filename> will be created.</para>
                        </simplesect>
                        <simplesect>
                                <application>bzip2</application> utility installed on your system.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user, 
                                execute the following commands:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
-       make linux-client
-       </userinput>
-                               </screen>
+       make linux-client</userinput>
+</screen>
                                <para>The output file <filename>evergreen_staff_client.tar.bz2</filename> will be created.</para>
                        </simplesect>
                        <simplesect>
                                utility installed on your system.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user,
                                execute the following commands:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
-       make extension
-       </userinput>
-                               </screen>
+       make extension</userinput>
+</screen>
                                <para>The output file <filename>evergreen.xpi</filename> will be created.</para>
                        </simplesect>
                </section>
                                                software (see <xref linkend="serversideinstallation-configure"/>). 
                                                As the <systemitem class="username">opensrf</systemitem> user, execute 
                                                the following commands:</para>
-                                               <screen>
-                                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2
        ./configure --prefix=/openils --sysconfdir=/openils/conf --with-updateshost=hostname
-       make
-       </userinput>
-                                               </screen>
+       make</userinput>
+</screen>
                                        </listitem>
                                        <listitem>
                                                <para>During a manual Staff Client build process.</para>
                                                <systemitem class="domainname">http://example.com</systemitem>).</para>
                                                <para>As the <systemitem class="username">opensrf</systemitem> user,
                                                execute the following commands to build the Staff Client (remember to
-                                               replace <emphasis>SOME_URL</emphasis> with an appropriate value)
-                                               :</para>
-                                               <screen>
-                                                       <userinput>
+                                               replace <emphasis>SOME_URL</emphasis> with an appropriate value):</para>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
-       make AUTOUPDATE_HOST=http://SOME_URL build
-       </userinput>
-                                               </screen>
+       make AUTOUPDATE_HOST=http://SOME_URL build</userinput>
+</screen>
                                        </listitem>
                                </itemizedlist>
                        </simplesect>
                                <para>As the <systemitem class="username">opensrf</systemitem> user, change
                                directory to the Staff Client source directory, then execute the following
                                commands:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
-       cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
-       </userinput>
-                               </screen>
+       cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
+</screen>
                                <para>Command to build all updates at once:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
-       make updates
-       </userinput>
-                               </screen>
+       make updates</userinput>
+</screen>
                                <para>commands to build updates individually:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        make generic-updates
        make win-updates
        make linux-updates
-       make extension-updates
-       </userinput>
-                               </screen>
+       make extension-updates</userinput>
+</screen>
                        </simplesect>
                        <simplesect>
                                <title>Building updates with clients</title>
                                <para>As the <systemitem class="username">opensrf</systemitem> user, execute
                                one of the following commands:</para>
                                <para>To build all updates at once:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
-       make updates-client
-       </userinput>
-                               </screen>
+       make updates-client</userinput>
+</screen>
                                <para>To build updates individually:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
        make generic-updates-client
        make win-updates-client
-       make linux-updates-client
-       </userinput>
-                               </screen>
+       make linux-updates-client</userinput>
+</screen>
                        </simplesect>
                        <simplesect>
                                <title>Activating the Update Server</title>
                                <filename>manualupdate.html</filename>, and
                                <filename>update.rdf</filename>, as the root user execute the following
                                commands:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the root user:
        cd /openils/var/updates/pub
-       chmod +x  check  download  manualupdate.html  update.rdf
-       </userinput>
-                               </screen>
+       chmod +x  check  download  manualupdate.html  update.rdf</userinput>
+</screen>
                        </simplesect>
                </section>
                <section>
                                start menu.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user, 
                                execute the following commands:</para>
-                               <screen>
-                                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
-       make NSIS_EXTRAOPTS=-DPROFILES win-client
-       </userinput>
-                               </screen>
+       make NSIS_EXTRAOPTS=-DPROFILES win-client</userinput>
+</screen>
                        </simplesect>
                        <simplesect>
                                <title> Multiple Staff Clients</title>
                <para>For example, if the source files for the Evergreen installation are in the directory 
                <filename class="directory">/home/opensrf/Evergreen-ILS-1.6.1.2/</filename> you can start the 
                Staff Client as shown in the following example:</para>
-               <screen>
-                       <userinput>
+<screen>
+       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build
-       xulrunner application.ini
-       </userinput>
-               </screen>
+       xulrunner application.ini</userinput>
+</screen>
                <section xml:id="staffclientinstallation-workstationnames">
                        <title>Assigning Workstation Names</title>
                        <indexterm>
                        interfaces - anything at all in the Staff Client.</para>
                        <itemizedlist>
                                <listitem>Create a new tab by pressing
-                               <keycombo><keycap>Ctrl</keycap><keycap>T</keycap></keycombo>
+                               <keycombo>
+                                       <keycap>Ctrl</keycap>
+                                       <keycap>T</keycap>
+                               </keycombo>
                                on the keyboard or selecting:
-                               <menuchoice><guimenu>File</guimenu><guimenuitem>New Tab</guimenuitem></menuchoice>
+                               <menuchoice>
+                                       <guimenu>File</guimenu>
+                                       <guimenuitem>New Tab</guimenuitem>
+                               </menuchoice>
                                from the menu.</listitem>
                                <listitem>Close a tab by pressing
-                               <keycombo><keycap>Ctrl</keycap><keycap>W</keycap></keycombo> on the keyboard or selecting
-                               <menuchoice><guimenu>File</guimenu><guimenuitem>Close Tab</guimenuitem></menuchoice>
+                               <keycombo>
+                                       <keycap>Ctrl</keycap>
+                                       <keycap>W</keycap>
+                               </keycombo> on the keyboard or selecting
+                               <menuchoice>
+                                       <guimenu>File</guimenu>
+                                       <guimenuitem>Close Tab</guimenuitem>
+                               </menuchoice>
                                from the menu.</listitem>
                                <listitem>Switch tabs by pressing 
-                               <keycombo><keycap>Ctrl</keycap><keycap>Tab</keycap></keycombo>
+                               <keycombo>
+                                       <keycap>Ctrl</keycap>
+                                       <keycap>Tab</keycap>
+                               </keycombo>
                                on the keyboard or selecting the tab in the tab bar.</listitem>
                        </itemizedlist>
                </section>
index 1230f84..dcb78c8 100644 (file)
                                <primary>Apache</primary>
                        </indexterm>
                        <glossdef>
-                               <para>Open-source web server software used to serve both static content and
-                               dynamic web pages in a secure and reliable way. More information is available
-                               at <ulink url="http://apache.org">http://apache.org</ulink>.</para>
+                               <para>Open-source web server software used to serve both static
+                               content and dynamic web pages in a secure and reliable way. More
+                               information is available at 
+                               <ulink url="http://apache.org">http://apache.org</ulink>.</para>
                        </glossdef>
                </glossentry>
        </glossdiv>
                        </indexterm>
                        <glossdef>
                                <para>Bookbags are lists of items that can be used for any number of
-                               purposes. For example, to keep track of what books you have read, books you
-                               would like to read, to maintain a class reading list, to maintain a reading
-                               list for a book club, to keep a list of books you would like for your
-                               birthday. There are an unlimited number of uses.</para>
+                               purposes. For example, to keep track of what books you have read,
+                               books you would like to read, to maintain a class reading list, to
+                               maintain a reading list for a book club, to keep a list of books you
+                               would like for your birthday. There are an unlimited number of
+                               uses.</para>
                        </glossdef>
                </glossentry>
        </glossdiv>
                                <secondary>CentOS</secondary>
                        </indexterm>
                        <glossdef>
-                               <para>A popular open-source operating system based on Red Hat Enterprises
-                               <systemitem class="osname">Linux</systemitem> (a.k.a. "RHEL") and often used
-                               for in web servers. More information is available at <ulink url="http://www.centos.org">http://www.centos.org</ulink>.</para>
+                               <para>A popular open-source operating system based on Red Hat
+                               Enterprises <systemitem class="osname">Linux</systemitem>
+                               (a.k.a. "RHEL") and often used for in web servers. More 
+                               information is available at 
+                               <ulink url="http://www.centos.org">http://www.centos.org</ulink>.</para>
                        </glossdef>
                </glossentry>
                <glossentry id="closure">
                        <glossterm>Closure Compiler</glossterm>
                        <glossdef>
                                <para>A suite of open-source tools used to build web applications with
-                               <application>Javascript</application>; originally developed by Google. 
+                               <application>Javascript</application>; originally developed by Google.
+                               It is used to create special builds of the Evergreen Staff Client.
                                More information is available at 
                                <ulink url="http://code.google.com/closure/compiler/">
                                http://code.google.com/closure/compiler/</ulink>.</para>
@@ -69,6 +74,7 @@
                                <para>An open-source archive of software modules written in
                                <application>Perl</application>. More information is available at 
                                <ulink url="http://www.cpan.org">http://www.cpan.org</ulink>.</para>
+                               <glossseealso otherterm="Perl"/>
                        </glossdef>
                </glossentry>
        </glossdiv>
                        </indexterm>
                        <glossdef>
                                <para>One of the most popular open-source operating system using the
-                               <systemitem class="osname">Linux</systemitem> kernel that provides over 25000
-                               useful precompiled software packages. Also known as 
-                               <systemitem class="osname">Debian GNU/Linux</systemitem>. More information is 
-                               available at <ulink url="http://www.debian.org">http://www.debian.org</ulink>.</para>
+                               <systemitem class="osname">Linux</systemitem> kernel that provides
+                               over 25000 useful precompiled software packages. Also known as
+                               <systemitem class="osname">Debian GNU/Linux</systemitem>. More
+                               information is available at 
+                               <ulink url="http://www.debian.org">http://www.debian.org</ulink>.</para>
                        </glossdef>
                </glossentry>
                <glossentry>
                                <primary>domain name</primary>
                        </indexterm>
                        <glossdef>
-                               <para>A unique set of case-insensitive, alphanumeric strings separated by
-                               periods that are used to name organizations, web sites and addresses on the
-                               Internet (e.g.: <uri>www.esilibrary.com</uri>). Domain names can be reserved
-                               via third-party registration services, and can be associated with a unique IP
-                               address or suite of IP addresses.</para>
+                               <para>A unique set of case-insensitive, alphanumeric strings
+                               separated by periods that are used to name organizations, web sites
+                               and addresses on the Internet (e.g.:
+                               <uri>www.esilibrary.com</uri>). Domain names can be reserved via
+                               third-party registration services, and can be associated with a
+                               unique IP address or suite of IP addresses.</para>
                                <glossseealso otherterm="ipaddress"/>
                        </glossdef>
                </glossentry>
                                <primary>ejabberd</primary>
                        </indexterm>
                        <glossdef>
-                               <para>An open-source Jabber/XMPP instant messaging server that runs under popular
-                               operating systems (e.g., <systemitem class="osname">Mac OSX</systemitem>, 
-                               <systemitem class="osname">GNU/Linux</systemitem>, and
-                               <systemitem class="osname">Microsoft Windows</systemitem>). One popular use is
-                               to provide <application>XMPP</application> messaging services for a
-                               <application>Jabber</application> domain across an extendable cluster of
-                               cheap, easily-replaced machine nodes. More information is available at 
+                               <para>An open-source Jabber/XMPP instant messaging server that is
+                               used for client-server message passing within Evergreen. It runs
+                               under popular operating systems (e.g.,
+                               <systemitem class="osname">Mac OSX</systemitem>, 
+                               <systemitem class="osname">GNU/Linux</systemitem>, and 
+                               <systemitem class="osname">Microsoft Windows</systemitem>). One
+                               popular use is to provide <application>XMPP</application> messaging
+                               services for a <application>Jabber</application> domain across an
+                               extendable cluster of cheap, easily-replaced machine nodes. More
+                               information is available at 
                                <ulink url="http://www.ejabberd.im/">http://www.ejabberd.im</ulink>.</para>
                                <glossseealso otherterm="Jabber"/>
                                <glossseealso otherterm="XMPP"/>
                                <secondary>Gentoo</secondary>
                        </indexterm>
                        <glossdef>
-                               <para>A popular open-source operating system built on the 
-                               <systemitem class="osname">Linux</systemitem> kernel. More information is available 
-                               at <ulink url="http://www.gentoo.org">http://www.gentoo.org</ulink>.</para>
+                               <para>A popular open-source operating system built on the
+                               <systemitem class="osname">Linux</systemitem> kernel. More
+                               information is available at 
+                               <ulink url="http://www.gentoo.org">http://www.gentoo.org</ulink>.</para>
                        </glossdef>
                </glossentry>
        </glossdiv>
                                <primary>IP Address</primary>
                        </indexterm>
                        <glossdef>
-                               <para>(Internet Protocol address) A numerical label consisting of four numbers
-                               separated by periods (e.g., "192.168.1.15") assigned to individual members of
-                               networked computing systems. It uniquely identifies each system on the network
-                               and allows controlled communication between such systems. The numerical label
-                               scheme must adhere to a strictly defined naming convention that is currently
-                               defined and overseen by the Internet Corporation for Assigned Names and
-                               Numbers ("ICANN").</para>
+                               <para>(Internet Protocol address) A numerical label consisting of
+                               four numbers separated by periods (e.g., "192.168.1.15") assigned to
+                               individual members of networked computing systems. It uniquely
+                               identifies each system on the network and allows controlled
+                               communication between such systems. The numerical label scheme must
+                               adhere to a strictly defined naming convention that is currently
+                               defined and overseen by the Internet Corporation for Assigned Names
+                               and Numbers ("ICANN").</para>
                        </glossdef>
                </glossentry>
                <glossentry id="Item Buckets">
                                <seealso>copy buckets</seealso>
                        </indexterm>
                        <glossdef>
-                               <para>Virtual <quote>containers</quote> to use in batch processing of item or
-                               copy records. They can be used to perform various cataloging/holdings
-                               maintenance tasks in batch.</para>
+                               <para>Virtual <quote>containers</quote> to use in batch processing
+                               of item or copy records. They can be used to perform various
+                               cataloging/holdings maintenance tasks in batch.</para>
                        </glossdef>
                </glossentry>
        </glossdiv>
                                <seealso>XMPP</seealso>
                        </indexterm>
                        <glossdef>
-                               <para>Now known as XMPP (eXtensible Messaging and Presence Protocol), it was
-                               originally named "Jabber".</para>
+                               <para>The communications protocol used for client-server message
+                               passing within Evergreen. Now known as XMPP (eXtensible Messaging and
+                               Presence Protocol), it was originally named "Jabber".</para>
                                <glossseealso otherterm="XMPP"/>
+                               <glossseealso otherterm="ejabberd"/>
                        </glossdef>
                </glossentry>
        </glossdiv>
                                <primary>MARC</primary>
                        </indexterm>
                        <glossdef>
-                               <para>The MARC formats are standards for the representation and communication
-                               of bibliographic and related information in machine-readable form.</para>
+                               <para>The MARC formats are standards for the representation and
+                               communication of bibliographic and related information in
+                               machine-readable form.</para>
                        </glossdef>
                </glossentry>
                <glossentry id="MARCXML">
                <glossentry id="McCoy">
                        <glossterm>McCoy</glossterm>
                        <glossdef>
-                               <para>An open-source application that allows add-on authors to provide secure
-                               updates to their users. More information is available at 
-                               <ulink url="https://developer.mozilla.org/en/McCoy">
+                               <para>An open-source application that allows add-on authors to
+                               provide secure updates to their users. It is used to create special
+                               builds of the Evergreen Staff Client. More information is available
+                               at <ulink url="https://developer.mozilla.org/en/McCoy">
                                http://developer.mozilla.org/en/McCoy</ulink>.</para>
                        </glossdef>
                </glossentry>
                                <primary>memcached</primary>
                        </indexterm>
                        <glossdef>
-                               <para>A general-purpose distributed memory caching system, usually with a
-                               client~server architecture spread over multiple computing systems. It reduces
-                               the number of times a data source (e.g., a database) must be directly accessed
-                               by temporarily caching data in memory, therefore dramatically speeding up
-                               database-driven web applications.</para>
+                               <para>A general-purpose distributed memory caching system, usually
+                               with a client-server architecture spread over multiple computing
+                               systems. It reduces the number of times a data source (e.g., a
+                               database) must be directly accessed by temporarily caching data in
+                               memory, therefore dramatically speeding up database-driven web
+                               applications.</para>
                        </glossdef>
                </glossentry>
        </glossdiv>
                <glossentry id="nsis">
                        <glossterm>nsis</glossterm>
                        <glossdef>
-                               <para>An open-source software tool used to create Windows installers. 
-                               More information is available at 
-                               <ulink url="http://nsis.sourceforge.net">http://nsis.sourceforge.net</ulink>.</para>
+                               <para>An open-source software tool used to create Windows
+                               installers. It is used to create special builds of the Evergreen
+                               Staff Client. More information is available at
+                               <ulink url="http://nsis.sourceforge.net">
+                               http://nsis.sourceforge.net</ulink>.</para>
                        </glossdef>
                </glossentry>
        </glossdiv>
                                <primary>OPAC</primary>
                        </indexterm>
                        <glossdef>
-                               <para>The "Online Public Access Catalog"; an online database of a library's
-                               holdings; used to find resources in their collections; possibly searchable by
-                               keyword, title, author, subject or call number.</para>
+                               <para>The "Online Public Access Catalog"; an online database of a
+                               library's holdings; used to find resources in their collections;
+                               possibly searchable by keyword, title, author, subject or call
+                               number.</para>
                        </glossdef>
                </glossentry>
                <glossentry id="OpenSRF">
                                <primary>OpenSRF</primary>
                        </indexterm>
                        <glossdef>
-                               <para>The "Open Scalable Request Framework" (pronounced 'open surf') is a
-                               stateful, decentralized service architecture that allows developers to create
-                               applications for Evergreen with a minimum of knowledge of its
-                               structure.</para>
+                               <para>The "Open Scalable Request Framework" (pronounced 'open surf')
+                               is a stateful, decentralized service architecture that allows
+                               developers to create applications for Evergreen with a minimum of
+                               knowledge of its structure.</para>
                        </glossdef>
                </glossentry>
        </glossdiv>
        <glossdiv>
                <title>P</title>
+               <glossentry id="Perl">
+                       <glossterm>Perl</glossterm>
+                       <indexterm>
+                               <primary>Perl</primary>
+                       </indexterm>
+                       <glossdef>
+                               <para>The high-level scripting language in which most of the business logic of Evergreen is written.</para>
+                               <glossseealso otherterm="CPAN"/>
+                       </glossdef>
+               </glossentry>
                <glossentry id="PKI">
                        <glossterm>PKI</glossterm>
                        <indexterm>
                                <primary>PKI</primary>
                        </indexterm>
                        <glossdef>
-                               <para>Public Key Infrastructure (PKI) describes the schemes needed to generate
-                               and maintain digital SSL Certificates.</para>
+                               <para>Public Key Infrastructure (PKI) describes the schemes needed
+                               to generate and maintain digital SSL Certificates.</para>
                                <glossseealso otherterm="SSL Certificate"/>
                        </glossdef>
                </glossentry>
                                <secondary>PostgreSQL</secondary>
                        </indexterm>
                        <glossdef>
-                               <para>A popular open-source object-relational database management system that
-                               underpins Evergreen software.</para>
+                               <para>A popular open-source object-relational database management
+                               system that underpins Evergreen software.</para>
                        </glossdef>
                </glossentry>
                <glossentry id="putty">
-                       <glossterm>Putty</glossterm>
+                       <glossterm>PuTTY</glossterm>
                        <indexterm>
                                <primary>SSH</primary>
                                <secondary>Putty</secondary>
                        </indexterm>
                        <glossdef>
-                               <para>A popular open-source telnet/ssh client for the Windows and Unix
-                               platforms.  More information is available at
+                               <para>A popular open-source telnet/ssh client for the Windows and
+                               Unix platforms. As used in Evergreen, a handy utility used to create
+                               an SSH Tunnel for connecting Staff Clients to Evergreen servers over
+                               insecure networks. More information is available at
                                <ulink url="http://www.chiark.greenend.org.uk/~sgtatham/putty/">
                                http://www.chiark.greenend.org.uk/~sgtatham/putty/</ulink>.</para>
+                               <glossseealso otherterm="sshtunnel"/>
                        </glossdef>
                </glossentry>
        </glossdiv>
                <glossentry id="Resource Hacker">
                        <glossterm>Resource Hacker</glossterm>
                        <glossdef>
-                               <para>An open-source utility used to view, modify, rename, add, delete and
-                               extract resources in 32bit Windows executables.
-                               More information is available at
-                               <ulink url="http://www.angusj.com/resourcehacker/">Resource Hacker</ulink></para>
+                               <para>An open-source utility used to view, modify, rename, add,
+                               delete and extract resources in 32bit Windows executables. It is
+                               used to create special builds of the Evergreen Staff Client. More
+                               information is available at
+                               <ulink url="http://www.angusj.com/resourcehacker/">
+                               Resource Hacker</ulink></para>
                        </glossdef>
                </glossentry>
                <glossentry id="RHEL">
                        <glossdef>
                                <para>Also known as "Red Hat Enterprises 
                                <systemitem class="osname">Linux</systemitem>". An official 
-                               <systemitem class="osname">Linux</systemitem> distribution that is targeted 
-                               at  the commercial market. It is the basis of other popular 
-                               <systemitem class="osname">Linux</systemitem> distributions, e.g., 
-                               <systemitem class="osname">CentOS</systemitem>. More information is available
-                               at <ulink url="http://www.redhat.com">http://www.redhat.com</ulink>.</para>
+                               <systemitem class="osname">Linux</systemitem> distribution that is
+                               targeted at the commercial market. It is the basis of other popular
+                               <systemitem class="osname">Linux</systemitem> distributions, e.g.,
+                               <systemitem class="osname">CentOS</systemitem>. More information is
+                               available at 
+                               <ulink url="http://www.redhat.com">http://www.redhat.com</ulink>.</para>
                        </glossdef>
                </glossentry>
        </glossdiv>
                                <primary>SIP</primary>
                        </indexterm>
                        <glossdef>
-                               <para>SIP, standing for Standard Interchange Protocol, was developed by the 3M
-                               Corporation to be a common protocol for data transfer between ILS' and third party
-                               devices.</para>
+                               <para>SIP (Standard Interchange Protocol) is a communications
+                               protocol used within Evergreen to transfer data to and from other
+                               third party devices, such as RFID and barcode scanners that handle
+                               patron and library material information. Version 2.0 (also known as
+                               "SIP2") is the current standard. It was originally developed by the
+                               3M Corporation.</para>
                        </glossdef>
                </glossentry>
                <glossentry id="srfsh">
                        </indexterm>
                        <glossterm>srfsh</glossterm>
                        <glossdef>
-                               <para>A command language interpreter (shell) that executes commands read from the
-                               standard input. It is used to test the Open Service Request Framework (OpenSRF).</para>
+                               <para>A command language interpreter (shell) that executes commands
+                               read from the standard input. It is used to test the Open Service
+                               Request Framework (OpenSRF).</para>
                        </glossdef>
                </glossentry>
                <glossentry id="SRU">
                                <primary>SRU</primary>
                        </indexterm>
                        <glossdef>
-                               <para>SRU is a standard XML-focused search protocol for Internet search
-                               queries, utilizing CQL (Contextual Query Language), a standard syntax for
-                               representing queries.</para>
+                               <para>SRU is a standard XML-focused search protocol for Internet
+                               search queries, utilizing CQL (Contextual Query Language), a
+                               standard syntax for representing queries.</para>
                        </glossdef>
                </glossentry>
                <glossentry id="ssh">
                                <primary>SSH</primary>
                        </indexterm>
                        <glossdef>
-                               <para>An encrypted network protocol using public-key cryptography that allows
-                               secure communications between systems on an insecure network. Typically used
-                               to access shell accounts but also supports tunneling, forwarding TCP ports and
-                               X11 connections, and transferring files.</para>
+                               <para>An encrypted network protocol using public-key cryptography
+                               that allows secure communications between systems on an insecure
+                               network. Typically used to access shell accounts but also supports
+                               tunneling, forwarding TCP ports and X11 connections, and
+                               transferring files.</para>
                        </glossdef>
                </glossentry>
                <glossentry id="sshproxy">
                                <secondary>proxy</secondary>
                        </indexterm>
                        <glossdef>
-                               <para>As used in Evergreen, a method of allowing one or more Staff Clients to
-                               communicate with one or more Evergreen servers over an insecure network by
-                               sending data through a secure SSH tunnel. It also buffers and caches all data
-                               travelling to and from Staff Clients to speed up access to resources on
-                               Evergreen servers.</para>
+                               <para>As used in Evergreen, a method of allowing one or more Staff
+                               Clients to communicate with one or more Evergreen servers over an
+                               insecure network by sending data through a secure SSH tunnel. It
+                               also buffers and caches all data travelling to and from Staff
+                               Clients to speed up access to resources on Evergreen servers.</para>
                                <glossseealso otherterm="ssh"/>
                                <glossseealso otherterm="tunneling"/>
                                <glossseealso otherterm="sshtunnel"/>
                                <secondary>tunneling</secondary>
                        </indexterm>
                        <glossdef>
-                               <para>An encrypted data channel existing over an SSH network connection. Used
-                               to securely transfer unencrypted data streams over insecure networks.</para>
+                               <para>An encrypted data channel existing over an SSH network
+                               connection. Used to securely transfer unencrypted data streams over
+                               insecure networks.</para>
                                <glossseealso otherterm="ssh"/>
                                <glossseealso otherterm="tunneling"/>
                        </glossdef>
                                <primary>SSL</primary>
                        </indexterm>
                        <glossdef>
-                               <para>As used in Evergreen, it is a method of ensuring that Staff Clients are
-                               able to connect to legitimate Evergreen servers.</para>
-                               <para>In general, it is a special electronic document used to guarantee
-                               authenticity of a digital message. Also known as a "public key", or "identity"
-                               or "digital" certificate. It combines an identity (of a person or an
-                               organization) and a unique public key to form a so-called digital signature,
-                               and is used to verify that the public key does, in fact, belong with that
-                               particular identity.</para>
+                               <para>As used in Evergreen, it is a method of ensuring that Staff
+                               Clients are able to connect to legitimate Evergreen servers.</para>
+                               <para>In general, it is a special electronic document used to
+                               guarantee authenticity of a digital message. Also known as a "public
+                               key", or "identity" or "digital" certificate. It combines an
+                               identity (of a person or an organization) and a unique public key to
+                               form a so-called digital signature, and is used to verify that the
+                               public key does, in fact, belong with that particular
+                               identity.</para>
+                               <glossseealso otherterm="PKI"/>
                        </glossdef>
                </glossentry>
        </glossdiv>
                                <seealso>SSH tunneling</seealso>
                        </indexterm>
                        <glossdef>
-                               <para>As used in Evergreen, it is a method of allowing Staff Clients to securely
-                               connect to legitimate Evergreen servers.</para>
-                               <para>In general, it is a method of encapsulating data provided in one network
-                               protocol (the "delivery"protocol), within data in a different network protocol
-                               (the "tunneling" protocol). Used to provide a secure path and secure
-                               communications through an insecure or incompatible network. Can be used to
-                               bypass firewalls by communicating via a protocol the firewall normally blocks,
-                               but "wrapped" inside a protocol that the firewall does not block.</para>
+                               <para>As used in Evergreen, it is a method of allowing Staff Clients
+                               to securely connect to legitimate Evergreen servers.</para>
+                               <para>In general, it is a method of encapsulating data provided in
+                               one network protocol (the "delivery"protocol), within data in a
+                               different network protocol (the "tunneling" protocol). Used to
+                               provide a secure path and secure communications through an insecure
+                               or incompatible network. Can be used to bypass firewalls by
+                               communicating via a protocol the firewall normally blocks, but
+                               "wrapped" inside a protocol that the firewall does not block.</para>
                                <glossseealso otherterm="sshtunnel"/>
                        </glossdef>
                </glossentry>
                        </indexterm>
                        <glossdef>
                                <para>A popular open-source operating system using the 
-                               <systemitem class="osname">Linux</systemitem> kernel that was originally based on the
-                               <systemitem class="osname">Debian GNU/Linux</systemitem> operating system. 
-                               More information is available at
+                               <systemitem class="osname">Linux</systemitem> kernel that was
+                               originally based on the 
+                               <systemitem class="osname">Debian GNU/Linux</systemitem> 
+                               operating system. More information is available at 
                                <ulink url="http://www.ubuntu.com">http://www.ubuntu.com</ulink>.</para>
                                <glossseealso otherterm="Debian"/>
                        </glossdef>
                                <primary>virtualization</primary>
                        </indexterm>
                        <glossdef>
-                               <para>A method of executing software in a special environment that is partitioned or
-                               separated from the real underlying hardware and software resources. In typical usage, it
-                               allows a <emphasis>host</emphasis> operating system to encapsulate or emulate another
-                               operating system environment in such a way that the emulated environment is completely
-                               unaware of the hosting environment. For instance, it allows a 
-                               <systemitem class="osname">Linux</systemitem> application to execute within a 
+                               <para>A method of executing software in a special environment that
+                               is partitioned or separated from the real underlying hardware and
+                               software resources. In typical usage, it allows a
+                               <emphasis>host</emphasis> operating system to encapsulate or emulate
+                               another operating system environment in such a way that the emulated
+                               environment is completely unaware of the hosting environment. For
+                               instance, it allows a <systemitem class="osname">Linux</systemitem>
+                               application to execute within a 
                                <systemitem class="osname">Windows</systemitem> environment.</para>
                        </glossdef>
                </glossentry>
                                <secondary>VirtualBox</secondary>
                        </indexterm>
                        <glossdef>
-                               <para>A popular commercial package of virtualization software that emulates the x86
-                               microprocessor architecture. It can be installed on
-                               <systemitem class="osname">Linux</systemitem>, <systemitem class="osname">Mac OS X</systemitem>,
+                               <para>A popular commercial package of virtualization software that
+                               emulates the x86 microprocessor architecture. It can be installed on
+                               <systemitem class="osname">Linux</systemitem>,
+                               <systemitem class="osname">Mac OS X</systemitem>,
                                <systemitem class="osname">Windows</systemitem> or 
-                               <systemitem class="osname">Solaris</systemitem> "host" operating systems and allows 
-                               other "guest" (typically including <systemitem class="osname">Linux</systemitem> and 
-                               <systemitem class="osname">Windows</systemitem>) operating systems to be loaded and executed.</para>
+                               <systemitem class="osname">Solaris</systemitem> "host" operating
+                               systems and allows other "guest" (typically including 
+                               <systemitem class="osname">Linux</systemitem> and 
+                               <systemitem class="osname">Windows</systemitem>) operating systems
+                               to be loaded and executed.</para>
                                <glossseealso otherterm="virtualization"/>
                        </glossdef>
                </glossentry>
                                <secondary>Virtual PC</secondary>
                        </indexterm>
                        <glossdef>
-                               <para>A popular commercial package of virtualization software that emulates the x86
-                               microprocessor architecture. It is installed on a Windows "host" operating system and
-                               allows other "guest" (typically including <systemitem class="osname">Linux</systemitem>
-                               and <systemitem class="osname">Windows</systemitem>) operating systems to be loaded and
-                               executed.</para>
+                               <para>A popular commercial package of virtualization software that
+                               emulates the x86 microprocessor architecture. It is installed on a
+                               Windows "host" operating system and allows other "guest" (typically
+                               including <systemitem class="osname">Linux</systemitem> and
+                               <systemitem class="osname">Windows</systemitem>) operating systems
+                               to be loaded and executed.</para>
                                <glossseealso otherterm="virtualization"/>
                        </glossdef>
                </glossentry>
                                <primary>volume buckets</primary>
                        </indexterm>
                        <glossdef>
-                               <para>Virtual <quote>containers</quote> to use in batch processing of multiple
-                               volumes. They can be used to perform various cataloging/holdings maintenance
-                               tasks in batch.</para>
+                               <para>Virtual <quote>containers</quote> to use in batch processing
+                               of multiple volumes. They can be used to perform various
+                               cataloging/holdings maintenance tasks in batch.</para>
                        </glossdef>
                </glossentry>
                <glossentry id="vmware">
                                <secondary>VMware</secondary>
                        </indexterm>
                        <glossdef>
-                               <para>A popular commercial package of virtualization software that emulates the x86
-                               microprocessor architecture. It can be installed on
+                               <para>A popular commercial package of virtualization software that
+                               emulates the x86 microprocessor architecture. It can be installed on
                                <systemitem class="osname">Linux</systemitem>, 
                                <systemitem class="osname">Mac OS X</systemitem>,
                                <systemitem class="osname">Windows</systemitem> or 
-                               <systemitem class="osname">Solaris</systemitem> "host" operating systems and
-                               allows other "guest" (typically including 
+                               <systemitem class="osname">Solaris</systemitem> "host" operating systems 
+                               and allows other "guest" (typically including 
                                <systemitem class="osname">Linux</systemitem> and 
-                               <systemitem class="osname">Windows</systemitem>) operating systems to be
-                               loaded and executed.</para>
+                               <systemitem class="osname">Windows</systemitem>) operating systems 
+                               to be loaded and executed.</para>
                                <glossseealso otherterm="virtualization"/>
                        </glossdef>
                </glossentry>
                                <para>A popular open-source application that allows
                                <systemitem class="osname">Linux</systemitem> and 
                                <systemitem class="osname">Unix</systemitem>
-                               systems to run <systemitem class="osname">Windows</systemitem> executables. 
-                               More information is available at 
+                               systems to run <systemitem class="osname">Windows</systemitem> 
+                               executables. More information is available at 
                                <ulink url="http://www.winehq.org/">http://www.winehq.org/</ulink>.</para>
                        </glossdef>
                </glossentry>
                                <primary>XML</primary>
                        </indexterm>
                        <glossdef>
-                               <para>The eXtensible Markup Language, a subset of SGML; a set of rules for
-                               encoding information in a way that is both human- and machine-readable. It is
-                               primarily used to define documents but can also be used to define arbitrary
-                               data structures. It was originally defined by the World Wide Web Consortium
-                               (W3C).</para>
+                               <para>The eXtensible Markup Language, a subset of SGML; a set of
+                               rules for encoding information in a way that is both human- and
+                               machine-readable. It is primarily used to define documents but can
+                               also be used to define arbitrary data structures. It was originally
+                               defined by the World Wide Web Consortium (W3C).</para>
                        </glossdef>
                </glossentry>
                <glossentry id="XMPP">
                                <seealso>jabber</seealso>
                        </indexterm>
                        <glossdef>
-                               <para>An open-standard communications protocol, based on XML, used in
-                               message-oriented middleware. It supports the concept of a consistent
-                               <emphasis>domain</emphasis> of message types that flow between software
-                               applications, possibly on different operating systems and architectures. 
-                               More information is available at 
-                               <ulink url="http://xmpp.org">http://xmpp.org</ulink>.</para>
+                               <para>The open-standard communications protocol (based on XML) used
+                               for client-server message passing within Evergreen. It supports the
+                               concept of a consistent <emphasis>domain</emphasis> of message types
+                               that flow between software applications, possibly on different
+                               operating systems and architectures. More information is available
+                               at <ulink url="http://xmpp.org">http://xmpp.org</ulink>.</para>
                                <glossseealso otherterm="Jabber"/>
+                               <glossseealso otherterm="ejabberd"/>
                        </glossdef>
                </glossentry>
                <glossentry id="xpath">
                                <primary>xpath</primary>
                        </indexterm>
                        <glossdef>
-                               <para>The XML Path Language, a query language based on a tree representation
-                               of an XML document. It is used to programmatically select nodes from an XML
-                               document and to do minor computation involving strings, numbers and Boolean
-                               values. It allows you to identify parts of the XML document tree, to navigate
-                               around the tree, and to uniquely select nodes. The currently version is "XPath
-                               2.0". It was originally defined by the World Wide Web Consortium (W3C).</para>
+                               <para>The XML Path Language, a query language based on a tree
+                               representation of an XML document. It is used to programmatically
+                               select nodes from an XML document and to do minor computation
+                               involving strings, numbers and Boolean values. It allows you to
+                               identify parts of the XML document tree, to navigate around the
+                               tree, and to uniquely select nodes. The currently version is "XPath
+                               2.0". It was originally defined by the World Wide Web Consortium
+                               (W3C).</para>
                        </glossdef>
                </glossentry>
                <glossentry id="xul">
                                <primary>xUL</primary>
                        </indexterm>
                        <glossdef>
-                               <para>The XML User Interface Language, a specialized interface language that allows
-                               building cross-platform applications that drive <application>Mozilla</application>
-                               -based browsers such as <application>Firefox</application>. More information is
-                               available at 
+                               <para>The XML User Interface Language, a specialized interface
+                               language that allows building cross-platform applications that drive
+                               <application>Mozilla</application>-based browsers such as
+                               <application>Firefox</application>. More information is available at
                                <ulink url="https://developer.mozilla.org/en/XUL">
                                https://developer.mozilla.org/en/XUL</ulink>.</para>
                        </glossdef>
                                <primary>XULRunner</primary>
                        </indexterm>
                        <glossdef>
-                               <para>A specialized run-time application environment that provides support for
-                               installing, upgrading and uninstalling <application>XUL</application>
-                               applications. It operates with <application>Mozilla</application>-based
-                               applications such as the <application>Firefox</application> browser. 
-                               More information is available at
+                               <para>A specialized run-time application environment that provides
+                               support for installing, upgrading and uninstalling
+                               <application>XUL</application> applications. It operates with
+                               <application>Mozilla</application>-based applications such as the
+                               <application>Firefox</application> browser. More information is
+                               available at
                                <ulink url="https://developer.mozilla.org/en/XULRunner">
                                https://developer.mozilla.org/en/XULRunner</ulink>.</para>
                                <glossseealso otherterm="xul"/>
                                <primary>yaz</primary>
                        </indexterm>
                        <glossdef>
-                               <para>A programmers’ toolkit supporting the development of Z39.50/SRW/SRU
-                               clients and servers.</para>
+                               <para>A programmers’ toolkit supporting the development of
+                               Z39.50/SRW/SRU clients and servers.</para>
                        </glossdef>
                </glossentry>
                <glossentry id="yaz-client">
                        <glossdef>
                                <para>Z39.50/SRU client for connecting to YAZ servers. 
                                More information is available at 
-                               <ulink url="http://www.indexdata.com/yaz">http://www.indexdata.com/yaz</ulink></para>
+                               <ulink url="http://www.indexdata.com/yaz">
+                               http://www.indexdata.com/yaz</ulink></para>
                        </glossdef>
                </glossentry>
        </glossdiv>
                                <primary>Z39.50</primary>
                        </indexterm>
                        <glossdef>
-                               <para>A client–server protocol for searching and retrieving information from
-                               remote computer databases.</para>
+                               <para>A client–server protocol for searching and retrieving
+                               information from remote computer databases.</para>
                        </glossdef>
                </glossentry>
        </glossdiv>