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