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_3.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_your_data.txt[]
 114
 115 include::admin_initial_setup/importing_via_staff_client.txt[]
 116
 117 // Return to normal title levels.
 118 :leveloffset: 0
 119
 120 include::admin/template_toolkit.txt[]
 121
 122 // Push titles down one level.
 123 :leveloffset: 1
 124
 125 include::opac/new_skin_customizations.txt[]
 126
 127 // Return to normal title levels.
 128 :leveloffset: 0
 129
 130 include::admin/auto_suggest_search.txt[]
 131
 132 include::admin/customize_staff_client.txt[]
 133
 134
 135 Using the Staff Client
 136 ======================
 137
 138
 139 Introduction
 140 ------------
 141
 142 This part of the documentation deals with general Staff Client usage including
 143 logging in, navigation and shortcuts.
 144
 145
 146 include::admin/staff_client-login.txt[]
 147
 148 include::admin/staff_client-tab_buttons.txt[]
 149
 150 include::admin/staff_client-double_clicking.txt[]
 151
 152 include::admin/staff_client-patron_border.txt[]
 153
 154 include::admin/staff_client-sorting_columns.txt[]
 155
 156 include::admin/staff_client-recent_searches.txt[]
 157
 158 include::admin/staff_client-return_to_results_from_marc.txt[]
 159
 160 include::admin/workstation_admin.txt[]
 161
 162 System Administration From the Staff Client
 163 ===========================================
 164
 165 Introduction
 166 ------------
 167
 168 This part deals with the options in the Server Administration menu found in the
 169 staff client.
 170
 171 // Follow structure from staff client system admin menu.
 172
 173 include::admin/acquisitions_admin.txt[]
 174
 175 include::admin/authorities.txt[]
 176
 177 include::admin/cn_prefixes_and_suffixes.txt[]
 178
 179 include::admin/circulation_limit_groups.txt[]
 180
 181 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]
 182
 183 include::admin/booking-admin.txt[]
 184
 185 include::admin/permissions.txt[]
 186
 187 include::admin/SMS_messaging.txt[]
 188
 189 include::admin/user_activity_type.txt[]
 190
 191
 192 Local Administration
 193 ====================
 194
 195 Introduction
 196 ------------
 197
 198 This part covers the options in the Local Administration menu found in the staff
 199 client.
 200
 201 // Follow structure from staff client local admin menu.
 202
 203 // Push titles down one level.
 204 :leveloffset: 1
 205
 206 include::admin/hold_driven_recalls.txt[]
 207
 208 // Return to normal title levels.
 209 :leveloffset: 0
 210
 211 include::admin/recent_staff_searches.txt[]
 212
 213 include::admin/lsa-library_settings_editor.txt[]
 214
 215 include::admin/lsa-standing_penalties.txt[]
 216
 217 include::admin/lsa-statcat.txt[]
 218
 219 include::admin/lsa-work_log.txt[]
 220
 221 Acquisitions
 222 ===========
 223
 224 include::acquisitions/introduction.txt[]
 225
 226 include::acquisitions/selection_lists_po.txt[]
 227
 228 include::acquisitions/invoices.txt[]
 229
 230 include::acquisitions/receive_items_from_invoice.txt[]
 231
 232 include::acquisitions/vandelay_acquisitions_integration.txt[]
 233
 234
 235 Cataloging
 236 ==========
 237
 238 Introduction
 239 ------------
 240
 241 Cataloguers should use this part for understanding the cataloguing procedures
 242 used in Evergreen.
 243
 244 include::cataloging/batch_importing_MARC.txt[]
 245
 246 include::cataloging/overlay_record_3950_import.txt[]
 247
 248 include::cataloging/monograph_parts.txt[]
 249
 250 include::cataloging/conjoined_items.txt[]
 251
 252
 253 Serials
 254 =======
 255
 256 include::serials/A-intro.txt[]
 257
 258 include::serials/B-copy_template.txt[]
 259
 260 include::serials/C-subscription-SCV.txt[]
 261
 262 include::serials/D-subscription-ASCV.txt[]
 263
 264 include::serials/E-edit_subscriptions.txt[]
 265
 266 include::serials/F-Receiving.txt[]
 267
 268 include::serials/G-Special_issue.txt[]
 269
 270 include::serials/H-holdings_statements.txt[]
 271
 272 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[]
 273
 274 Circulation
 275 ===========
 276
 277 Introduction
 278 ------------
 279
 280 Use this section for understanding the circulation procedures in the Evergreen
 281 system.
 282
 283 include::circulation/circulating_items.txt[]
 284
 285 include::circulation/holds_management.txt[]
 286
 287 include::circulation/booking.txt[]
 288
 289 include::circulation/circulation_patron_records.txt[]
 290
 291 include::circulation/triggered_events.txt[]
 292
 293 // Push titles down one level.
 294 :leveloffset: 1
 295
 296 include::circulation/offline_mode.txt[]
 297
 298 // Return to normal title levels.
 299 :leveloffset: 0
 300
 301 Reports
 302 =======
 303
 304 Introduction
 305 ------------
 306
 307 Learn how to create and use reports in Evergreen.
 308
 309 include::reports/reporter_daemon.txt[]
 310
 311 include::reports/reporter_folder.txt[]
 312
 313 include::reports/reporter_create_templates.txt[]
 314
 315 include::reports/reporter_generating_reports.txt[]
 316
 317 include::reports/reporter_view_output.txt[]
 318
 319 include::reports/reporter_cloning_shared_templates.txt[]
 320
 321 include::reports/reporter_add_data_source.txt[]
 322
 323 include::reports/reporter_running_recurring_reports.txt[]
 324
 325 include::reports/reporter_template_terminology.txt[]
 326
 327 include::reports/reporter_export_usingpgAdmin.txt[]
 328
 329 Using the Public Access Catalog
 330 ===============================
 331
 332 Introduction
 333 ------------
 334
 335 Use this part for information about searching the Evergreen public access catalog.
 336
 337 include::opac/my_lists.txt[]
 338
 339 include::opac/kids_opac.txt[]
 340
 341 // Push titles down one level.
 342 :leveloffset: 1
 343
 344 include::opac/search_form.txt[]
 345
 346 // Return to normal title levels.
 347 :leveloffset: 0
 348
 349
 350 Developer Resources
 351 ===================
 352
 353 Introduction
 354 ------------
 355
 356 Developers can use this part to learn more about the programming languages,
 357 communication protocols and standards used in Evergreen.
 358
 359 // Push titles down one level.
 360 :leveloffset: 1
 361
 362 include::development/intro_opensrf.txt[]
 363 include::development/updating_translations_launchpad.txt[]
 364
 365 // Return to normal title levels.
 366 :leveloffset: 0
 367
 368 include::attributions.txt[]
 369
 370 include::licensing.txt[]
 371
 372 [appendix]
 373 Admonitions
 374 ===========
 375
 376 * Note
 377
 378 image::media/note.png[]
 379
 380 * warning
 381
 382 image::media/warning.png[]
 383
 384 * caution
 385
 386 image::media/caution.png[]
 387
 388 * tip
 389
 390 image::media/tip.png[]
 391
 392 [index]
 393 Index
 394 =====
 395