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