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