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