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