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