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