+++ /dev/null
--<?xml version="1.0" encoding="utf-8"?>\r
--<chapter xml:id="sipserver" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
-- xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
-- <info>\r
-- <title>SIP Server</title>\r
-- </info>\r
-- <para><systemitem class="protocol">SIP</systemitem>, standing for <systemitem class="protocol">Standard Interchange Protocol</systemitem>, was developed by the \r
-- <orgname class="corporation">3M</orgname>corporation to be a common protocol for data transfer between ILS' \r
-- (referred to in <systemitem class="protocol">SIP</systemitem> as an <emphasis>ACS</emphasis>, or <emphasis>Automated Circulation System</emphasis>)\r
-- <indexterm><primary>Automated Circulation System</primary></indexterm> and a \r
-- third party device. Originally, the protocol was developed for \r
-- use with 3M SelfCheck (often abbreviated SC, not to be confused with Staff Client) systems, but has since expanded to other companies and devices. It is now common to find \r
-- <systemitem class="protocol">SIP</systemitem> in use in several other vendors' SelfCheck systems<indexterm><primary>SelfCheck</primary></indexterm>, as well as other non-SelfCheck devices. \r
-- Some examples include:</para>\r
-- <itemizedlist>\r
-- <listitem>Patron Authentication (computer access, subscription databases)</listitem>\r
-- <listitem>Automated Material Handling (AMH) <indexterm><primary>Automated Material Handling (AMH)</primary></indexterm>- The automated sorting of items, often to bins or \r
-- book carts, based on shelving location or other programmable criteria</listitem>\r
-- </itemizedlist>\r
-- \r
-- <section xml:id="Installing_SIP_Server">\r
-- <info>\r
-- <title>Installing the <systemitem class="protocol">SIP</systemitem> Server</title>\r
-- </info>\r
-- <para>This is a rough intro to installing the <systemitem class="protocol">SIP</systemitem> server for Evergreen.</para>\r
-- <simplesect xml:id="Gettingthecode">\r
-- <title>Getting the code</title>\r
- <para>Current <systemitem class="protocol">SIP</systemitem> server code lives at in the Evergreen git repository:</para>\r
- <para>Current <systemitem class="protocol">SIP</systemitem> code lives at github:</para>\r
-- <screen><userinput>cd /opt</userinput></screen>\r
- <screen><userinput>git clone git://git.evergreen-ils.org/SIPServer.git SIPServer</userinput></screen>\r
- <screen><userinput>git clone git://github.com/atz/SIPServer.git SIPServer</userinput></screen>\r
- <para>Or use the old style:</para>\r
- <screen><userinput>$ cd /opt</userinput></screen>\r
- <screen><userinput>$ sudo cvs -d:pserver:anonymous@openncip.cvs.sourceforge.net:/cvsroot/openncip login</userinput></screen>\r
- <para>When prompted for the CVS password, just hit Enter (sudo password may be req'd)</para>\r
- <screen><userinput>$ sudo cvs -z3 -d:pserver:anonymous@openncip.cvs.sourceforge.net:/cvsroot/openncip co -P SIPServer</userinput></screen>\r
- \r
-- </simplesect>\r
-- <simplesect xml:id="Configuring_Server">\r
-- <title>Configuring the Server</title>\r
-- <procedure>\r
-- <step>\r
-- <para>Type the following commands from the command prompt:</para><indexterm><primary>configuration files</primary><secondary>oils_sip.xml</secondary></indexterm>\r
-- <screen><userinput>$ sudo su opensrf</userinput></screen>\r
-- <screen><userinput>$ cd /openils/conf</userinput></screen>\r
-- <screen><userinput>$ cp oils_sip.xml.example oils_sip.xml</userinput></screen>\r
-- </step>\r
-- <step>\r
-- <para>Edit <filename>oils_sip.xml</filename><indexterm><primary>configuration files</primary><secondary>oils_sip.xml</secondary></indexterm>. \r
-- Change the commented out <server-params> section to this:</para>\r
--<programlisting>\r
--<server-params\r
--min_servers='1'\r
--min_spare_servers='0'\r
--max_servers='25'\r
--/>\r
--</programlisting>\r
-- </step>\r
-- <step>\r
-- <para> max_servers will directly correspond to the number of allowed <systemitem class="protocol">SIP</systemitem> clients. Set the number accordingly, but \r
-- bear in mind that too many connections can \r
-- exhaust memory. On a 4G RAM/4 CPU server (that is also running evergreen), it is not recommended to exceed 100 \r
-- <systemitem class="protocol">SIP</systemitem> client connections.</para> \r
-- </step>\r
-- </procedure> \r
-- </simplesect>\r
-- <simplesect xml:id="Adding_SIP_users">\r
-- <title>Adding <systemitem class="protocol">SIP</systemitem> Users</title>\r
-- <procedure>\r
-- <step>\r
-- <para>Type the following commands from the command prompt:</para><indexterm><primary>configuration files</primary><secondary>oils_sip.xml</secondary></indexterm>\r
-- <screen><userinput>$ sudo su opensrf</userinput></screen>\r
-- <screen><userinput>$ cd /openils/conf</userinput></screen>\r
-- <screen><userinput>$ cp oils_sip.xml.example oils_sip.xml</userinput></screen>\r
-- </step>\r
-- <step>\r
-- <para> in the <accounts> section, add <systemitem class="protocol">SIP</systemitem> client login information. Make sure that all \r
-- <varname><logins></varname> use the same institution attribute, and make \r
-- sure the institution is listed in <varname><institutions></varname>. All attributes in the <varname><login></varname> section will be \r
-- used by the <systemitem class="protocol">SIP</systemitem> client.</para>\r
-- \r
-- </step>\r
-- <step>\r
-- <para> In Evergreen, create a new profile group called <systemitem class="groupname">SIP</systemitem>. \r
-- This group should be a sub-group of <systemitem class="groupname">Users</systemitem> \r
-- (not <systemitem class="groupname">Staff</systemitem> or <systemitem class="groupname">Patrons</systemitem>). \r
-- Set Editing Permission as <emphasis role="bold">group_application.user.sip_client</emphasis> and give the group the following permissions:</para>\r
-- <literallayout>\r
-- COPY_CHECKIN\r
-- COPY_CHECKOUT\r
-- RENEW_CIRC \r
-- VIEW_CIRCULATIONS\r
-- VIEW_COPY_CHECKOUT_HISTORY \r
-- VIEW_PERMIT_CHECKOUT\r
-- VIEW_USER\r
-- VIEW_USER_FINES_SUMMARY\r
-- VIEW_USER_TRANSACTIONS\r
-- </literallayout>\r
-- <para>OR use SQL like:</para>\r
--<screen>\r
--<userinput>\r
- INSERT INTO permission.grp_tree (name,parent,description,application_perm) \r
- VALUES ('SIP', 1, 'SIP2 Client Systems', 'group_application.user.sip_client');\r
-INSERT INTO permission.grp_tree (id,name,parent,description,application_perm) \r
-VALUES (8, 'SIP', 1, 'SIP2 Client Systems', 'group_application.user.sip_client');\r
-- \r
--INSERT INTO\r
-- permission.grp_perm_map (grp, perm, depth, grantable)\r
--SELECT\r
-- g.id, p.id, 0, FALSE\r
--FROM\r
-- permission.grp_tree g,\r
-- permission.perm_list p\r
--WHERE\r
-- g.name = 'SIP' AND\r
-- p.code IN (\r
-- 'COPY_CHECKIN',\r
-- 'COPY_CHECKOUT',\r
-- 'RENEW_CIRC',\r
-- 'VIEW_CIRCULATIONS',\r
-- 'VIEW_COPY_CHECKOUT_HISTORY',\r
-- 'VIEW_PERMIT_CHECKOUT',\r
-- 'VIEW_USER',\r
-- 'VIEW_USER_FINES_SUMMARY',\r
-- 'VIEW_USER_TRANSACTIONS'\r
--);\r
--</userinput>\r
--</screen>\r
-- \r
-- <para>Verify:</para>\r
--<screen>\r
--<userinput>\r
--SELECT *\r
- FROM permission.grp_perm_map pgpm\r
- INNER JOIN permission.perm_list ppl ON pgpm.perm = ppl.id\r
- INNER JOIN permission.grp_tree pgt ON pgt.id = pgpm.grp\r
- WHERE pgt.name = 'SIP';\r
-FROM permission.grp_perm_map JOIN permission.perm_list ON\r
-permission.grp_perm_map.perm=permission.perm_list.id\r
-WHERE grp=8;\r
--</userinput>\r
--</screen>\r
-- \r
- <para>Keep in mind that the id <emphasis role="bold">(8)</emphasis> may not necessarily be available on your system.</para> \r
-- </step>\r
-- <step>\r
-- <para>For each account created in the <login> section of <filename>oils_sip.xml</filename>, create a user (via the staff client user editor) \r
-- that has the same username \r
-- and password and put that user into the <systemitem class="groupname">SIP</systemitem> group.</para>\r
-- <note><para>The expiration date will affect the <systemitem class="groupname">SIP</systemitem> users' connection so you might want to make a note of \r
-- this somewhere.</para></note> \r
-- </step>\r
-- </procedure> \r
-- </simplesect>\r
-- <simplesect xml:id="Running_SIP_server">\r
-- <title>Running the server</title>\r
-- <para>To start the <systemitem class="protocol">SIP</systemitem> server type the following commands from the command prompt:</para>\r
-- <screen><userinput>$ sudo su opensrf</userinput></screen>\r
-- <screen><userinput>$ oils_ctl.sh -d /openils/var/run -s /openils/conf/oils_sip.xml -a [start|stop|restart]_sip</userinput></screen> \r
-- </simplesect>\r
-- <simplesect xml:id="Logging-SIP">\r
-- <title>Logging-SIP</title><indexterm><primary>SIP</primary></indexterm>\r
-- <simplesect>\r
-- <title><systemitem class="service">Syslog</systemitem></title>\r
-- <para>It is useful to log <systemitem class="protocol">SIP</systemitem> requests to a separate file especially during initial setup by modifying your \r
-- syslog config file.</para><indexterm><primary>syslog</primary></indexterm>\r
-- <procedure>\r
-- <step>\r
-- <para>Edit syslog.conf.</para>\r
-- <screen><userinput>$ sudo vi /etc/syslog.conf # maybe /etc/rsyslog.conf</userinput></screen> \r
-- </step>\r
-- <step>\r
-- <para>Add this:</para>\r
-- <programlisting>local6.* -/var/log/SIP_evergreen.log</programlisting> \r
-- </step>\r
-- <step>\r
-- <para><systemitem class="service">Syslog</systemitem> expects the logfile to exist so create the file.</para>\r
-- <screen><userinput>$ sudo touch /var/log/SIP_evergreen.log</userinput></screen> \r
-- </step>\r
-- <step>\r
-- <para>Restart <systemitem class="service">sysklogd</systemitem>.</para>\r
-- <screen><userinput>$ sudo /etc/init.d/sysklogd restart</userinput></screen> \r
-- </step>\r
-- </procedure> \r
-- </simplesect>\r
-- <simplesect>\r
-- <title><systemitem class="service">Syslog-NG</systemitem></title>\r
-- \r
-- <procedure>\r
-- <step>\r
-- <para>Edit logging config.</para><indexterm><primary>syslog-NG</primary></indexterm>\r
-- <screen><userinput>sudo vi /etc/syslog-ng/syslog-ng.conf</userinput></screen> \r
-- </step>\r
-- <step>\r
-- <para>Add:</para>\r
--<programlisting>\r
--# SIP2 for Evergreen\r
--filter f_eg_sip { level(warn, err, crit) and facility(local6); };\r
--destination eg_sip { file("/var/log/SIP_evergreen.log"); };\r
--log { source(s_all); filter(f_eg_sip); destination(eg_sip); };\r
--</programlisting> \r
-- </step>\r
-- <step>\r
-- <para><systemitem class="service">Syslog-ng</systemitem> expects the logfile to exist so create the file.</para>\r
-- <screen><userinput>$ sudo touch /var/log/SIP_evergreen.log</userinput></screen> \r
-- </step>\r
-- <step>\r
-- <para>Restart <systemitem class="service">syslog-ng</systemitem></para>\r
-- <screen><userinput>$ sudo /etc/init.d/syslog-ng restart</userinput></screen> \r
-- </step>\r
-- </procedure> \r
-- </simplesect>\r
-- </simplesect> \r
-- <simplesect xml:id="Testing_SIP_Connection">\r
-- <title>Testing Your <systemitem class="protocol">SIP</systemitem> Connection</title><indexterm><primary>SIP</primary></indexterm>\r
-- <itemizedlist>\r
-- <listitem>\r
- <para>In the root directory of the SIPServer code:</para>\r
- <para>In the top level CVS checkout of the SIPServer code.</para>\r
-- <screen><userinput>$ cd SIPServer/t</userinput></screen>\r
-- </listitem>\r
-- <listitem>\r
-- <para> Edit <filename>SIPtest.pm</filename>, change the <varname>$instid</varname>, <varname>$server</varname>, <varname>$username</varname>, and \r
-- <varname>$password</varname> variables. This will be enough to test connectivity. \r
-- To run all tests, you'll need to change all the variables in the Configuration section.</para>\r
-- <screen><userinput>$ PERL5LIB=../ perl 00sc_status.t</userinput></screen>\r
-- <para>This should produce something like:</para>\r
--<screen>\r
--1..4\r
--ok 1 - Invalid username\r
--ok 2 - Invalid username\r
--ok 3 - login\r
--ok 4 - SC status\r
--</screen>\r
-- </listitem> \r
-- <listitem>\r
-- <para> Don't be dismayed at <emphasis role="bold">Invalid Username</emphasis>. That's just one of the many tests that are run.</para>\r
-- </listitem> \r
-- </itemizedlist>\r
-- </simplesect>\r
-- <simplesect xml:id="SIP-More_Testing">\r
-- <title>More Testing</title>\r
-- <procedure>\r
-- <step>\r
-- <para>Once you have opened up either the <systemitem class="protocol">SIP</systemitem> OR <systemitem class="protocol">SIP2</systemitem> ports to be \r
-- accessible from outside you can do some testing via <systemitem class="protocol">telnet</systemitem>. You can try this with localhost \r
-- if you so wish, but we want to prove that <systemitem class="protocol">SIP2</systemitem> works from non-localhost. \r
-- Replace <varname>$instid</varname>, <varname>$server</varname>, <varname>$barcode</varname>, <varname>$username</varname>, \r
-- and <varname>$password</varname> variables below as necessary.</para>\r
-- <note><para>We are using <systemitem>6001</systemitem> here which is associated with <systemitem class="protocol">SIP2</systemitem> as per our configuration.</para></note><indexterm><primary>telnet</primary></indexterm>\r
--<screen>\r
--<userinput>$ telnet $server 6001</userinput>\r
--Connected to $server.\r
--Escape character is '^]'.\r
--<userinput>9300CN**$username**|CO**$password**|CP**$instid**</userinput>\r
--</screen> \r
-- <para>You should get back.</para>\r
-- <screen>941</screen>\r
-- </step>\r
-- <step>\r
-- <para>Now just copy in the following line (with variables replaced) you don't need to hit enter, just paste!</para>\r
-- <screen>2300120080623 172148AO**$instid**|AA**$barcode**|AC$password|AD**$password**</screen>\r
-- <para>You will get back the patron information for $barcode (something similar to the what's below).</para>\r
--<screen>24 Y 00120100113 170738AEFirstName MiddleName LastName|AA**$barcode**|BLY|CQY\r
--|BHUSD|BV0.00|AFOK|AO**$instid**|\r
--</screen>\r
-- <para>The response declares it is a valid patron <varname>BLY</varname> with a valid password <varname>CQY</varname> and shows the user's \r
-- <varname>$name</varname>.</para>\r
-- </step>\r
-- </procedure>\r
-- </simplesect>\r
-- </section>\r
-- <section xml:id="SIP_Communication">\r
-- <info>\r
-- <title><systemitem class="protocol">SIP</systemitem> Communication</title><indexterm><primary>SIP</primary></indexterm>\r
-- </info>\r
-- <para><systemitem class="protocol">SIP</systemitem> generally communicates over a <systemitem class="protocol">TCP</systemitem> connection (either raw sockets or over \r
-- <systemitem class="protocol">telnet</systemitem>), but can also communicate via serial connections and other methods. In Evergreen, \r
-- the most common deployment is a <systemitem class="protocol">RAW</systemitem> socket connection on port <systemitem>6001</systemitem>.</para>\r
-- <para><systemitem class="protocol">SIP</systemitem> communication consists of strings of messages, each message request and response begin with a 2-digit \r
-- <quote>command</quote> - Requests usually being an odd \r
-- number and responses usually increased by 1 to be an even number. The combination numbers for the request command and response is often referred to as a \r
-- <emphasis>Message Pair</emphasis> (for example, a 23 command is a request for patron status, a 24 response is a patron status, and the message pair 23/24 is \r
-- patron status message pair). The table in the next section shows the message pairs and a description of them.</para>\r
-- <para>For clarification, the <quote>Request</quote> is from the device (selfcheck or otherwise) to the ILS/ACS. The response is… the response \r
-- to the request ;).</para>\r
-- <para>Within each request and response, a number of fields (either a fixed width or separated with a <emphasis role="bold">|</emphasis> [pipe symbol] and preceeded with a \r
-- 2-character field identifier) \r
-- are used. The fields vary between message pairs.</para>\r
-- <informaltable>\r
-- <tgroup cols="4">\r
-- <colspec colnum="1" colname="pair" colwidth="0.5*"/>\r
-- <colspec colnum="2" colname="name" colwidth="1.0*"/>\r
-- <colspec colnum="3" colname="supported" colwidth="1.0*"/>\r
-- <colspec colnum="4" colname="details" colwidth="3.0*"/>\r
-- <thead>\r
-- <row>\r
-- <entry>Pair</entry>\r
-- <entry>Name</entry>\r
-- <entry>Supported?</entry>\r
-- <entry>Details</entry>\r
-- </row>\r
-- </thead>\r
-- <tbody>\r
-- <row>\r
-- <entry>01</entry>\r
-- <entry>Block Patron</entry>\r
-- <entry>Yes</entry>\r
-- <entry><link linkend='SIP_Block_Patron'>01_Block_Patron</link> - ACS responds with 24 Patron Status Response</entry>\r
-- </row>\r
-- <row>\r
-- <entry>09/10</entry>\r
-- <entry>Checkin</entry>\r
-- <entry>Yes (with extensions)</entry>\r
-- <entry><link linkend='SIP_Checkin'>09/10_Checkin</link></entry>\r
-- </row>\r
-- <row>\r
-- <entry>11/12</entry>\r
-- <entry>Checkout</entry>\r
-- <entry>Yes (no renewals)</entry>\r
-- <entry><link linkend='SIP_Checkout'>11/12_Checkout</link></entry>\r
-- </row>\r
-- <row>\r
-- <entry>15/16</entry>\r
-- <entry>Hold</entry>\r
-- <entry>No</entry>\r
-- <entry><link linkend='SIP_Hold'>15/16_Hold</link></entry>\r
-- </row>\r
-- <row>\r
-- <entry>17/18</entry>\r
-- <entry>Item Information</entry>\r
-- <entry>Yes (no extensions)</entry>\r
-- <entry><link linkend='SIP_Item_Information'>17/18_Item_Information</link></entry>\r
-- </row>\r
-- <row>\r
-- <entry>19/20</entry>\r
-- <entry>Item Status Update</entry>\r
-- <entry>No</entry>\r
-- <entry><link linkend='SIP_Item_Status_Update'>19/20_Item_Status_Update</link> - Returns Patron Enable response, but doesn't make any changes in EG</entry>\r
-- </row>\r
-- <row>\r
-- <entry>23/24</entry>\r
-- <entry>Patron Status</entry>\r
-- <entry>Yes</entry>\r
-- <entry><link linkend='SIP_Patron_Status'>23/24_Patron_Status</link> - 63/64 <quote>Patron Information</quote> preferred</entry>\r
-- </row>\r
-- <row>\r
-- <entry>25/26</entry>\r
-- <entry>Patron Enable</entry>\r
-- <entry>No</entry>\r
-- <entry><link linkend='SIP_Patron_Enable'>25/26_Patron_Enable</link> - Used during system testing and validation</entry>\r
-- </row>\r
-- <row>\r
-- <entry>29/30</entry>\r
-- <entry>Renew</entry>\r
-- <entry>NO (maybe?)</entry>\r
-- <entry><link linkend='SIP_Renew'>29/30_Renew</link></entry>\r
-- </row>\r
-- <row>\r
-- <entry>35/36</entry>\r
-- <entry>End Session</entry>\r
-- <entry>Yes</entry>\r
-- <entry><link linkend='SIP_End_Session'>35/36_End_Session</link></entry>\r
-- </row>\r
-- <row>\r
-- <entry>37/38</entry>\r
-- <entry>Fee Paid</entry>\r
-- <entry>No</entry>\r
-- <entry><link linkend='SIP_Fee_Paid'>37/38_Fee_Paid</link></entry>\r
-- </row>\r
-- <row>\r
-- <entry>63/64</entry>\r
-- <entry>Patron Information</entry>\r
-- <entry>Yes (no extensions)</entry>\r
-- <entry><link linkend='SIP_Patron_Information'>63/64_Patron_Information</link></entry>\r
-- </row>\r
-- <row>\r
-- <entry>65/66</entry>\r
-- <entry>Renew All</entry>\r
-- <entry>No</entry>\r
-- <entry><link linkend='SIP_Renew_All'>65/66_Renew_All</link></entry>\r
-- </row>\r
-- <row>\r
-- <entry>93/94</entry>\r
-- <entry>Login</entry>\r
-- <entry>Yes</entry>\r
-- <entry><link linkend='SIP_Login'>93/94_Login</link> - Must be first command to Evergreen ACS (via socket) or <systemitem class="protocol">SIP</systemitem> will terminate</entry>\r
-- </row>\r
-- <row>\r
-- <entry>97/96</entry>\r
-- <entry>Resend last message</entry>\r
-- <entry>Yes</entry>\r
-- <entry><link linkend='SIP_Resend'>97/96_Resend</link></entry>\r
-- </row>\r
-- <row>\r
-- <entry>99/98</entry>\r
-- <entry>SC/ACS Status</entry>\r
-- <entry>Yes</entry>\r
-- <entry><link linkend='SIP_SC_ACS_Status'>99/98_SC_and_ACS_Status</link></entry>\r
-- </row>\r
-- </tbody>\r
-- </tgroup>\r
-- </informaltable>\r
-- <simplesect xml:id="SIP_Block_Patron">\r
-- <title>01 Block Patron</title>\r
-- <para>A selfcheck will issue a <command>Block Patron</command> command if a patron leaves their card in a selfcheck machine or if the selfcheck detects tampering (such as attempts \r
-- to disable multiple items during a single item checkout, multiple failed pin entries, etc).</para><indexterm><primary>SelfCheck</primary></indexterm>\r
-- <para>In Evergreen, this command does the following:</para>\r
-- <itemizedlist>\r
-- <listitem>User alert message: <emphasis>CARD BLOCKED BY SELF-CHECK MACHINE</emphasis> (this is independent of the AL \r
-- <emphasis>Blocked Card Message</emphasis> field).</listitem>\r
-- <listitem>Card is marked inactive.</listitem>\r
-- </itemizedlist>\r
-- <para>The request looks like:</para>\r
-- <screen>01<card retained><date>[fields AO, AL, AA, AC]</screen>\r
-- <para><emphasis>Card Retained</emphasis>: A single character field of <emphasis>Y</emphasis> or <emphasis>N</emphasis> - tells the ACS whether the SC has \r
-- retained the card (ex: left in the machine) or not.</para> \r
-- <para><emphasis>Date</emphasis>: An 18 character field for the date/time when the block occurred.</para> \r
-- <para><emphasis>Format</emphasis>: YYYYMMDDZZZZHHMMSS (ZZZZ being zone - 4 blanks when local time, <quote> Z</quote> (3 blanks and a Z) represents UTC(GMT/Zulu)</para>\r
-- <para><emphasis>Fields</emphasis>: See <link linkend='SIP_Fields'>Fields</link> for more details.</para>\r
-- <para>The response is a 24 <quote>Patron Status Response</quote> with the following:</para>\r
-- <itemizedlist>\r
-- <listitem>Charge privileges denied</listitem>\r
-- <listitem>Renewal privileges denied</listitem>\r
-- <listitem>Recall privileges denied (hard-coded in every 24 or 64 response)</listitem>\r
-- <listitem>hold privileges denied</listitem>\r
-- <listitem>Screen Message 1 (AF): <emphasis>blocked</emphasis></listitem>\r
-- <listitem>Patron</listitem>\r
--\r
-- </itemizedlist>\r
-- </simplesect>\r
-- <simplesect xml:id="SIP_Checkin">\r
-- <title>09/10 Checkin</title>\r
-- <para>The request looks like:</para>\r
-- <screen>09<No block (Offline)><xact date><return date>[Fields AP,AO,AB,AC,CH,BI]</screen>\r
-- <para><emphasis>No Block (Offline)</emphasis>: A single character field of <emphasis>Y</emphasis> or <emphasis>N</emphasis> - Offline transactions are not currently \r
-- supported so send <emphasis>N</emphasis>.</para> \r
-- <para><emphasis>xact date</emphasis>: an 18 character field for the date/time when the checkin occurred. Format: YYYYMMDDZZZZHHMMSS (ZZZZ being zone - \r
-- 4 blanks when local time, <quote> Z</quote> (3 blanks and a Z) represents UTC(GMT/Zulu)</para> \r
-- <para><emphasis>Fields</emphasis>: See <link linkend='SIP_Fields'>Fields</link> for more details.</para>\r
-- <para>The response is a 10 <quote>Checkin Response</quote> with the following:</para>\r
-- <screen>10<resensitize><magnetic media><alert><xact date>[Fields AO,AB,AQ,AJ,CL,AA,CK,CH,CR,CS,CT,CV,CY,DA,AF,AG]</screen>\r
-- <para>Example (with a remote hold):</para>\r
-- <screen>09N20100507 16593720100507 165937APCheckin Bin 5|AOBR1|AB1565921879|ACsip_01|</screen>\r
--<screen>\r
--101YNY20100623 165731AOBR1|AB1565921879|AQBR1|AJPerl 5 desktop reference|CK001|CSQA76.73.P33V76 1996\r
--|CTBR3|CY373827|DANicholas Richard Woodard|CV02|\r
--</screen>\r
-- <para>Here you can see a hold alert for patron <varname>CY</varname> <emphasis>373827</emphasis>, named <varname>DA</varname> <emphasis>Nicholas Richard Woodard</emphasis>, \r
-- to be picked up at <varname>CT</varname> <quote>BR3</quote>. Since the transaction is happening \r
-- at <varname>AO</varname> <quote>BR1</quote>, the alert type <varname>CV</varname> is 02 for <emphasis>hold at remote library</emphasis>. \r
-- The possible values for <varname>CV</varname> are:</para>\r
-- <itemizedlist>\r
-- <listitem>00: unknown</listitem>\r
-- <listitem>01: local hold</listitem>\r
-- <listitem>02: remote hold</listitem>\r
-- <listitem>03: ILL transfer (not used by EG)</listitem>\r
-- <listitem>04: transfer</listitem>\r
-- <listitem>99: other</listitem>\r
-- </itemizedlist>\r
-- <note>\r
- <para>The logic for Evergreen to determine whether the content is magnetic_media comes from either legacy circ scripts or search_config_circ_modifier. \r
- <para>the logic for Evergreen to determine the content is magnetic_media comes from either legacy circ scripts or search_config_circ_modifier. \r
-- The default is non-magnetic.<indexterm><primary>magnetic media</primary></indexterm> \r
-- The same is true for media_type (default 001). Evergreen does not populate the collection_code because it does not really have any, but it will provide the \r
-- call_number where available.</para>\r
-- <para>Unlike the <varname>item_id</varname> (barcode), the <varname>title_id</varname> is actually a title string, unless the configuration forces the return of \r
-- the bib ID.</para>\r
-- <para>Don't be confused by the different branches that can show up in the same response line.</para>\r
-- <itemizedlist>\r
-- <listitem><varname>AO</varname> is where the transaction took place,</listitem>\r
-- <listitem><varname>AQ</varname> is the <quote>permanent location</quote>, and</listitem>\r
-- <listitem><varname>CT</varname> is the <emphasis>destination location</emphasis> (i.e., pickup lib for a hold or target lib for a transfer).</listitem>\r
-- </itemizedlist>\r
-- </note>\r
-- </simplesect>\r
-- <simplesect xml:id="SIP_Checkout">\r
-- <title>11/12 Checkout</title>\r
-- </simplesect>\r
-- <simplesect xml:id="SIP_Hold">\r
-- <title>15/16 Hold</title>\r
-- <para>Not yet supported.</para>\r
-- </simplesect>\r
-- <simplesect xml:id="SIP_Item_Information">\r
-- <title>17/18 Item Information</title>\r
-- <para>The request looks like:</para>\r
-- <screen>17<xact_date>[fields: AO,AB,AC]</screen>\r
-- <para>The request is very terse. <varname>AC</varname> is optional.</para>\r
-- <para>The following response structure is for <systemitem class="protocol">SIP2</systemitem>. (Version 1 of the protocol had only 6 total fields.)</para>\r
--<screen>\r
--18<circulation_status><security_marker><fee_type><xact_date>\r
--[fields: CF,AH,CJ,CM,AB,AJ,BG,BH,BV,CK,AQ,AP,CH,AF,AG,+CT,+CS]\r
--</screen>\r
-- <para>Example:</para>\r
-- <screen>1720060110 215612AOBR1|ABno_such_barcode|</screen>\r
-- <screen>1801010120100609 162510ABno_such_barcode|AJ|</screen>\r
-- <screen>1720060110 215612AOBR1|AB1565921879|</screen>\r
--<screen>1810020120100623 171415AB1565921879|AJPerl 5 desktop reference|CK001|AQBR1|APBR1|BGBR1\r
--|CTBR3|CSQA76.73.P33V76 1996|\r
--</screen>\r
-- <para>The first case is with a bogus barcode. The latter shows an item with a circulation_status of <emphasis>10</emphasis> for <emphasis>in transit between libraries</emphasis>. \r
-- The known values of <varname>circulation_status</varname> are enumerated in the spec.</para>\r
-- <para>EXTENSIONS: The <varname>CT</varname> field for <emphasis>destination location</emphasis> and <varname>CS</varname> <emphasis>call number</emphasis> are used by \r
-- Automated Material Handling systems.</para><indexterm><primary>Automated Material Handling (AMH)</primary></indexterm>\r
-- </simplesect>\r
-- <simplesect xml:id="SIP_Item_Status_Update">\r
-- <title>19/20 Item Status Update</title>\r
-- </simplesect>\r
-- <simplesect xml:id="SIP_Patron_Status">\r
-- <title>23/24 Patron Status</title>\r
-- <para>Example:</para>\r
-- <screen>2300120060101 084235AOUWOLS|AAbad_barcode|ACsip_01|ADbad_password|</screen>\r
-- <screen>24YYYY 00120100507 013934AE|AAbad_barcode|BLN|AOUWOLS|</screen>\r
-- <screen>2300120060101 084235AOCONS|AA999999|ACsip_01|ADbad_password|</screen>\r
-- <screen>24 Y 00120100507 022318AEDoug Fiander|AA999999|BLY|CQN|BHUSD|BV0.00|AFOK|AOCONS|</screen>\r
-- <screen>2300120060101 084235AOCONS|AA999999|ACsip_01|ADuserpassword|LY|CQN|BHUSD|BV0.00|AFOK|AOCONS|</screen>\r
-- <screen>24 Y 00120100507 022803AEDoug Fiander|AA999999|BLY|CQY|BHUSD|BV0.00|AFOK|AOCONS|</screen>\r
-- <orderedlist>\r
-- <listitem>The <varname>BL</varname> field (<systemitem class="protocol">SIP2</systemitem>, optional) is <emphasis>valid patron</emphasis>, so the \r
-- <emphasis>N</emphasis> value means \r
-- <emphasis>bad_barcode</emphasis> doesn't match a patron, the <emphasis>Y</emphasis> value means 999999 does.</listitem>\r
-- <listitem>The <varname>CQ</varname> field (<systemitem class="protocol">SIP2</systemitem>, optional) is <emphasis>valid password</emphasis>, so the <emphasis>N</emphasis> \r
-- value means <emphasis>bad_password</emphasis> doesn't match 999999's password, the <emphasis>Y</emphasis> means <emphasis>userpassword</emphasis> \r
-- does.</listitem>\r
-- </orderedlist>\r
-- <para>So if you were building the most basic <systemitem class="protocol">SIP2</systemitem> authentication client, you would check for \r
-- <emphasis>|CQY|</emphasis> in the response to know the user's barcode and password \r
-- are correct (<varname>|CQY|</varname> implies <varname>|BLY|</varname>, since you cannot check the password unless the barcode exists). However, in practice, \r
-- depending on the application, there are other factors to consider in authentication, like whether the user is blocked from checkout, owes excessive fines, reported their \r
-- card lost, etc. These limitations are reflected in the 14-character <emphasis>patron status</emphasis> string immediately following the <emphasis>24</emphasis> code. \r
-- See the field definitions in your copy of the spec.</para>\r
-- </simplesect>\r
-- <simplesect xml:id="SIP_Patron_Enable">\r
-- <title>25/26 Patron Enable</title>\r
-- <para>Not yet supported.</para>\r
-- </simplesect>\r
-- <simplesect xml:id="SIP_Renew">\r
-- <title>29/30 Renew</title>\r
-- <para>Evergreen ACS status message indicates <emphasis>renew</emphasis> is supported.</para>\r
-- </simplesect>\r
-- <simplesect xml:id="SIP_End_Session">\r
-- <title>35/36 End Session</title>\r
-- <screen>3520100505 115901AOBR1|AA999999|</screen>\r
-- <screen>36Y20100507 161213AOCONS|AA999999|AFThank you!|</screen>\r
-- <para>The <emphasis>Y/N</emphasis> code immediately after the 36 indicates <emphasis>success/failure</emphasis>. Failure is not particularly meaningful or \r
-- important in this context, and for evergreen it is hardcoded <emphasis>Y</emphasis>.</para> \r
-- </simplesect>\r
-- <simplesect xml:id="SIP_Fee_Paid">\r
-- <title>37/38 Fee Paid</title>\r
-- <para>Not implemented.</para>\r
-- </simplesect>\r
-- <simplesect xml:id="SIP_Patron_Information">\r
-- <title>63/64 Patron Information</title>\r
-- <para>Attempting to retrieve patron info with a bad barcode:</para>\r
-- <screen>6300020060329 201700 AOBR1|AAbad_barcode|</screen>\r
-- <screen>64YYYY 00020100623 141130000000000000000000000000AE|AAbad_barcode|BLN|AOBR1|</screen>\r
-- <para>Attempting to retrieve patron info with a good barcode (but bad patron password):</para>\r
-- <screen>6300020060329 201700 AOBR1|AA999999|ADbadpwd|</screen>\r
--<screen>\r
--64 Y 00020100623 141130000000000000000000000000AA999999|AEDavid J. Fiander|BHUSD|BV0.00\r
--|BD2 Meadowvale Dr. St Thomas, ON Canada\r
--</screen>\r
--<screen>90210|BEdjfiander@somemail.com|BF(519) 555 1234|AQBR1|BLY|CQN|PB19640925|PCPatrons\r
--|PIUnfiltered|AFOK|AOBR1|\r
--</screen>\r
-- <para>See <link linkend='SIP_Patron_Status'>23/24 Patron Status</link> for info on <varname>BL</varname> and <varname>CQ</varname> fields.</para>\r
-- </simplesect>\r
-- <simplesect xml:id="SIP_Renew_All">\r
-- <title>65/66 Renew All</title>\r
-- <para>Not yet supported.</para>\r
-- </simplesect>\r
-- <simplesect xml:id="SIP_Login">\r
-- <title>93/94 Login</title>\r
-- <para>Example:</para>\r
-- <screen>9300CNsip_01|CObad_value|CPBR1|</screen>\r
-- <screen>[Connection closed by foreign host.]</screen>\r
-- <screen>...</screen>\r
-- <screen>9300CNsip_01|COsip_01|CPBR1|</screen>\r
-- <screen>941</screen>\r
-- <para><emphasis>941</emphasis> means successful terminal login. <emphasis>940</emphasis> or getting dropped means failure.</para>\r
-- </simplesect>\r
-- <simplesect xml:id="SIP_Resend">\r
-- <title>97/96 Resend</title>\r
-- </simplesect>\r
-- <simplesect xml:id="SIP_SC_ACS_Status">\r
-- <title>99/98 SC and ACS Status</title>\r
-- <screen>99<status code><max print width><protocol version></screen>\r
-- <para>All 3 fields are required:</para>\r
-- <itemizedlist>\r
-- <listitem>status code - 1 character:</listitem>\r
-- <itemizedlist>\r
-- <listitem>0: SC is OK</listitem>\r
-- <listitem>1: SC is out of paper</listitem>\r
-- <listitem>2: SC shutting down</listitem> \r
-- </itemizedlist>\r
-- <listitem>max print width - 3 characters - the integer number of characters the client can print</listitem>\r
-- <listitem>protocol version - 4 characters - x.xx</listitem>\r
-- </itemizedlist>\r
--<screen>\r
--98<on-line status><checkin ok><checkout ok><ACS renewal policy>\r
--<status update ok><offline ok><timeout period>\r
--</screen>\r
--<screen>\r
--<retries allowed><date/time sync><protocol version><institution id>\r
--<library name><supported messages><terminal\r
--</screen> \r
-- <screen>location><screen message><print line></screen>\r
-- <para>Example:</para>\r
-- <screen>9910302.00</screen>\r
-- <screen>98YYYYNN60000320100510 1717202.00AOCONS|BXYYYYYYYYYNYNNNYN|</screen>\r
-- <para>The Supported Messages field <varname>BX</varname> appears only in <systemitem class="protocol">SIP2</systemitem>, and specifies whether 16 different \r
-- <systemitem class="protocol">SIP</systemitem> commands are supported by the ACS or not.</para>\r
-- </simplesect>\r
-- <simplesect xml:id="SIP_Fields">\r
-- <title>Fields</title>\r
-- <para>All fixed-length fields in a communication will appear before the first variable-length field. This allows for simple parsing. Variable-length fields are by \r
-- definition delimited, though there will not necessarily be an initial delimiter between the last fixed-length field and the first variable-length one. It would be \r
-- unnecessary, since you should know the exact position where that field begins already.</para>\r
-- </simplesect>\r
-- </section>\r
--</chapter>\r
--\r
+++ /dev/null
--<?xml version='1.0' encoding='UTF-8'?>\r
--<appendix xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"\r
--xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="about_this_documentation">\r
-- <info>\r
-- <title>About this Documentation</title>\r
-- </info>\r
-- <section xml:id="aboutDIG">\r
-- <title>About the Documentation Interest Group (DIG)</title>\r
-- <para>The Evergreen DIG was established in May 2009 at the first Evergreen International Conference, where members of the Evergreen community committed to developing single-source, \r
-- standards-based documentation for Evergreen. Since then, the DIG has been actively working toward that goal.</para>\r
-- <table>\r
-- <title>Evergreen DIG Participants</title>\r
-- <tgroup align="left" cols="2" colsep="1" rowsep="1">\r
-- <colspec colnum="1" colwidth="1.0*"/>\r
-- <colspec colnum="2" colwidth="1.0*"/>\r
-- <thead>\r
-- <row>\r
-- <entry>Name</entry>\r
-- <entry>Organization</entry>\r
-- </row>\r
-- </thead>\r
-- <tbody> \r
-- <row>\r
- <entry>Hilary Caws-Elwitt</entry>\r
- <entry>Susquehanna County Library</entry>\r
- <entry>Jeremy Buhler</entry>\r
- <entry>SITKA</entry>\r
- </row> \r
- <row>\r
- <entry>Paula Burton </entry>\r
- <entry>King County Library System</entry>\r
- </row>\r
- <row>\r
- <entry>Matt Carlson</entry>\r
- <entry>King County Library System </entry>\r
- </row>\r
- <row>\r
- <entry>Sarah Childs</entry>\r
- <entry>Hussey-Mayfield Memorial Public Library</entry>\r
- </row>\r
- \r
- <row>\r
- <entry>Anton Chuppin</entry>\r
- <entry>Nova Scotia Provincial Library</entry>\r
- </row>\r
- <row>\r
- <entry>Marlene Coleman</entry>\r
- <entry>Beaufort Country Library</entry>\r
-- </row>\r
-- <row>\r
-- <entry>Karen Collier</entry>\r
-- <entry>Kent County Public Library </entry>\r
-- </row>\r
-- <row>\r
-- <entry>Shannon Dineen</entry>\r
-- <entry>SITKA</entry>\r
-- </row>\r
-- <row>\r
-- <entry>George Duimovich</entry>\r
-- <entry>NRCan Library</entry>\r
-- </row>\r
-- <row>\r
- <entry>Sally Fortin</entry>\r
- <entry>Equinox Software</entry>\r
- <entry>Jennifer Durham</entry>\r
- <entry>Statesboro Regional Library System</entry>\r
- </row>\r
- <row>\r
- <entry>Jennifer Finney</entry>\r
- <entry>Florence County Library</entry>\r
-- </row> \r
-- <row>\r
- <entry>Wolf Halton</entry>\r
- <entry>Lysaris</entry>\r
- <entry>Lynn Floyd</entry>\r
- <entry>Anderson County Library</entry>\r
-- </row>\r
- \r
- <row>\r
- <entry>Sally Fortin</entry>\r
- <entry>Equinox Software</entry>\r
- </row> \r
-- <row>\r
-- <entry>Tina Ji</entry>\r
-- <entry>SITKA</entry>\r
-- </row>\r
-- <row>\r
-- <entry>Catherine Lemmer</entry>\r
-- <entry>Indiana State Library</entry>\r
-- </row>\r
-- <row>\r
- <entry>June Rayner</entry>\r
- <entry> eiNetwork</entry>\r
- <entry>Roma Matott</entry>\r
- <entry>Pioneer Library System</entry>\r
- </row>\r
- <row>\r
- <entry>Andrea Neiman</entry>\r
- <entry>Kent County Public Library</entry>\r
- </row>\r
- <row>\r
- <entry>Kevin Pischke</entry>\r
- <entry>William Jessup University </entry>\r
-- </row>\r
-- <row>\r
-- <entry>Tara Robertson</entry>\r
-- <entry>N/A</entry>\r
-- </row>\r
-- <row>\r
-- <entry>Rod Schiffman</entry>\r
-- <entry>Alpha-G Consulting</entry>\r
-- </row>\r
- \r
-- <row>\r
-- <entry>Steve Sheppard</entry>\r
-- <entry>Open</entry>\r
-- </row>\r
-- <row>\r
-- <entry>Ben Shum</entry>\r
-- <entry>Bibliomation</entry>\r
- </row>\r
- <row>\r
- <entry>Roni Shwaish</entry>\r
- <entry>eiNetwork</entry>\r
-- </row>\r
-- <row>\r
-- <entry>Robert Soulliere</entry>\r
-- <entry>Mohawk College</entry>\r
- </row>\r
- <row>\r
- <entry>Tim Spindler</entry>\r
- <entry>C/W MARS</entry>\r
-- </row>\r
-- <row>\r
-- <entry>Lindsay Stratton</entry>\r
-- <entry>Pioneer Library System</entry>\r
- </row>\r
- <row>\r
- <entry>Yamil Suarez</entry>\r
- <entry>Berklee College of Music</entry>\r
-- </row>\r
-- <row>\r
-- <entry>Jenny Turner</entry>\r
-- <entry>PALS</entry>\r
-- </row>\r
-- <row>\r
-- <entry>Repke de Vries</entry>\r
-- <entry>International Institute for Social History</entry>\r
- </row>\r
- <row>\r
- <entry>D. Ceabron Williams</entry>\r
- <entry>Flint River Regional Library System </entry>\r
-- </row>\r
-- <row>\r
-- <entry>Tigran Zargaryan</entry>\r
-- <entry>Fundamental Scientific Library of the National Academy of Sciences</entry>\r
-- </row>\r
-- </tbody>\r
-- </tgroup>\r
-- </table>\r
- <table>\r
- <title>Past DIG Participants</title>\r
- <tgroup align="left" cols="2" colsep="1" rowsep="1">\r
- <colspec colnum="1" colwidth="1.0*"/>\r
- <colspec colnum="2" colwidth="1.0*"/>\r
- <thead>\r
- <row>\r
- <entry>Name</entry>\r
- <entry>Organization</entry>\r
- \r
- </row>\r
- </thead>\r
- <tbody> \r
- <row>\r
- <entry>Paul Weiss </entry>\r
- <entry>Consultant/Sage Library System</entry>\r
- </row> \r
- <row>\r
- <entry>Karen Schneider</entry>\r
- <entry>Equinox Software </entry>\r
- </row>\r
- </tbody>\r
- </tgroup>\r
- </table> \r
-- </section>\r
-- <section xml:id="attributions">\r
- <title>Attributions</title> \r
- <para>Copyright © 2009-2011 <link linkend="aboutDIG">Evergreen DIG</link></para> \r
- <title>Attributions</title> \r
- <para>Copyright © 2009-2011 <link linkend="aboutDIG">Evergreen DIG</link></para> \r
-- <para>Copyright © 2007-2011 <link xl:href="http://www.esilibrary.com/esi/">Equinox</link></para> \r
-- <para>Copyright © 2007-2011 <link xl:href="http://coffeecode.net/">Dan Scott</link></para>\r
-- <para>Copyright © 2009-2011 <link xl:href="http://sitka.bclibraries.ca/">BC Libraries Cooperative (SITKA)</link></para>\r
-- <para>Copyright © 2008-2011 <link xl:href="http://www.kcls.org/">King County Library System</link></para>\r
- <para>Copyright © 2009-2011 <link xl:href="http://www.pls-net.org/">Pioneer Library System</link></para>\r
- <para>Copyright © 2009-2011 <link xl:href="http://www.mnpals.org/">PALS</link></para>\r
- <para>Copyright © 2009-2011 <link xl:href="http://www.georgialibraries.org/">Georgia Public Library Service</link></para>\r
- <para>Copyright © 2008-2011 <link xl:href="http://projectconifer.ca/">Project Conifer</link></para>\r
- <para>Copyright © 2009-2011 <link xl:href="http://biblio.org/">Bibliomation</link></para>\r
- <para>Copyright © 2008-2011 <link xl:href="http://www.in.gov/library/evergreen.htm">Evergreen Indiana</link></para>\r
- <para>Copyright © 2009-2010 <link xl:href="http://www.pls-net.org/">Pioneer Library System</link></para>\r
- <para>Copyright © 2009-2010 <link xl:href="http://www.mnpals.org/">PALS</link></para>\r
- <para>Copyright © 2009-2010 <link xl:href="http://www.georgialibraries.org/">Georgia Public Library Service</link></para>\r
- <para>Copyright © 2008-2010 <link xl:href="http://projectconifer.ca/">Project Conifer</link></para>\r
- <para>Copyright © 2009-2010 <link xl:href="http://biblio.org/">Bibliomation</link></para>\r
- <para>Copyright © 2008-2010 <link xl:href="http://www.in.gov/library/evergreen.htm">Evergreen Indiana</link></para>\r
-- </section>\r
-- <section xml:id="howtoParticipate">\r
-- <title>How to Participate</title><indexterm><primary>Documentation Interest Group (DIG)</primary></indexterm>\r
-- <para>Contributing to documentation is an excellent way to support Evergreen, even if you are new to documentation. In fact, beginners often have a distinct advantage over the \r
-- experts, more easily spotting the places where documentation is lacking or where it is unclear.</para>\r
-- <para>We welcome your contribution with planning, writing, editing, testing, translating to DocBook, and other tasks. Whatever your background or experience we are keen to \r
-- have your help!</para> \r
-- <para>What you can do:</para>\r
-- <itemizedlist>\r
-- <listitem>Join the Evergreen documentation listserv: <link xl:href="http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation" \r
-- xl:title="Join the DIG listserv">list.georgialibraries.org/mailman/listinfo/open-ils-documentation</link> . This is the primary way we communicate with each other. \r
-- Please send an email introducing yourself to the list.</listitem><indexterm><primary>mailing lists</primary></indexterm>\r
-- <listitem>Add yourself to the <link xl:href="http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:digparticipants"> participant list</link> \r
-- if you have an Evergreen DokuWiki account, or send a request to <email>docs@evergreen-ils.org</email>.</listitem>\r
-- <listitem>Check out the <link xl:href="http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:outline">documentation outline</link> to see which areas need work, \r
-- and let the DIG list know in which areas you would like to work.</listitem>\r
-- <listitem>Review the documentation and report any error or make suggestion using <link xl:href="https://bugs.launchpad.net/evergreen/+filebug">Launchpad</link>.</listitem>\r
-- </itemizedlist>\r
-- <simplesect>\r
-- <title>Volunteer Roles</title>\r
-- <para>We are now looking for people to help produce the documentation. If you interested in participating, email the DIG facilitators at <email>docs@evergreen-ils.org</email> \r
-- or post on the documentation mailing list. We're looking for volunteers to work on the following:</para>\r
-- <itemizedlist>\r
-- <listitem>Writing – Produce the documentation (<quote>from scratch,</quote> and/or revised from existing materials). We're open to receiving content in any formats, such as \r
-- Word or Open Office, but of course, would be most delighted with DocBook xml format.</listitem>\r
-- <listitem>Testing – Compare the documents with the functions they describe and ensuring that the procedures accomplish the desired results. Even if you are not \r
-- officially in the DIG, we would appreciate any suggestions you may have for Evergreen documentation.</listitem>\r
-- <listitem>XML conversion – Convert existing documentation to DocBook format.</listitem>\r
-- <listitem>Editorial review – Ensuring the documentation is clear and follows <link xl:href="http://docs.evergreen-ils.org/style_guide/html/">Evergreen DIG style \r
-- guide</link> conventions.</listitem>\r
-- <listitem>Style and Design – Edit the DocBook style sheets or post style tips and suggestions on the DIG list.</listitem><indexterm><primary>DocBook</primary></indexterm>\r
-- </itemizedlist>\r
-- </simplesect>\r
-- </section> \r
--</appendix>\r
--\r
--\r
+++ /dev/null
--<?xml version="1.0" encoding="UTF-8"?>
- <glossary xml:id="Glossary" xmlns="http://docbook.org/ns/docbook"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:xl="http://www.w3.org/1999/xlink">
-<glossary xml:id="Glossary" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xl="http://www.w3.org/1999/xlink">
-- <title>Glossary</title>
-- <abstract>
-- <para>In this section we expand acronyms, define terms, and generally try
-- to explain concepts used by Evergreen software.</para>
-- </abstract>
-- <glossdiv>
-- <title>A</title>
-- <glossentry xml:id="Apache">
-- <glossterm>Apache</glossterm>
-- <indexterm>
-- <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>
-- </glossdef>
-- </glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>B</title>
-- <glossentry xml:id="Book_Bags">
-- <glossterm>Bookbags</glossterm>
-- <indexterm>
-- <primary>bookbags</primary>
-- </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>
-- </glossdef>
-- </glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>C</title>
-- <glossentry xml:id="CentOS">
-- <glossterm>CentOS</glossterm>
-- <indexterm>
-- <primary>Linux</primary>
-- <secondary>CentOS</secondary>
-- </indexterm>
-- <glossdef>
-- <para>A popular open-source operating system based on Red Hat
-- Enterprises <systemitem class="osname">Linux</systemitem>
-- (also known as "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 xml: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.
-- 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>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="CPAN">
-- <glossterm>CPAN</glossterm>
-- <indexterm>
-- <primary>Perl</primary>
-- <secondary>CPAN</secondary>
-- </indexterm>
-- <glossdef>
-- <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>
-- <glossdiv>
-- <title>D</title>
-- <glossentry xml:id="Debian">
-- <glossterm>Debian</glossterm>
-- <indexterm>
-- <primary>Linux</primary>
-- <secondary>Debian</secondary>
-- </indexterm>
-- <glossdef>
- <para>One of the most popular open-source operating system based on the
- <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>
- <glossseealso otherterm="Fedora"/>
- <glossseealso otherterm="Ubuntu"/>
-- </glossdef>
-- </glossentry>
-- <glossentry>
-- <glossterm>Domain name</glossterm>
-- <indexterm>
-- <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>
-- <glossseealso otherterm="ipaddress"/>
-- </glossdef>
-- </glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>E</title>
-- <glossentry xml:id="ejabberd">
-- <glossterm>ejabberd</glossterm>
-- <indexterm>
-- <primary>ejabberd</primary>
-- </indexterm>
-- <glossdef>
-- <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"/>
-- </glossdef>
-- </glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>F</title>
- <glossentry xml:id="Fedora">
- <glossterm>Fedora</glossterm>
- <indexterm>
- <primary>Linux</primary>
- <secondary>Fedora</secondary>
- </indexterm>
- <glossdef>
- <para>A popular open-source operating system based on the
- <systemitem class="osname">Linux</systemitem> kernel.
- More information is available at
- <ulink url="http://http://fedoraproject.org/">http://fedoraproject.org/</ulink>.</para>
- <glossseealso otherterm="Debian"/>
- <glossseealso otherterm="Ubuntu"/>
- </glossdef>
- </glossentry>
- <glossentry></glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>G</title>
-- <glossentry xml:id="Gentoo">
-- <glossterm>Gentoo</glossterm>
-- <indexterm>
-- <primary>Linux</primary>
-- <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>
-- </glossdef>
-- </glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>H</title>
-- <glossentry></glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>I</title>
-- <glossentry xml:id="ipaddress">
-- <glossterm>IP Address</glossterm>
-- <indexterm>
-- <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>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="Item_Buckets">
-- <glossterm>Item/copy Buckets</glossterm>
-- <indexterm>
-- <primary>copy buckets</primary>
-- <seealso>item buckets</seealso>
-- </indexterm>
-- <indexterm>
-- <primary>item buckets</primary>
-- <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>
-- </glossdef>
-- </glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>J</title>
-- <glossentry xml:id="Jabber">
-- <glossterm>Jabber</glossterm>
-- <indexterm>
-- <primary>jabber</primary>
-- <seealso>XMPP</seealso>
-- </indexterm>
-- <glossdef>
-- <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>
-- <glossdiv>
-- <title>K</title>
-- <glossentry></glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>L</title>
-- <glossentry></glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>M</title>
-- <glossentry xml:id="MARC">
-- <glossterm>MARC</glossterm>
-- <indexterm>
-- <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>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="MARCXML">
-- <glossterm>MARCXML</glossterm>
-- <indexterm>
-- <primary>MARCXML</primary>
-- </indexterm>
-- <glossdef>
-- <para>Framework for working with MARC data in a XML environment.</para>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="McCoy">
-- <glossterm>McCoy</glossterm>
-- <glossdef>
-- <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>
-- <glossentry xml:id="memcached">
-- <glossterm>memcached</glossterm>
-- <indexterm>
-- <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>
-- </glossdef>
-- </glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>N</title>
-- <glossentry xml:id="netaddr">
-- <glossterm>Network address</glossterm>
-- <indexterm>
-- <primary>network address</primary>
-- <seealso>ip address</seealso>
-- </indexterm>
-- <glossdef>
-- <para>Also known as an IP address (Internet Protocol address).</para>
-- <glossseealso otherterm="ipaddress"/>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="nsis">
-- <glossterm>nsis</glossterm>
-- <glossdef>
-- <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>
-- <glossdiv>
-- <title>O</title>
-- <glossentry xml:id="OPAC">
-- <glossterm>OPAC</glossterm>
-- <indexterm>
-- <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>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="OpenSRF">
-- <glossterm>OpenSRF</glossterm>
-- <indexterm>
-- <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>
-- </glossdef>
-- </glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>P</title>
-- <glossentry xml: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>
- <para>The high-level scripting language in which most of the business logic of Evergreen is written.</para>
-- <glossseealso otherterm="CPAN"/>
-- </glossdef>
-- </glossentry>
-- <glossentry xml: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>
-- <glossseealso otherterm="SSL_Certificate"/>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="PostgreSQL">
-- <glossterm>PostgreSQL</glossterm>
-- <indexterm>
-- <primary>databases</primary>
-- <secondary>PostgreSQL</secondary>
-- </indexterm>
-- <glossdef>
-- <para>A popular open-source object-relational database management
-- system that underpins Evergreen software.</para>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="putty">
-- <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. 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>
-- <glossdiv>
-- <title>Q</title>
-- <glossentry></glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>R</title>
-- <glossentry xml: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. 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 xml:id="RHEL">
-- <glossterm>RHEL</glossterm>
-- <indexterm>
-- <primary>Linux</primary>
-- <secondary>RHEL</secondary>
-- </indexterm>
-- <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>
-- </glossdef>
-- </glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>S</title>
-- <glossentry xml:id="SIP2">
-- <glossterm>SIP</glossterm>
-- <indexterm>
-- <primary>SIP</primary>
-- </indexterm>
-- <glossdef>
-- <para>SIP (Standard Interchange Protocol) is a communications
-- protocol used within Evergreen for transferring 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 xml:id="srfsh">
-- <indexterm>
-- <primary>srfsh</primary>
-- </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>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="SRU">
-- <glossterm>SRU</glossterm>
-- <indexterm>
-- <primary>SRU</primary>
-- </indexterm>
-- <glossdef>
-- <para>SRU (Search & Retrieve URL Service) is a search protocol
-- used in web search and retrieval. It expresses queries in Contextual
-- Query Language (CQL) and transmits them as a URL, returning XML data
-- as if it were a web page.</para>
-- <glossseealso otherterm="SRW"/>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="SRW">
-- <glossterm>SRW</glossterm>
-- <indexterm>
-- <primary>SRW</primary>
-- </indexterm>
-- <glossdef>
-- <para>SRW (Search & Retrieve Web Service), also known as "SRU
-- via HTTP SOAP", is a search protocol used in web search and
-- retrieval. It uses a SOAP interface and expresses both the query and
-- result as XML data streams.</para>
-- <glossseealso otherterm="SRU"/>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="ssh">
-- <glossterm>SSH</glossterm>
-- <indexterm>
-- <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>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="sshproxy">
-- <glossterm>SSH proxy</glossterm>
-- <indexterm>
-- <primary>SSH</primary>
-- <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>
-- <glossseealso otherterm="ssh"/>
-- <glossseealso otherterm="tunneling"/>
-- <glossseealso otherterm="sshtunnel"/>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="sshtunnel">
-- <glossterm>SSH tunnel</glossterm>
-- <indexterm>
-- <primary>SSH</primary>
-- <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>
-- <glossseealso otherterm="ssh"/>
-- <glossseealso otherterm="tunneling"/>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="SSL_Certificate">
-- <glossterm>SSL Certificate</glossterm>
-- <indexterm>
-- <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>
- <glossseealso otherterm="PKI"/>
- </glossdef>
- </glossentry>
- <glossentry xml:id="SuperCat">
- <glossterm>SuperCat</glossterm>
- <indexterm>
- <primary>SuperCat</primary>
- </indexterm>
- <glossdef>
- <para>A popular commercial utility used to catalog, search and manage the
- contents of media such as CDs and DVDs.</para>
-- <glossseealso otherterm="PKI"/>
-- </glossdef>
-- </glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>T</title>
-- <glossentry xml:id="tunneling">
-- <glossterm>tunneling</glossterm>
-- <indexterm>
-- <primary>tunneling</primary>
-- <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>
-- <glossseealso otherterm="sshtunnel"/>
-- </glossdef>
-- </glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>U</title>
-- <glossentry xml:id="Ubuntu">
-- <glossterm>Ubuntu</glossterm>
-- <indexterm>
-- <primary>Linux</primary>
-- <secondary>Ubuntu</secondary>
-- </indexterm>
-- <glossdef>
- <para>A popular open-source operating system based on the
- <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
-- <ulink url="http://www.ubuntu.com">http://www.ubuntu.com</ulink>.</para>
-- <glossseealso otherterm="Debian"/>
- <glossseealso otherterm="Fedora"/>
-- </glossdef>
-- </glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>V</title>
-- <glossentry xml:id="virtualization">
-- <glossterm>Virtualization</glossterm>
-- <indexterm>
-- <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
-- a <emphasis>guest</emphasis> operating system environment in such a
-- way that the emulated environment is completely unaware of the
-- hosting environment. As used in Evergreen, it enables a copy of the
-- <systemitem class="osname">Linux</systemitem> operating system
-- running Evergreen software to execute within a
-- <systemitem class="osname">Windows</systemitem> environment.</para>
-- <glossseealso otherterm="virtualbox"/>
-- <glossseealso otherterm="virtualpc"/>
-- <glossseealso otherterm="vmware"/>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="virtualbox">
-- <glossterm>VirtualBox</glossterm>
-- <indexterm>
-- <primary>virtualization software</primary>
-- <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>,
-- <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>
-- <glossseealso otherterm="virtualization"/>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="virtualpc">
-- <glossterm>Virtual PC</glossterm>
-- <indexterm>
-- <primary>virtualization software</primary>
-- <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>
-- <glossseealso otherterm="virtualization"/>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="vmware">
-- <glossterm>VMware</glossterm>
-- <indexterm>
-- <primary>virtualization software</primary>
-- <secondary>VMware</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>,
-- <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>
-- <glossseealso otherterm="virtualization"/>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="Volume_Buckets">
-- <glossterm>Volume Buckets</glossterm>
-- <indexterm>
-- <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>
-- </glossdef>
-- </glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>W</title>
-- <glossentry xml:id="wine">
-- <glossterm>Wine</glossterm>
-- <indexterm>
-- <primary>Linux</primary>
-- <secondary>Wine</secondary>
-- </indexterm>
-- <glossdef>
-- <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
-- <ulink url="http://www.winehq.org/">http://www.winehq.org/</ulink>.</para>
-- </glossdef>
-- </glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>X</title>
-- <glossentry xml:id="xml">
-- <glossterm>XML</glossterm>
-- <indexterm>
-- <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>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="XMPP">
-- <glossterm>XMPP</glossterm>
-- <indexterm>
-- <primary>XMPP</primary>
-- <seealso>jabber</seealso>
-- </indexterm>
-- <glossdef>
-- <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 xml:id="xpath">
-- <glossterm>xpath</glossterm>
-- <indexterm>
-- <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>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="xul">
-- <glossterm>XUL</glossterm>
-- <indexterm>
-- <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
-- <ulink url="https://developer.mozilla.org/en/XUL">
-- https://developer.mozilla.org/en/XUL</ulink>.</para>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="xulrunner">
-- <glossterm>xulrunner</glossterm>
-- <indexterm>
-- <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
-- <ulink url="https://developer.mozilla.org/en/XULRunner">
-- https://developer.mozilla.org/en/XULRunner</ulink>.</para>
-- <glossseealso otherterm="xul"/>
-- </glossdef>
-- </glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>Y</title>
-- <glossentry xml:id="YAZ">
-- <glossterm>YAZ</glossterm>
-- <indexterm>
-- <primary>yaz</primary>
-- </indexterm>
-- <glossdef>
-- <para>A programmers’ toolkit supporting the development of
-- Z39.50 / SRW / SRU clients and servers.</para>
-- <glossseealso otherterm="SRU"/>
-- <glossseealso otherterm="SRW"/>
-- <glossseealso otherterm="Z39.50"/>
-- </glossdef>
-- </glossentry>
-- <glossentry xml:id="yaz-client">
-- <indexterm>
-- <primary>yaz</primary>
-- </indexterm>
-- <glossterm>yaz-client</glossterm>
-- <glossdef>
-- <para>A Z39.50/SRU client for connecting to YAZ servers.
-- More information is available at
-- <ulink url="http://www.indexdata.com/yaz/doc/yaz-client.html">
-- http://www.indexdata.com/yaz/doc/yaz-client.html</ulink></para>
-- <glossseealso otherterm="SRU"/>
-- </glossdef>
-- </glossentry>
-- </glossdiv>
-- <glossdiv>
-- <title>Z</title>
-- <glossentry xml:id="Z39.50">
-- <glossterm>Z
projects / Evergreen-DocBook.git / commitdiff