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