7b7ae1af61ad813882cbc79e414b297d0ac25c7c
[working/Evergreen.git] / docs / root.adoc
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
61 include::RELEASE_NOTES_2_12.adoc[]
62
63
64 Software Installation
65 =====================
66
67
68 Introduction
69 ------------
70
71 This part will guide you through the installation steps installation or
72 upgrading your Evergreen system. It is intended for system administrators. 
73
74
75 include::installation/system_requirements.adoc[]
76
77 // Push titles down one level.
78 :leveloffset: 1
79
80 include::installation/server_installation.adoc[]
81
82 // Return to normal title levels.
83 :leveloffset: 0
84
85 include::installation/staff_client_installation.adoc[]
86
87 include::installation/server_upgrade.adoc[]
88
89 include::installation/edi_setup.adoc[]
90
91
92 System Configuration and Customization
93 ======================================
94
95 Introduction
96 ------------
97
98 The Evergreen system allows a free range of customizations to every aspect of
99 the system. Use this part of the documentation to become familiar with the tools
100 for configuring the system as well as customizing the catalog and staff client.  
101
102 // Push titles down one level.
103 :leveloffset: 1
104
105 include::admin_initial_setup/describing_your_organization.adoc[]
106
107 include::admin_initial_setup/describing_your_people.adoc[]
108
109 include::admin_initial_setup/migrating_patron_data.adoc[]
110
111 include::admin_initial_setup/migrating_your_data.adoc[]
112
113 include::admin_initial_setup/importing_via_staff_client.adoc[]
114
115 include::admin_initial_setup/ordering_materials.adoc[]
116
117 include::admin_initial_setup/designing_your_catalog.adoc[]
118
119 include::admin_initial_setup/borrowing_items.adoc[]
120
121 // Return to normal title levels.
122 :leveloffset: 0
123
124 include::admin_initial_setup/hard_due_dates.adoc[]
125
126
127
128 include::admin/template_toolkit.adoc[]
129
130 // Push titles down one level.
131 :leveloffset: 1
132
133 include::opac/new_skin_customizations.adoc[]
134
135 // Return to normal title levels.
136 :leveloffset: 0
137
138 include::admin/auto_suggest_search.adoc[]
139
140 include::admin/authentication_proxy.adoc[]
141
142 // Push titles down one level.
143 :leveloffset: 1
144
145 include::TechRef/KidsOPAC.adoc[]
146
147 // Return to normal title levels.
148 :leveloffset: 0
149
150 include::admin/customize_staff_client.adoc[]
151
152 include::admin/patron_address_by_zip_code.adoc[]
153
154 // Push titles down one level.
155 :leveloffset: 1
156
157 include::admin/phonelist.adoc[]
158
159 // Return to normal title levels.
160 :leveloffset: 0
161
162 include::admin/sip_server.adoc[]
163
164 include::admin/apache_rewrite_tricks.adoc[]
165
166 include::admin/apache_access_handler.adoc[]
167
168
169 Using the Browser Staff Client
170 ==============================
171
172
173 Introduction
174 ------------
175
176 This part of the documentation deals with general Browser Client usage including
177 logging in, navigation and shortcuts.
178
179 For information about the XUL client, consult the http://docs.evergreen-ils.org/2.11/[Evergreen 2.11 documentation].
180
181 include::admin/web_client-login.adoc[]
182
183 include::admin/web_client-browser-tab-shortcuts.adoc[]
184
185 include::admin/staff_client-column_picker.adoc[]
186
187 include::admin/staff_client-recent_searches.adoc[]
188
189 include::admin/staff_client-return_to_results_from_marc.adoc[]
190
191 include::admin/workstation_admin.adoc[]
192
193 // Push titles down one level.
194 :leveloffset: 1
195
196 include::admin/workstation_admin_receipt_template_editor.adoc[]
197
198 // Return to normal title levels.
199 :leveloffset: 0
200
201 System Administration From the Staff Client
202 ===========================================
203
204 Introduction
205 ------------
206
207 This part deals with the options in the Server Administration menu found in the
208 staff client. 
209
210 // Follow structure from staff client system admin menu.
211
212 include::admin/acquisitions_admin.adoc[]
213
214 include::admin/age_hold_protection.adoc[]
215
216 include::admin/authorities.adoc[]
217
218 include::admin/Best_Hold_Selection_Sort_Order.adoc[]
219
220 include::admin/booking-admin.adoc[]
221
222 include::admin/cn_prefixes_and_suffixes.adoc[]
223
224 include::admin/desk_payments.adoc[]
225
226 include::admin/circulation_limit_groups.adoc[]
227
228 include::admin/copy_statuses.adoc[]
229
230 // Push titles down one level.
231 :leveloffset: 1
232
233 include::admin/floating_groups.adoc[]
234
235 // Return to normal title levels.
236 :leveloffset: 0
237
238 include::admin/MARC_Import_Remove_Fields.adoc[]
239
240 include::admin/MARC_RAD_MVF_CRA.adoc[]
241
242 include::admin/Org_Unit_Proximity_Adjustments.adoc[]
243
244 include::admin/permissions.adoc[]
245
246 include::admin/SMS_messaging.adoc[]
247
248 include::admin/user_activity_type.adoc[]
249
250 include::admin/restrict_Z39.50_sources_by_perm_group.adoc[]
251
252
253 Local Administration
254 ====================
255
256 Introduction
257 ------------
258
259 This part covers the options in the Local Administration menu found in the staff
260 client. 
261
262 // Follow structure from staff client local admin menu.
263
264 include::admin/librarysettings.adoc[]
265
266 //    Address Alert Feature
267 include::admin/lsa-address_alert.adoc[]
268
269 //    Barcode Completion Feature
270 include::admin/lsa-barcode_completion.adoc[]
271
272 // Push titles down one level.
273 :leveloffset: 1
274
275 include::admin/hold_driven_recalls.adoc[]
276
277 // Return to normal title levels.
278 :leveloffset: 0
279
280 include::admin/actiontriggers.adoc[]
281
282 include::admin/recent_staff_searches.adoc[]
283
284 include::admin/lsa-standing_penalties.adoc[]
285
286 include::admin/lsa-statcat.adoc[]
287
288 include::admin/popularity_badges_web_client.adoc[]
289
290 include::admin/lsa-work_log.adoc[]
291
292 Acquisitions
293 ===========
294
295 include::acquisitions/introduction.adoc[]
296
297 include::acquisitions/selection_lists_po.adoc[]
298
299 include::acquisitions/invoices.adoc[]
300
301 include::acquisitions/receive_items_from_invoice.adoc[]
302
303 include::acquisitions/vandelay_acquisitions_integration.adoc[]
304
305 include::acquisitions/purchase_requests_patron_view.adoc[]
306
307 include::acquisitions/purchase_requests_management.adoc[]
308
309 include::acquisitions/blanket.adoc[]
310
311
312 Cataloging
313 ==========
314
315 include::cataloging/cataloging_web_client.adoc[]
316
317 include::cataloging/copy-buckets_web_client.adoc[]
318
319
320 include::cataloging/MARC_Editor.adoc[]
321
322 // Push titles down one level.
323 :leveloffset: 2
324
325 include::cataloging/physical_char_wizard.adoc[]
326
327 // Return titles to correct level.
328 :leveloffset: 0
329
330 include::cataloging/batch_importing_MARC.adoc[]
331
332 include::cataloging/overlay_record_3950_import.adoc[]
333
334 include::cataloging/z39.50_search_enhancements.adoc[]
335
336 include::cataloging/monograph_parts.adoc[]
337
338 include::cataloging/conjoined_items.adoc[]
339
340 include::cataloging/cataloging_electronic_resources.adoc[]
341
342 include::cataloging/tpac_copy_edit_links.adoc[]
343
344 include::cataloging/MARC_batch_edit.adoc[]
345
346 include::cataloging/authorities.adoc[]
347
348 include::cataloging/link_checker.adoc[]
349
350
351 Serials
352 =======
353
354 include::serials/A-intro.adoc[]
355
356 include::serials/B-copy_template.adoc[]
357
358 include::serials/C-subscription-SCV.adoc[]
359
360 include::serials/D-subscription-ASCV.adoc[]
361
362 include::serials/E-edit_subscriptions.adoc[]
363
364 include::serials/F-Receiving.adoc[]
365
366 include::serials/G-Special_issue.adoc[]
367
368 include::serials/H-holdings_statements.adoc[]
369
370 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.adoc[]
371
372 Circulation
373 ===========
374
375 Introduction
376 ------------
377
378 Use this section for understanding the circulation procedures in the Evergreen
379 system.  
380
381 include::circulation/circulating_items_web_client.adoc[]
382
383 include::circulation/holds.adoc[]
384
385 include::circulation/booking.adoc[]
386
387 include::circulation/circulation_patron_records_web_client.adoc[]
388
389 include::circulation/triggered_events.adoc[]
390
391 // Push titles down one level.
392 :leveloffset: 1
393
394 include::circulation/offline_mode.adoc[]
395
396 include::circulation/self_check.adoc[]
397
398 include::circulation/rfid_product_integration.adoc[]
399
400 // Return to normal title levels.
401 :leveloffset: 0
402
403 Reports
404 =======
405
406 Introduction
407 ------------
408
409 Learn how to create and use reports in Evergreen. 
410
411 include::reports/reporter_daemon.adoc[]
412
413 include::reports/reporter_folder.adoc[]
414
415 include::reports/reporter_create_templates.adoc[]
416
417 include::reports/reporter_generating_reports.adoc[]
418
419 include::reports/reporter_view_output.adoc[]
420
421 include::reports/reporter_cloning_shared_templates.adoc[]
422
423 include::reports/reporter_add_data_source.adoc[]
424
425 include::reports/reporter_running_recurring_reports.adoc[]
426
427 include::reports/reporter_template_terminology.adoc[]
428
429 include::reports/reporter_template_enhancements.adoc[]
430
431 include::reports/reporter_export_usingpgAdmin.adoc[]
432
433 Using the Public Access Catalog
434 ===============================
435
436 Introduction
437 ------------
438
439 Evergreen has a public OPAC that meets WCAG guidelines (http://www.w3.org/WAI/intro/wcag), which helps make the OPAC accessible to users with a range of disabilities. This part of the documentation explains how to use the Evergreen public OPAC. It covers the basic catalog and more advanced search topics. It also describes the ``My Account'' tools users have to find information and manage their personal library accounts through the OPAC. This section could be used by staff and patrons but would be more useful for staff as a generic reference when developing custom guides and tutorials for their users.
440
441 include::opac/using_the_public_access_catalog.adoc[]
442
443 include::opac/my_lists.adoc[]
444
445 include::opac/kids_opac.adoc[]
446
447 include::opac/catalog_browse.adoc[]
448
449 include::opac/advanced_features.adoc[]
450
451 include::opac/tpac_meta_record_holds.adoc[]
452
453 include::opac/linked_libraries.adoc[]
454
455 include::opac/opensearch.adoc[]
456
457 // Push titles down one level.
458 :leveloffset: 1
459
460 include::opac/search_form.adoc[]
461
462 // Return to normal title levels.
463 :leveloffset: 0
464
465
466 Developer Resources
467 ===================
468
469 Introduction
470 ------------
471
472 Developers can use this part to learn more about the programming languages,
473 communication protocols and standards used in Evergreen.  
474
475 include::development/support_scripts.adoc[]
476
477 // Push titles down one level.
478 :leveloffset: 1
479
480 include::development/pgtap.adoc[]
481 include::development/intro_opensrf.adoc[]
482 include::development/updating_translations_launchpad.adoc[]
483
484 // Return to normal title levels.
485 :leveloffset: 0
486
487
488 Getting Data from Evergreen
489 ===========================
490
491 Introduction
492 ------------
493
494 You may be interested in re-using data from your Evergreen installation in
495 another application.  This part describes several methods to get the data
496 you need.
497
498 // Push titles down one level.
499 :leveloffset: 1
500
501 include::development/data_supercat.adoc[]
502
503 include::development/data_unapi.adoc[]
504
505 // Return to normal title levels.
506 :leveloffset: 0
507
508 include::attributions.adoc[]
509
510 include::licensing.adoc[]
511
512 [appendix]
513 Admonitions
514 ===========
515
516 * Note 
517
518 image::media/note.png[]
519
520 * warning
521
522 image::media/warning.png[]
523
524 * caution
525
526 image::media/caution.png[]
527
528 * tip
529
530 image::media/tip.png[]
531
532 [index]
533 Index
534 =====
535