ref #9204 , ref #9208 move cdmlib-remote and cdmlib-print to taxeditor.printpublisher
[taxeditor.git] / eu.etaxonomy.taxeditor.cdmlib / README.txt
1
2 Information on Apache FOP dependencies
3 =========================================
4
5 $Id$
6
7 The Apache Licenses can also be found here:
8 http://www.apache.org/licenses/
9
10
11 Normal Dependencies
12 ----------------------
13
14 - Apache Jakarta Commons IO
15
16 commons-io-*.jar
17 http://jakarta.apache.org/commons/io/
18 (I/O routines)
19
20 Apache License v2.0
21
22 - Apache Jakarta Commons Logging
23
24 commons-logging-*.jar
25 http://jakarta.apache.org/commons/logging/
26 (Logging adapter for various logging backends like JDK 1.4 logging or Log4J)
27
28 Apache License v2.0
29
30 - Apache Avalon Framework
31
32 avalon-framework-*.jar
33 http://excalibur.apache.org/framework/
34 (Avalon Framework, maintained by the Apache Excalibur project)
35
36 Apache License v2.0
37
38 - Apache XML Graphics Commons
39
40 xmlgraphics-commons-*.jar
41 http://xmlgraphics.apache.org/
42 (Common Library for Apache Batik and Apache FOP)
43
44 Apache License v2.0
45
46 - Apache Batik
47
48 batik-*.jar
49 http://xmlgraphics.apache.org/batik/
50 (SVG Implementation)
51
52 Apache License v2.0
53
54 => removed 2020-08
55
56 - Apache XML Commons Externals (JAXP API)
57
58 xml-apis.jar
59 http://xml.apache.org/commons/components/external/
60 (the JAXP API, plus SAX and various W3C DOM Java bindings,
61 maintained in XML Commons Externals)
62
63 Apache License v2.0 (applies to the distribution)
64 SAX is in the public domain
65 http://www.saxproject.org/copying.html
66 W3C Software Notice and License (applies to the various DOM Java bindings)
67 W3C Document License (applies to the DOM documentation)
68 http://www.w3.org/Consortium/Legal/copyright-software
69 http://www.w3.org/Consortium/Legal/copyright-documents
70 http://www.w3.org/Consortium/Legal/
71
72 Apache License v2.0 (applies to the distribution)
73 W3C Software Notice and License (applies to the various DOM Java bindings)
74 W3C Document License (applies to the DOM documentation)
75 http://www.w3.org/Consortium/Legal/copyright-software
76 http://www.w3.org/Consortium/Legal/copyright-documents
77 http://www.w3.org/Consortium/Legal/
78
79 - Apache Xalan-J
80
81 xalan-*.jar and serializer-*.jar
82 http://xalan.apache.org
83 (JAXP-compliant XSLT and XPath implementation)
84
85 Apache License v2.0 (applies to Xalan-J)
86 Apache License v1.1 (applies to Apache BCEL and Apache REGEXP bundled in the JAR)
87 Historical Permission Notice and Disclaimer (applies to CUP Parser Generator)
88 http://www.opensource.org/licenses/historical.php
89 (see xalan.runtime.LICENSE.txt)
90
91
92 Special Dependencies
93 -----------------------
94
95 - Apache Xerces-J
96
97 xercesImpl-*.jar
98 http://xerces.apache.org
99 (JAXP-compliant XML parser and DOM Level 3 implementation)
100
101 Apache License v2.0
102
103 Xerces-J is not directly referenced by FOP or any of its dependencies.
104
105
106 A note on JAXP
107 -----------------------
108
109 Since Java 1.4, JAXP (Java API for XML Processing) is part of the
110 JRE/JDK. Every JVM includes the APIs and an implementation. However,
111 older JREs often contain implementations with bugs that are triggered
112 by code in Apache FOP and therefore need to be overridden. Now, since
113 JAXP is part of the class library, special precautions are necessary
114 to replace the original implementations. This is not done by simply
115 adding new JARs to the classpath as these classes would never be
116 loaded (due to Java's class loader hierarchy).
117
118 Replacing the default implementations involves understanding the
119 "Endorsed Standards Override Mechanism".
120 More information can be found here:
121 http://java.sun.com/j2se/1.4.2/docs/guide/standards/index.html
122
123 See also:
124 http://xml.apache.org/xalan-j/faq.html#faq-N100EF
125
126 Essentially, you have two different possibilities:
127 - add the replacement JARs in the jre/lib/endorsed directory of your JRE.
128 - Use the -Xbootclasspath/p: option when starting the JVM (may not be
129 available for every JVM).
130
131
132 Optional Dependencies
133 ------------------------
134
135 The following libraries are not bundled with FOP and must be installed manually.
136 Please make sure you've read the license of each package.
137
138 - JAI Image I/O Tools
139
140 https://jai-imageio.dev.java.net/
141 BSD license
142
143 Note: This is not the same as JAI! Only the ImageIO-compatible codecs
144 are packaged as "Image I/O Tools". The name may be misleading.
145
146 - JAI (Java Advanced Imaging API)
147
148 http://java.sun.com/products/java-media/jai
149 Java Research License and Java Distribution License (Check which one applies to you!)
150
151 Currently used for:
152 - Grayscale error diffusion dithering in the PCL Renderer
153
154 - JEuclid (MathML implementation, for the MathML extension)
155
156 http://jeuclid.sourceforge.net/
157 http://sourceforge.net/projects/jeuclid
158 Apache License v1.1
159
160
161
162 Additional development-time dependencies
163 -------------------------------------------
164
165 - Servlet API
166
167 servlet-*.jar
168 http://jakarta.apache.org/tomcat/
169 (Servlet API, javax.servlet)
170
171 Apache License v1.1
172
173 - Apache Ant
174
175 (not bundled, requires pre-installation)
176 http://ant.apache.org
177 (XML-based build system
178
179 Apache License V2.0
180
181 - JUnit
182
183 (not bundled, provided by Apache Ant or your IDE)
184 http://www.junit.org
185 Common Public License V1.0