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 // Push titles down one level.
  61 :leveloffset: 1
  62
  63 include::RELEASE_NOTES_2_8.txt[]
  64
  65 // Return to normal title levels.
  66 :leveloffset: 0
  67
  68
  69
  70 Software Installation
  71 =====================
  72
  73
  74 Introduction
  75 ------------
  76
  77 This part will guide you through the installation steps installation or
  78 upgrading your Evergreen system. It is intended for system administrators.
  79
  80
  81 include::installation/system_requirements.txt[]
  82
  83 // Push titles down one level.
  84 :leveloffset: 1
  85
  86 include::installation/server_installation.txt[]
  87
  88 // Return to normal title levels.
  89 :leveloffset: 0
  90
  91 include::installation/staff_client_installation.txt[]
  92
  93 include::installation/server_upgrade.txt[]
  94
  95 include::installation/edi_setup.txt[]
  96
  97
  98 System Configuration and Customization
  99 ======================================
 100
 101 Introduction
 102 ------------
 103
 104 The Evergreen system allows a free range of customizations to every aspect of
 105 the system. Use this part of the documentation to become familiar with the tools
 106 for configuring the system as well as customizing the catalog and staff client.
 107
 108 // Push titles down one level.
 109 :leveloffset: 1
 110
 111 include::admin_initial_setup/describing_your_organization.txt[]
 112
 113 include::admin_initial_setup/describing_your_people.txt[]
 114
 115 include::admin_initial_setup/migrating_patron_data.txt[]
 116
 117 include::admin_initial_setup/migrating_your_data.txt[]
 118
 119 include::admin_initial_setup/importing_via_staff_client.txt[]
 120
 121 include::admin_initial_setup/ordering_materials.txt[]
 122
 123 include::admin_initial_setup/designing_your_catalog.txt[]
 124
 125 include::admin_initial_setup/borrowing_items.txt[]
 126
 127 // Return to normal title levels.
 128 :leveloffset: 0
 129
 130 include::admin_initial_setup/hard_due_dates.txt[]
 131
 132
 133
 134 include::admin/template_toolkit.txt[]
 135
 136 // Push titles down one level.
 137 :leveloffset: 1
 138
 139 include::opac/new_skin_customizations.txt[]
 140
 141 // Return to normal title levels.
 142 :leveloffset: 0
 143
 144 include::admin/auto_suggest_search.txt[]
 145
 146 include::admin/authentication_proxy.txt[]
 147
 148 // Push titles down one level.
 149 :leveloffset: 1
 150
 151 include::TechRef/KidsOPAC.txt[]
 152
 153 // Return to normal title levels.
 154 :leveloffset: 0
 155
 156 include::admin/customize_staff_client.txt[]
 157
 158 include::admin/patron_address_by_zip_code.txt[]
 159
 160 // Push titles down one level.
 161 :leveloffset: 1
 162
 163 include::admin/phonelist.txt[]
 164
 165 // Return to normal title levels.
 166 :leveloffset: 0
 167
 168 include::admin/sip_server.txt[]
 169
 170 include::admin/apache_rewrite_tricks.txt[]
 171
 172 include::admin/apache_access_handler.txt[]
 173
 174
 175 Using the Staff Client
 176 ======================
 177
 178
 179 Introduction
 180 ------------
 181
 182 This part of the documentation deals with general Staff Client usage including
 183 logging in, navigation and shortcuts.
 184
 185
 186 include::admin/staff_client-login.txt[]
 187
 188 include::admin/staff_client-button_bar_toolbar.txt[]
 189
 190 include::admin/staff_client-sticky_settings.txt[]
 191
 192 include::admin/staff_client-tab_buttons.txt[]
 193
 194 include::admin/staff_client-double_clicking.txt[]
 195
 196 include::admin/staff_client-patron_border.txt[]
 197
 198 include::admin/staff_client-sorting_columns.txt[]
 199
 200 include::admin/staff_client-column_picker.txt[]
 201
 202 include::admin/staff_client-recent_searches.txt[]
 203
 204 include::admin/staff_client-return_to_results_from_marc.txt[]
 205
 206 include::admin/workstation_admin.txt[]
 207
 208 // Push titles down one level.
 209 :leveloffset: 1
 210
 211 include::admin/workstation_admin_receipt_template_editor.txt[]
 212
 213 // Return to normal title levels.
 214 :leveloffset: 0
 215
 216 include::admin/workstation_admin_customizable_toolbar.txt[]
 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.txt[]
 230
 231 include::admin/age_hold_protection.txt[]
 232
 233 include::admin/authorities.txt[]
 234
 235 include::admin/Best_Hold_Selection_Sort_Order.txt[]
 236
 237 include::admin/booking-admin.txt[]
 238
 239 include::admin/cn_prefixes_and_suffixes.txt[]
 240
 241 include::admin/circulation_limit_groups.txt[]
 242
 243 include::admin/copy_statuses.txt[]
 244
 245 // Push titles down one level.
 246 :leveloffset: 1
 247
 248 include::admin/floating_groups.txt[]
 249
 250 // Return to normal title levels.
 251 :leveloffset: 0
 252
 253 include::admin/MARC_Import_Remove_Fields.txt[]
 254
 255 include::admin/MARC_RAD_MVF_CRA.txt[]
 256
 257 include::admin/Org_Unit_Proximity_Adjustments.txt[]
 258
 259 include::admin/permissions.txt[]
 260
 261 include::admin/SMS_messaging.txt[]
 262
 263 include::admin/user_activity_type.txt[]
 264
 265 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]
 266
 267
 268 Local Administration
 269 ====================
 270
 271 Introduction
 272 ------------
 273
 274 This part covers the options in the Local Administration menu found in the staff
 275 client.
 276
 277 // Follow structure from staff client local admin menu.
 278
 279 include::admin/librarysettings.adoc[]
 280
 281 include::admin/lsa-address_alert.txt[]
 282
 283 // Push titles down one level.
 284 :leveloffset: 1
 285
 286 include::admin/hold_driven_recalls.txt[]
 287
 288 // Return to normal title levels.
 289 :leveloffset: 0
 290
 291 include::admin/actiontriggers.txt[]
 292
 293 include::admin/recent_staff_searches.txt[]
 294
 295 include::admin/lsa-standing_penalties.txt[]
 296
 297 include::admin/lsa-statcat.txt[]
 298
 299 include::admin/lsa-work_log.txt[]
 300
 301 Acquisitions
 302 ===========
 303
 304 include::acquisitions/introduction.txt[]
 305
 306 include::acquisitions/selection_lists_po.txt[]
 307
 308 include::acquisitions/invoices.txt[]
 309
 310 include::acquisitions/receive_items_from_invoice.txt[]
 311
 312 include::acquisitions/vandelay_acquisitions_integration.txt[]
 313
 314
 315 Cataloging
 316 ==========
 317
 318 Introduction
 319 ------------
 320
 321 Cataloguers should use this part for understanding the cataloguing procedures
 322 used in Evergreen.
 323
 324 include::cataloging/MARC_Fixed_Field.txt[]
 325
 326 include::cataloging/physical_char_wizard.txt[]
 327
 328 include::cataloging/batch_importing_MARC.txt[]
 329
 330 include::cataloging/overlay_record_3950_import.txt[]
 331
 332 include::cataloging/z39.50_search_enhancements.txt[]
 333
 334 include::cataloging/monograph_parts.txt[]
 335
 336 include::cataloging/conjoined_items.txt[]
 337
 338 include::cataloging/cataloging_electronic_resources.txt[]
 339
 340 include::cataloging/tpac_copy_edit_links.txt[]
 341
 342 include::cataloging/MARC_batch_edit.txt[]
 343
 344 include::cataloging/authorities.txt[]
 345
 346 include::cataloging/link_checker.txt[]
 347
 348
 349 Serials
 350 =======
 351
 352 include::serials/A-intro.txt[]
 353
 354 include::serials/B-copy_template.txt[]
 355
 356 include::serials/C-subscription-SCV.txt[]
 357
 358 include::serials/D-subscription-ASCV.txt[]
 359
 360 include::serials/E-edit_subscriptions.txt[]
 361
 362 include::serials/F-Receiving.txt[]
 363
 364 include::serials/G-Special_issue.txt[]
 365
 366 include::serials/H-holdings_statements.txt[]
 367
 368 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[]
 369
 370 Circulation
 371 ===========
 372
 373 Introduction
 374 ------------
 375
 376 Use this section for understanding the circulation procedures in the Evergreen
 377 system.
 378
 379 include::circulation/circulating_items.txt[]
 380
 381 include::circulation/holds.txt[]
 382
 383 include::circulation/booking.txt[]
 384
 385 include::circulation/circulation_patron_records.txt[]
 386
 387 include::circulation/triggered_events.txt[]
 388
 389 // Push titles down one level.
 390 :leveloffset: 1
 391
 392 include::circulation/offline_mode.txt[]
 393
 394 include::circulation/self_check.txt[]
 395
 396 include::circulation/rfid_product_integration.txt[]
 397
 398 // Return to normal title levels.
 399 :leveloffset: 0
 400
 401 Reports
 402 =======
 403
 404 Introduction
 405 ------------
 406
 407 Learn how to create and use reports in Evergreen.
 408
 409 include::reports/reporter_daemon.txt[]
 410
 411 include::reports/reporter_folder.txt[]
 412
 413 include::reports/reporter_create_templates.txt[]
 414
 415 include::reports/reporter_generating_reports.txt[]
 416
 417 include::reports/reporter_view_output.txt[]
 418
 419 include::reports/reporter_cloning_shared_templates.txt[]
 420
 421 include::reports/reporter_add_data_source.txt[]
 422
 423 include::reports/reporter_running_recurring_reports.txt[]
 424
 425 include::reports/reporter_template_terminology.txt[]
 426
 427 include::reports/reporter_template_enhancements.txt[]
 428
 429 include::reports/reporter_export_usingpgAdmin.txt[]
 430
 431 Web Client Preview
 432 ==================
 433
 434 Introduction
 435 ------------
 436
 437 The Evergreen Web Staff Client is in the early stages of development and is
 438 being provided as a "preview" version beginning in Evergreen version 2.7.  If
 439 you are an early adopter, thank you!  Please keep in mind:
 440
 441   . *We want your feedback!* Please report any errors, bugs, strange behavior,
 442 etc. using https://bugs.launchpad.net/evergreen/[Launchpad]. And please send
 443 requested features or design improvements to the
 444 mailto:open-ils-dev@list.georgialibraries.org[Evergreen Developers email list].
 445
 446   . *It is changing rapidly.* Features are being added in "sprints" grouped by
 447 workflow. Read the
 448 http://evergreen-ils.org/dokuwiki/doku.php?id=dev:browser_staff:dev_sprints[development
 449 wiki page] and watch the
 450 http://libmail.georgialibraries.org/mailman/listinfo/open-ils-general[general
 451 email list] for updates. (However, these changes will only appear on your client
 452 when your version of Evergreen is upgraded. Ask your server administrator for
 453 details.)
 454
 455   . *The design may change significantly.* Initially, it will follow the design
 456 of the current XUL-based staff client. But the browser framework provides more
 457 flexibility for design choices. Also, Evergreen has accepted an
 458 http://wiki.evergreen-ils.org/doku.php?id=opw:ui_suggest:julialima[intern] to
 459 focus on a User Interface Style Guide from December 2014 through March 2015.
 460 Watch http://evergreen-ils.org/communicate/irc/[IRC] and the
 461 http://libmail.georgialibraries.org/mailman/listinfo/open-ils-general[general
 462 email list] to follow the progress.
 463
 464 The following rationale was published in the Release Notes for Evergreen 2.7:
 465 ====
 466 The 2.7 release will contain a preview of web client circulation features.
 467 Circulation is the first step in moving all staff functions from the existing
 468 XULRunner-based client to a web application that will be based on AngularJS.
 469
 470 Evergreen is moving away from the existing client because XULRunner no longer
 471 supports features critical to the Evergreen software, including remote XUL,
 472 multi-part streaming, and XML JavaScript. The new web client is expected to show
 473 some speed improvements, to provide comprehensive support for
 474 internationalization/localization, to provide good support for assistive
 475 technologies, to be easier to customize locally, and to be more mobile friendly.
 476
 477 The intent of the preview is to make it easier for end users at Evergreen sites
 478 to try the new client, become familiar with its features, and to discover/report
 479 bugs that are found. Instructions to implement the web client can be found in
 480 the code in Open-ILS/web/js/ui/default/staff/README.install. These will be
 481 revised and moved to the full README for 2.7.1.
 482 ====
 483
 484
 485 Using the Web Client
 486 --------------------
 487
 488 Introduction
 489 ~~~~~~~~~~~~
 490 This part of the documentation deals with general client usage including
 491 logging in, navigation and shortcuts.
 492
 493 // Push titles down one level.
 494 :leveloffset: 1
 495
 496 include::admin/web_client-login.txt[]
 497
 498 include::admin/web_client-browser-tab-shortcuts.txt[]
 499
 500 // Return to normal title levels.
 501 :leveloffset: 0
 502
 503 Circulation
 504 -----------
 505 Use this section for understanding the circulation procedures in the Evergreen system.
 506
 507 include::circulation/circulation_patron_records_web_client.txt[]
 508
 509
 510 Using the Public Access Catalog
 511 ===============================
 512
 513 Introduction
 514 ------------
 515
 516 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.
 517
 518 include::opac/using_the_public_access_catalog.txt[]
 519
 520 include::opac/my_lists.txt[]
 521
 522 include::opac/kids_opac.txt[]
 523
 524 include::opac/catalog_browse.txt[]
 525
 526 include::opac/advanced_features.txt[]
 527
 528 include::opac/tpac_meta_record_holds.txt[]
 529
 530 include::opac/linked_libraries.txt[]
 531
 532 include::opac/opensearch.txt[]
 533
 534 // Push titles down one level.
 535 :leveloffset: 1
 536
 537 include::opac/search_form.txt[]
 538
 539 // Return to normal title levels.
 540 :leveloffset: 0
 541
 542
 543 Developer Resources
 544 ===================
 545
 546 Introduction
 547 ------------
 548
 549 Developers can use this part to learn more about the programming languages,
 550 communication protocols and standards used in Evergreen.
 551
 552 include::development/support_scripts.txt[]
 553
 554 // Push titles down one level.
 555 :leveloffset: 1
 556
 557 include::development/pgtap.txt[]
 558 include::development/intro_opensrf.txt[]
 559 include::development/updating_translations_launchpad.txt[]
 560
 561 // Return to normal title levels.
 562 :leveloffset: 0
 563
 564 include::attributions.txt[]
 565
 566 include::licensing.txt[]
 567
 568 [appendix]
 569 Admonitions
 570 ===========
 571
 572 * Note
 573
 574 image::media/note.png[]
 575
 576 * warning
 577
 578 image::media/warning.png[]
 579
 580 * caution
 581
 582 image::media/caution.png[]
 583
 584 * tip
 585
 586 image::media/tip.png[]
 587
 588 [index]
 589 Index
 590 =====
 591