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_6.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 include::admin/customize_staff_client.txt[]
 139
 140 // Push titles down one level.
 141 :leveloffset: 1
 142
 143 include::admin/phonelist.txt[]
 144
 145 // Return to normal title levels.
 146 :leveloffset: 0
 147
 148
 149 Using the Staff Client
 150 ======================
 151
 152
 153 Introduction
 154 ------------
 155
 156 This part of the documentation deals with general Staff Client usage including
 157 logging in, navigation and shortcuts.
 158
 159
 160 include::admin/staff_client-login.txt[]
 161
 162 include::admin/staff_client-button_bar_toolbar.txt[]
 163
 164 include::admin/staff_client-sticky_settings.txt[]
 165
 166 include::admin/staff_client-tab_buttons.txt[]
 167
 168 include::admin/staff_client-double_clicking.txt[]
 169
 170 include::admin/staff_client-patron_border.txt[]
 171
 172 include::admin/staff_client-sorting_columns.txt[]
 173
 174 include::admin/staff_client-column_picker.txt[]
 175
 176 include::admin/staff_client-recent_searches.txt[]
 177
 178 include::admin/staff_client-return_to_results_from_marc.txt[]
 179
 180 include::admin/workstation_admin.txt[]
 181
 182 System Administration From the Staff Client
 183 ===========================================
 184
 185 Introduction
 186 ------------
 187
 188 This part deals with the options in the Server Administration menu found in the
 189 staff client.
 190
 191 // Follow structure from staff client system admin menu.
 192
 193 include::admin/acquisitions_admin.txt[]
 194
 195 include::admin/authorities.txt[]
 196
 197 include::admin/Best_Hold_Selection_Sort_Order.txt[]
 198
 199 include::admin/cn_prefixes_and_suffixes.txt[]
 200
 201 include::admin/circulation_limit_groups.txt[]
 202
 203 include::admin/booking-admin.txt[]
 204
 205 // Push titles down one level.
 206 :leveloffset: 1
 207
 208 include::admin/floating_groups.txt[]
 209
 210 // Return to normal title levels.
 211 :leveloffset: 0
 212
 213 include::admin/MARC_Import_Remove_Fields.txt[]
 214
 215 include::admin/Org_Unit_Proximity_Adjustments.txt[]
 216
 217 include::admin/permissions.txt[]
 218
 219 include::admin/SMS_messaging.txt[]
 220
 221 include::admin/user_activity_type.txt[]
 222
 223 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]
 224
 225
 226 Local Administration
 227 ====================
 228
 229 Introduction
 230 ------------
 231
 232 This part covers the options in the Local Administration menu found in the staff
 233 client.
 234
 235 // Follow structure from staff client local admin menu.
 236
 237 // Push titles down one level.
 238 :leveloffset: 1
 239
 240 include::admin/hold_driven_recalls.txt[]
 241
 242 // Return to normal title levels.
 243 :leveloffset: 0
 244
 245 include::admin/actiontriggers.txt[]
 246
 247 include::admin/recent_staff_searches.txt[]
 248
 249 include::admin/lsa-library_settings_editor.txt[]
 250
 251 include::admin/lsa-standing_penalties.txt[]
 252
 253 include::admin/lsa-statcat.txt[]
 254
 255 include::admin/lsa-work_log.txt[]
 256
 257 Acquisitions
 258 ===========
 259
 260 include::acquisitions/introduction.txt[]
 261
 262 include::acquisitions/selection_lists_po.txt[]
 263
 264 include::acquisitions/invoices.txt[]
 265
 266 include::acquisitions/receive_items_from_invoice.txt[]
 267
 268 include::acquisitions/vandelay_acquisitions_integration.txt[]
 269
 270
 271 Cataloging
 272 ==========
 273
 274 Introduction
 275 ------------
 276
 277 Cataloguers should use this part for understanding the cataloguing procedures
 278 used in Evergreen.
 279
 280 include::cataloging/batch_importing_MARC.txt[]
 281
 282 include::cataloging/overlay_record_3950_import.txt[]
 283
 284 include::cataloging/z39.50_search_enhancements.txt[]
 285
 286 include::cataloging/monograph_parts.txt[]
 287
 288 include::cataloging/conjoined_items.txt[]
 289
 290 include::cataloging/cataloging_electronic_resources.txt[]
 291
 292 include::cataloging/link_checker.txt[]
 293
 294
 295 Serials
 296 =======
 297
 298 include::serials/A-intro.txt[]
 299
 300 include::serials/B-copy_template.txt[]
 301
 302 include::serials/C-subscription-SCV.txt[]
 303
 304 include::serials/D-subscription-ASCV.txt[]
 305
 306 include::serials/E-edit_subscriptions.txt[]
 307
 308 include::serials/F-Receiving.txt[]
 309
 310 include::serials/G-Special_issue.txt[]
 311
 312 include::serials/H-holdings_statements.txt[]
 313
 314 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[]
 315
 316 Circulation
 317 ===========
 318
 319 Introduction
 320 ------------
 321
 322 Use this section for understanding the circulation procedures in the Evergreen
 323 system.
 324
 325 include::circulation/circulating_items.txt[]
 326
 327 include::circulation/holds.txt[]
 328
 329 include::circulation/booking.txt[]
 330
 331 include::circulation/circulation_patron_records.txt[]
 332
 333 include::circulation/triggered_events.txt[]
 334
 335 // Push titles down one level.
 336 :leveloffset: 1
 337
 338 include::circulation/offline_mode.txt[]
 339
 340 include::circulation/self_check.txt[]
 341
 342 include::circulation/rfid_product_integration.txt[]
 343
 344 // Return to normal title levels.
 345 :leveloffset: 0
 346
 347 Reports
 348 =======
 349
 350 Introduction
 351 ------------
 352
 353 Learn how to create and use reports in Evergreen.
 354
 355 include::reports/reporter_daemon.txt[]
 356
 357 include::reports/reporter_folder.txt[]
 358
 359 include::reports/reporter_create_templates.txt[]
 360
 361 include::reports/reporter_generating_reports.txt[]
 362
 363 include::reports/reporter_view_output.txt[]
 364
 365 include::reports/reporter_cloning_shared_templates.txt[]
 366
 367 include::reports/reporter_add_data_source.txt[]
 368
 369 include::reports/reporter_running_recurring_reports.txt[]
 370
 371 include::reports/reporter_template_terminology.txt[]
 372
 373 include::reports/reporter_export_usingpgAdmin.txt[]
 374
 375 Using the Public Access Catalog
 376 ===============================
 377
 378 Introduction
 379 ------------
 380
 381 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.
 382
 383 include::opac/using_the_public_access_catalog.txt[]
 384
 385 include::opac/my_lists.txt[]
 386
 387 include::opac/kids_opac.txt[]
 388
 389 include::opac/catalog_browse.txt[]
 390
 391 include::opac/advanced_features.txt[]
 392
 393 include::opac/linked_libraries.txt[]
 394
 395 include::opac/opensearch.txt[]
 396
 397 // Push titles down one level.
 398 :leveloffset: 1
 399
 400 include::opac/search_form.txt[]
 401
 402 // Return to normal title levels.
 403 :leveloffset: 0
 404
 405
 406 Developer Resources
 407 ===================
 408
 409 Introduction
 410 ------------
 411
 412 Developers can use this part to learn more about the programming languages,
 413 communication protocols and standards used in Evergreen.
 414
 415 include::development/support_scripts.txt[]
 416
 417 // Push titles down one level.
 418 :leveloffset: 1
 419
 420 include::development/pgtap.txt[]
 421 include::development/intro_opensrf.txt[]
 422 include::development/updating_translations_launchpad.txt[]
 423
 424 // Return to normal title levels.
 425 :leveloffset: 0
 426
 427 include::attributions.txt[]
 428
 429 include::licensing.txt[]
 430
 431 [appendix]
 432 Admonitions
 433 ===========
 434
 435 * Note
 436
 437 image::media/note.png[]
 438
 439 * warning
 440
 441 image::media/warning.png[]
 442
 443 * caution
 444
 445 image::media/caution.png[]
 446
 447 * tip
 448
 449 image::media/tip.png[]
 450
 451 [index]
 452 Index
 453 =====
 454