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