docs/root.txt

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