root.txt

   1 Evergreen Documentation\r
   2 =======================\r
   3 Documentation Interest Group\r
   4 :doctype: book\r
   5 :toc:\r
   6 :numbered:\r
   7 \r
   8 Introduction\r
   9 ============ \r
  10 \r
  11 About This Documentation\r
  12 ------------------------\r
  13 \r
  14 This guide was produced by the Evergreen Documentation Interest Group (DIG),\r
  15 consisting of numerous volunteers from many different organizations. The DIG\r
  16 has drawn together, edited, and supplemented pre-existing documentation\r
  17 contributed by libraries and consortia running Evergreen that were kind enough\r
  18 to release their documentation into the creative commons. Please see the\r
  19 <<attributions,Attributions>> section for a full list of authors and\r
  20 contributing organizations. Just like the software it describes, this guide is\r
  21 a work in progress, continually revised to meet the needs of its users, so if\r
  22 you find errors or omissions, please let us know, by contacting the DIG\r
  23 facilitators at docs@evergreen-ils.org.\r
  24 \r
  25 This guide to Evergreen is intended to meet the needs of front-line library\r
  26 staff, catalogers, library administrators, system administrators, and software\r
  27 developers. It is organized into Parts, Chapters, and Sections addressing key\r
  28 aspects of the software, beginning with the topics of broadest interest to the\r
  29 largest groups of users and progressing to some of the more specialized and\r
  30 technical topics of interest to smaller numbers of users.\r
  31 \r
  32 Copies of this guide can be accessed in PDF and HTML formats from http://docs.evergreen-ils.org/.\r
  33 \r
  34 About Evergreen\r
  35 ---------------\r
  36 \r
  37 Evergreen is an open source library automation software designed to meet the\r
  38 needs of the very smallest to the very largest libraries and consortia. Through\r
  39 its staff interface, it facilitates the management, cataloging, and circulation\r
  40 of library materials, and through its online public access interface it helps\r
  41 patrons find those materials.\r
  42 \r
  43 The Evergreen software is freely licensed under the GNU General Public License,\r
  44 meaning that it is free to download, use, view, modify, and share. It has an\r
  45 active development and user community, as well as several companies offering\r
  46 migration, support, hosting, and development services.\r
  47 \r
  48 The community’s development requirements state that Evergreen must be:\r
  49 \r
  50 * Stable, even under extreme load.\r
  51 * Robust, and capable of handling a high volume of transactions and simultaneous users.\r
  52 * Flexible, to accommodate the varied needs of libraries.\r
  53 * Secure, to protect our patrons’ privacy and data.\r
  54 * User-friendly, to facilitate patron and staff use of the system.\r
  55 \r
  56 Evergreen, which first launched in 2006 now powers over 544 libraries of every\r
  57 type – public, academic, special, school, and even tribal and home libraries –\r
  58 in over a dozen countries worldwide.\r
  59 \r
  60 // Push titles down one level.\r
  61 :leveloffset: 1\r
  62 \r
  63 include::release_notes.txt[]\r
  64 \r
  65 // Return to normal title levels.\r
  66 :leveloffset: 0\r
  67 \r
  68 Software Installation\r
  69 =====================\r
  70 \r
  71 \r
  72 Introduction\r
  73 ------------\r
  74 \r
  75 This part will guide you through the installation steps installation or\r
  76 upgrading your Evergreen system. It is intended for system administrators. \r
  77 \r
  78 \r
  79 include::installation/system_requirements.txt[]\r
  80 \r
  81 // Push titles down one level.\r
  82 :leveloffset: 1\r
  83 \r
  84 include::installation/server_installation.txt[]\r
  85 \r
  86 // Return to normal title levels.\r
  87 :leveloffset: 0\r
  88 \r
  89 include::installation/server_upgrade.txt[]\r
  90 \r
  91 include::installation/edi_setup.txt[]\r
  92 \r
  93 // include::staff_client_installation.txt[] \r
  94 // include::org_unit_structure_initialization.txt[]\r
  95 // include::loading_data.txt[]\r
  96 \r
  97 \r
  98 System Configuration and Customization\r
  99 ======================================\r
 100 \r
 101 Introduction\r
 102 ------------\r
 103 \r
 104 The Evergreen system allows a free range of customizations to every aspect of\r
 105 the system. Use this part of the documentation to become familiar with the tools\r
 106 for  configuring the system as well as  customizing  the OPAC and staff client.  \r
 107 \r
 108 // include::global_system_configuration.txt[]\r
 109 // include::opac_customization.txt[]\r
 110 \r
 111 include::admin/template_toolkit.txt[]\r
 112 \r
 113 include::admin/auto_suggest_search.txt[]\r
 114 \r
 115 include::admin/customize_staff_client.txt[]\r
 116 \r
 117 // include::backing_up.txt[]\r
 118  \r
 119 \r
 120 \r
 121 Using the Staff Client\r
 122 ======================\r
 123 \r
 124 \r
 125 Introduction\r
 126 ------------\r
 127 \r
 128 This part of the documentation deals with general Staff Client usage including\r
 129 logging in, navigation and shortcuts.\r
 130 \r
 131 \r
 132 include::admin/staff_client-tab_buttons.txt[]\r
 133 \r
 134 include::admin/staff_client-double_clicking.txt[]\r
 135 \r
 136 include::admin/staff_client-sorting_columns.txt[]\r
 137 \r
 138 include::admin/staff_client-recent_searches.txt[]\r
 139 \r
 140 include::admin/staff_client-return_to_results_from_marc.txt[]\r
 141 \r
 142 System Administration From the Staff Client\r
 143 ===========================================\r
 144 \r
 145 Introduction\r
 146 ------------\r
 147 \r
 148 This part deals with the options in the Server Administration menu found in the\r
 149 staff client. \r
 150 \r
 151 // Follow structure from staff client system admin menu.\r
 152 \r
 153 include::admin/acquisitions_admin.txt[]\r
 154 \r
 155 include::admin/authorities.txt[]\r
 156 \r
 157 include::admin/cn_prefixes_and_suffixes.txt[]\r
 158 \r
 159 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]\r
 160 \r
 161 include::admin/booking-admin.txt[]\r
 162 \r
 163 include::admin/SMS_messaging.txt[]\r
 164 \r
 165 include::admin/user_activity_type.txt[]\r
 166 \r
 167 \r
 168 Local Administration\r
 169 ====================\r
 170 \r
 171 Introduction\r
 172 ------------\r
 173 \r
 174 This part covers the options in the Local Administration menu found in the staff\r
 175 client. \r
 176 \r
 177 // Follow structure from staff client local admin menu.\r
 178 \r
 179 // Push titles down one level.\r
 180 :leveloffset: 1\r
 181 \r
 182 include::admin/hold_driven_recalls.txt[]\r
 183 \r
 184 // Return to normal title levels.\r
 185 :leveloffset: 0\r
 186 \r
 187 include::admin/recent_staff_searches.txt[]\r
 188 \r
 189 include::admin/lsa-library_settings_editor.txt[]\r
 190 \r
 191 include::admin/lsa-statcat.txt[]\r
 192 \r
 193 \r
 194 Acquisitions\r
 195 ===========\r
 196 \r
 197 include::acquisitions/introduction.txt[]\r
 198 \r
 199 include::acquisitions/selection_lists_po.txt[]\r
 200 \r
 201 include::acquisitions/receive_items_from_invoice.txt[]\r
 202 \r
 203 include::acquisitions/vandelay_acquisitions_integration.txt[]\r
 204 \r
 205 \r
 206 Cataloging\r
 207 ==========\r
 208 \r
 209 Introduction\r
 210 ------------\r
 211 \r
 212 Cataloguers should use this part for understanding the cataloguing procedures\r
 213 used in Evergreen.\r
 214 \r
 215 include::cataloging/batch_importing_MARC.txt[]\r
 216 \r
 217 include::cataloging/overlay_record_3950_import.txt[]\r
 218 \r
 219 include::cataloging/monograph_parts.txt[]\r
 220 \r
 221 include::cataloging/conjoined_items.txt[]\r
 222 \r
 223 \r
 224 Serials\r
 225 =======\r
 226 \r
 227 include::serials/A-intro.txt[]\r
 228 \r
 229 include::serials/B-copy_template.txt[]\r
 230 \r
 231 include::serials/C-subscription-SCV.txt[]\r
 232 \r
 233 include::serials/D-subscription-ASCV.txt[]\r
 234 \r
 235 include::serials/E-edit_subscriptions.txt[]\r
 236 \r
 237 include::serials/F-Receiving.txt[]\r
 238 \r
 239 include::serials/G-Special_issue.txt[]\r
 240 \r
 241 include::serials/H-holdings_statements.txt[]\r
 242 \r
 243 \r
 244 Circulation\r
 245 ===========\r
 246 \r
 247 Introduction\r
 248 ------------\r
 249 \r
 250 Use this section for understanding the circulation procedures in the Evergreen\r
 251 system.  \r
 252 \r
 253 include::circulation/circulating_items.txt[]\r
 254 \r
 255 include::circulation/booking.txt[]\r
 256 \r
 257 Reports\r
 258 =======\r
 259 \r
 260 Introduction\r
 261 ------------\r
 262 \r
 263 Learn how to create and use reports in Evergreen. \r
 264 \r
 265 Using the Public Access Catalog\r
 266 ===============================\r
 267 \r
 268 Introduction\r
 269 ------------\r
 270 \r
 271 Use this part for information about searching the Evergreen public access catalog.\r
 272 \r
 273 include::opac/my_lists.txt[]\r
 274 \r
 275 Developer Resources\r
 276 ===================\r
 277 \r
 278 Introduction\r
 279 ------------\r
 280 \r
 281 Developers can use this part to learn more about the programming languages,\r
 282 communication protocols and standards used in Evergreen.  \r
 283 \r
 284 // Push titles down one level.\r
 285 :leveloffset: 1\r
 286 \r
 287 include::development/updating_translations_launchpad.txt[]\r
 288 \r
 289 // Return to normal title levels.\r
 290 :leveloffset: 0\r
 291 \r
 292 [appendix]\r
 293 \r
 294 include::attributions.txt[]\r
 295 \r
 296 Admonitions\r
 297 ===========\r
 298 \r
 299 Images used for Admonitions\r
 300 ---------------------------\r
 301 \r
 302 * Note \r
 303 \r
 304 image::media/note.png[]\r
 305 \r
 306 * warning\r
 307 \r
 308 image::media/warning.png[]\r
 309 \r
 310 * caution\r
 311 \r
 312 image::media/caution.png[]\r
 313 \r
 314 * tip\r
 315 \r
 316 image::media/tip.png[]\r
 317 \r
 318 \r