docs/root.adoc

   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_3_0.adoc[]
  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.adoc[]
  76
  77 // Push titles down one level.
  78 :leveloffset: 1
  79
  80 include::installation/server_installation.adoc[]
  81
  82 // Return to normal title levels.
  83 :leveloffset: 0
  84
  85 include::installation/server_upgrade.adoc[]
  86
  87 include::installation/edi_setup.adoc[]
  88
  89
  90 System Configuration and Customization
  91 ======================================
  92
  93 Introduction
  94 ------------
  95
  96 The Evergreen system allows a free range of customizations to every aspect of
  97 the system. Use this part of the documentation to become familiar with the tools
  98 for configuring the system as well as customizing the catalog and staff client.
  99
 100 // Push titles down one level.
 101 :leveloffset: 1
 102
 103 include::admin_initial_setup/describing_your_organization.adoc[]
 104
 105 include::admin_initial_setup/describing_your_people.adoc[]
 106
 107 include::admin_initial_setup/migrating_patron_data.adoc[]
 108
 109 include::admin_initial_setup/migrating_your_data.adoc[]
 110
 111 include::admin_initial_setup/importing_via_staff_client.adoc[]
 112
 113 include::admin_initial_setup/ordering_materials.adoc[]
 114
 115 include::admin_initial_setup/designing_your_catalog.adoc[]
 116
 117 include::admin/search_interface.adoc[]
 118
 119 include::admin_initial_setup/borrowing_items.adoc[]
 120
 121 // Return to normal title levels.
 122 :leveloffset: 0
 123
 124 include::admin_initial_setup/hard_due_dates.adoc[]
 125
 126
 127
 128 include::admin/template_toolkit.adoc[]
 129
 130 // Push titles down one level.
 131 :leveloffset: 1
 132
 133 include::opac/new_skin_customizations.adoc[]
 134
 135 // Return to normal title levels.
 136 :leveloffset: 0
 137
 138 include::admin/auto_suggest_search.adoc[]
 139
 140 include::admin/authentication_proxy.adoc[]
 141
 142 // Push titles down one level.
 143 :leveloffset: 1
 144
 145 include::TechRef/KidsOPAC.adoc[]
 146
 147 // Return to normal title levels.
 148 :leveloffset: 0
 149
 150 include::admin/customize_staff_client.adoc[]
 151
 152 include::admin/patron_address_by_zip_code.adoc[]
 153
 154 // Push titles down one level.
 155 :leveloffset: 1
 156
 157 include::admin/phonelist.adoc[]
 158
 159 // Return to normal title levels.
 160 :leveloffset: 0
 161
 162 include::admin/sip_server.adoc[]
 163
 164 :leveloffset: 1
 165
 166 include::admin/sip_privacy.adoc[]
 167
 168 :leveloffset: 0
 169
 170 include::admin/apache_rewrite_tricks.adoc[]
 171
 172 include::admin/apache_access_handler.adoc[]
 173
 174 include::admin/ebook_api_service.adoc[]
 175
 176 include::admin/hold_targeter_service.adoc[]
 177
 178 // Push titles down one level.
 179 :leveloffset: 1
 180
 181 include::admin/backups.adoc[]
 182
 183 // Return to normal title levels.
 184 :leveloffset: 0
 185
 186
 187
 188 Using the Browser Staff Client
 189 ==============================
 190
 191
 192 Introduction
 193 ------------
 194
 195 This part of the documentation deals with general Browser Client usage including
 196 logging in, navigation and shortcuts.
 197
 198 For information about the XUL client, consult the http://docs.evergreen-ils.org/2.11/[Evergreen 2.11 documentation].
 199
 200 include::admin/web_client-login.adoc[]
 201
 202 include::admin/web-client-browser-best-practices.adoc[]
 203
 204 include::admin/staff_client-column_picker.adoc[]
 205
 206 include::admin/staff_client-recent_searches.adoc[]
 207
 208 include::admin/workstation_admin.adoc[]
 209
 210 // Push titles down one level.
 211 :leveloffset: 1
 212
 213 include::admin/workstation_admin_receipt_template_editor.adoc[]
 214
 215 // Return to normal title levels.
 216 :leveloffset: 0
 217
 218 System Administration From the Staff Client
 219 ===========================================
 220
 221 Introduction
 222 ------------
 223
 224 This part deals with the options in the Server Administration menu found in the
 225 staff client.
 226
 227 // Follow structure from staff client system admin menu.
 228
 229 include::admin/acquisitions_admin.adoc[]
 230
 231 include::admin/age_hold_protection.adoc[]
 232
 233 include::admin/authorities.adoc[]
 234
 235 include::admin/Best_Hold_Selection_Sort_Order.adoc[]
 236
 237 include::admin/booking-admin.adoc[]
 238
 239 include::admin/cn_prefixes_and_suffixes.adoc[]
 240
 241 include::admin/desk_payments.adoc[]
 242
 243 include::admin/circulation_limit_groups.adoc[]
 244
 245 include::admin/copy_statuses.adoc[]
 246
 247 // Push titles down one level.
 248 :leveloffset: 1
 249
 250 include::admin/floating_groups.adoc[]
 251
 252 // Return to normal title levels.
 253 :leveloffset: 0
 254
 255 include::admin/MARC_Import_Remove_Fields.adoc[]
 256
 257 include::admin/copy_tags_admin.adoc[]
 258
 259 include::admin/MARC_RAD_MVF_CRA.adoc[]
 260
 261 include::admin/Org_Unit_Proximity_Adjustments.adoc[]
 262
 263 include::admin/permissions.adoc[]
 264
 265 include::admin/SMS_messaging.adoc[]
 266
 267 include::admin/user_activity_type.adoc[]
 268
 269 include::admin/restrict_Z39.50_sources_by_perm_group.adoc[]
 270
 271
 272 Local Administration
 273 ====================
 274
 275 Introduction
 276 ------------
 277
 278 This part covers the options in the Local Administration menu found in the staff
 279 client.
 280
 281 // Follow structure from staff client local admin menu.
 282
 283 include::admin/librarysettings.adoc[]
 284
 285 //    Address Alert Feature
 286 include::admin/lsa-address_alert.adoc[]
 287
 288 //    Barcode Completion Feature
 289 include::admin/lsa-barcode_completion.adoc[]
 290
 291 // Push titles down one level.
 292 :leveloffset: 1
 293
 294 include::admin/hold_driven_recalls.adoc[]
 295
 296 // Return to normal title levels.
 297 :leveloffset: 0
 298
 299 include::admin/actiontriggers.adoc[]
 300
 301 include::admin/actiontriggers_process.adoc[]
 302
 303 include::admin/recent_staff_searches.adoc[]
 304
 305 include::admin/lsa-standing_penalties.adoc[]
 306
 307 include::admin/lsa-statcat.adoc[]
 308
 309 include::admin/popularity_badges_web_client.adoc[]
 310
 311 include::admin/lsa-work_log.adoc[]
 312
 313 Acquisitions
 314 ===========
 315
 316 include::acquisitions/introduction.adoc[]
 317
 318 include::acquisitions/selection_lists_po.adoc[]
 319
 320 include::acquisitions/invoices.adoc[]
 321
 322 include::acquisitions/receive_items_from_invoice.adoc[]
 323
 324 include::acquisitions/vandelay_acquisitions_integration.adoc[]
 325
 326 include::acquisitions/purchase_requests_patron_view.adoc[]
 327
 328 include::acquisitions/purchase_requests_management.adoc[]
 329
 330 include::acquisitions/blanket.adoc[]
 331
 332
 333 Cataloging
 334 ==========
 335
 336 Introduction
 337 ------------
 338
 339 This part describes cataloging in Evergreen.
 340
 341 include::cataloging/marc_tag_table.adoc[]
 342
 343 include::cataloging/copy-buckets_web_client.adoc[]
 344
 345 include::cataloging/copy_tags_cataloging.adoc[]
 346
 347 include::cataloging/MARC_Editor.adoc[]
 348
 349 :leveloffset: 1
 350
 351 include::cataloging/record_buckets.adoc[]
 352
 353 // Push titles down one level.
 354 :leveloffset: 2
 355
 356 include::cataloging/physical_char_wizard.adoc[]
 357
 358 // Return titles to correct level.
 359 :leveloffset: 0
 360
 361 include::cataloging/batch_importing_MARC.adoc[]
 362
 363 include::cataloging/overlay_record_3950_import.adoc[]
 364
 365 include::cataloging/z39.50_search_enhancements.adoc[]
 366
 367
 368 include::cataloging/monograph_parts.adoc[]
 369
 370
 371 include::cataloging/conjoined_items.adoc[]
 372
 373 include::cataloging/cataloging_electronic_resources.adoc[]
 374
 375 include::cataloging/tpac_copy_edit_links.adoc[]
 376
 377 include::cataloging/MARC_batch_edit.adoc[]
 378
 379 include::cataloging/authorities.adoc[]
 380
 381 include::cataloging/link_checker.adoc[]
 382
 383
 384 Serials
 385 =======
 386
 387 include::serials/A-intro.adoc[]
 388
 389 include::serials/B-serials_admin.adoc[]
 390
 391 include::serials/C-serials_workflow.adoc[]
 392
 393 include::serials/D-Receiving.adoc[]
 394
 395 include::serials/E-routing_lists.adoc[]
 396
 397 include::serials/F-Special_issue.adoc[]
 398
 399 include::serials/G-binding.adoc[]
 400
 401 include::serials/H-holdings_statements.adoc[]
 402
 403 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.adoc[]
 404
 405 Circulation
 406 ===========
 407
 408 Introduction
 409 ------------
 410
 411 Use this section for understanding the circulation procedures in the Evergreen
 412 system.
 413
 414 include::circulation/circulating_items_web_client.adoc[]
 415
 416 Holds Management
 417 ----------------
 418
 419 include::circulation/basic_holds.adoc[]
 420
 421 include::circulation/advanced_holds.adoc[]
 422
 423 include::circulation/booking.adoc[]
 424
 425 include::circulation/circulation_patron_records_web_client.adoc[]
 426
 427 include::admin/patron_self_registration.adoc[]
 428
 429 include::circulation/triggered_events.adoc[]
 430
 431 // Push titles down one level.
 432 :leveloffset: 1
 433
 434 include::circulation/offline_circ_webclient.adoc[]
 435
 436 include::circulation/self_check.adoc[]
 437
 438 include::circulation/rfid_product_integration.adoc[]
 439
 440 // Return to normal title levels.
 441 :leveloffset: 0
 442
 443 Reports
 444 =======
 445
 446 Introduction
 447 ------------
 448
 449 Learn how to create and use reports in Evergreen.
 450
 451 include::reports/reporter_daemon.adoc[]
 452
 453 include::reports/reporter_folder.adoc[]
 454
 455 include::reports/reporter_create_templates.adoc[]
 456
 457 include::reports/reporter_generating_reports.adoc[]
 458
 459 include::reports/reporter_view_output.adoc[]
 460
 461 include::reports/reporter_cloning_shared_templates.adoc[]
 462
 463 include::reports/reporter_add_data_source.adoc[]
 464
 465 include::reports/reporter_running_recurring_reports.adoc[]
 466
 467 include::reports/reporter_template_terminology.adoc[]
 468
 469 include::reports/reporter_template_enhancements.adoc[]
 470
 471 include::reports/reporter_export_usingpgAdmin.adoc[]
 472
 473 Using the Public Access Catalog
 474 ===============================
 475
 476 Introduction
 477 ------------
 478
 479 Evergreen has a public OPAC that meets WCAG guidelines (http://www.w3.org/WAI/intro/wcag), which helps make the OPAC accessible to users with a range of disabilities. This part of the documentation explains how to use the Evergreen public OPAC. It covers the basic catalog and more advanced search topics. It also describes the ``My Account'' tools users have to find information and manage their personal library accounts through the OPAC. This section could be used by staff and patrons but would be more useful for staff as a generic reference when developing custom guides and tutorials for their users.
 480
 481 include::opac/using_the_public_access_catalog.adoc[]
 482
 483 include::opac/my_lists.adoc[]
 484
 485 include::opac/kids_opac.adoc[]
 486
 487 include::opac/catalog_browse.adoc[]
 488
 489 include::opac/advanced_features.adoc[]
 490
 491 include::opac/tpac_meta_record_holds.adoc[]
 492
 493 include::opac/linked_libraries.adoc[]
 494
 495 include::opac/opensearch.adoc[]
 496
 497 // Push titles down one level.
 498 :leveloffset: 1
 499
 500 include::opac/search_form.adoc[]
 501
 502 // Return to normal title levels.
 503 :leveloffset: 0
 504
 505
 506 Developer Resources
 507 ===================
 508
 509 Introduction
 510 ------------
 511
 512 Developers can use this part to learn more about the programming languages,
 513 communication protocols and standards used in Evergreen.
 514
 515 include::development/support_scripts.adoc[]
 516
 517 // Push titles down one level.
 518 :leveloffset: 1
 519
 520 include::development/pgtap.adoc[]
 521 include::development/intro_opensrf.adoc[]
 522 include::development/updating_translations_launchpad.adoc[]
 523
 524 // Return to normal title levels.
 525 :leveloffset: 0
 526
 527
 528 Getting Data from Evergreen
 529 ===========================
 530
 531 Introduction
 532 ------------
 533
 534 You may be interested in re-using data from your Evergreen installation in
 535 another application.  This part describes several methods to get the data
 536 you need.
 537
 538 // Push titles down one level.
 539 :leveloffset: 1
 540
 541 include::development/data_supercat.adoc[]
 542
 543 include::development/data_unapi.adoc[]
 544
 545 // Return to normal title levels.
 546 :leveloffset: 0
 547
 548 include::shared/attributions.adoc[]
 549
 550 include::licensing.adoc[]
 551
 552 [appendix]
 553 Admonitions
 554 ===========
 555
 556 * Note
 557
 558 image::media/note.png[]
 559
 560 * warning
 561
 562 image::media/warning.png[]
 563
 564 * caution
 565
 566 image::media/caution.png[]
 567
 568 * tip
 569
 570 image::media/tip.png[]
 571
 572 [index]
 573 Index
 574 =====
 575