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_10.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.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_initial_setup/hard_due_dates.txt[]
 125
 126
 127
 128 include::admin/template_toolkit.txt[]
 129
 130 // Push titles down one level.
 131 :leveloffset: 1
 132
 133 include::opac/new_skin_customizations.txt[]
 134
 135 // Return to normal title levels.
 136 :leveloffset: 0
 137
 138 include::admin/auto_suggest_search.txt[]
 139
 140 include::admin/authentication_proxy.txt[]
 141
 142 // Push titles down one level.
 143 :leveloffset: 1
 144
 145 include::TechRef/KidsOPAC.txt[]
 146
 147 // Return to normal title levels.
 148 :leveloffset: 0
 149
 150 include::admin/customize_staff_client.txt[]
 151
 152 include::admin/patron_address_by_zip_code.txt[]
 153
 154 // Push titles down one level.
 155 :leveloffset: 1
 156
 157 include::admin/phonelist.txt[]
 158
 159 // Return to normal title levels.
 160 :leveloffset: 0
 161
 162 include::admin/sip_server.txt[]
 163
 164 include::admin/apache_rewrite_tricks.txt[]
 165
 166 include::admin/apache_access_handler.txt[]
 167
 168
 169 Using the Staff Client
 170 ======================
 171
 172
 173 Introduction
 174 ------------
 175
 176 This part of the documentation deals with general Staff Client usage including
 177 logging in, navigation and shortcuts.
 178
 179
 180 include::admin/staff_client-login.txt[]
 181
 182 include::admin/staff_client-button_bar_toolbar.txt[]
 183
 184 include::admin/staff_client-sticky_settings.txt[]
 185
 186 include::admin/staff_client-tab_buttons.txt[]
 187
 188 include::admin/staff_client-double_clicking.txt[]
 189
 190 include::admin/staff_client-patron_border.txt[]
 191
 192 include::admin/staff_client-sorting_columns.txt[]
 193
 194 include::admin/staff_client-column_picker.txt[]
 195
 196 include::admin/staff_client-recent_searches.txt[]
 197
 198 include::admin/staff_client-return_to_results_from_marc.txt[]
 199
 200 include::admin/workstation_admin.txt[]
 201
 202 // Push titles down one level.
 203 :leveloffset: 1
 204
 205 include::admin/workstation_admin_receipt_template_editor.txt[]
 206
 207 // Return to normal title levels.
 208 :leveloffset: 0
 209
 210 include::admin/workstation_admin_customizable_toolbar.txt[]
 211
 212 System Administration From the Staff Client
 213 ===========================================
 214
 215 Introduction
 216 ------------
 217
 218 This part deals with the options in the Server Administration menu found in the
 219 staff client.
 220
 221 // Follow structure from staff client system admin menu.
 222
 223 include::admin/acquisitions_admin.txt[]
 224
 225 include::admin/age_hold_protection.txt[]
 226
 227 include::admin/authorities.txt[]
 228
 229 include::admin/Best_Hold_Selection_Sort_Order.txt[]
 230
 231 include::admin/booking-admin.txt[]
 232
 233 include::admin/cn_prefixes_and_suffixes.txt[]
 234
 235 include::admin/circulation_limit_groups.txt[]
 236
 237 include::admin/copy_statuses.txt[]
 238
 239 // Push titles down one level.
 240 :leveloffset: 1
 241
 242 include::admin/floating_groups.txt[]
 243
 244 // Return to normal title levels.
 245 :leveloffset: 0
 246
 247 include::admin/MARC_Import_Remove_Fields.txt[]
 248
 249 include::admin/MARC_RAD_MVF_CRA.txt[]
 250
 251 include::admin/Org_Unit_Proximity_Adjustments.txt[]
 252
 253 include::admin/permissions.txt[]
 254
 255 include::admin/SMS_messaging.txt[]
 256
 257 include::admin/user_activity_type.txt[]
 258
 259 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]
 260
 261
 262 Local Administration
 263 ====================
 264
 265 Introduction
 266 ------------
 267
 268 This part covers the options in the Local Administration menu found in the staff
 269 client.
 270
 271 // Follow structure from staff client local admin menu.
 272
 273 include::admin/librarysettings.adoc[]
 274
 275 //    Address Alert Feature
 276 include::admin/lsa-address_alert.txt[]
 277
 278 //    Barcode Completion Feature
 279 include::admin/lsa-barcode_completion.txt[]
 280
 281 // Push titles down one level.
 282 :leveloffset: 1
 283
 284 include::admin/hold_driven_recalls.txt[]
 285
 286 // Return to normal title levels.
 287 :leveloffset: 0
 288
 289 include::admin/actiontriggers.txt[]
 290
 291 include::admin/recent_staff_searches.txt[]
 292
 293 include::admin/lsa-standing_penalties.txt[]
 294
 295 include::admin/lsa-statcat.txt[]
 296
 297 include::admin/lsa-work_log.txt[]
 298
 299 Acquisitions
 300 ===========
 301
 302 include::acquisitions/introduction.txt[]
 303
 304 include::acquisitions/selection_lists_po.txt[]
 305
 306 include::acquisitions/invoices.txt[]
 307
 308 include::acquisitions/receive_items_from_invoice.txt[]
 309
 310 include::acquisitions/vandelay_acquisitions_integration.txt[]
 311
 312 include::acquisitions/purchase_requests_patron_view.txt[]
 313
 314 include::acquisitions/purchase_requests_management.txt[]
 315
 316
 317 Cataloging
 318 ==========
 319
 320 Introduction
 321 ------------
 322
 323 Cataloguers should use this part for understanding the cataloguing procedures
 324 used in Evergreen.
 325
 326 include::cataloging/MARC_Editor.txt[]
 327
 328 // Push titles down one level.
 329 :leveloffset: 2
 330
 331 include::cataloging/physical_char_wizard.txt[]
 332
 333 // Return titles to correct level.
 334 :leveloffset: 0
 335
 336 include::cataloging/batch_importing_MARC.txt[]
 337
 338 include::cataloging/overlay_record_3950_import.txt[]
 339
 340 include::cataloging/z39.50_search_enhancements.txt[]
 341
 342 include::cataloging/monograph_parts.txt[]
 343
 344 include::cataloging/conjoined_items.txt[]
 345
 346 include::cataloging/cataloging_electronic_resources.txt[]
 347
 348 include::cataloging/tpac_copy_edit_links.txt[]
 349
 350 include::cataloging/MARC_batch_edit.txt[]
 351
 352 include::cataloging/authorities.txt[]
 353
 354 include::cataloging/link_checker.txt[]
 355
 356
 357 Serials
 358 =======
 359
 360 include::serials/A-intro.txt[]
 361
 362 include::serials/B-copy_template.txt[]
 363
 364 include::serials/C-subscription-SCV.txt[]
 365
 366 include::serials/D-subscription-ASCV.txt[]
 367
 368 include::serials/E-edit_subscriptions.txt[]
 369
 370 include::serials/F-Receiving.txt[]
 371
 372 include::serials/G-Special_issue.txt[]
 373
 374 include::serials/H-holdings_statements.txt[]
 375
 376 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[]
 377
 378 Circulation
 379 ===========
 380
 381 Introduction
 382 ------------
 383
 384 Use this section for understanding the circulation procedures in the Evergreen
 385 system.
 386
 387 include::circulation/circulating_items.txt[]
 388
 389 include::circulation/holds.txt[]
 390
 391 include::circulation/booking.txt[]
 392
 393 include::circulation/circulation_patron_records.txt[]
 394
 395 include::circulation/triggered_events.txt[]
 396
 397 // Push titles down one level.
 398 :leveloffset: 1
 399
 400 include::circulation/offline_mode.txt[]
 401
 402 include::circulation/self_check.txt[]
 403
 404 include::circulation/rfid_product_integration.txt[]
 405
 406 // Return to normal title levels.
 407 :leveloffset: 0
 408
 409 Reports
 410 =======
 411
 412 Introduction
 413 ------------
 414
 415 Learn how to create and use reports in Evergreen.
 416
 417 include::reports/reporter_daemon.txt[]
 418
 419 include::reports/reporter_folder.txt[]
 420
 421 include::reports/reporter_create_templates.txt[]
 422
 423 include::reports/reporter_generating_reports.txt[]
 424
 425 include::reports/reporter_view_output.txt[]
 426
 427 include::reports/reporter_cloning_shared_templates.txt[]
 428
 429 include::reports/reporter_add_data_source.txt[]
 430
 431 include::reports/reporter_running_recurring_reports.txt[]
 432
 433 include::reports/reporter_template_terminology.txt[]
 434
 435 include::reports/reporter_template_enhancements.txt[]
 436
 437 include::reports/reporter_export_usingpgAdmin.txt[]
 438
 439 Web Client Preview
 440 ==================
 441
 442 Introduction
 443 ------------
 444
 445 The Evergreen Web Staff Client is in the early stages of development and is
 446 being provided as a "preview" version beginning in Evergreen version 2.7.  If
 447 you are an early adopter, thank you!  Please keep in mind:
 448
 449   . *We want your feedback!* Please report any errors, bugs, strange behavior,
 450 etc. using https://bugs.launchpad.net/evergreen/[Launchpad]. And please send
 451 requested features or design improvements to the
 452 mailto:open-ils-dev@list.georgialibraries.org[Evergreen Developers email list].
 453
 454   . *It is changing rapidly.* Features are being added in "sprints" grouped by
 455 workflow. Read the
 456 http://evergreen-ils.org/dokuwiki/doku.php?id=dev:browser_staff:dev_sprints[development
 457 wiki page] and watch the
 458 http://libmail.georgialibraries.org/mailman/listinfo/open-ils-general[general
 459 email list] for updates. (However, these changes will only appear on your client
 460 when your version of Evergreen is upgraded. Ask your server administrator for
 461 details.)
 462
 463   . *The design may change significantly.* Initially, it will follow the design
 464 of the current XUL-based staff client. But the browser framework provides more
 465 flexibility for design choices. Also, Evergreen hired an
 466 http://lima-julia.tumblr.com/EG-style-guide[intern] from December 2014 through
 467 March 2015 to create a
 468 http://evergreen-ils.org/documentation/previews/proposed_style_guide.html[User
 469 Interface Style Guide]. Watch http://evergreen-ils.org/communicate/irc/[IRC] and the
 470 http://libmail.georgialibraries.org/mailman/listinfo/open-ils-general[general
 471 email list] to follow the progress.
 472
 473 The following rationale was published in the Release Notes for Evergreen 2.7:
 474 ====
 475 The 2.7 release will contain a preview of web client circulation features.
 476 Circulation is the first step in moving all staff functions from the existing
 477 XULRunner-based client to a web application that will be based on AngularJS.
 478
 479 Evergreen is moving away from the existing client because XULRunner no longer
 480 supports features critical to the Evergreen software, including remote XUL,
 481 multi-part streaming, and XML JavaScript. The new web client is expected to show
 482 some speed improvements, to provide comprehensive support for
 483 internationalization/localization, to provide good support for assistive
 484 technologies, to be easier to customize locally, and to be more mobile friendly.
 485
 486 The intent of the preview is to make it easier for end users at Evergreen sites
 487 to try the new client, become familiar with its features, and to discover/report
 488 bugs that are found. Instructions to implement the web client can be found in
 489 the code in Open-ILS/web/js/ui/default/staff/README.install. These will be
 490 revised and moved to the full README for 2.7.1.
 491 ====
 492
 493 Evergreen 2.9 includes the following improvements to the web client preview:
 494 ====
 495 The web staff client now includes additional functionality to support
 496 cataloging and item maintenance, including:
 497
 498 - a new MARC editor
 499 - the service backing the authority headings chooser now has the ability
 500   to filter the browse by subject thesaurus
 501 - Z39.50 search and record import
 502 - improvements to copy and record bucket functionality
 503 - embedding the link checker interface
 504 - embedding the MARC batch import/export interface
 505 - the web staff volume/copy editor
 506
 507 Nearly all of the cataloging functionality available in the XUL staff client is
 508 now present in the web staff client with the exception of printing spine
 509 labels. Nonetheless, the web staff client remains a preview and is not
 510 recommended for production use.
 511 ====
 512
 513
 514 Using the Web Client
 515 --------------------
 516
 517 Introduction
 518 ~~~~~~~~~~~~
 519 This part of the documentation deals with general client usage including
 520 logging in, navigation and shortcuts.
 521
 522 // Push titles down one level.
 523 :leveloffset: 1
 524
 525 include::admin/web_client-login.txt[]
 526
 527 include::admin/web_client-browser-tab-shortcuts.txt[]
 528
 529 // Return to normal title levels.
 530 :leveloffset: 0
 531
 532 Circulation
 533 -----------
 534 Use this section for understanding the circulation procedures in the Evergreen system.
 535
 536 // Push titles down one level.
 537 :leveloffset: 1
 538
 539 include::circulation/circulation_patron_records_web_client.txt[]
 540
 541 // Return to normal title levels.
 542 :leveloffset: 0
 543
 544 Cataloging
 545 ----------
 546
 547 // Push titles down one level.
 548 :leveloffset: 1
 549
 550 include::cataloging/cataloging_web_client.txt[]
 551
 552 include::cataloging/copy-buckets_web_client.txt[]
 553
 554 // Return to normal title levels.
 555 :leveloffset: 0
 556
 557
 558 Using the Public Access Catalog
 559 ===============================
 560
 561 Introduction
 562 ------------
 563
 564 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.
 565
 566 include::opac/using_the_public_access_catalog.txt[]
 567
 568 include::opac/my_lists.txt[]
 569
 570 include::opac/kids_opac.txt[]
 571
 572 include::opac/catalog_browse.txt[]
 573
 574 include::opac/advanced_features.txt[]
 575
 576 include::opac/tpac_meta_record_holds.txt[]
 577
 578 include::opac/linked_libraries.txt[]
 579
 580 include::opac/opensearch.txt[]
 581
 582 // Push titles down one level.
 583 :leveloffset: 1
 584
 585 include::opac/search_form.txt[]
 586
 587 // Return to normal title levels.
 588 :leveloffset: 0
 589
 590
 591 Developer Resources
 592 ===================
 593
 594 Introduction
 595 ------------
 596
 597 Developers can use this part to learn more about the programming languages,
 598 communication protocols and standards used in Evergreen.
 599
 600 include::development/support_scripts.txt[]
 601
 602 // Push titles down one level.
 603 :leveloffset: 1
 604
 605 include::development/pgtap.txt[]
 606 include::development/intro_opensrf.txt[]
 607 include::development/updating_translations_launchpad.txt[]
 608
 609 // Return to normal title levels.
 610 :leveloffset: 0
 611
 612
 613 Getting Data from Evergreen
 614 ===========================
 615
 616 Introduction
 617 ------------
 618
 619 You may be interested in re-using data from your Evergreen installation in
 620 another application.  This part describes several methods to get the data
 621 you need.
 622
 623 // Push titles down one level.
 624 :leveloffset: 1
 625
 626 include::development/data_supercat.txt[]
 627
 628 include::development/data_unapi.txt[]
 629
 630 // Return to normal title levels.
 631 :leveloffset: 0
 632
 633 include::attributions.txt[]
 634
 635 include::licensing.txt[]
 636
 637 [appendix]
 638 Admonitions
 639 ===========
 640
 641 * Note
 642
 643 image::media/note.png[]
 644
 645 * warning
 646
 647 image::media/warning.png[]
 648
 649 * caution
 650
 651 image::media/caution.png[]
 652
 653 * tip
 654
 655 image::media/tip.png[]
 656
 657 [index]
 658 Index
 659 =====
 660