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