Structure root.txt as book. Add release notes from 2.2 code repo.
[working/Evergreen.git] / root.txt
1 Evergreen Documentation\r
2 =======================\r
3 \r
4 \r
5 Introduction\r
6 ============ \r
7 \r
8 This guide was produced by the Evergreen Documentation Interest Group (DIG), consisting of numerous volunteers from many different organizations. The DIG has drawn together, edited, and supplemented pre-existing documentation contributed by libraries and consortia running Evergreen that were kind enough to release their documentation into the creative commons. For a full list of authors and contributing organizations, see Appendix B, About this Documentation. Just like the software it describes, this guide is a work in progress, continually revised to meet the needs of its users, so if you find errors or omissions, please let us know, by contacting the DIG facilitators at\r
9 \r
10 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
11 \r
12 Copies of this guide can be accessed in PDF and HTML formats from\r
13 \r
14 About Evergreen\r
15 ---------------\r
16 \r
17 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
18 \r
19 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
20 \r
21 The community’s development requirements state that Evergreen must be:\r
22 \r
23 * Stable, even under extreme load.\r
24 * Robust, and capable of handling a high volume of transactions and simultaneous users.\r
25 * Flexible, to accommodate the varied needs of libraries.\r
26 * Secure, to protect our patrons’ privacy and data.\r
27 * User-friendly, to facilitate patron and staff use of the system.\r
28 \r
29 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
30 \r
31 include::release_notes.txt[]\r
32 \r
33 Software Installation\r
34 =====================\r
35 \r
36 [partintro]\r
37 --\r
38 This part will guide you through the installation steps installation or upgrading your Evergreen system. It is intended for system administrators. \r
39 --\r
40 \r
41 // include::system_requirements.txt[]\r
42 // include::server_installation.txt[]\r
43 // include::server_upgrade.txt[]\r
44 // include::system_troubleshooting.txt[]\r
45 // include::staff_client_installation.txt[] \r
46 // include::org_unit_structure_initialization.txt[]\r
47 // include::loading_data.txt[]\r
48 \r
49 \r
50 System Configuration and Customization\r
51 ======================================\r
52 \r
53 [partintro]\r
54 --\r
55 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
56 --\r
57 \r
58 // include::global_system_configuration.txt[]\r
59 // include::opac_customization.txt[]\r
60 //include::staff_client_customization.txt[]\r
61 // include::backing_up.txt[]\r
62  \r
63 \r
64 \r
65 System Administration From the Staff Client\r
66 ===========================================\r
67 \r
68 [partintro]\r
69 --\r
70 This part deals with the options in the Server Administration menu found in the staff client. \r
71 --\r
72 \r
73 // Follow structure from staff client system admin menu.\r
74 \r
75 \r
76 Local Administration\r
77 ====================\r
78 \r
79 [partintro]\r
80 --\r
81 This part covers the options in the Local Administration menu found in the staff client. \r
82 --\r
83 \r
84 // Follow structure from staff client local admin menu.\r
85 \r
86 \r
87 Acuisitions\r
88 ===========\r
89 \r
90 [partintro]\r
91 --\r
92 This part is intended for staff who are involved in managing and processing acquisitions. \r
93 --\r
94 \r
95 Cataloging\r
96 ==========\r
97 \r
98 [partintro]\r
99 --\r
100 Cataloguers should use this part for understanding the cataloguing procedures used in Evergreen.\r
101 --\r
102 \r
103 Serials\r
104 =======\r
105 \r
106 [partintro]\r
107 --\r
108 This part is intended for staff involved in Serials management and processing.\r
109 --\r
110 \r
111 Circulation\r
112 ===========\r
113 \r
114 [partintro]\r
115 --\r
116 Use this section for understanding the circulation procedures in the Evergreen system.  \r
117 --\r
118 \r
119 Reports\r
120 =======\r
121 \r
122 [partintro]\r
123 --\r
124 Learn how to create and use reports in Evergreen. \r
125 --\r
126 \r
127 Using the Public Access Catalog\r
128 ===============================\r
129 \r
130 [partintro]\r
131 --\r
132 Use this part for information about searching the Evergreen public access catalog.\r
133 --\r
134 \r
135 Developer Resources\r
136 ===================\r
137 \r
138 [partintro]\r
139 --\r
140 Developers can use this part to learn more about the programming languages, communication protocols and standards used in Evergreen.  \r
141 --\r
142 \r
143 [appendix]\r
144 \r
145 \r