Docs: New chapter for Library Settings Editor
[working/Evergreen.git] / 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
61 include::RELEASE_NOTES_2_7.txt[]
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.txt[]
76
77 // Push titles down one level.
78 :leveloffset: 1
79
80 include::installation/server_installation.txt[]
81
82 // Return to normal title levels.
83 :leveloffset: 0
84
85 include::installation/staff_client_installation.txt[]
86
87 include::installation/server_upgrade.txt[]
88
89 include::installation/edi_setup.txt[]
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.txt[]
106
107 include::admin_initial_setup/describing_your_people.txt[]
108
109 include::admin_initial_setup/migrating_patron_data.txt[]
110
111 include::admin_initial_setup/migrating_your_data.txt[]
112
113 include::admin_initial_setup/importing_via_staff_client.txt[]
114
115 include::admin_initial_setup/ordering_materials.txt[]
116
117 include::admin_initial_setup/designing_your_catalog.txt[]
118
119 include::admin_initial_setup/borrowing_items.txt[]
120
121 // Return to normal title levels.
122 :leveloffset: 0
123
124 include::admin_initial_setup/hard_due_dates.txt[]
125
126
127
128 include::admin/template_toolkit.txt[]
129
130 // Push titles down one level.
131 :leveloffset: 1
132
133 include::opac/new_skin_customizations.txt[]
134
135 // Return to normal title levels.
136 :leveloffset: 0
137
138 include::admin/auto_suggest_search.txt[]
139
140 include::admin/authentication_proxy.txt[]
141
142 // Push titles down one level.
143 :leveloffset: 1
144
145 include::TechRef/KidsOPAC.txt[]
146
147 // Return to normal title levels.
148 :leveloffset: 0
149
150 include::admin/customize_staff_client.txt[]
151
152 include::admin/patron_address_by_zip_code.txt[]
153
154 // Push titles down one level.
155 :leveloffset: 1
156
157 include::admin/phonelist.txt[]
158
159 // Return to normal title levels.
160 :leveloffset: 0
161
162 include::admin/sip_server.txt[]
163
164 include::admin/apache_rewrite_tricks.txt[]
165
166 include::admin/apache_access_handler.txt[]
167
168
169 Using the Staff Client
170 ======================
171
172
173 Introduction
174 ------------
175
176 This part of the documentation deals with general Staff Client usage including
177 logging in, navigation and shortcuts.
178
179
180 include::admin/staff_client-login.txt[]
181
182 include::admin/staff_client-button_bar_toolbar.txt[]
183
184 include::admin/staff_client-sticky_settings.txt[]
185
186 include::admin/staff_client-tab_buttons.txt[]
187
188 include::admin/staff_client-double_clicking.txt[]
189
190 include::admin/staff_client-patron_border.txt[]
191
192 include::admin/staff_client-sorting_columns.txt[]
193
194 include::admin/staff_client-column_picker.txt[]
195
196 include::admin/staff_client-recent_searches.txt[]
197
198 include::admin/staff_client-return_to_results_from_marc.txt[]
199
200 include::admin/workstation_admin.txt[]
201
202 // Push titles down one level.
203 :leveloffset: 1
204
205 include::admin/workstation_admin_receipt_template_editor.txt[]
206
207 // Return to normal title levels.
208 :leveloffset: 0
209
210 include::admin/workstation_admin_customizable_toolbar.txt[]
211
212 System Administration From the Staff Client
213 ===========================================
214
215 Introduction
216 ------------
217
218 This part deals with the options in the Server Administration menu found in the
219 staff client. 
220
221 // Follow structure from staff client system admin menu.
222
223 include::admin/acquisitions_admin.txt[]
224
225 include::admin/age_hold_protection.txt[]
226
227 include::admin/authorities.txt[]
228
229 include::admin/Best_Hold_Selection_Sort_Order.txt[]
230
231 include::admin/booking-admin.txt[]
232
233 include::admin/cn_prefixes_and_suffixes.txt[]
234
235 include::admin/circulation_limit_groups.txt[]
236
237 include::admin/copy_statuses.txt[]
238
239 // Push titles down one level.
240 :leveloffset: 1
241
242 include::admin/floating_groups.txt[]
243
244 // Return to normal title levels.
245 :leveloffset: 0
246
247 include::admin/MARC_Import_Remove_Fields.txt[]
248
249 include::admin/MARC_RAD_MVF_CRA.txt[]
250
251 include::admin/Org_Unit_Proximity_Adjustments.txt[]
252
253 include::admin/permissions.txt[]
254
255 include::admin/SMS_messaging.txt[]
256
257 include::admin/user_activity_type.txt[]
258
259 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]
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 include::admin/lsa-address_alert.txt[]
276
277 // Push titles down one level.
278 :leveloffset: 1
279
280 include::admin/hold_driven_recalls.txt[]
281
282 // Return to normal title levels.
283 :leveloffset: 0
284
285 include::admin/actiontriggers.txt[]
286
287 include::admin/recent_staff_searches.txt[]
288
289 include::admin/lsa-standing_penalties.txt[]
290
291 include::admin/lsa-statcat.txt[]
292
293 include::admin/lsa-work_log.txt[]
294
295 Acquisitions
296 ===========
297
298 include::acquisitions/introduction.txt[]
299
300 include::acquisitions/selection_lists_po.txt[]
301
302 include::acquisitions/invoices.txt[]
303
304 include::acquisitions/receive_items_from_invoice.txt[]
305
306 include::acquisitions/vandelay_acquisitions_integration.txt[]
307
308
309 Cataloging
310 ==========
311
312 Introduction
313 ------------
314
315 Cataloguers should use this part for understanding the cataloguing procedures
316 used in Evergreen.
317
318 include::cataloging/MARC_Fixed_Field.txt[]
319
320 include::cataloging/physical_char_wizard.txt[]
321
322 include::cataloging/batch_importing_MARC.txt[]
323
324 include::cataloging/overlay_record_3950_import.txt[]
325
326 include::cataloging/z39.50_search_enhancements.txt[]
327
328 include::cataloging/monograph_parts.txt[]
329
330 include::cataloging/conjoined_items.txt[]
331
332 include::cataloging/cataloging_electronic_resources.txt[]
333
334 include::cataloging/tpac_copy_edit_links.txt[]
335
336 include::cataloging/MARC_batch_edit.txt[]
337
338 include::cataloging/authorities.txt[]
339
340 include::cataloging/link_checker.txt[]
341
342
343 Serials
344 =======
345
346 include::serials/A-intro.txt[]
347
348 include::serials/B-copy_template.txt[]
349
350 include::serials/C-subscription-SCV.txt[]
351
352 include::serials/D-subscription-ASCV.txt[]
353
354 include::serials/E-edit_subscriptions.txt[]
355
356 include::serials/F-Receiving.txt[]
357
358 include::serials/G-Special_issue.txt[]
359
360 include::serials/H-holdings_statements.txt[]
361
362 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[]
363
364 Circulation
365 ===========
366
367 Introduction
368 ------------
369
370 Use this section for understanding the circulation procedures in the Evergreen
371 system.  
372
373 include::circulation/circulating_items.txt[]
374
375 include::circulation/holds.txt[]
376
377 include::circulation/booking.txt[]
378
379 include::circulation/circulation_patron_records.txt[]
380
381 include::circulation/triggered_events.txt[]
382
383 // Push titles down one level.
384 :leveloffset: 1
385
386 include::circulation/offline_mode.txt[]
387
388 include::circulation/self_check.txt[]
389
390 include::circulation/rfid_product_integration.txt[]
391
392 // Return to normal title levels.
393 :leveloffset: 0
394
395 Reports
396 =======
397
398 Introduction
399 ------------
400
401 Learn how to create and use reports in Evergreen. 
402
403 include::reports/reporter_daemon.txt[]
404
405 include::reports/reporter_folder.txt[]
406
407 include::reports/reporter_create_templates.txt[]
408
409 include::reports/reporter_generating_reports.txt[]
410
411 include::reports/reporter_view_output.txt[]
412
413 include::reports/reporter_cloning_shared_templates.txt[]
414
415 include::reports/reporter_add_data_source.txt[]
416
417 include::reports/reporter_running_recurring_reports.txt[]
418
419 include::reports/reporter_template_terminology.txt[]
420
421 include::reports/reporter_template_enhancements.txt[]
422
423 include::reports/reporter_export_usingpgAdmin.txt[]
424
425 Web Client Preview
426 ==================
427
428 Introduction
429 ------------
430
431 The Evergreen Web Staff Client is in the early stages of development and is
432 being provided as a "preview" version beginning in Evergreen version 2.7.  If
433 you are an early adopter, thank you!  Please keep in mind:
434
435   . *We want your feedback!* Please report any errors, bugs, strange behavior,
436 etc. using https://bugs.launchpad.net/evergreen/[Launchpad]. And please send
437 requested features or design improvements to the
438 mailto:open-ils-dev@list.georgialibraries.org[Evergreen Developers email list].
439
440   . *It is changing rapidly.* Features are being added in "sprints" grouped by
441 workflow. Read the
442 http://evergreen-ils.org/dokuwiki/doku.php?id=dev:browser_staff:dev_sprints[development
443 wiki page] and watch the
444 http://libmail.georgialibraries.org/mailman/listinfo/open-ils-general[general
445 email list] for updates. (However, these changes will only appear on your client
446 when your version of Evergreen is upgraded. Ask your server administrator for
447 details.)
448
449   . *The design may change significantly.* Initially, it will follow the design
450 of the current XUL-based staff client. But the browser framework provides more
451 flexibility for design choices. Also, Evergreen has accepted an
452 http://wiki.evergreen-ils.org/doku.php?id=opw:ui_suggest:julialima[intern] to
453 focus on a User Interface Style Guide from December 2014 through March 2015.
454 Watch http://evergreen-ils.org/communicate/irc/[IRC] and the
455 http://libmail.georgialibraries.org/mailman/listinfo/open-ils-general[general
456 email list] to follow the progress.
457
458 The following rationale was published in the Release Notes for Evergreen 2.7:
459 ====
460 The 2.7 release will contain a preview of web client circulation features.
461 Circulation is the first step in moving all staff functions from the existing
462 XULRunner-based client to a web application that will be based on AngularJS.
463
464 Evergreen is moving away from the existing client because XULRunner no longer
465 supports features critical to the Evergreen software, including remote XUL,
466 multi-part streaming, and XML JavaScript. The new web client is expected to show
467 some speed improvements, to provide comprehensive support for
468 internationalization/localization, to provide good support for assistive
469 technologies, to be easier to customize locally, and to be more mobile friendly.
470
471 The intent of the preview is to make it easier for end users at Evergreen sites
472 to try the new client, become familiar with its features, and to discover/report
473 bugs that are found. Instructions to implement the web client can be found in
474 the code in Open-ILS/web/js/ui/default/staff/README.install. These will be
475 revised and moved to the full README for 2.7.1.
476 ====
477
478
479 Using the Web Client
480 --------------------
481
482 Introduction
483 ~~~~~~~~~~~~
484 This part of the documentation deals with general client usage including
485 logging in, navigation and shortcuts.
486
487 // Push titles down one level.
488 :leveloffset: 1
489
490 include::admin/web_client-login.txt[]
491
492 include::admin/web_client-browser-tab-shortcuts.txt[]
493
494 // Return to normal title levels.
495 :leveloffset: 0
496
497 Circulation
498 -----------
499 Use this section for understanding the circulation procedures in the Evergreen system.
500
501 include::circulation/circulation_patron_records_web_client.txt[]
502
503
504 Using the Public Access Catalog
505 ===============================
506
507 Introduction
508 ------------
509
510 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.
511
512 include::opac/using_the_public_access_catalog.txt[]
513
514 include::opac/my_lists.txt[]
515
516 include::opac/kids_opac.txt[]
517
518 include::opac/catalog_browse.txt[]
519
520 include::opac/advanced_features.txt[]
521
522 include::opac/tpac_meta_record_holds.txt[]
523
524 include::opac/linked_libraries.txt[]
525
526 include::opac/opensearch.txt[]
527
528 // Push titles down one level.
529 :leveloffset: 1
530
531 include::opac/search_form.txt[]
532
533 // Return to normal title levels.
534 :leveloffset: 0
535
536
537 Developer Resources
538 ===================
539
540 Introduction
541 ------------
542
543 Developers can use this part to learn more about the programming languages,
544 communication protocols and standards used in Evergreen.  
545
546 include::development/support_scripts.txt[]
547
548 // Push titles down one level.
549 :leveloffset: 1
550
551 include::development/pgtap.txt[]
552 include::development/intro_opensrf.txt[]
553 include::development/updating_translations_launchpad.txt[]
554
555 // Return to normal title levels.
556 :leveloffset: 0
557
558 include::attributions.txt[]
559
560 include::licensing.txt[]
561
562 [appendix]
563 Admonitions
564 ===========
565
566 * Note 
567
568 image::media/note.png[]
569
570 * warning
571
572 image::media/warning.png[]
573
574 * caution
575
576 image::media/caution.png[]
577
578 * tip
579
580 image::media/tip.png[]
581
582 [index]
583 Index
584 =====
585