Information on Apache FOP dependencies
=========================================
$Id$
The Apache Licenses can also be found here:
http://www.apache.org/licenses/
Normal Dependencies
----------------------
- Apache Jakarta Commons IO
commons-io-*.jar
http://jakarta.apache.org/commons/io/
(I/O routines)
Apache License v2.0
- Apache Jakarta Commons Logging
commons-logging-*.jar
http://jakarta.apache.org/commons/logging/
(Logging adapter for various logging backends like JDK 1.4 logging or Log4J)
Apache License v2.0
- Apache Avalon Framework
avalon-framework-*.jar
http://excalibur.apache.org/framework/
(Avalon Framework, maintained by the Apache Excalibur project)
Apache License v2.0
- Apache XML Graphics Commons
xmlgraphics-commons-*.jar
http://xmlgraphics.apache.org/
(Common Library for Apache Batik and Apache FOP)
Apache License v2.0
- Apache Batik
batik-*.jar
http://xmlgraphics.apache.org/batik/
(SVG Implementation)
Apache License v2.0
- Apache XML Commons Externals (JAXP API)
xml-apis.jar
http://xml.apache.org/commons/components/external/
(the JAXP API, plus SAX and various W3C DOM Java bindings,
maintained in XML Commons Externals)
Apache License v2.0 (applies to the distribution)
SAX is in the public domain
http://www.saxproject.org/copying.html
W3C Software Notice and License (applies to the various DOM Java bindings)
W3C Document License (applies to the DOM documentation)
http://www.w3.org/Consortium/Legal/copyright-software
http://www.w3.org/Consortium/Legal/copyright-documents
http://www.w3.org/Consortium/Legal/
xml-apis-ext-*.jar
http://xml.apache.org/commons/components/external/
(additional DOM APIs from W3C, like SVG, SMIL and Simple API for CSS)
Apache License v2.0 (applies to the distribution)
W3C Software Notice and License (applies to the various DOM Java bindings)
W3C Document License (applies to the DOM documentation)
http://www.w3.org/Consortium/Legal/copyright-software
http://www.w3.org/Consortium/Legal/copyright-documents
http://www.w3.org/Consortium/Legal/
- Apache Xalan-J
xalan-*.jar and serializer-*.jar
http://xalan.apache.org
(JAXP-compliant XSLT and XPath implementation)
Apache License v2.0 (applies to Xalan-J)
Apache License v1.1 (applies to Apache BCEL and Apache REGEXP bundled in the JAR)
Historical Permission Notice and Disclaimer (applies to CUP Parser Generator)
http://www.opensource.org/licenses/historical.php
(see xalan.runtime.LICENSE.txt)
Special Dependencies
-----------------------
- Apache Xerces-J
xercesImpl-*.jar
http://xerces.apache.org
(JAXP-compliant XML parser and DOM Level 3 implementation)
Apache License v2.0
Xerces-J is not directly referenced by FOP or any of its dependencies.
A note on JAXP
-----------------------
Since Java 1.4, JAXP (Java API for XML Processing) is part of the
JRE/JDK. Every JVM includes the APIs and an implementation. However,
older JREs often contain implementations with bugs that are triggered
by code in Apache FOP and therefore need to be overridden. Now, since
JAXP is part of the class library, special precautions are necessary
to replace the original implementations. This is not done by simply
adding new JARs to the classpath as these classes would never be
loaded (due to Java's class loader hierarchy).
Replacing the default implementations involves understanding the
"Endorsed Standards Override Mechanism".
More information can be found here:
http://java.sun.com/j2se/1.4.2/docs/guide/standards/index.html
See also:
http://xml.apache.org/xalan-j/faq.html#faq-N100EF
Essentially, you have two different possibilities:
- add the replacement JARs in the jre/lib/endorsed directory of your JRE.
- Use the -Xbootclasspath/p: option when starting the JVM (may not be
available for every JVM).
Optional Dependencies
------------------------
The following libraries are not bundled with FOP and must be installed manually.
Please make sure you've read the license of each package.
- JAI Image I/O Tools
https://jai-imageio.dev.java.net/
BSD license
Note: This is not the same as JAI! Only the ImageIO-compatible codecs
are packaged as "Image I/O Tools". The name may be misleading.
- JAI (Java Advanced Imaging API)
http://java.sun.com/products/java-media/jai
Java Research License and Java Distribution License (Check which one applies to you!)
Currently used for:
- Grayscale error diffusion dithering in the PCL Renderer
- JEuclid (MathML implementation, for the MathML extension)
http://jeuclid.sourceforge.net/
http://sourceforge.net/projects/jeuclid
Apache License v1.1
Additional development-time dependencies
-------------------------------------------
- Servlet API
servlet-*.jar
http://jakarta.apache.org/tomcat/
(Servlet API, javax.servlet)
Apache License v1.1
- Apache Ant
(not bundled, requires pre-installation)
http://ant.apache.org
(XML-based build system
Apache License V2.0
- JUnit
(not bundled, provided by Apache Ant or your IDE)
http://www.junit.org
Common Public License V1.0
- XMLUnit
lib/build/xmlunit-*.jar
(based on JUnit, used for testing)
http://xmlunit.sourceforge.net/
BSD style license
- QDox
lib/build/qdox-*.jar
(used by the processing feedback mechanism, not needed at runtime)
http://qdox.codehaus.org/
Apache License V2.0
Additional build-time dependencies
-------------------------------------------
These libraries are needed during the build only and
not at runtime.
- PMD
lib/build/pmd14-*.jar
(used for a code quality report)
http://pmd.sourceforge.net/
BSD style license
- Jaxen
lib/build/jaxen-*.jar
(required by PMD)
http://jaxen.codehaus.org/
BSD style license
- Retroweaver
(currently used only to verify Java 1.4 compatibility)
http://retroweaver.sourceforge.net
BSD style license
- ASM
lib/build/asm-*.jar
(required by Retroweaver)
http://asm.objectweb.org
BSD style license
- backport-util-concurrent
lib/build/backport-util-concurrent-*.jar
(required by Retroweaver)
http://backport-jsr166.sourceforge.net/
in public domain | # | Change | User | Description | Committed | |
|---|---|---|---|---|---|
| #1 | 26953 | Paul Allen | Move //guest/perforce_software/p4convert to //guest/perforce_software/p4convert/main | ||
| //guest/perforce_software/p4convert/docs/fop-1.1/lib/README.txt | |||||
| #2 | 14806 | Paul Allen | Update docs and add +w. | ||
| #1 | 13920 | Paul Allen | copy part 2 (no errors) | ||
| //guest/paul_allen/p4convert-maven/docs/fop-1.1/lib/README.txt | |||||
| #1 | 13895 | Paul Allen | Copying using p4convert-docbook | ||
| //guest/perforce_software/doc_build/main/fop-1.1/lib/README.txt | |||||
| #1 | 12728 | eedwards |
Upgrade ANT doc build infrastructure to assemble PDFs: - remove non-namespaced DocBook source and add namespaced DocBook source. - add Apache FOP 1.1 - copy fonts, images, XSL into _build, establishing new asset structure. The original structure remains until all guides using it can be upgraded, and several other issues can be resolved. - updated build.xml to allow for per-target build properties. - upgraded the P4SAG to use the new infrastructure. - tweaked admonition presentation in PDFs to remove admonition graphics, and resemble closely the presentation used in the new HTML layout, including the same colors. With these changes, building PDFs involves using a shell, navigating into the guide's directory (just P4SAG for now), and executing "ant pdf". Issues still to be resolved: - PDF generation encounters several warnings about missing fonts (bold versions of Symbol and ZapfDingbats), and a couple of locations where the page content exceeds the defined content area. - Due to issues within Apache FOP, PDF generation emits a substantial amount of output that is not easily suppressed without losing important warning information. - Apache FOP's interface to ANT does not expose a way to set the font base directory. The current configuration does work under Mac OSX, but further testing on Windows will need to be done to determine if the relative paths defined continue to work. The workaround is for Windows users to customize the fop-config.xml to provide absolute system paths to the required fonts. - HTML generation needs further browser testing, and exhibits broken navigation on iOS browsers within the TOC sidebar. - A number of PDF and HTML presentation tweaks still need to be made, for example: sidebars, gui* DocBook tags, whitespace, section separation, etc. |
||