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