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_4.txt[]
  64
  65 // Return to normal title levels.
  66 :leveloffset: 0
  67
  68 Software Installation
  69 =====================
  70
  71
  72 Introduction
  73 ------------
  74
  75 This part will guide you through the installation steps installation or
  76 upgrading your Evergreen system. It is intended for system administrators.
  77
  78
  79 include::installation/system_requirements.txt[]
  80
  81 // Push titles down one level.
  82 :leveloffset: 1
  83
  84 include::installation/server_installation.txt[]
  85
  86 // Return to normal title levels.
  87 :leveloffset: 0
  88
  89 include::installation/staff_client_installation.txt[]
  90
  91 include::installation/server_upgrade.txt[]
  92
  93 include::installation/edi_setup.txt[]
  94
  95
  96 System Configuration and Customization
  97 ======================================
  98
  99 Introduction
 100 ------------
 101
 102 The Evergreen system allows a free range of customizations to every aspect of
 103 the system. Use this part of the documentation to become familiar with the tools
 104 for configuring the system as well as customizing the catalog and staff client.
 105
 106 // Push titles down one level.
 107 :leveloffset: 1
 108
 109 include::admin_initial_setup/describing_your_organization.txt[]
 110
 111 include::admin_initial_setup/describing_your_people.txt[]
 112
 113 include::admin_initial_setup/migrating_patron_data.txt[]
 114
 115 include::admin_initial_setup/migrating_your_data.txt[]
 116
 117 include::admin_initial_setup/importing_via_staff_client.txt[]
 118
 119 include::admin_initial_setup/ordering_materials.txt[]
 120
 121 include::admin_initial_setup/designing_your_catalog.txt[]
 122
 123 include::admin_initial_setup/borrowing_items.txt[]
 124
 125 // Return to normal title levels.
 126 :leveloffset: 0
 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/customize_staff_client.txt[]
 141
 142
 143 Using the Staff Client
 144 ======================
 145
 146
 147 Introduction
 148 ------------
 149
 150 This part of the documentation deals with general Staff Client usage including
 151 logging in, navigation and shortcuts.
 152
 153
 154 include::admin/staff_client-login.txt[]
 155
 156 include::admin/staff_client-tab_buttons.txt[]
 157
 158 include::admin/staff_client-double_clicking.txt[]
 159
 160 include::admin/staff_client-patron_border.txt[]
 161
 162 include::admin/staff_client-sorting_columns.txt[]
 163
 164 include::admin/staff_client-recent_searches.txt[]
 165
 166 include::admin/staff_client-return_to_results_from_marc.txt[]
 167
 168 include::admin/workstation_admin.txt[]
 169
 170 System Administration From the Staff Client
 171 ===========================================
 172
 173 Introduction
 174 ------------
 175
 176 This part deals with the options in the Server Administration menu found in the
 177 staff client.
 178
 179 // Follow structure from staff client system admin menu.
 180
 181 include::admin/acquisitions_admin.txt[]
 182
 183 include::admin/authorities.txt[]
 184
 185 include::admin/Best_Hold_Selection_Sort_Order.txt[]
 186
 187 include::admin/cn_prefixes_and_suffixes.txt[]
 188
 189 include::admin/circulation_limit_groups.txt[]
 190
 191 include::admin/booking-admin.txt[]
 192
 193 include::admin/MARC_Import_Remove_Fields.txt[]
 194
 195 include::admin/Org_Unit_Proximity_Adjustments.txt[]
 196
 197 include::admin/permissions.txt[]
 198
 199 include::admin/SMS_messaging.txt[]
 200
 201 include::admin/user_activity_type.txt[]
 202
 203 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]
 204
 205
 206 Local Administration
 207 ====================
 208
 209 Introduction
 210 ------------
 211
 212 This part covers the options in the Local Administration menu found in the staff
 213 client.
 214
 215 // Follow structure from staff client local admin menu.
 216
 217 // Push titles down one level.
 218 :leveloffset: 1
 219
 220 include::admin/hold_driven_recalls.txt[]
 221
 222 // Return to normal title levels.
 223 :leveloffset: 0
 224
 225 include::admin/recent_staff_searches.txt[]
 226
 227 include::admin/lsa-library_settings_editor.txt[]
 228
 229 include::admin/lsa-standing_penalties.txt[]
 230
 231 include::admin/lsa-statcat.txt[]
 232
 233 include::admin/lsa-work_log.txt[]
 234
 235 Acquisitions
 236 ===========
 237
 238 include::acquisitions/introduction.txt[]
 239
 240 include::acquisitions/selection_lists_po.txt[]
 241
 242 include::acquisitions/invoices.txt[]
 243
 244 include::acquisitions/receive_items_from_invoice.txt[]
 245
 246 include::acquisitions/vandelay_acquisitions_integration.txt[]
 247
 248
 249 Cataloging
 250 ==========
 251
 252 Introduction
 253 ------------
 254
 255 Cataloguers should use this part for understanding the cataloguing procedures
 256 used in Evergreen.
 257
 258 include::cataloging/batch_importing_MARC.txt[]
 259
 260 include::cataloging/overlay_record_3950_import.txt[]
 261
 262 include::cataloging/monograph_parts.txt[]
 263
 264 include::cataloging/conjoined_items.txt[]
 265
 266 include::cataloging/link_checker.txt[]
 267
 268
 269 Serials
 270 =======
 271
 272 include::serials/A-intro.txt[]
 273
 274 include::serials/B-copy_template.txt[]
 275
 276 include::serials/C-subscription-SCV.txt[]
 277
 278 include::serials/D-subscription-ASCV.txt[]
 279
 280 include::serials/E-edit_subscriptions.txt[]
 281
 282 include::serials/F-Receiving.txt[]
 283
 284 include::serials/G-Special_issue.txt[]
 285
 286 include::serials/H-holdings_statements.txt[]
 287
 288 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[]
 289
 290 Circulation
 291 ===========
 292
 293 Introduction
 294 ------------
 295
 296 Use this section for understanding the circulation procedures in the Evergreen
 297 system.
 298
 299 include::circulation/circulating_items.txt[]
 300
 301 include::circulation/holds_management.txt[]
 302
 303 include::circulation/booking.txt[]
 304
 305 include::circulation/circulation_patron_records.txt[]
 306
 307 include::circulation/triggered_events.txt[]
 308
 309 // Push titles down one level.
 310 :leveloffset: 1
 311
 312 include::circulation/offline_mode.txt[]
 313
 314 include::circulation/self_check.txt[]
 315
 316 // Return to normal title levels.
 317 :leveloffset: 0
 318
 319 Reports
 320 =======
 321
 322 Introduction
 323 ------------
 324
 325 Learn how to create and use reports in Evergreen.
 326
 327 include::reports/reporter_daemon.txt[]
 328
 329 include::reports/reporter_folder.txt[]
 330
 331 include::reports/reporter_create_templates.txt[]
 332
 333 include::reports/reporter_generating_reports.txt[]
 334
 335 include::reports/reporter_view_output.txt[]
 336
 337 include::reports/reporter_cloning_shared_templates.txt[]
 338
 339 include::reports/reporter_add_data_source.txt[]
 340
 341 include::reports/reporter_running_recurring_reports.txt[]
 342
 343 include::reports/reporter_template_terminology.txt[]
 344
 345 include::reports/reporter_export_usingpgAdmin.txt[]
 346
 347 Using the Public Access Catalog
 348 ===============================
 349
 350 Introduction
 351 ------------
 352
 353 Use this part for information about searching the Evergreen public access catalog.
 354
 355 include::opac/my_lists.txt[]
 356
 357 include::opac/kids_opac.txt[]
 358
 359 include::opac/advanced_features.txt[]
 360
 361 // Push titles down one level.
 362 :leveloffset: 1
 363
 364 include::opac/search_form.txt[]
 365
 366 include::opac/authority_enhanced_browse.txt[]
 367
 368 // Return to normal title levels.
 369 :leveloffset: 0
 370
 371
 372 Developer Resources
 373 ===================
 374
 375 Introduction
 376 ------------
 377
 378 Developers can use this part to learn more about the programming languages,
 379 communication protocols and standards used in Evergreen.
 380
 381 // Push titles down one level.
 382 :leveloffset: 1
 383
 384 include::development/intro_opensrf.txt[]
 385 include::development/updating_translations_launchpad.txt[]
 386
 387 // Return to normal title levels.
 388 :leveloffset: 0
 389
 390 include::attributions.txt[]
 391
 392 include::licensing.txt[]
 393
 394 [appendix]
 395 Admonitions
 396 ===========
 397
 398 * Note
 399
 400 image::media/note.png[]
 401
 402 * warning
 403
 404 image::media/warning.png[]
 405
 406 * caution
 407
 408 image::media/caution.png[]
 409
 410 * tip
 411
 412 image::media/tip.png[]
 413
 414 [index]
 415 Index
 416 =====
 417