Updates for FOP 0.95.
authorGerald Combs <gerald@wireshark.org>
Tue, 10 Nov 2009 01:32:59 +0000 (01:32 -0000)
committerGerald Combs <gerald@wireshark.org>
Tue, 10 Nov 2009 01:32:59 +0000 (01:32 -0000)
svn path=/trunk/; revision=30913

config.nmake
docbook/README.txt

index 223f82a4756da9992cf00db9c75843e00b827bf4..796fbe6f3e28f04dd3790f3ea3373840b6237724 100644 (file)
@@ -858,7 +858,7 @@ See the developer's guide section "C-Runtime "Redistributable" files" for detail
 # Guide, ...), you'll need some additional tools / libraries compared to the
 # rest of the build process.
 #
-# FOR DETAILED INSTRUCTIONS TO GENERATE THE DOCS, SEE: docbook\readme.txt.
+# FOR DETAILED INSTRUCTIONS TO GENERATE THE DOCS, SEE: docbook\README.txt.
 #
 # If you don't call the Makefile.nmake in the docbook dir to generate the
 # docs, the following settings in this section will have no effect.
@@ -866,6 +866,9 @@ See the developer's guide section "C-Runtime "Redistributable" files" for detail
 # formatting objects processor executable
 # Comment this out if you don't have fop installed or you don't want the docs
 # in PDF format.
+#
+# You may want to install the FOP hyphenation patterns from
+# http://offo.sourceforge.net/hyphenation/
 !IFNDEF FOP
 FOP=fop-0.95\fop.bat
 !ENDIF
index b2684a1b362ffaa2ad042e0379fd4698045948d3..9fa4fa85262c595cea52a9cdb4b5da08f2f4e4b4 100644 (file)
@@ -13,8 +13,8 @@ but see the requirements below.
 
 
 The guides are written in Docbook/XML (formerly Docbook/SGML). This format is 
-now used by many other documentation projects, e.g. "the linux documentation 
-project" uses it too.
+now used by many other documentation projects, e.g. "the Linux Documentation 
+Project."
 
 To get HTML, PDF or other output formats, conversions are done using XSL 
 stylesheets, which provides a flexible way for these conversions.
@@ -69,19 +69,24 @@ FOP processor (for PDF generation only)
 ---------------------------------------
 FOP processor from the apache project:
 http://xml.apache.org/fop/
-FOP is a JAVA program, so you need to have a JAVA environment installed.
-I have put the fop-0.20.5 dir right into the docbook sources dir. If you have 
-it somewhere else, you'll have to change the setting in the Makefile 
-(or config.nmake for Win32).
-
-As I got OutOfMemoryException when running fop, I had to insert -Xmx256m into 
-the last line of the fop.bat file from:
-java -cp "%LOCALCLASSPATH%" org.apache.fop.apps.Fop %1 %2 %3 %4 %5 %6 %7 %8
-to:
-java -Xmx256m -cp "%LOCALCLASSPATH%" org.apache.fop.apps.Fop %1 %2 %3 %4 %5 %6 %7 %8
-This should be added automatically on unixish systems.
-
-JIMI (for PDF generation only)
+
+FOP is a Java program, so you need to have a Java environment installed.
+The makefiles look for fop-0.95 in the docbook directory. You can change
+this location by setting the FOP environment variable or by changing
+config.nmake.
+
+FOP might return an OutOfMemoryException. You can limit its memory usage
+by adding " -Xmx256m" to the FOP_OPTS environment variable. The Windows
+makefile does this by default.
+
+Hyphenation Patterns
+------------------------------
+Hyphenation patterns for FOP can be found at
+http://offo.sourceforge.net/hyphenation/. Different pattern files have
+different licenses. The English patterns may have restrictions on
+commercial use.
+
+JIMI (for PDF generation with fop 0.20.5 only)
 ------------------------------
 Jimi is a JAVA class library for managing images. 
 In addition to FOP, be sure to also have installed JAI and/or jimi to be able