docs/index.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <book version="5.0" xmlns="http://docbook.org/ns/docbook"
   3   xmlns:xi="http://www.w3.org/2001/XInclude">
   4   <info>
   5     <title>The Book of Evergreen</title>
   6     <author><personname><firstname>Dan</firstname><surname>Scott</surname></personname></author>
   7     <copyright><year>2007</year><holder>Dan Scott</holder></copyright>
   8   </info>
   9
  10   <part><title>Preface</title>
  11     <chapter><title>Why read this book?</title><indexterm><primary>book rationale</primary></indexterm></chapter>
  12     <chapter><title>Conventions</title><indexterm><primary>book conventions</primary></indexterm></chapter>
  13     <chapter><title>Getting Evergreen</title><indexterm><primary>acquiring Evergreen</primary></indexterm></chapter>
  14     <chapter><title>Requests for comments</title><indexterm><primary>comments</primary><secondary>requests for</secondary></indexterm></chapter>
  15   </part>
  16
  17   <part><title>Introduction</title>
  18     <chapter><title>What is Evergreen?</title><indexterm><primary>about Evergreen</primary></indexterm></chapter>
  19     <chapter><title>A brief history of Evergreen</title><indexterm><primary>history</primary></indexterm></chapter>
  20     <chapter><title>Is Evergreen right for your library?</title><indexterm><primary>assessing Evergreen</primary></indexterm></chapter>
  21     <chapter><title>Evergreen architecture</title><indexterm><primary>architecture</primary></indexterm></chapter>
  22     <chapter><title>Evergreen concepts</title>
  23       <section><title>Organizational units: consortiums, libraries, and locations</title><indexterm><primary>org_units</primary></indexterm></section>
  24       <section><title>Items: bibliographic records, volumes, and copies</title><indexterm><primary>items</primary></indexterm></section>
  25     </chapter>
  26     <chapter><title>Scenarios: a tale of two Evergreen systems</title>
  27       <section>
  28         <title>Scenario 1: Le Grande University</title>
  29         <para>
  30           Le Grande University is a large academic institution that
  31           features one main library and six libraries with specialized
  32           collections distributed across campus. Circulation counts are
  33           low, search sessions are low volume but lengthy and in-depth,
  34           faculty and students make heavy use of shared resource lists
  35           and RSS feeds for lists of new resources in areas of interest.
  36         </para>
  37       </section>
  38       <section>
  39         <title>Scenario 2: Metropolitan Public Library Consortium</title>
  40         <para>
  41           The Metropolitan Public Library Consortium consists of one large
  42           central reference library, a set of 33 branch libraries in the
  43           city core, and 25 branch libraries distributed throughout the five
  44           recently amalgamated suburban areas that were once independent public
  45           libraries.
  46         </para>
  47         <para>
  48           Circulation counts are extremely high. Search sessions are high
  49           volume but typically short in duration and simple title / author
  50           searches. Catalog interfaces must be available in many different
  51           languages to support the diverse population of patrons. The staff
  52           client interface must be available in both official federal
  53           languages (French and English).
  54         </para>
  55       </section>
  56     </chapter>
  57   </part>
  58
  59   <part><title>Setting up an Evergreen system</title>
  60     <chapter><title>Setting up the router</title><indexterm><primary>router</primary><secondary>setting up</secondary></indexterm></chapter>
  61     <chapter><title>Setting up PostgreSQL database</title><indexterm><primary>database</primary><secondary>setting up</secondary></indexterm></chapter>
  62     <chapter><title>Setting up the memcached servers</title><indexterm><primary>memcached</primary><secondary>setting up</secondary></indexterm></chapter>
  63     <chapter><title>Configuring Evergreen</title>
  64       <section><title>Defining basic connection information (opensrf_core.xml)</title><indexterm><primary>router connections</primary></indexterm></section>
  65       <section><title>Defining Z39.50 sources (opensrf.xml)</title><indexterm><primary>Z39.50 sources</primary></indexterm></section>
  66       <section><title>Defining an added content service (opensrf.xml)</title><indexterm><primary>added content</primary></indexterm></section>
  67       <section><title>Setting default login timeouts (opensrf.xml)</title><indexterm><primary>OPAC inactivity timeouts</primary></indexterm></section>
  68       <section><title>Setting circulation policies (opensrf.xml / circ_groups.js)</title><indexterm><primary>circulation rules</primary></indexterm></section>
  69       <section><title>Defining field mappings (fm_IDL.xml)</title><indexterm><primary>interface definition language</primary></indexterm></section>
  70     </chapter>
  71     <chapter><title>Setting up Apache Web server</title>
  72       <section><title>Basic configuration (apache2.conf / httpd.conf)</title><indexterm><primary>Web server</primary><secondary>configuring</secondary></indexterm></section>
  73       <section><title>Defining your virtual host</title><indexterm><primary>virtual host</primary></indexterm></section>
  74     </chapter>
  75     <chapter><title>Installing the Evergreen staff client</title><indexterm><primary>staff client</primary><secondary>installing</secondary></indexterm></chapter>
  76     <chapter><title>Troubleshooting</title><indexterm><primary>troubleshooting</primary></indexterm></chapter>
  77   </part>
  78
  79   <part><title>Administering Evergreen</title>
  80     <xi:include href="starting_stopping.xml" />
  81     <chapter><title>Setting up organizational units</title><indexterm><primary>organizational units</primary><secondary>setting up</secondary></indexterm></chapter>
  82     <chapter><title>Generating reports</title><indexterm><primary>reporting</primary></indexterm></chapter>
  83     <chapter><title>Preventing disaster</title><indexterm><primary>backups</primary></indexterm></chapter>
  84   </part>
  85
  86   <part><title>Core tasks</title>
  87     <chapter><title>Cataloging</title><indexterm><primary>cataloging</primary></indexterm></chapter>
  88     <chapter><title>Circulation</title>
  89       <section><title>Offline circulation</title><indexterm><primary>circulation</primary><secondary>offline</secondary></indexterm></section>
  90     </chapter>
  91     <chapter><title>Course reserves</title><indexterm><primary>reserves</primary><secondary>academic</secondary></indexterm></chapter>
  92     <chapter><title>Acquisitions</title><indexterm><primary>acquisitions</primary></indexterm></chapter>
  93     <chapter><title>Serials</title><indexterm><primary>serials</primary></indexterm></chapter>
  94   </part>
  95
  96   <part><title>Customizing Evergreen</title>
  97     <partintro>
  98       <title>About this section</title>
  99       <para>
 100         This section is intended to describe the tasks that Evergreen administrators
 101         can perform to customize the look and feel of the system for their libraries.
 102         All tasks described here will be able to be completed with a rudimentary
 103         knowledge of XHTML, CSS, and JavaScript.
 104       </para>
 105     </partintro>
 106     <chapter><title>Customizing the staff client</title>
 107       <section><title>Changing the theme</title><indexterm><primary>staff client</primary><secondary>customizing</secondary><tertiary>theme</tertiary></indexterm></section>
 108       <section><title>Changing labels and messages</title><indexterm><primary>staff client</primary><secondary>customizing</secondary><tertiary>labels and messages</tertiary></indexterm></section>
 109       <section><title>Changing key mappings</title><indexterm><primary>staff client</primary><secondary>customizing</secondary><tertiary>key mappings</tertiary></indexterm></section>
 110     </chapter>
 111     <chapter><title>Customizing the catalog</title>
 112       <section><title>Changing the theme</title><indexterm><primary>catalog</primary><secondary>customizing</secondary><tertiary>theme</tertiary></indexterm></section>
 113       <section><title>Changing labels and messages</title><indexterm><primary>catalog</primary><secondary>customizing</secondary><tertiary>labels and messages</tertiary></indexterm></section>
 114       <section><title>Changing the hit list details</title><indexterm><primary>search results</primary><secondary>customizing</secondary></indexterm></section>
 115       <section><title>Changing the detailed view details</title><indexterm><primary>record details</primary><secondary>customizing</secondary></indexterm></section>
 116     </chapter>
 117   </part>
 118
 119   <part><title>Technical reference</title>
 120     <partintro>
 121       <title>About this section</title>
 122       <para>
 123         This section will document the Evergreen application programming
 124         interfaces (APIs), database schemas, communication protocols,
 125         client and catalog design and implementation, and configuration
 126         files.
 127       </para>
 128     </partintro>
 129     <chapter><title>Application Programming Interfaces</title>
 130       <section><title>OpenSRF</title><indexterm><primary>OpenSRF</primary></indexterm></section>
 131       <section><title>Web services</title><indexterm><primary>Web services</primary></indexterm></section>
 132     </chapter>
 133     <chapter><title>Database schemas</title><indexterm><primary>database schema</primary></indexterm></chapter>
 134     <chapter><title>Communication protocols (XMPP + JSON)</title><indexterm><primary>protocols</primary></indexterm></chapter>
 135     <chapter><title>Configuration files</title><indexterm><primary>configuration files</primary></indexterm></chapter>
 136   </part>
 137 </book>