From 6cfe1547e8b30815518583c55d6fd723d95abc8e Mon Sep 17 00:00:00 2001 From: Robert Soulliere Date: Wed, 3 Nov 2010 15:42:11 -0400 Subject: [PATCH] DocBook formmating. Add some glassary definitions. --- 1.6/admin/staffclientinstallation.xml | 437 ++++++++++--------- 1.6/appendices/glossary.xml | 779 ++++++++++++++++++---------------- 2 files changed, 625 insertions(+), 591 deletions(-) diff --git a/1.6/admin/staffclientinstallation.xml b/1.6/admin/staffclientinstallation.xml index 5df07af..05c46be 100644 --- a/1.6/admin/staffclientinstallation.xml +++ b/1.6/admin/staffclientinstallation.xml @@ -112,9 +112,9 @@ The Staff Client data from the directory ./staff_client/build must be placed somewhere on the machine (e.g. ~/Desktop/Evergreen_Staff_Client). Remember to call XULRunner with the full path to the binary, followed by the install command and the path to the client data: - - /Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client - + +/Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client + This command should exit quietly. The folder /Applications/OpenILS will be created, containing a launcher named open_ils_staff_client. @@ -129,10 +129,10 @@ Flush Receiptdb file: First, get the package identifier, then purge/forget the build that was initially installed: - - sudo pkgutil --pkgs > /tmp/pkgs.txt - sudo pkgutil --forget org.mozilla.xulrunner - + +sudo pkgutil --pkgs > /tmp/pkgs.txt +sudo pkgutil --forget org.mozilla.xulrunner + It may not be necessary to edit the file /Library/Receipts/InstallHistory.plist after deleting the folder XUL.framework. See @@ -150,75 +150,74 @@ * MacOS Create an APP folder structure with the following commands: - - mkdir -p Evergreen.app/Contents/Frameworks - mkdir -p Evergreen.app/Contents/Resources - mkdir -p Evergreen.app/Contents/MacOS - + +mkdir -p Evergreen.app/Contents/Frameworks +mkdir -p Evergreen.app/Contents/Resources +mkdir -p Evergreen.app/Contents/MacOS + Create a new file in the folder Evergreen.app/Contents/Info.plist containing the following data (adjust for your version of Evergreen): - - - - - CFBundleExecutable - xulrunner - CFBundleGetInfoString - OpenILS open_ils_staff_client rel_1_6_0_7 - CFBundleInfoDictionaryVersion - 6.0 - CFBundleName - Evergreen Staff Client - CFBundlePackageType - APPL - CFBundleShortVersionString - rel_1_6_0_7 - CFBundleVersion - rel_1_6_0_7.rel_1_6_0_7 - NSAppleScriptEnabled - - CFBundleTypeIconFile - Evergreen.icns - - - ]]> - + + + + + CFBundleExecutable + xulrunner + CFBundleGetInfoString + OpenILS open_ils_staff_client rel_1_6_0_7 + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + Evergreen Staff Client + CFBundlePackageType + APPL + CFBundleShortVersionString + rel_1_6_0_7 + CFBundleVersion + rel_1_6_0_7.rel_1_6_0_7 + NSAppleScriptEnabled + + CFBundleTypeIconFile + Evergreen.icns + + +]]> Download and install an appropriate Mac OS package of XULRunner from the Mozilla website (see above for recommendations). Make a copy of the folder /Library/Frameworks/XUL.Framework inside your APP file. It should look something like this: - - * Evergreen.app/ - __* Contents/ - ____* Frameworks/ - ______* XUL.Framework/ - ______* Versions/ - ________* Current -> 1.9.1.3 (symlink) - ________* 1.9.1.3/ - ______* XUL -> Versions/Current/XUL - ______* libxpcom.dylib -> Versions/Current/libxpcom.dylib - ______* xulrunner-bin -> Versions/Current/xulrunner-bin - + +* Evergreen.app/ +__* Contents/ +____* Frameworks/ +______* XUL.Framework/ +______* Versions/ +________* Current -> 1.9.1.3 (symlink) +________* 1.9.1.3/ +______* XUL -> Versions/Current/XUL +______* libxpcom.dylib -> Versions/Current/libxpcom.dylib +______* xulrunner-bin -> Versions/Current/xulrunner-bin + Copy XUL.Framework/Versions/Current/xulrunner into the folder Evergreen.app/MacOS (do not symlink; copy the file). Make Evergreen.app/Resources the root of your Evergreen application files like this: - - * Evergreen.app/ - __* Contents/ - ____* Resources/ - ______* BUILD_ID - ______* application.ini - ______* chrome/ - ______* components/ - ______* etc. - + +* Evergreen.app/ +__* Contents/ +____* Resources/ +______* BUILD_ID +______* application.ini +______* chrome/ +______* components/ +______* etc. + Put a Mac format icon file named Evergreen.icns in Resources. @@ -236,35 +235,35 @@ in the following example. As the opensrf user, change directory to the Staff Client source directory, then recursively copy the entire directory tree to the remote workstation: - - su - opensrf - cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client - scp -r build user@client.linux.machine:~/eg-client-x.x.x.x/ - + +su - opensrf +cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client +scp -r build user@client.linux.machine:~/eg-client-x.x.x.x/ + To test the newly copied Staff Client, as the opensrf user log into the remote workstation and execute it as shown: - - su - opensrf - xulrunner ~/eg-client-x.x.x.x/build/application.ini - + +su - opensrf +xulrunner ~/eg-client-x.x.x.x/build/application.ini + Building the Staff Client on the Server A Linux Staff Client is automatically built on the server as part of the normal make install process for Evergreen server-side software, using a procedure similar to this: - - cd ~/ILS/Open-ILS/xul/staff_client - make STAFF_CLIENT_BUILD_ID='12345' - mkdir /openils/var/web/xul/ - mkdir /openils/var/web/xul/12345/ - cd build/ - cp -R server/ /openils/var/web/xul/12345/ - + +cd ~/ILS/Open-ILS/xul/staff_client +make STAFF_CLIENT_BUILD_ID='12345' +mkdir /openils/var/web/xul/ +mkdir /openils/var/web/xul/12345/ +cd build/ +cp -R server/ /openils/var/web/xul/12345/ + The Staff Client can be run from the build directory using this command: - - su - opensrf - xulrunner application.ini - + +su - opensrf +xulrunner application.ini + In order to install a compatible Staff Client on another Linux system, just copy the applicable files from the server to that system, or even manually build it on that system. Ensure that the BUILD_ID you choose on the server matches the BUILD_ID for each Staff Client you use on other systems. If you will be using a pre-packaged Windows version on some systems, you may want to choose the BUILD_ID on both server and other versions to match that @@ -273,11 +272,11 @@ If you are allowed to make changes on the Evergreen server, another option is to create a symbolic link. In order for a copy of the Staff Client and server to work together, the BUILD_ID must match the name of the directory containing the server components of the Staff Client, or the name of a symbolic link to that directory. - - su - root - cd /openils/var/web/xul - ln -s SERVER_BUILD_ID/ CLIENT_BUILD_ID - + +su - root +cd /openils/var/web/xul +ln -s SERVER_BUILD_ID/ CLIENT_BUILD_ID + Building the Staff Client on the client Machine @@ -293,10 +292,10 @@ subversion and xulrunner. You can also use synaptic, the graphical user interface for apt-get. For subversion, select the latest version; for xulrunner, select version 1.8.1.4-2ubuntu5. - - sudo apt-get install subversion - sudo apt-get install xulrunner - + +sudo apt-get install subversion +sudo apt-get install xulrunner + Download the Source Code @@ -320,11 +319,11 @@ As the opensrf user, open a terminal (command-line prompt) and navigate 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: - - su - opensrf - cd /YOUR/DOWNLOAD/DIRECTORY - svn co rel_1_2_1_4/ - + +su - opensrf +cd /YOUR/DOWNLOAD/DIRECTORY +svn co rel_1_2_1_4/ + Remember to change "rel_1_6_1_2" to the appropriate tag for your installation. @@ -340,12 +339,12 @@ determine whether or not a connecting client is supported. For instance, for the PINES installation (version 1.2.1.4) the supported BUILD_ID is "rel_1_2_1_4". Modify the following commands accordingly. As the opensrf user, run the following commands to build the Staff Client: - - su - opensrf - cd /YOUR/DOWNLOAD/DIRECTORY - cd Open-ILS/xul/staff_client - make STAFF_CLIENT_BUILD_ID='rel_1_6_1_2' - + +su - opensrf +cd /YOUR/DOWNLOAD/DIRECTORY +cd Open-ILS/xul/staff_client +make STAFF_CLIENT_BUILD_ID='rel_1_6_1_2' + @@ -353,10 +352,10 @@ Run the Staff Client (from the command line) As the opensrf user, navigate to the build/ subdirectory (not staff_client/) and run the following command: - - su - opensrf - xulrunner application.ini - + +su - opensrf +xulrunner application.ini + Cleaning Up / Creating Shortcuts @@ -364,21 +363,21 @@ to remove them to save space, or to create a clean directory containing the built Staff Client that can be copied to other machines. As the opensrf user, issue the following commands to create a clean "staging" directory in which to place the finished Staff Client, and to copy into it the "staff_client" directory: - - su - opensrf - mkdir ~/<Destination Directory> - cd ~/<Download Directory>/Open-ILS/xul/ - cp -r staff_client ~/<Destination Directory> - + +su - opensrf +mkdir ~/<Destination Directory> +cd ~/<Download Directory>/Open-ILS/xul/ +cp -r staff_client ~/<Destination Directory> + Finally, test the Staff Client to verify that all the necessary files were moved to the destination directory: - - cd ~/<Destination Directory>/staff_client/build - xulrunner application.ini - + +cd ~/<Destination Directory>/staff_client/build +xulrunner application.ini + If there were no problems, then finish the cleanup by removing the original download directory and all subdirectories: - - rm -r -f ~/<Download Directory> - + +rm -r -f ~/<Download Directory> + You may wish to create DesktopStart MenuK-Menu shortcuts for the Staff Client using the command xulrunner ~/<Destination Directory>/staff_client/build/application.ini as the target. @@ -396,29 +395,29 @@ Install wine - - sudo apt-get install wine - + +sudo apt-get install wine + Download Windows installer for the Staff Client As the opensrf user, run the following commands to download the Windows installer for the proper Staff Client from the open-ils.org website and place it in a temporary directory: - - su - opensrf - cd /YOUR/DOWNLOAD/DIRECTORY - wget http://open-ils.org/downloads/evergreen-setup-rel_version-number.exe - + +su - opensrf +cd /YOUR/DOWNLOAD/DIRECTORY +wget http://open-ils.org/downloads/evergreen-setup-rel_version-number.exe + Run the downloaded Windows installer As the opensrf user, navigate to the directory where you downloaded the Windows executable file, then execute it: - - su - opensrf - cd /YOUR/DOWNLOAD/DIRECTORY - wine evergreen-setup-rel_version-number.exe - + +su - opensrf +cd /YOUR/DOWNLOAD/DIRECTORY +wine evergreen-setup-rel_version-number.exe + If this step fails, you may need to configure Wine first to properly emulate Windows XP. To do so, type "winecfg" from the command line; in the "Applications" tab of the window that pops up, select "Default Settings" and choose "Windows XP" from the drop-down menu, then click Apply. @@ -481,19 +480,19 @@ During the normal make install Evergreen server-side software build process, the variable defaults to an automatically generated date/time string, but you can also override the value of BUILD_ID. The following commands could be used during the normal build process: - - su - root - cd /home/opensrf/[Evergreen Install Directory] - make STAFF_CLIENT_BUILD_ID=[version ID] install - + +su - root +cd /home/opensrf/[Evergreen Install Directory] +make STAFF_CLIENT_BUILD_ID=[version ID] install + The following commands will manually build the Staff Client using a different BUILD_ID. As the opensrf user, change directory to the Staff Client source directory, then set the variable and build the Staff Client: - - su - opensrf - cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client - make STAFF_CLIENT_BUILD_ID=my_test_id build - + +su - opensrf +cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client +make STAFF_CLIENT_BUILD_ID=my_test_id build + Option STAFF_CLIENT_VERSION @@ -501,43 +500,43 @@ in the Evergreen source root. The variable defaults to 0trunk.revision, where the value of "revision" is automatically generated. You can override the value of VERSION similarly to the BUILD_ID. The following commands could be used during the normal build process: - - su - root - cd /home/opensrf/[Evergreen Install Directory] - make STAFF_CLIENT_VERSION=0mytest.200 install - + +su - root +cd /home/opensrf/[Evergreen Install Directory] +make STAFF_CLIENT_VERSION=0mytest.200 install + The following commands will manually build the Staff Client using a different VERSION. If you plan to make extensions update automatically, the VERSION needs to conform to the format recommended in Toolkit Version Format and newer versions need to be "higher" than older versions. As the opensrf user, change directory to the Staff Client source directory, then set the variable and build the Staff Client: - - su - opensrf - cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client - make STAFF_CLIENT_VERSION=0mytest.200 build - + +su - opensrf +cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client +make STAFF_CLIENT_VERSION=0mytest.200 build + Option STAFF_CLIENT_STAMP_ID variable During the normal make install Evergreen server-side software build process, this variable is generated from STAFF_CLIENT_VERSION. You can override the value of STAMP_ID similarly to the BUILD_ID. The following commands could be used during the normal build process: - - su - root - cd /home/opensrf/[Evergreen Install Directory] - make STAFF_CLIENT_STAMP_ID=my_test_stamp install - + +su - root +cd /home/opensrf/[Evergreen Install Directory] +make STAFF_CLIENT_STAMP_ID=my_test_stamp install + The following commands will manually build the Staff Client using a different STAMP_ID. It is possible to have multiple versions of the Staff Client by specifying a different STAMP_ID for each, possibly for different uses or client-side customizations. As the opensrf user, change directory to the Staff Client source directory, then set the variable and build the Staff Client: - - su - opensrf - cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client - make STAFF_CLIENT_STAMP_ID=my_test_stamp build - + +su - opensrf +cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client +make STAFF_CLIENT_STAMP_ID=my_test_stamp build + @@ -616,11 +615,11 @@ You can create a so-called "developer build" of the Staff Client by substituting "devbuild" for "build" when running make. The build will contain an extra configuration file that enables some developer options. As the opensrf user, run make from the Staff Client source directory: - - su - opensrf - cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client - make devbuild - + +su - opensrf +cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client +make devbuild + Compressed Javascript @@ -628,38 +627,38 @@ by substituting for "build" when running make. For more information see Google Closure Compiler. As the opensrf user, run the following commands from the Staff Client source directory: - - su - opensrf - cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client - make compress-javascript - + +su - opensrf +cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client +make compress-javascript + You can also combine Javascript review and compression, and also perform a "developer build". As the opensrf user, run the following commands from the Staff Client source directory: In the following make below, the order of options is important! - - su - opensrf - cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client - make devbuild compress-javascript - + +su - opensrf +cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client +make devbuild compress-javascript + Automatic Update Host The host used to check for automatic Staff Client updates can be overridden by specifying the option. The following commands could have been used during the normal build process: - - su - root - cd /home/opensrf/[Evergreen Install Directory] - make AUTOUPDATE_HOST=localhost install - + +su - root +cd /home/opensrf/[Evergreen Install Directory] +make AUTOUPDATE_HOST=localhost install + You can manually set to set up automatic update checking. The following commands will manually build the Staff Client using a different . As the opensrf user, change directory to the Staff Client source directory, then set the variable and build the Staff Client: - - su - opensrf - cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client - make AUTOUPDATE_HOST=localhost build - + +su - opensrf +cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client +make AUTOUPDATE_HOST=localhost build + For more information on Automatic Updates, see . @@ -671,12 +670,12 @@ option of installing the Staff Client on the same machine it was built on, or on a different machine. Assuming you have already built the Staff Client, and that your installation is in the directory /openils/var/web/xul, as the opensrf user, change directory to the Staff Client source directory, then execute the following commands: - - su - opensrf - cd /home/opensrf/[Evergreen Install Directory]/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)" - + +su - opensrf +cd /home/opensrf/[Evergreen Install Directory]/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)" + Packaging the Staff Client @@ -690,11 +689,11 @@ suitable for use with the xulrunner parameter >. As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: - - su - opensrf - cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client - make generic-client - + +su - opensrf +cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client +make generic-client + Packaging a Windows Client @@ -728,11 +727,11 @@ As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: - - su - opensrf - cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client - make win-client - + +su - opensrf +cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client +make win-client + Packaging a Linux Client @@ -740,11 +739,11 @@ creates the output file "evergreen_staff_client.tar.bz2". As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: - - su - opensrf - cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client - make linux-client - + +su - opensrf +cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client +make linux-client + Packaging a Firefox Extension @@ -752,11 +751,11 @@ as a Firefox extension and creates the output file evergreen.xpi. As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: - - su - opensrf - cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client - make extension - + +su - opensrf +cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client +make extension + @@ -790,12 +789,12 @@ At configuration time for the normal build of Evergreen server-side software This must be done when the Evergreen server-side software is first configured (see ). As the opensrf user, use the utility "configure" as shown: - - su - opensrf - cd /home/opensrf/[Evergreen Install Directory] - ./configure --prefix=/openils --sysconfdir=/openils/conf --with-updateshost=hostname - make - + +su - opensrf +cd /home/opensrf/[Evergreen Install Directory] +./configure --prefix=/openils --sysconfdir=/openils/conf --with-updateshost=hostname +make + During a manual Staff Client build process diff --git a/1.6/appendices/glossary.xml b/1.6/appendices/glossary.xml index 22077d6..d832a1a 100644 --- a/1.6/appendices/glossary.xml +++ b/1.6/appendices/glossary.xml @@ -1,372 +1,407 @@ - - - Glossary - - In this section we expand acronyms, define terms, and generally try to explain concepts used by Evergreen software. - - - A - - Apache - - 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 apache.org. - - - - - B - - Book Bags - - PLEASE ADD CONTENT - - - - - C - - Closure Compiler - - A suite of open-source tools used to build web applications with Javascript; originally developed by Google. More information is available at http://code.google.com/closure/compiler/. - - - - CPAN - - An open-source archive of software modules written in Perl. More information is available at www.cpan.org. - - - - - D - - Debian - - One of the most popular open-source operating system using the Linux kernel that provides over 25000 useful precompiled software packages. Also known as Debian GNU/Linux. More information is available at www.debian.org. - - - - Domain name - - 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.: www.esilibrary.com). Domain names can be reserved via third-party registration services, and can be associated with a unique IP address or suite of IP addresses. - - - - - - E - - ejabberd - - An open-source Jabber/XMPP instant messaging server that runs under popular operating systems (e.g., Mac OSX, GNU/Linux, and Microsoft Windows). One popular use is to provide XMPP messaging services for a Jabber domain across an extendable cluster of cheap, easily-replaced machine nodes. More information is available at http://www.ejabberd.im. - - - - - - - F - - - - G - - - - H - - - - I - - IP Address - - (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"). - - - - Item Buckets - - PLEASE ADD CONTENT - - - - - J - - Jabber - - Now known as XMPP (eXtensible Messaging and Presence Protocol), it was originally named "Jabber". - - - - - - K - - - - L - - - - M - - MARC - - PLEASE ADD CONTENT - - - - MARCXML - - PLEASE ADD CONTENT - - - - McCoy - - An open-source application that allows add-on authors to provide secure updates to their users. More information is available at developer.mozilla.org/en/McCoy. - - - - memcached - - 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. - - - - - N - - Network address - - Also known as an IP address (Internet Protocol address). - - - - - nsis - - An open-source software tool used to create Windows installers. More information is available at http://nsis.sourceforge.net. - - - - - O - - OPAC - - 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. - - - - OpenSRF - - 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. - - - - - P - - PostgreSQL - - A popular open-source object-relational database management system that underpins Evergreen software. - - - - Putty - - A popular open-source telnet/ssh client for the Windows and Unix platforms. More information is available at http://www.chiark.greenend.org.uk/~sgtatham/putty/. - - - - - Q - - - - R - - Resource Hacker - - An open-source utility used to view, modify, rename, add, delete and extract resources in 32bit Windows executables - - - - - S - - SIP2 - - PLEASE ADD CONTENT - - - - srfsh - - A command language interpreter (shell) that executes commands read from the standard input. It is used to test the Open Service Request Framework (OpenSRF). - - - - SRU - - PLEASE ADD CONTENT - - - - SSH - - 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. - - - - SSH proxy - - 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. - - - - - - - SSH tunnel - - An encrypted data channel existing over an SSH network connection. Used to securely transfer unencrypted data streams over insecure networks. - - - - - - SSL Certificate - - 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. - - - - - T - - tunneling - - 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. - - - - - - U - - Ubuntu - - A popular open-source operating system using the Linux kernel that was originally based on the Debian GNU/Linux operating system. More information is available at www.ubuntu.com. - - - - - - V - - Virtualization - - 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 "host" 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 Linux application to execute within a Windows environment. - - - - VirtualBox - - A popular commercial package of virtualization software that emulates the x86 microprocessor architecture. It can be installed on Linux, Mac OS X, Windows or Solaris "host" operating systems and allows other "guest" (typically including Linux and Windows) operating systems to be loaded and executed. - - - - - Virtual PC - - 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 Linux and Windows) operating systems to be loaded and executed. - - - - - Volume Buckets - - PLEASE ADD CONTENT - - - - VMware - - A popular commercial package of virtualization software that emulates the x86 microprocessor architecture. It can be installed on Linux, Mac OS X, Windows or Solaris "host" operating systems and allows other "guest" (typically including Linux and Windows) operating systems to be loaded and executed. - - - - - - W - - Wine - - A popular open-source application that allows Linux and Unix systems to run Windows executables. More information is available at http://www.winehq.org/. - - - - - X - - XML - - 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). - - - - XMPP - - An open-standard communications protocol, based on XML, used in message-oriented middleware. It supports the concept of a consistent "domain" of message types that flow between software applications, possibly on different operating systems and architectures. More information is available at xmpp.org. - - - - - xpath - - 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). - - - - XUL - - The XML User Interface Language, a specialized interface language that allows building cross-platform applications that drive Mozilla-based browsers such as Firefox. More information is available at https://developer.mozilla.org/en/XUL. - - - - xulrunner - - A specialized run-time application environment that provides support for installing, upgrading and uninstalling XUL applications. It operates with Mozilla-based applications such as the Firefox browser. More information is available at https://developer.mozilla.org/en/XULRunner. - - - - - - Y - - YAZ - - PLEASE ADD CONTENT - - - - yaz-client - - PLEASE ADD CONTENT - - - - - Z - - Z39.50 - - PLEASE ADD CONTENT - - - - + + + Glossary + + In this section we expand acronyms, define terms, and generally try to explain concepts used by Evergreen software. + + + A + + Apache + + 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 apache.org. + + + + + B + + Bookbags + + 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. + + + + + C + + Closure Compiler + + A suite of open-source tools used to build web applications with Javascript; originally developed by Google. More information is available at http://code.google.com/closure/compiler/. + + + + CPAN + + An open-source archive of software modules written in Perl. More information is available at www.cpan.org. + + + + + D + + Debian + + One of the most popular open-source operating system using the Linux kernel that provides over 25000 useful precompiled software packages. Also known as Debian GNU/Linux. More information is available at www.debian.org. + + + + Domain name + + 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.: www.esilibrary.com). Domain names can be reserved via third-party registration services, and can be associated with a unique IP address or suite of IP addresses. + + + + + + E + + ejabberd + + An open-source Jabber/XMPP instant messaging server that runs under popular operating systems (e.g., Mac OSX, GNU/Linux, and Microsoft Windows). One popular use is to provide XMPP messaging services for a Jabber domain across an extendable cluster of cheap, easily-replaced machine nodes. More information is available at http://www.ejabberd.im. + + + + + + + F + + + + G + + + + H + + + + I + + IP Address + + (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"). + + + + Item/copy Buckets + + Virtual containers to use in batch processing of item or copy records. They can be used to perform various cataloging/holdings maintenance tasks + in batch. + + + + + J + + Jabber + + Now known as XMPP (eXtensible Messaging and Presence Protocol), it was originally named "Jabber". + + + + + + K + + + + L + + + + M + + MARC + + The MARC formats are standards for the representation and communication of bibliographic and related information in machine-readable form. + + + + MARCXML + + Framework for working with MARC data in a XML environment. + + + + McCoy + + An open-source application that allows add-on authors to provide secure updates to their users. More information is available at developer.mozilla.org/en/McCoy. + + + + memcached + + 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. + + + + + N + + Network address + + Also known as an IP address (Internet Protocol address). + + + + + nsis + + An open-source software tool used to create Windows installers. More information is available at http://nsis.sourceforge.net. + + + + + O + + OPAC + + 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. + + + + OpenSRF + + 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. + + + + + P + + PostgreSQL + + A popular open-source object-relational database management system that underpins Evergreen software. + + + + Putty + + A popular open-source telnet/ssh client for the Windows and Unix platforms. More information is available at + http://www.chiark.greenend.org.uk/~sgtatham/putty/. + + + + + Q + + + + R + + Resource Hacker + + An open-source utility used to view, modify, rename, add, delete and extract resources in 32bit Windows executables + + + + + S + + + + 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. + + + + srfsh + + A command language interpreter (shell) that executes commands read from the standard input. It is used to test the Open Service Request Framework (OpenSRF). + + + + SRU + + SRU is a standard XML-focused search protocol for Internet search queries, utilizing CQL (Contextual Query Language), a standard syntax for representing + queries. + + + + SSH + + 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. + + + + SSH proxy + + 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. + + + + + + + SSH tunnel + + An encrypted data channel existing over an SSH network connection. Used to securely transfer unencrypted data streams over insecure networks. + + + + + + SSL Certificate + + 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. + + + + + T + + tunneling + + 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. + + + + + + U + + Ubuntu + + A popular open-source operating system using the Linux kernel that was originally based on the + Debian GNU/Linux operating system. More information is available at www.ubuntu.com. + + + + + + V + + Virtualization + + 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 host 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 Linux application to execute within a + Windows environment. + + + + VirtualBox + + A popular commercial package of virtualization software that emulates the x86 microprocessor architecture. It can be installed on + Linux, Mac OS X, Windows or + Solaris "host" operating systems and allows other "guest" (typically including Linux + and Windows) operating systems to be loaded and executed. + + + + + Virtual PC + + 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 Linux and Windows) operating systems to + be loaded and executed. + + + + + Volume Buckets + + Virtual containers to use in batch processing of multiple volumes. They can be used to perform various cataloging/holdings maintenance tasks + in batch. + + + + VMware + + A popular commercial package of virtualization software that emulates the x86 microprocessor architecture. It can be installed on Linux, Mac OS X, Windows or Solaris "host" operating systems and allows other "guest" (typically including Linux and Windows) operating systems to be loaded and executed. + + + + + + W + + Wine + + A popular open-source application that allows Linux and Unix systems to + run Windows executables. More information is available at http://www.winehq.org/. + + + + + X + + XML + + 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). + + + + XMPP + + An open-standard communications protocol, based on XML, used in message-oriented middleware. It supports the concept of a consistent domain + of message types that flow between software applications, possibly on different operating systems and architectures. More information is available at + xmpp.org. + + + + + xpath + + 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). + + + + XUL + + The XML User Interface Language, a specialized interface language that allows building cross-platform applications that drive Mozilla + -based browsers such as Firefox. More information is available at + https://developer.mozilla.org/en/XUL. + + + + xulrunner + + A specialized run-time application environment that provides support for installing, upgrading and uninstalling XUL applications. + It operates with Mozilla-based applications such as the Firefox browser. More information is available at + https://developer.mozilla.org/en/XULRunner. + + + + + + Y + + YAZ + + A programmers’ toolkit supporting the development of Z39.50/SRW/SRU clients and servers. + + + + yaz-client + + Z39.50/SRU client for connecting to YAZ servers. + + + + + Z + + Z39.50 + + A client–server protocol for searching and retrieving information from remote computer databases. + + + + -- 2.11.0