Add asciidoc root document and release notes.
[working/Evergreen.git] / root.txt
1 Evergreen Documentation\r
2 =======================\r
3 Robert Soulliere <robert.soulliere@mohawkcollege.ca>\r
4 v2.2, January 2011\r
5 \r
6 Introduction\r
7 ------------ \r
8 \r
9 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 docs@evergreen-ils.org.\r
10 \r
11 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
12 \r
13 Copies of this guide can be accessed in PDF and HTML formats from http://docs.evergreen-ils.org/.\r
14 \r
15 About Evergreen\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 \r
34 \r
35 Software Installation\r
36 ---------------------\r
37 \r
38 Introduction\r
39 ~~~~~~~~~~~~\r
40 \r
41 \r
42 System Configuration and Customization\r
43 --------------------------------------\r
44 \r
45 Introduction\r
46 ~~~~~~~~~~~~\r
47 \r
48 \r
49 System Administration From the Staff Client\r
50 -------------------------------------------\r
51 \r
52 Introduction\r
53 ~~~~~~~~~~~~\r
54 \r
55 \r
56 \r
57 Local Administration\r
58 --------------------\r
59 \r
60 Introduction\r
61 ~~~~~~~~~~~~\r
62 \r
63 \r
64 Acqiostions\r
65 -----------\r
66 \r
67 Introduction\r
68 ~~~~~~~~~~~~\r
69 \r
70 \r
71 Cataloging\r
72 ----------\r
73 \r
74 Intrododuction\r
75 ~~~~~~~~~~~~~~\r
76 \r
77 \Serials\r
78 -------\r
79 \r
80 Introduction\r
81 ~~~~~~~~~~~~\r
82 \r
83 \r
84 Circulation\r
85 -----------\r
86 \r
87 Introduction\r
88 ~~~~~~~~~~~~\r
89 \r
90 \r
91 Reports\r
92 -------\r
93 \r
94 Introduction\r
95 ~~~~~~~~~~~~\r
96 \r
97 \r
98 Using the Public Access Catalog\r
99 -------------------------------\r
100 \r
101 Introduction\r
102 ~~~~~~~~~~~~\r
103 \r
104 \r
105 Developer Resources\r
106 -------------------\r
107 \r
108 Introduction\r
109 ~~~~~~~~~~~~\r
110 \r
111 \r
112 Appendices\r
113 ----------\r
114 \r