Documentation: Fix various issues causing errors during processing.
[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_2.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 // include::staff_client_installation.txt[] 
94 // include::org_unit_structure_initialization.txt[]
95 // include::loading_data.txt[]
96
97
98 System Configuration and Customization
99 ======================================
100
101 Introduction
102 ------------
103
104 The Evergreen system allows a free range of customizations to every aspect of
105 the system. Use this part of the documentation to become familiar with the tools
106 for  configuring the system as well as  customizing  the OPAC and staff client.  
107
108 // include::global_system_configuration.txt[]
109 // include::opac_customization.txt[]
110
111 include::admin/template_toolkit.txt[]
112
113 include::admin/auto_suggest_search.txt[]
114
115 include::admin/customize_staff_client.txt[]
116
117 // include::backing_up.txt[]
118  
119
120
121 Using the Staff Client
122 ======================
123
124
125 Introduction
126 ------------
127
128 This part of the documentation deals with general Staff Client usage including
129 logging in, navigation and shortcuts.
130
131
132 include::admin/staff_client-tab_buttons.txt[]
133
134 include::admin/staff_client-double_clicking.txt[]
135
136 include::admin/staff_client-sorting_columns.txt[]
137
138 include::admin/staff_client-recent_searches.txt[]
139
140 include::admin/staff_client-return_to_results_from_marc.txt[]
141
142 System Administration From the Staff Client
143 ===========================================
144
145 Introduction
146 ------------
147
148 This part deals with the options in the Server Administration menu found in the
149 staff client. 
150
151 // Follow structure from staff client system admin menu.
152
153 include::admin/acquisitions_admin.txt[]
154
155 include::admin/authorities.txt[]
156
157 include::admin/cn_prefixes_and_suffixes.txt[]
158
159 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]
160
161 include::admin/booking-admin.txt[]
162
163 include::admin/SMS_messaging.txt[]
164
165 include::admin/user_activity_type.txt[]
166
167
168 Local Administration
169 ====================
170
171 Introduction
172 ------------
173
174 This part covers the options in the Local Administration menu found in the staff
175 client. 
176
177 // Follow structure from staff client local admin menu.
178
179 // Push titles down one level.
180 :leveloffset: 1
181
182 include::admin/hold_driven_recalls.txt[]
183
184 // Return to normal title levels.
185 :leveloffset: 0
186
187 include::admin/recent_staff_searches.txt[]
188
189 include::admin/lsa-library_settings_editor.txt[]
190
191 include::admin/lsa-statcat.txt[]
192
193
194 Acquisitions
195 ===========
196
197 include::acquisitions/introduction.txt[]
198
199 include::acquisitions/selection_lists_po.txt[]
200
201 include::acquisitions/receive_items_from_invoice.txt[]
202
203 include::acquisitions/vandelay_acquisitions_integration.txt[]
204
205
206 Cataloging
207 ==========
208
209 Introduction
210 ------------
211
212 Cataloguers should use this part for understanding the cataloguing procedures
213 used in Evergreen.
214
215 include::cataloging/batch_importing_MARC.txt[]
216
217 include::cataloging/overlay_record_3950_import.txt[]
218
219 include::cataloging/monograph_parts.txt[]
220
221 include::cataloging/conjoined_items.txt[]
222
223
224 Serials
225 =======
226
227 include::serials/A-intro.txt[]
228
229 include::serials/B-copy_template.txt[]
230
231 include::serials/C-subscription-SCV.txt[]
232
233 include::serials/D-subscription-ASCV.txt[]
234
235 include::serials/E-edit_subscriptions.txt[]
236
237 include::serials/F-Receiving.txt[]
238
239 include::serials/G-Special_issue.txt[]
240
241 include::serials/H-holdings_statements.txt[]
242
243 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[]
244
245 Circulation
246 ===========
247
248 Introduction
249 ------------
250
251 Use this section for understanding the circulation procedures in the Evergreen
252 system.  
253
254 include::circulation/circulating_items.txt[]
255
256 include::circulation/booking.txt[]
257
258 include::circulation/circulation_patron_records.txt[]
259
260 Reports
261 =======
262
263 Introduction
264 ------------
265
266 Learn how to create and use reports in Evergreen. 
267
268 Using the Public Access Catalog
269 ===============================
270
271 Introduction
272 ------------
273
274 Use this part for information about searching the Evergreen public access catalog.
275
276 include::opac/my_lists.txt[]
277
278 Developer Resources
279 ===================
280
281 Introduction
282 ------------
283
284 Developers can use this part to learn more about the programming languages,
285 communication protocols and standards used in Evergreen.  
286
287 // Push titles down one level.
288 :leveloffset: 1
289
290 include::development/updating_translations_launchpad.txt[]
291
292 // Return to normal title levels.
293 :leveloffset: 0
294
295 include::attributions.txt[]
296
297 include::licensing.txt[]
298
299 [appendix]
300 Admonitions
301 ===========
302
303 * Note 
304
305 image::media/note.png[]
306
307 * warning
308
309 image::media/warning.png[]
310
311 * caution
312
313 image::media/caution.png[]
314
315 * tip
316
317 image::media/tip.png[]
318
319 [index]
320 Index
321 =====
322