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