caf366f6cbcd853810391e3e1176785e84addf48
[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 // Push titles down one level.
61 :leveloffset: 1
62
63 include::RELEASE_NOTES_2_3.txt[]
64
65 // Return to normal title levels.
66 :leveloffset: 0
67
68 Software Installation
69 =====================
70
71
72 Introduction
73 ------------
74
75 This part will guide you through the installation steps installation or
76 upgrading your Evergreen system. It is intended for system administrators. 
77
78
79 include::installation/system_requirements.txt[]
80
81 // Push titles down one level.
82 :leveloffset: 1
83
84 include::installation/server_installation.txt[]
85
86 // Return to normal title levels.
87 :leveloffset: 0
88
89 include::installation/server_upgrade.txt[]
90
91 include::installation/edi_setup.txt[]
92
93
94 System Configuration and Customization
95 ======================================
96
97 Introduction
98 ------------
99
100 The Evergreen system allows a free range of customizations to every aspect of
101 the system. Use this part of the documentation to become familiar with the tools
102 for  configuring the system as well as  customizing  the OPAC and staff client.  
103
104 include::admin/template_toolkit.txt[]
105
106 include::admin/auto_suggest_search.txt[]
107
108 include::admin/customize_staff_client.txt[]
109
110
111 Using the Staff Client
112 ======================
113
114
115 Introduction
116 ------------
117
118 This part of the documentation deals with general Staff Client usage including
119 logging in, navigation and shortcuts.
120
121
122 include::admin/staff_client-tab_buttons.txt[]
123
124 include::admin/staff_client-double_clicking.txt[]
125
126 include::admin/staff_client-patron_border.txt[]
127
128 include::admin/staff_client-sorting_columns.txt[]
129
130 include::admin/staff_client-recent_searches.txt[]
131
132 include::admin/staff_client-return_to_results_from_marc.txt[]
133
134 System Administration From the Staff Client
135 ===========================================
136
137 Introduction
138 ------------
139
140 This part deals with the options in the Server Administration menu found in the
141 staff client. 
142
143 // Follow structure from staff client system admin menu.
144
145 include::admin/acquisitions_admin.txt[]
146
147 include::admin/authorities.txt[]
148
149 include::admin/cn_prefixes_and_suffixes.txt[]
150
151 include::admin/circulation_limit_groups.txt[]
152
153 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]
154
155 include::admin/booking-admin.txt[]
156
157 include::admin/permissions.txt[]
158
159 include::admin/SMS_messaging.txt[]
160
161 include::admin/user_activity_type.txt[]
162
163
164 Local Administration
165 ====================
166
167 Introduction
168 ------------
169
170 This part covers the options in the Local Administration menu found in the staff
171 client. 
172
173 // Follow structure from staff client local admin menu.
174
175 // Push titles down one level.
176 :leveloffset: 1
177
178 include::admin/hold_driven_recalls.txt[]
179
180 // Return to normal title levels.
181 :leveloffset: 0
182
183 include::admin/recent_staff_searches.txt[]
184
185 include::admin/lsa-library_settings_editor.txt[]
186
187 include::admin/lsa-receipt_template_editor.txt[]
188
189 include::admin/lsa-standing_penalties.txt[]
190
191 include::admin/lsa-statcat.txt[]
192
193 include::admin/lsa-work_log.txt[]
194
195 Acquisitions
196 ===========
197
198 include::acquisitions/introduction.txt[]
199
200 include::acquisitions/selection_lists_po.txt[]
201
202 include::acquisitions/receive_items_from_invoice.txt[]
203
204 include::acquisitions/vandelay_acquisitions_integration.txt[]
205
206
207 Cataloging
208 ==========
209
210 Introduction
211 ------------
212
213 Cataloguers should use this part for understanding the cataloguing procedures
214 used in Evergreen.
215
216 include::cataloging/batch_importing_MARC.txt[]
217
218 include::cataloging/overlay_record_3950_import.txt[]
219
220 include::cataloging/monograph_parts.txt[]
221
222 include::cataloging/conjoined_items.txt[]
223
224
225 Serials
226 =======
227
228 include::serials/A-intro.txt[]
229
230 include::serials/B-copy_template.txt[]
231
232 include::serials/C-subscription-SCV.txt[]
233
234 include::serials/D-subscription-ASCV.txt[]
235
236 include::serials/E-edit_subscriptions.txt[]
237
238 include::serials/F-Receiving.txt[]
239
240 include::serials/G-Special_issue.txt[]
241
242 include::serials/H-holdings_statements.txt[]
243
244 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[]
245
246 Circulation
247 ===========
248
249 Introduction
250 ------------
251
252 Use this section for understanding the circulation procedures in the Evergreen
253 system.  
254
255 include::circulation/circulating_items.txt[]
256
257 include::circulation/holds_management.txt[]
258
259 include::circulation/booking.txt[]
260
261 include::circulation/circulation_patron_records.txt[]
262
263 include::circulation/triggered_events.txt[]
264
265 Reports
266 =======
267
268 Introduction
269 ------------
270
271 Learn how to create and use reports in Evergreen. 
272
273 include::reports/reporter_daemon.txt[]
274
275 include::reports/reporter_folder.txt[]
276
277 include::reports/reporter_create_templates.txt[]
278
279 include::reports/reporter_generating_reports.txt[]
280
281 include::reports/reporter_view_output.txt[]
282
283 include::reports/reporter_cloning_shared_templates.txt[]
284
285 include::reports/reporter_add_data_source.txt[]
286
287 include::reports/reporter_running_recurring_reports.txt[]
288
289 include::reports/reporter_template_terminology.txt[]
290
291 include::reports/reporter_export_usingpgAdmin.txt[]
292
293 Using the Public Access Catalog
294 ===============================
295
296 Introduction
297 ------------
298
299 Use this part for information about searching the Evergreen public access catalog.
300
301 include::opac/my_lists.txt[]
302
303 include::opac/kids_opac.txt[]
304
305 // Push titles down one level.
306 :leveloffset: 1
307
308 include::opac/search_form.txt[]
309
310 // Return to normal title levels.
311 :leveloffset: 0
312
313
314 Developer Resources
315 ===================
316
317 Introduction
318 ------------
319
320 Developers can use this part to learn more about the programming languages,
321 communication protocols and standards used in Evergreen.  
322
323 // Push titles down one level.
324 :leveloffset: 1
325
326 // include::development/updating_translations_launchpad.txt[]
327
328 // Return to normal title levels.
329 :leveloffset: 0
330
331 include::attributions.txt[]
332
333 include::licensing.txt[]
334
335 [appendix]
336 Admonitions
337 ===========
338
339 * Note 
340
341 image::media/note.png[]
342
343 * warning
344
345 image::media/warning.png[]
346
347 * caution
348
349 image::media/caution.png[]
350
351 * tip
352
353 image::media/tip.png[]
354
355 [index]
356 Index
357 =====
358