Update docs to point to 2.6 release notes
[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_6.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/template_toolkit.txt[]
125
126 // Push titles down one level.
127 :leveloffset: 1
128
129 include::opac/new_skin_customizations.txt[]
130
131 // Return to normal title levels.
132 :leveloffset: 0
133
134 include::admin/auto_suggest_search.txt[]
135
136 include::admin/customize_staff_client.txt[]
137
138 // Push titles down one level.
139 :leveloffset: 1
140
141 include::admin/phonelist.txt[]
142
143 // Return to normal title levels.
144 :leveloffset: 0
145
146
147 Using the Staff Client
148 ======================
149
150
151 Introduction
152 ------------
153
154 This part of the documentation deals with general Staff Client usage including
155 logging in, navigation and shortcuts.
156
157
158 include::admin/staff_client-login.txt[]
159
160 include::admin/staff_client-button_bar_toolbar.txt[]
161
162 include::admin/staff_client-sticky_settings.txt[]
163
164 include::admin/staff_client-tab_buttons.txt[]
165
166 include::admin/staff_client-double_clicking.txt[]
167
168 include::admin/staff_client-patron_border.txt[]
169
170 include::admin/staff_client-sorting_columns.txt[]
171
172 include::admin/staff_client-column_picker.txt[]
173
174 include::admin/staff_client-recent_searches.txt[]
175
176 include::admin/staff_client-return_to_results_from_marc.txt[]
177
178 include::admin/workstation_admin.txt[]
179
180 System Administration From the Staff Client
181 ===========================================
182
183 Introduction
184 ------------
185
186 This part deals with the options in the Server Administration menu found in the
187 staff client. 
188
189 // Follow structure from staff client system admin menu.
190
191 include::admin/acquisitions_admin.txt[]
192
193 include::admin/authorities.txt[]
194
195 include::admin/Best_Hold_Selection_Sort_Order.txt[]
196
197 include::admin/cn_prefixes_and_suffixes.txt[]
198
199 include::admin/circulation_limit_groups.txt[]
200
201 include::admin/booking-admin.txt[]
202
203 // Push titles down one level.
204 :leveloffset: 1
205
206 include::admin/floating_groups.txt[]
207
208 // Return to normal title levels.
209 :leveloffset: 0
210
211 include::admin/MARC_Import_Remove_Fields.txt[]
212
213 include::admin/Org_Unit_Proximity_Adjustments.txt[]
214
215 include::admin/permissions.txt[]
216
217 include::admin/SMS_messaging.txt[]
218
219 include::admin/user_activity_type.txt[]
220
221 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]
222
223
224 Local Administration
225 ====================
226
227 Introduction
228 ------------
229
230 This part covers the options in the Local Administration menu found in the staff
231 client. 
232
233 // Follow structure from staff client local admin menu.
234
235 // Push titles down one level.
236 :leveloffset: 1
237
238 include::admin/hold_driven_recalls.txt[]
239
240 // Return to normal title levels.
241 :leveloffset: 0
242
243 include::admin/actiontriggers.txt[]
244
245 include::admin/recent_staff_searches.txt[]
246
247 include::admin/lsa-library_settings_editor.txt[]
248
249 include::admin/lsa-standing_penalties.txt[]
250
251 include::admin/lsa-statcat.txt[]
252
253 include::admin/lsa-work_log.txt[]
254
255 Acquisitions
256 ===========
257
258 include::acquisitions/introduction.txt[]
259
260 include::acquisitions/selection_lists_po.txt[]
261
262 include::acquisitions/invoices.txt[]
263
264 include::acquisitions/receive_items_from_invoice.txt[]
265
266 include::acquisitions/vandelay_acquisitions_integration.txt[]
267
268
269 Cataloging
270 ==========
271
272 Introduction
273 ------------
274
275 Cataloguers should use this part for understanding the cataloguing procedures
276 used in Evergreen.
277
278 include::cataloging/batch_importing_MARC.txt[]
279
280 include::cataloging/overlay_record_3950_import.txt[]
281
282 include::cataloging/z39.50_search_enhancements.txt[]
283
284 include::cataloging/monograph_parts.txt[]
285
286 include::cataloging/conjoined_items.txt[]
287
288 include::cataloging/link_checker.txt[]
289
290
291 Serials
292 =======
293
294 include::serials/A-intro.txt[]
295
296 include::serials/B-copy_template.txt[]
297
298 include::serials/C-subscription-SCV.txt[]
299
300 include::serials/D-subscription-ASCV.txt[]
301
302 include::serials/E-edit_subscriptions.txt[]
303
304 include::serials/F-Receiving.txt[]
305
306 include::serials/G-Special_issue.txt[]
307
308 include::serials/H-holdings_statements.txt[]
309
310 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[]
311
312 Circulation
313 ===========
314
315 Introduction
316 ------------
317
318 Use this section for understanding the circulation procedures in the Evergreen
319 system.  
320
321 include::circulation/circulating_items.txt[]
322
323 include::circulation/holds.txt[]
324
325 include::circulation/booking.txt[]
326
327 include::circulation/circulation_patron_records.txt[]
328
329 include::circulation/triggered_events.txt[]
330
331 // Push titles down one level.
332 :leveloffset: 1
333
334 include::circulation/offline_mode.txt[]
335
336 include::circulation/self_check.txt[]
337
338 include::circulation/rfid_product_integration.txt[]
339
340 // Return to normal title levels.
341 :leveloffset: 0
342
343 Reports
344 =======
345
346 Introduction
347 ------------
348
349 Learn how to create and use reports in Evergreen. 
350
351 include::reports/reporter_daemon.txt[]
352
353 include::reports/reporter_folder.txt[]
354
355 include::reports/reporter_create_templates.txt[]
356
357 include::reports/reporter_generating_reports.txt[]
358
359 include::reports/reporter_view_output.txt[]
360
361 include::reports/reporter_cloning_shared_templates.txt[]
362
363 include::reports/reporter_add_data_source.txt[]
364
365 include::reports/reporter_running_recurring_reports.txt[]
366
367 include::reports/reporter_template_terminology.txt[]
368
369 include::reports/reporter_export_usingpgAdmin.txt[]
370
371 Using the Public Access Catalog
372 ===============================
373
374 Introduction
375 ------------
376
377 Use this part for information about searching the Evergreen public access catalog.
378
379 include::opac/my_lists.txt[]
380
381 include::opac/kids_opac.txt[]
382
383 include::opac/catalog_browse.txt[]
384
385 include::opac/advanced_features.txt[]
386
387 include::opac/linked_libraries.txt[]
388
389 include::opac/opensearch.txt[]
390
391 // Push titles down one level.
392 :leveloffset: 1
393
394 include::opac/search_form.txt[]
395
396 // Return to normal title levels.
397 :leveloffset: 0
398
399
400 Developer Resources
401 ===================
402
403 Introduction
404 ------------
405
406 Developers can use this part to learn more about the programming languages,
407 communication protocols and standards used in Evergreen.  
408
409 // Push titles down one level.
410 :leveloffset: 1
411
412 include::development/pgtap.txt[]
413 include::development/intro_opensrf.txt[]
414 include::development/updating_translations_launchpad.txt[]
415
416 // Return to normal title levels.
417 :leveloffset: 0
418
419 include::attributions.txt[]
420
421 include::licensing.txt[]
422
423 [appendix]
424 Admonitions
425 ===========
426
427 * Note 
428
429 image::media/note.png[]
430
431 * warning
432
433 image::media/warning.png[]
434
435 * caution
436
437 image::media/caution.png[]
438
439 * tip
440
441 image::media/tip.png[]
442
443 [index]
444 Index
445 =====
446