scripts/mir-setup/README: update with link to new doc on wiki
[mir.git] / lib / README.txt
1 This folder contains all necessary java libraries to compile
2 MIR. Have a look at the /doc folder for java libraries that
3 have to be present on your system in order to make MIR run.
4
5 The libraries should be stored in this folder containing
6 their version in the filename. The filename should look like:
7
8   name-of-library-x.y.z.jar
9
10 A description and url should be added here. Please keep track
11 of the documentation! If there are things to be done regarding
12 a certain library, this is stated in a todo field
13
14 Make sure to check in the libs with the binary flag. If you
15 forgot to do so you can fire up "cvs admin -kb [name_of_lib]" 
16
17 Now the descriptions in alphabetical order:
18
19
20 avalon-framework-4.0
21 ------------------------------------------------
22 version    : 4.0
23 url        : http://avalon.apache.org/framework
24 description: The Avalon Framework consists of 
25              interfaces that define relationships 
26              between commonly used application 
27              components, best-of-practice pattern 
28              enforcements, and several lightweight 
29              convenience implementations of the 
30              generic components.
31 todo       : update to 4.2 (not developed anymore)
32
33
34
35 batik
36 ------------------------------------------------
37 version    : ??
38 url        : http://xml.apache.org/batik/
39 description: batik is for images in the Scalable Vector 
40              Graphics (SVG) 
41 todo       : check if necessary / update to version 1.5.1
42              MIR compiles without it. Is it (still) 
43              necessary?
44
45
46 commons-beanutils
47 ------------------------------------------------
48 version    : 1.6.1
49 url        : http://jakarta.apache.org/commons/
50 description: Commons-BeanUtils provides 
51                          easy-to-use wrappers around the Java 
52                          reflection and introspection APIs. 
53
54      
55 commons-collections
56 ------------------------------------------------
57 version    : 2.1
58 url        : http://jakarta.apache.org/commons/
59 description: needed for parsing the configuration 
60              properties file and provides more useful collections
61              like a LRUCache
62 todo       : update to 3.1
63
64
65 commons-dbcp
66 -----------------------------------------------
67 version    : 1.1
68 url        : http://jakarta.apache.org/commons/
69 description: database connection pooling library
70 todo       : upgrade to 1.2.1
71
72 commons-fileupload
73 -----------------------------------------------
74 version    : 1.0
75 url        : http://jakarta.apache.org/commons/
76 description: jakarta version of fileupload
77
78
79 commons-httpclient
80 -----------------------------------------------
81 version    : 2.0
82 url        : http://jakarta.apache.org/commons/
83 description: httpclient simulation
84 todo       : upgrade to 3.0
85
86
87 commons-logging
88 ------------------------------------------------
89 version    : 1.0.3
90 url        : http://jakarta.apache.org/commons/
91 description: Commons-Logging is a wrapper around 
92              a variety of logging API 
93              implementations. 
94 todo       : upgrade to 1.0.4
95
96
97 commons-net
98 ------------------------------------------------
99 version    : 1.0
100 url        : http://jakarta.apache.org/commons/
101 description: needed for the mail feature
102 todo       : upgrade to 1.3.0
103
104
105 commons-pool
106 ------------------------------------------------
107 version    : 1.1
108 url        : http://jakarta.apache.org/commons-pool
109 description: generic object pooling framework
110 todo       : upgrade to 1.2
111
112
113
114 fop
115 ------------------------------------------------
116 version    : ??
117 url        : http://xml.apache.org/fop/
118 description:
119 todo       : The latest stable version is FOP-0.20.5
120              check if necessary
121
122
123 freemarker.jar / freemarker-utility.jar
124 ------------------------------------------------
125 version    : 1.6.2 (probably)
126 url        : http://fm-classic.sourceforge.net
127 description: template engine
128 todo       : update to version 1.8.x 
129              template changes involved on update
130
131
132 gnu-regexp
133 ------------------------------------------------
134 version    : 1.1.4
135 url        : http://www.cacas.org/java/gnu/regexp/
136 description: GNU regular expression library
137 todo         : check if to be replaced with jakarta
138              commons regexp 1.3
139
140
141 iText
142 ------------------------------------------------
143 version    : ??
144 url        : http://www.lowagie.com/iText/
145 description: PDF
146 todo         : upgrade to version 1.2.x
147
148
149 jimi
150 ------------------------------------------------
151 version    : ??
152 url        : http://java.sun.com/products/jimi/
153 description: Jimi is a class library for managing 
154              images
155 todo       : check for update / check if necessary
156
157
158 log4j
159 ------------------------------------------------
160 version    : 1.2.8
161 url        : http://jakarta.apache.org/log4j/
162 description: Jakarta Log4J standard library for
163              the logging layer of MIR.
164 todo       : upgrade to 1.2.9
165
166 logkit
167 ------------------------------------------------
168 version    : 1.0
169 url        : http://www.axint.net/apache/avalon/logkit/v1.2/
170 description: LogKit is an easy to use logging 
171              toolkit. 
172 depends on : avalon
173 todo       : update to version 1.2
174
175
176 lucene
177 ------------------------------------------------
178 version    : 1.2
179 url        : http://jakarta.apache.org/lucene/
180 description: Jakarta Lucene is a high-performance, 
181              full-featured text search engine written 
182              entirely in Java.
183 todo       : upgrade to 1.4.3 
184
185 multex
186 ------------------------------------------------
187 version    : 3
188 url        : http://www.tfh-berlin.de/~knabe/java/multex
189 description: nested exceptions
190 todo       : upgrade to multex 6
191
192 postgresql
193 ------------------------------------------------
194 version    : 7.4 (jdbc2-version) build 215
195 url        : http://jdbc.postgresql.org
196 description: JDBC driver for postgresql database
197
198
199 tidy
200 ------------------------------------------------
201 version    : ??
202 url        : http://jtidy.sourceforge.net/ (probably)
203 description: html cleanup jar
204
205
206 velocity
207 ------------------------------------------------
208 version    : 1.3.1 
209 url        : http://jakarta.apache.org/velocity
210 description: template engine
211 todo       : upgrade to 1.4
212
213
214 xmlrpc
215 ------------------------------------------------
216 version    : 1.2-b1 
217 url        : http://ws.apache.org/xmlrpc/
218 description: Java implementation of XML-RPC, a popular 
219                                      protocol that uses XML over HTTP to 
220                                      implement remote procedure calls
221
222