Add customizing the staff client toolbars and add a section for using the staff clien...
[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 // include::global_system_configuration.txt[]\r
92 // include::opac_customization.txt[]\r
93 \r
94 include::admin/template_toolkit.txt[]\r
95 \r
96 include::admin/auto_suggest_search.txt[]\r
97 \r
98 include::customize_staff_client.txt[]\r
99 \r
100 // include::backing_up.txt[]\r
101  \r
102 \r
103 \r
104 Using the Staff Client\r
105 ======================\r
106 \r
107 \r
108 Introduction\r
109 ------------\r
110 \r
111 This part of the documentation deals with general Staff Client usage including logging in, navigation and shortcuts.\r
112 \r
113 \r
114 System Administration From the Staff Client\r
115 ===========================================\r
116 \r
117 Introduction\r
118 ------------\r
119 \r
120 This part deals with the options in the Server Administration menu found in the staff client. \r
121 \r
122 // Follow structure from staff client system admin menu.\r
123 \r
124 include::admin/acquisitions_admin.txt[]\r
125 \r
126 include::admin/authorities.txt[]\r
127 \r
128 include::admin/cn_prefixes_and_suffixes.txt[]\r
129 \r
130 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]\r
131 \r
132 include::admin/booking-admin.txt[]\r
133 \r
134 include::admin/SMS_messaging.txt[]\r
135 \r
136 include::admin/user_activity_type.txt[]\r
137 \r
138 \r
139 Local Administration\r
140 ====================\r
141 \r
142 Introduction\r
143 ------------\r
144 \r
145 This part covers the options in the Local Administration menu found in the staff client. \r
146 \r
147 // Follow structure from staff client local admin menu.\r
148 \r
149 \r
150 include::admin/recent_staff_searches.txt[]\r
151 \r
152 include::admin/lsa-library_settings_editor.txt[]\r
153 \r
154 include::admin/lsa-statcat.txt[]\r
155 \r
156 \r
157 Acquisitions\r
158 ===========\r
159 \r
160 include::acquisitions/introduction.txt[]\r
161 \r
162 include::acquisitions/selection_lists_po.txt[]\r
163 \r
164 include::acquisitions/receive_items_from_invoice.txt[]\r
165 \r
166 include::acquisitions/vandelay_acquisitions_integration.txt[]\r
167 \r
168 \r
169 Cataloging\r
170 ==========\r
171 \r
172 Introduction\r
173 ------------\r
174 \r
175 Cataloguers should use this part for understanding the cataloguing procedures used in Evergreen.\r
176 \r
177 include::cataloging/batch_importing_MARC.txt[]\r
178 \r
179 include::cataloging/overlay_record_3950_import.txt[]\r
180 \r
181 include::cataloging/monograph_parts.txt[]\r
182 \r
183 include::cataloging/conjoined_items.txt[]\r
184 \r
185 \r
186 Serials\r
187 =======\r
188 \r
189 include::serials/A-intro.txt[]\r
190 \r
191 include::serials/B-copy_template.txt[]\r
192 \r
193 include::serials/C-subscription-SCV.txt[]\r
194 \r
195 include::serials/D-subscription-ASCV.txt[]\r
196 \r
197 include::serials/E-edit_subscriptions.txt[]\r
198 \r
199 include::serials/F-Receiving.txt[]\r
200 \r
201 include::serials/G-Special_issue.txt[]\r
202 \r
203 include::serials/H-holdings_statements.txt[]\r
204 \r
205 \r
206 Circulation\r
207 ===========\r
208 \r
209 Introduction\r
210 ------------\r
211 \r
212 Use this section for understanding the circulation procedures in the Evergreen system.  \r
213 \r
214 include::circulation/circulating_items.txt[]\r
215 \r
216 include::circulation/booking.txt[]\r
217 \r
218 Reports\r
219 =======\r
220 \r
221 Introduction\r
222 ------------\r
223 \r
224 Learn how to create and use reports in Evergreen. \r
225 \r
226 Using the Public Access Catalog\r
227 ===============================\r
228 \r
229 Introduction\r
230 ------------\r
231 \r
232 Use this part for information about searching the Evergreen public access catalog.\r
233 \r
234 include::opac/my_lists.txt[]\r
235 \r
236 Developer Resources\r
237 ===================\r
238 \r
239 Introduction\r
240 ------------\r
241 \r
242 Developers can use this part to learn more about the programming languages, communication protocols and standards used in Evergreen.  \r
243 \r
244 // Push titles down one level.\r
245 :leveloffset: 1\r
246 \r
247 include::development/updating_translations_launchpad.txt[]\r
248 \r
249 // Return to normal title levels.\r
250 :leveloffset: 0\r
251 \r
252 [appendix]\r
253 \r
254 include::attributions.txt[]\r
255 \r
256 Admonitions\r
257 ===========\r
258 \r
259 Images used for Admonitions\r
260 ---------------------------\r
261 \r
262 * Note \r
263 \r
264 image::media/note.png[]\r
265 \r
266 * warning\r
267 \r
268 image::media/warning.png[]\r
269 \r
270 * caution\r
271 \r
272 image::media/caution.png[]\r
273 \r
274 * tip\r
275 \r
276 image::media/tip.png[]\r
277 \r
278 \r