88a41e309aaac3391eabfac9a6eac49134a5c7b5
[working/Evergreen.git] / root.txt
1 Evergreen Documentation\r
2 =======================\r
3 Documentation Interest Group\r
4 :doctype: book\r
5 :toc:\r
6 :numbered:\r
7 \r
8 Introduction\r
9 ============ \r
10 \r
11 About This Documentation\r
12 ------------------------\r
13 \r
14 This guide was produced by the Evergreen Documentation Interest Group (DIG),\r
15 consisting of numerous volunteers from many different organizations. The DIG\r
16 has drawn together, edited, and supplemented pre-existing documentation\r
17 contributed by libraries and consortia running Evergreen that were kind enough\r
18 to release their documentation into the creative commons. Please see the\r
19 <<attributions,Attributions>> section for a full list of authors and\r
20 contributing organizations. Just like the software it describes, this guide is\r
21 a work in progress, continually revised to meet the needs of its users, so if\r
22 you find errors or omissions, please let us know, by contacting the DIG\r
23 facilitators at docs@evergreen-ils.org.\r
24 \r
25 This guide to Evergreen is intended to meet the needs of front-line library staff, catalogers, library administrators, system administrators, and software developers. It is organized into Parts, Chapters, and Sections addressing key aspects of the software, beginning with the topics of broadest interest to the largest groups of users and progressing to some of the more specialized and technical topics of interest to smaller numbers of users.\r
26 \r
27 Copies of this guide can be accessed in PDF and HTML formats from http://docs.evergreen-ils.org/.\r
28 \r
29 About Evergreen\r
30 ---------------\r
31 \r
32 Evergreen is an open source library automation software designed to meet the needs of the very smallest to the very largest libraries and consortia. Through its staff interface, it facilitates the management, cataloging, and circulation of library materials, and through its online public access interface it helps patrons find those materials.\r
33 \r
34 The Evergreen software is freely licensed under the GNU General Public License, meaning that it is free to download, use, view, modify, and share. It has an active development and user community, as well as several companies offering migration, support, hosting, and development services.\r
35 \r
36 The community’s development requirements state that Evergreen must be:\r
37 \r
38 * Stable, even under extreme load.\r
39 * Robust, and capable of handling a high volume of transactions and simultaneous users.\r
40 * Flexible, to accommodate the varied needs of libraries.\r
41 * Secure, to protect our patrons’ privacy and data.\r
42 * User-friendly, to facilitate patron and staff use of the system.\r
43 \r
44 Evergreen, which first launched in 2006 now powers over 544 libraries of every type – public, academic, special, school, and even tribal and home libraries – in over a dozen countries worldwide.\r
45 \r
46 // Push titles down one level.\r
47 :leveloffset: 1\r
48 \r
49 include::release_notes.txt[]\r
50 \r
51 // Return to normal title levels.\r
52 :leveloffset: 0\r
53 \r
54 Software Installation\r
55 =====================\r
56 \r
57 \r
58 Introduction\r
59 ------------\r
60 \r
61 This part will guide you through the installation steps installation or upgrading your Evergreen system. It is intended for system administrators. \r
62 \r
63 \r
64 include::installation/system_requirements.txt[]\r
65 \r
66 // Push titles down one level.\r
67 :leveloffset: 1\r
68 \r
69 include::installation/server_installation.txt[]\r
70 \r
71 // Return to normal title levels.\r
72 :leveloffset: 0\r
73 \r
74 include::installation/server_upgrade.txt[]\r
75 \r
76 include::installation/edi_setup.txt[]\r
77 \r
78 // include::staff_client_installation.txt[] \r
79 // include::org_unit_structure_initialization.txt[]\r
80 // include::loading_data.txt[]\r
81 \r
82 \r
83 System Configuration and Customization\r
84 ======================================\r
85 \r
86 Introduction\r
87 ------------\r
88 \r
89 The Evergreen system allows a free range of customizations to every aspect of the system. Use this part of the documentation to become familiar with the tools for  configuring the system as well as  customizing  the OPAC and staff client.  \r
90 \r
91 \r
92 // include::global_system_configuration.txt[]\r
93 // include::opac_customization.txt[]\r
94 \r
95 \r
96 include::admin/template_toolkit.txt[]\r
97 include::admin/auto_suggest_search.txt[]\r
98 \r
99 \r
100 //include::staff_client_customization.txt[]\r
101 // include::backing_up.txt[]\r
102  \r
103 \r
104 \r
105 System Administration From the Staff Client\r
106 ===========================================\r
107 \r
108 Introduction\r
109 ------------\r
110 \r
111 This part deals with the options in the Server Administration menu found in the staff client. \r
112 \r
113 // Follow structure from staff client system admin menu.\r
114 \r
115 include::admin/acquisitions_admin.txt[]\r
116 \r
117 include::admin/authorities.txt[]\r
118 \r
119 include::admin/cn_prefixes_and_suffixes.txt[]\r
120 \r
121 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]\r
122 \r
123 include::admin/booking-admin.txt[]\r
124 \r
125 include::admin/SMS_messaging.txt[]\r
126 \r
127 include::admin/user_activity_type.txt[]\r
128 \r
129 \r
130 Local Administration\r
131 ====================\r
132 \r
133 Introduction\r
134 ------------\r
135 \r
136 This part covers the options in the Local Administration menu found in the staff client. \r
137 \r
138 // Follow structure from staff client local admin menu.\r
139 \r
140 \r
141 include::admin/recent_staff_searches.txt[]\r
142 \r
143 include::admin/lsa-library_settings_editor.txt[]\r
144 \r
145 include::admin/lsa-statcat.txt[]\r
146 \r
147 \r
148 Acquisitions\r
149 ===========\r
150 \r
151 include::acquisitions/introduction.txt[]\r
152 \r
153 include::acquisitions/selection_lists_po.txt[]\r
154 \r
155 include::acquisitions/receive_items_from_invoice.txt[]\r
156 \r
157 include::acquisitions/vandelay_acquisitions_integration.txt[]\r
158 \r
159 \r
160 Cataloging\r
161 ==========\r
162 \r
163 Introduction\r
164 ------------\r
165 \r
166 Cataloguers should use this part for understanding the cataloguing procedures used in Evergreen.\r
167 \r
168 include::cataloging/batch_importing_MARC.txt[]\r
169 \r
170 include::cataloging/overlay_record_3950_import.txt[]\r
171 \r
172 include::cataloging/monograph_parts.txt[]\r
173 \r
174 include::cataloging/conjoined_items.txt[]\r
175 \r
176 \r
177 Serials\r
178 =======\r
179 \r
180 include::serials/A-intro.txt[]\r
181 \r
182 include::serials/B-copy_template.txt[]\r
183 \r
184 include::serials/C-subscription-SCV.txt[]\r
185 \r
186 include::serials/D-subscription-ASCV.txt[]\r
187 \r
188 include::serials/E-edit_subscriptions.txt[]\r
189 \r
190 include::serials/F-Receiving.txt[]\r
191 \r
192 include::serials/G-Special_issue.txt[]\r
193 \r
194 include::serials/H-holdings_statements.txt[]\r
195 \r
196 \r
197 Circulation\r
198 ===========\r
199 \r
200 Introduction\r
201 ------------\r
202 \r
203 Use this section for understanding the circulation procedures in the Evergreen system.  \r
204 \r
205 include::circulation/circulating_items.txt[]\r
206 \r
207 include::circulation/booking.txt[]\r
208 \r
209 Reports\r
210 =======\r
211 \r
212 Introduction\r
213 ------------\r
214 \r
215 Learn how to create and use reports in Evergreen. \r
216 \r
217 Using the Public Access Catalog\r
218 ===============================\r
219 \r
220 Introduction\r
221 ------------\r
222 \r
223 Use this part for information about searching the Evergreen public access catalog.\r
224 \r
225 include::opac/my_lists.txt[]\r
226 \r
227 Developer Resources\r
228 ===================\r
229 \r
230 Introduction\r
231 ------------\r
232 \r
233 Developers can use this part to learn more about the programming languages, communication protocols and standards used in Evergreen.  \r
234 \r
235 // Push titles down one level.\r
236 :leveloffset: 1\r
237 \r
238 include::development/updating_translations_launchpad.txt[]\r
239 \r
240 // Return to normal title levels.\r
241 :leveloffset: 0\r
242 \r
243 [appendix]\r
244 \r
245 include::attributions.txt[]\r
246 \r
247 Admonitions\r
248 ===========\r
249 \r
250 Images used for Admonitions\r
251 ---------------------------\r
252 \r
253 * Note \r
254 \r
255 image::media/note.png[]\r
256 \r
257 * warning\r
258 \r
259 image::media/warning.png[]\r
260 \r
261 * caution\r
262 \r
263 image::media/caution.png[]\r
264 \r
265 * tip\r
266 \r
267 image::media/tip.png[]\r
268 \r
269 \r