diff options
| author | Gerald Combs <gerald@wireshark.org> | 2009-11-10 01:32:59 +0000 |
|---|---|---|
| committer | Gerald Combs <gerald@wireshark.org> | 2009-11-10 01:32:59 +0000 |
| commit | cc036df5ea95a34d8544914f80767f2d05b5b1f1 (patch) | |
| tree | 0f1ba5866f36c5ca7fca24edd11724f4f85e7faf /docbook/README.txt | |
| parent | ca04ab9979e1b4cc7b5cca6a775bf8e105b05228 (diff) | |
| download | wireshark-cc036df5ea95a34d8544914f80767f2d05b5b1f1.tar.gz | |
Updates for FOP 0.95.
svn path=/trunk/; revision=30913
Diffstat (limited to 'docbook/README.txt')
| -rw-r--r-- | docbook/README.txt | 35 |
1 files changed, 20 insertions, 15 deletions
diff --git a/docbook/README.txt b/docbook/README.txt index b2684a1b36..9fa4fa8526 100644 --- a/docbook/README.txt +++ b/docbook/README.txt @@ -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 |