- Timestamp:
- 12/15/2014 03:13:32 PM (9 years ago)
- Branches:
- 10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, 7.10, 7.7, 7.8, 7.9, 8.0, 8.1, 8.2, 8.3, 8.4, 9.0, 9.1, basic, bdubbs/svn, elogind, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, lazarus, lxqt, nosym, perl-modules, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, trunk, upgradedb, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal
- Children:
- 7f5413b
- Parents:
- 75b189d4
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
pst/ps/fop.xml
r75b189d4 r6fe6db6 44 44 <title>Introduction to fop</title> 45 45 46 <para>The <application>FOP</application> (Formatting Objects Processor) 47 package contains a print formatter driven by XSL formatting objects 48 (XSL-FO). It is a <application>Java</application> application that reads 49 a formatting object tree and renders the resulting pages to a specified 50 output. Output formats currently supported include PDF, PCL, PostScript, 51 SVG, XML (area tree representation), print, AWT, MIF and ASCII text. The 52 primary output target is PDF.</para> 46 <para> 47 The <application>FOP</application> (Formatting Objects Processor) 48 package contains a print formatter driven by XSL formatting objects 49 (XSL-FO). It is a <application>Java</application> application that reads 50 a formatting object tree and renders the resulting pages to a specified 51 output. Output formats currently supported include PDF, PCL, PostScript, 52 SVG, XML (area tree representation), print, AWT, MIF and ASCII text. The 53 primary output target is PDF. 54 </para> 53 55 54 56 &lfs76_checked; … … 137 139 <title>Installation of fop</title> 138 140 139 <para>Ensure <envar>$JAVA_HOME</envar> is set correctly before beginning 140 the build. To build the <application>JIMI SDK</application> and/or 141 <application>XMLUnit</application> extension classes, ensure the 142 corresponding <filename class='extension'>.jar</filename> files can be 143 found via the <envar>CLASSPATH</envar> environment variable.</para> 141 <para> 142 Ensure <envar>$JAVA_HOME</envar> is set correctly before beginning 143 the build. To build the <application>JIMI SDK</application> and/or 144 <application>XMLUnit</application> extension classes, ensure the 145 corresponding <filename class='extension'>.jar</filename> files can be 146 found via the <envar>CLASSPATH</envar> environment variable. 147 </para> 144 148 <!-- 145 149 <sect3> 146 150 <title>Installing OFFO Hyphenation Patterns</title> 147 151 148 <para>First, unpack the <application>fop</application> source tarball and 149 the hyphenation zipfile from the same directory, then change directories 150 into the root of the <application>fop</application> source tree. Copy the 151 XML hyphenation patterns into the <application>fop</application> source 152 tree by running the following commands:</para> 152 <para> 153 First, unpack the <application>fop</application> source tarball and 154 the hyphenation zipfile from the same directory, then change directories 155 into the root of the <application>fop</application> source tree. Copy 156 the XML hyphenation patterns into the <application>fop</application> 157 source tree by running the following commands: 158 </para> 153 159 154 160 <screen><userinput>cp ../offo-hyphenation/hyph/* hyph && … … 160 166 <title>Installing Java Advanced Imaging (JAI) API components</title> 161 167 162 <para>Next install the JAI API components. As the <systemitem 163 class="username">root</systemitem> user:</para> 168 <para> 169 Install the JAI API components. As the <systemitem 170 class="username">root</systemitem> user: 171 </para> 164 172 165 173 <screen role="root"><userinput>case `uname -m` in … … 181 189 <title>Installing fop Components</title> 182 190 183 <para>Compile <application>fop</application> by running the 184 following commands:</para> 191 <para> 192 The <command>javadoc</command> command coming with OpenJDK 8 has 193 become much stricter than before regarding the conformance of the 194 Javadoc comments in source code to HTML. The FOP documentation does 195 not meet those standard, so the conformance checks have to be 196 disabled. This can be done with the following command: 197 </para> 198 199 <screen><userinput>sed -i '\@</javad@i<arg value="-Xdoclint:none"/>' build.xml</userinput></screen> 200 201 <para> 202 Then, compile <application>fop</application> by running the 203 following commands: 204 </para> 185 205 186 206 <screen><userinput>ant compile && … … 189 209 mv build/javadocs .</userinput></screen> 190 210 191 <para>If <application>Forrest</application> is installed, 192 build the full set of documentation:</para> 211 <para> 212 If <application>Forrest</application> is installed, 213 build the full set of documentation: 214 </para> 193 215 194 216 <screen><userinput>ant docs</userinput></screen> 195 217 196 <para>To test the application, run <command>ant junit-all</command>. The 197 hyphenation tests will fail. To see a list of other test targets, use 198 <command>ant -p</command>. You must run the tests from an X-window using 199 a GL-aware <application>Xorg</application> server or some of the 200 <application>JUnit</application> tests will hang.</para> 201 202 <para>Now, as the <systemitem class="username">root</systemitem> 203 user:</para> 218 <para> 219 To test the application, run <command>ant junit-all</command>. The 220 hyphenation tests will fail. To see a list of other test targets, use 221 <command>ant -p</command>. You must run the tests from an X-window using 222 a GL-aware <application>Xorg</application> server or some of the 223 <application>JUnit</application> tests will hang. 224 </para> 225 226 <para> 227 Now, as the <systemitem class="username">root</systemitem> user: 228 </para> 204 229 205 230 <screen role="root"><userinput>install -v -d -m755 /opt/fop-&fop-version; && … … 216 241 <title>Command Explanations</title> 217 242 218 <para><command>ant <option>target</option></command>: This reads the file 219 <filename>build.xml</filename> and builds the target files.</para> 220 221 <para><command>ln -v -sf fop-&fop-version; /opt/fop</command>: This is 222 optional and creates a convenience symlink so that <envar>$FOP_HOME</envar> 223 doesn't have to be changed each time there's a package version change.</para> 243 <para> 244 <command>ant <option>target</option></command>: This reads the file 245 <filename>build.xml</filename> and builds the target files. 246 </para> 247 248 <para> 249 <command>ln -v -sf fop-&fop-version; /opt/fop</command>: This is 250 optional and creates a convenience symlink so that 251 <envar>$FOP_HOME</envar> doesn't have to be changed each time there's a 252 package version change. 253 </para> 224 254 225 255 </sect2> … … 231 261 <title>Config Files</title> 232 262 233 <para><filename>~/.foprc</filename></para> 263 <para> 264 <filename>~/.foprc</filename> 265 </para> 234 266 235 267 <indexterm zone="fop fop-config"> … … 242 274 <title>Configuration Information</title> 243 275 244 <para>Using <application>fop</application> to process some large FO's 245 (including the FO derived from the BLFS XML sources), can lead to memory 246 errors. Unless you add a parameter to the <command>java</command> command 247 used in the <command>fop</command> script you may receive messages 248 similar to the one shown below:</para> 249 250 <para><computeroutput>Exception in thread "main" java.lang.OutOfMemoryError: 251 Java heap space</computeroutput></para> 252 253 <para>To avoid errors like this, you need to pass an extra parameter to 254 the <command>java</command> command used in the <command>fop</command> 255 script. This can be accomplished by creating a 256 <filename>~/.foprc</filename> (which is sourced by the 257 <command>fop</command> script) and adding the parameter to the 258 <envar>FOP_OPTS</envar> environment variable.</para> 259 260 <para>The <command>fop</command> script looks for a 261 <envar>FOP_HOME</envar> environment variable to locate the 262 <application>fop</application> class libraries. You can create this 263 variable using the <filename>~/.foprc</filename> file as well. Create 264 a <filename>~/.foprc</filename> file using the following commands:</para> 276 <para> 277 Using <application>fop</application> to process some large FO's 278 (including the FO derived from the BLFS XML sources), can lead to 279 memory errors. Unless you add a parameter to the 280 <command>java</command> command used in the <command>fop</command> 281 script you may receive messages similar to the one shown below: 282 </para> 283 284 <para> 285 <computeroutput> 286 Exception in thread "main" java.lang.OutOfMemoryError: Java heap 287 space 288 </computeroutput> 289 </para> 290 291 <para> 292 To avoid errors like this, you need to pass an extra parameter to 293 the <command>java</command> command used in the <command>fop</command> 294 script. This can be accomplished by creating a 295 <filename>~/.foprc</filename> (which is sourced by the 296 <command>fop</command> script) and adding the parameter to the 297 <envar>FOP_OPTS</envar> environment variable. 298 </para> 299 300 <para> 301 The <command>fop</command> script looks for a 302 <envar>FOP_HOME</envar> environment variable to locate the 303 <application>fop</application> class libraries. You can create this 304 variable using the <filename>~/.foprc</filename> file as well. Create 305 a <filename>~/.foprc</filename> file using the following commands: 306 </para> 265 307 266 308 <screen><userinput>cat > ~/.foprc << "EOF" … … 269 311 EOF</userinput></screen> 270 312 271 <para>Replace <replaceable><RAM_Installed></replaceable> with a 272 number representing the amount of RAM installed in your computer (in 273 megabytes). An example would be 274 <userinput>FOP_OPTS="-Xmx768m"</userinput>. 275 <!-- the URL is broken 276 For more information about 277 memory issues running <application>fop</application>, see 278 <ulink url="http://xml.apache.org/fop/running.html#memory"/>. 279 --> 280 </para> 281 282 <para>To include the <command>fop</command> script in your path, 283 update your personal or system-wide profile with the following:</para> 313 <para> 314 Replace <replaceable><RAM_Installed></replaceable> with a 315 number representing the amount of RAM installed in your computer (in 316 megabytes). An example would be 317 <userinput>FOP_OPTS="-Xmx768m"</userinput>. 318 <!-- the URL is broken 319 For more information about 320 memory issues running <application>fop</application>, see 321 <ulink url="http://xml.apache.org/fop/running.html#memory"/>. 322 --> 323 </para> 324 325 <para> 326 To include the <command>fop</command> script in your path, 327 update your personal or system-wide profile with the following: 328 </para> 284 329 285 330 <screen><literal>PATH=$PATH:/opt/fop</literal></screen> 286 331 287 <note><para>Running <command>fop</command> can be somewhat verbose. 288 The default logging level can be changed from INFO to any of 289 FINEST, FINER, FINE, CONFIG, INFO, WARNING, SEVERE, ALL, or OFF. 290 To do this, edit 291 <filename>$JAVA_HOME/jre/lib/logging.properties</filename> and change 292 the entries for <option>.leval</option> and 293 <option>java.util.logging.ConsoleHandler.level</option> to 294 the desired value.</para></note> 332 <note> 333 <para> 334 Running <command>fop</command> can be somewhat verbose. 335 The default logging level can be changed from INFO to any of 336 FINEST, FINER, FINE, CONFIG, INFO, WARNING, SEVERE, ALL, or OFF. 337 To do this, edit 338 <filename>$JAVA_HOME/jre/lib/logging.properties</filename> and change 339 the entries for <option>.leval</option> and 340 <option>java.util.logging.ConsoleHandler.level</option> to 341 the desired value. 342 </para> 343 </note> 295 344 296 345 </sect3>
Note:
See TracChangeset
for help on using the changeset viewer.