xmlgraphics-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From psan...@apache.org
Subject svn commit: r955955 [7/8] - in /xmlgraphics/site/deploy/fop: ./ dev/ trunk/
Date Fri, 18 Jun 2010 11:52:38 GMT
Modified: xmlgraphics/site/deploy/fop/trunk/embedding.pdf
URL: http://svn.apache.org/viewvc/xmlgraphics/site/deploy/fop/trunk/embedding.pdf?rev=955955&r1=955954&r2=955955&view=diff
==============================================================================
Files xmlgraphics/site/deploy/fop/trunk/embedding.pdf (original) and xmlgraphics/site/deploy/fop/trunk/embedding.pdf Fri Jun 18 11:52:37 2010 differ

Modified: xmlgraphics/site/deploy/fop/trunk/embedding.xml
URL: http://svn.apache.org/viewvc/xmlgraphics/site/deploy/fop/trunk/embedding.xml?rev=955955&r1=955954&r2=955955&view=diff
==============================================================================
--- xmlgraphics/site/deploy/fop/trunk/embedding.xml (original)
+++ xmlgraphics/site/deploy/fop/trunk/embedding.xml Fri Jun 18 11:52:37 2010
@@ -18,14 +18,14 @@
   <header>
     <title>Apache FOP: Embedding</title>
     <subtitle>How to Embed FOP in a Java application</subtitle>
-    <version>$Revision: 772147 $</version>
+    <version>$Revision: 955927 $</version>
   </header>
 
   <body>
   <section id="overview">
     <title>Overview</title>
     <p>
-      Review <link href="running.html">Running FOP</link> for important information that applies 
+      Review <link href="running.html">Running FOP</link> for important information that applies
       to embedded applications as well as command-line use, such as options and performance.
     </p>
     <p>
@@ -50,7 +50,7 @@
   <section id="basics">
     <title>Basic Usage Pattern</title>
     <p>
-      Apache FOP relies heavily on JAXP. It uses SAX events exclusively to receive the XSL-FO 
+      Apache FOP relies heavily on JAXP. It uses SAX events exclusively to receive the XSL-FO
       input document. It is therefore a good idea that you know a few things about JAXP (which
       is a good skill anyway). Let's look at the basic usage pattern for FOP...
     </p>
@@ -78,14 +78,14 @@ try {
   // Step 4: Setup JAXP using identity transformer
   TransformerFactory factory = TransformerFactory.newInstance();
   Transformer transformer = factory.newTransformer(); // identity transformer
-           
-  // Step 5: Setup input and output for XSLT transformation 
+
+  // Step 5: Setup input and output for XSLT transformation
   // Setup input stream
   Source src = new StreamSource(new File("C:/Temp/myfile.fo"));
 
   // Resulting SAX events (the generated FO) must be piped through to FOP
   Result res = new SAXResult(fop.getDefaultHandler());
-            
+
   // Step 6: Start XSLT transformation and FOP processing
   transformer.transform(src, res);
 
@@ -98,13 +98,13 @@ try {
     </p>
     <ul>
       <li>
-        <strong>Step 1:</strong> You create a new FopFactory instance. The FopFactory instance holds 
+        <strong>Step 1:</strong> You create a new FopFactory instance. The FopFactory instance holds
         references to configuration information and cached data. It's important to reuse this
         instance if you plan to render multiple documents during a JVM's lifetime.
       </li>
       <li>
         <strong>Step 2:</strong> You set up an OutputStream that the generated document
-        will be written to. It's a good idea to buffer the OutputStream as demonstrated 
+        will be written to. It's a good idea to buffer the OutputStream as demonstrated
         to improve performance.
       </li>
       <li>
@@ -115,26 +115,26 @@ try {
         OutputStream you've setup up in step 2.
       </li>
       <li>
-        <strong>Step 4</strong> We recommend that you use JAXP Transformers even 
-        if you don't do XSLT transformations to generate the XSL-FO file. This way 
-        you can always use the same basic pattern. The example here sets up an 
-        "identity transformer" which just passes the input (Source) unchanged to the 
-        output (Result). You don't have to work with a SAXParser if you don't do any 
+        <strong>Step 4</strong> We recommend that you use JAXP Transformers even
+        if you don't do XSLT transformations to generate the XSL-FO file. This way
+        you can always use the same basic pattern. The example here sets up an
+        "identity transformer" which just passes the input (Source) unchanged to the
+        output (Result). You don't have to work with a SAXParser if you don't do any
         XSLT transformations.
       </li>
       <li>
-        <strong>Step 5:</strong> Here you set up the input and output for the XSLT 
-        transformation. The Source object is set up to load the "myfile.fo" file. 
-        The Result is set up so the output of the XSLT transformation is sent to FOP. 
-        The FO file is sent to FOP in the form of SAX events which is the most efficient 
-        way. Please always avoid saving intermediate results to a file or a memory buffer 
+        <strong>Step 5:</strong> Here you set up the input and output for the XSLT
+        transformation. The Source object is set up to load the "myfile.fo" file.
+        The Result is set up so the output of the XSLT transformation is sent to FOP.
+        The FO file is sent to FOP in the form of SAX events which is the most efficient
+        way. Please always avoid saving intermediate results to a file or a memory buffer
         because that affects performance negatively.
       </li>
       <li>
-        <strong>Step 6:</strong> Finally, we start the XSLT transformation by starting 
-        the JAXP Transformer. As soon as the JAXP Transformer starts to send its output 
-        to FOP, FOP itself starts its processing in the background. When the 
-        <code>transform()</code> method returns FOP will also have finished converting 
+        <strong>Step 6:</strong> Finally, we start the XSLT transformation by starting
+        the JAXP Transformer. As soon as the JAXP Transformer starts to send its output
+        to FOP, FOP itself starts its processing in the background. When the
+        <code>transform()</code> method returns FOP will also have finished converting
         the FO file to a PDF file and you can close the OutputStream.
         <note label="Tip!">
           It's a good idea to enclose the whole conversion in a try..finally statement. If
@@ -144,16 +144,16 @@ try {
       </li>
     </ul>
     <p>
-      If you're not totally familiar with JAXP Transformers, please have a look at the 
+      If you're not totally familiar with JAXP Transformers, please have a look at the
       <link href="#examples">Embedding examples</link> below. The section contains examples
       for all sorts of use cases. If you look at all of them in turn you should be able
       to see the patterns in use and the flexibility this approach offers without adding
       too much complexity.
     </p>
     <p>
-      This may look complicated at first, but it's really just the combination of an 
+      This may look complicated at first, but it's really just the combination of an
       XSL transformation and a FOP run. It's also easy to comment out the FOP part
-      for debugging purposes, for example when you're tracking down a bug in your 
+      for debugging purposes, for example when you're tracking down a bug in your
       stylesheet. You can easily write the XSL-FO output from the XSL transformation
       to a file to check if that part generates the expected output. An example for that
       can be found in the <link href="#examples">Embedding examples</link> (See "ExampleXML2FO").
@@ -166,7 +166,7 @@ try {
         While with Avalon Logging the loggers were directly given to FOP, FOP now retrieves
         its logger(s) through a statically available LogFactory. This is similar to the
         general pattern that you use when you work with Apache Log4J directly, for example.
-        We call this "static logging" (Commons Logging, Log4J) as opposed to "instance logging" 
+        We call this "static logging" (Commons Logging, Log4J) as opposed to "instance logging"
         (Avalon Logging). This has a consequence: You can't give FOP a logger for each
         processing run anymore. The log output of multiple, simultaneously running FOP instances
         is sent to the same logger.
@@ -200,12 +200,12 @@ try {
         the <link href="events.html">Events subsystem</link> is the right approach.
       </p>
     </section>
-  
+
     <section id="render">
       <title>Processing XSL-FO</title>
       <p>
-        Once the Fop instance is set up, call <code>getDefaultHandler()</code> to obtain a SAX 
-        DefaultHandler instance to which you can send the SAX events making up the XSL-FO 
+        Once the Fop instance is set up, call <code>getDefaultHandler()</code> to obtain a SAX
+        DefaultHandler instance to which you can send the SAX events making up the XSL-FO
         document you'd like to render. FOP processing starts as soon as the DefaultHandler's
         <code>startDocument()</code> method is called. Processing stops again when the
         DefaultHandler's <code>endDocument()</code> method is called. Please refer to the basic
@@ -216,15 +216,15 @@ try {
     <section id="render-with-xslt">
       <title>Processing XSL-FO generated from XML+XSLT</title>
       <p>
-        If you want to process XSL-FO generated from XML using XSLT we recommend 
-        again using standard JAXP to do the XSLT part and piping the generated SAX 
-        events directly through to FOP. The only thing you'd change to do that 
+        If you want to process XSL-FO generated from XML using XSLT we recommend
+        again using standard JAXP to do the XSLT part and piping the generated SAX
+        events directly through to FOP. The only thing you'd change to do that
         on the basic usage pattern above is to set up the Transformer differently:
       </p>
       <source xml:space="preserve"><![CDATA[
   //without XSLT:
   //Transformer transformer = factory.newTransformer(); // identity transformer
-  
+
   //with XSLT:
   Source xslt = new StreamSource(new File("mystylesheet.xsl"));
   Transformer transformer = factory.newTransformer(xslt);]]></source>
@@ -233,14 +233,14 @@ try {
   <section id="input">
     <title>Input Sources</title>
     <p>
-      The input XSL-FO document is always received by FOP as a SAX stream (see the 
+      The input XSL-FO document is always received by FOP as a SAX stream (see the
       <link href="../dev/design/parsing.html">Parsing Design Document</link> for the rationale).
     </p>
     <p>
-      However, you may not always have your input document available as a SAX stream. 
+      However, you may not always have your input document available as a SAX stream.
       But with JAXP it's easy to convert different input sources to a SAX stream so you
       can pipe it into FOP. That sounds more difficult than it is. You simply have
-      to set up the right Source instance as input for the JAXP transformation. 
+      to set up the right Source instance as input for the JAXP transformation.
       A few examples:
     </p>
     <ul>
@@ -269,8 +269,8 @@ try {
     <p>
       There are a variety of upstream data manipulations possible.
       For example, you may have a DOM and an XSL stylesheet; or you may want to
-      set variables in the stylesheet. Interface documentation and some cookbook 
-      solutions to these situations are provided in 
+      set variables in the stylesheet. Interface documentation and some cookbook
+      solutions to these situations are provided in
       <link href="http://xml.apache.org/xalan-j/usagepatterns.html">Xalan Basic Usage Patterns</link>.
     </p>
   </section>
@@ -284,7 +284,7 @@ try {
       <title>Customizing the FopFactory</title>
       <p>
         The FopFactory holds configuration data and references to objects which are reusable over
-        multiple rendering runs. It's important to instantiate it only once (except in special 
+        multiple rendering runs. It's important to instantiate it only once (except in special
         environments) and reuse it every time to create new FOUserAgent and Fop instances.
       </p>
       <p>
@@ -295,34 +295,34 @@ try {
           <p>
             The <strong>font base URL</strong> to use when resolving relative URLs for fonts. Example:
           </p>
-          <source xml:space="preserve"><![CDATA[fopFactory.setFontBaseURL("file:///C:/Temp/fonts");]]></source>
+          <source xml:space="preserve"><![CDATA[fopFactory.getFontManager().setFontBaseURL("file:///C:/Temp/fonts");]]></source>
         </li>
         <li>
           <p>
-            The <strong>hyphenation base URL</strong> to use when resolving relative URLs for 
+            The <strong>hyphenation base URL</strong> to use when resolving relative URLs for
             hyphenation patterns. Example:
           </p>
           <source xml:space="preserve"><![CDATA[fopFactory.setHyphenBaseURL("file:///C:/Temp/hyph");]]></source>
         </li>
         <li>
           <p>
-            Disable <strong>strict validation</strong>. When disabled FOP is less strict about the rules 
+            Disable <strong>strict validation</strong>. When disabled FOP is less strict about the rules
             established by the XSL-FO specification. Example:
           </p>
           <source xml:space="preserve"><![CDATA[fopFactory.setStrictValidation(false);]]></source>
         </li>
         <li>
           <p>
-            Enable an <strong>alternative set of rules for text indents</strong> that tries to mimic the behaviour of many commercial 
-            FO implementations, that chose to break the specification in this respect. The default of this option is 
-            'false', which causes Apache FOP to behave exactly as described in the specification. To enable the 
+            Enable an <strong>alternative set of rules for text indents</strong> that tries to mimic the behaviour of many commercial
+            FO implementations, that chose to break the specification in this respect. The default of this option is
+            'false', which causes Apache FOP to behave exactly as described in the specification. To enable the
             alternative behaviour, call:
           </p>
           <source xml:space="preserve"><![CDATA[fopFactory.setBreakIndentInheritanceOnReferenceAreaBoundary(true);]]></source>
         </li>
         <li>
           <p>
-            Set the <strong>source resolution</strong> for the document. This is used internally to determine the pixel 
+            Set the <strong>source resolution</strong> for the document. This is used internally to determine the pixel
             size for SVG images and bitmap images without resolution information. Default: 72 dpi. Example:
           </p>
           <source xml:space="preserve"><![CDATA[fopFactory.setSourceResolution(96); // =96dpi (dots/pixels per Inch)]]></source>
@@ -330,7 +330,7 @@ try {
         <li>
           <p>
             Manually add an <strong>ElementMapping instance</strong>. If you want to supply a special FOP extension
-            you can give the instance to the FOUserAgent. Normally, the FOP extensions can be automatically detected 
+            you can give the instance to the FOUserAgent. Normally, the FOP extensions can be automatically detected
             (see the documentation on extension for more info). Example:
           </p>
           <source xml:space="preserve"><![CDATA[fopFactory.addElementMapping(myElementMapping); // myElementMapping is a org.apache.fop.fo.ElementMapping]]></source>
@@ -338,13 +338,13 @@ try {
         <li>
           <p>
             Set a <strong>URIResolver</strong> for custom URI resolution. By supplying a JAXP URIResolver you can add
-            custom URI resolution functionality to FOP. For example, you can use 
+            custom URI resolution functionality to FOP. For example, you can use
             <link href="ext:xml.apache.org/commons/resolver">Apache XML Commons Resolver</link> to make use of XCatalogs. Example:
           </p>
           <source xml:space="preserve"><![CDATA[fopFactory.setURIResolver(myResolver); // myResolver is a javax.xml.transform.URIResolver]]></source>
           <note>
             Both the FopFactory and the FOUserAgent have a method to set a URIResolver. The URIResolver on the FopFactory
-            is primarily used to resolve URIs on factory-level (hyphenation patterns, for example) and it is always used 
+            is primarily used to resolve URIs on factory-level (hyphenation patterns, for example) and it is always used
             if no other URIResolver (for example on the FOUserAgent) resolved the URI first.
           </note>
         </li>
@@ -353,9 +353,9 @@ try {
     <section id="user-agent">
       <title>Customizing the User Agent</title>
       <p>
-        The user agent is the entity that allows you to interact with a single rendering run, i.e. the processing of a single 
+        The user agent is the entity that allows you to interact with a single rendering run, i.e. the processing of a single
         document. If you wish to customize the user agent's behaviour, the first step is to create your own instance
-        of FOUserAgent using the appropriate factory method on FopFactory and pass that 
+        of FOUserAgent using the appropriate factory method on FopFactory and pass that
         to the factory method that will create a new Fop instance:
       </p>
       <source xml:space="preserve"><![CDATA[
@@ -412,16 +412,16 @@ try {
         </li>
         <li>
           <p>
-            Set the <strong>target resolution</strong> for the document. This is used to 
-            specify the output resolution for bitmap images generated by bitmap renderers 
-            (such as the TIFF renderer) and by bitmaps generated by Apache Batik for filter 
+            Set the <strong>target resolution</strong> for the document. This is used to
+            specify the output resolution for bitmap images generated by bitmap renderers
+            (such as the TIFF renderer) and by bitmaps generated by Apache Batik for filter
             effects and such. Default: 72 dpi. Example:
           </p>
           <source xml:space="preserve"><![CDATA[userAgent.setTargetResolution(300); // =300dpi (dots/pixels per Inch)]]></source>
         </li>
         <li>
           <p>
-            Set <strong>your own Renderer instance</strong>. If you want to supply your own renderer or 
+            Set <strong>your own Renderer instance</strong>. If you want to supply your own renderer or
             configure a Renderer in a special way you can give the instance to the FOUserAgent. Normally,
             the Renderer instance is created by FOP. Example:
           </p>
@@ -429,8 +429,8 @@ try {
         </li>
         <li>
           <p>
-            Set <strong>your own FOEventHandler instance</strong>. If you want to supply your own FOEventHandler or 
-            configure an FOEventHandler subclass in a special way you can give the instance to the FOUserAgent. Normally, 
+            Set <strong>your own FOEventHandler instance</strong>. If you want to supply your own FOEventHandler or
+            configure an FOEventHandler subclass in a special way you can give the instance to the FOUserAgent. Normally,
             the FOEventHandler instance is created by FOP. Example:
           </p>
           <source xml:space="preserve"><![CDATA[userAgent.setFOEventHandlerOverride(myFOEventHandler); // myFOEventHandler is an org.apache.fop.fo.FOEventHandler]]></source>
@@ -438,7 +438,7 @@ try {
         <li>
           <p>
             Set a <strong>URIResolver</strong> for custom URI resolution. By supplying a JAXP URIResolver you can add
-            custom URI resolution functionality to FOP. For example, you can use 
+            custom URI resolution functionality to FOP. For example, you can use
             <link href="ext:xml.apache.org/commons/resolver">Apache XML Commons Resolver</link> to make use of XCatalogs. Example:
           </p>
           <source xml:space="preserve"><![CDATA[userAgent.setURIResolver(myResolver); // myResolver is a javax.xml.transform.URIResolver]]></source>
@@ -458,7 +458,7 @@ try {
   <section id="config-external">
     <title>Using a Configuration File</title>
     <p>
-      Instead of setting the parameters manually in code as shown above you can also set 
+      Instead of setting the parameters manually in code as shown above you can also set
       many values from an XML configuration file:
     </p>
     <source xml:space="preserve"><![CDATA[
@@ -485,7 +485,7 @@ fopFactory.setUserConfig(new File("C:/Te
       <p>
         Fop instances shouldn't (and can't) be reused. Please recreate
         Fop and FOUserAgent instances for each rendering run using the FopFactory.
-        This is a cheap operation as all reusable information is held in the 
+        This is a cheap operation as all reusable information is held in the
         FopFactory. That's why it's so important to reuse the FopFactory instance.
      </p>
     </section>
@@ -511,12 +511,12 @@ fopFactory.setUserConfig(new File("C:/Te
     <section id="render-info">
       <title>Getting information on the rendering process</title>
       <p>
-        To get the number of pages that were rendered by FOP you can call 
-        <code>Fop.getResults()</code>. This returns a <code>FormattingResults</code> object 
-        where you can look up the number of pages produced. It also gives you the 
-        page-sequences that were produced along with their id attribute and their 
-        numbers of pages. This is particularly useful if you render multiple 
-        documents (each enclosed by a page-sequence) and have to know the number of 
+        To get the number of pages that were rendered by FOP you can call
+        <code>Fop.getResults()</code>. This returns a <code>FormattingResults</code> object
+        where you can look up the number of pages produced. It also gives you the
+        page-sequences that were produced along with their id attribute and their
+        numbers of pages. This is particularly useful if you render multiple
+        documents (each enclosed by a page-sequence) and have to know the number of
         pages of each document.
       </p>
     </section>
@@ -528,19 +528,19 @@ fopFactory.setUserConfig(new File("C:/Te
     </p>
     <ul>
       <li>
-        Whenever possible, try to use SAX to couple the individual components involved 
+        Whenever possible, try to use SAX to couple the individual components involved
         (parser, XSL transformer, SQL datasource etc.).
       </li>
       <li>
-        Depending on the target OutputStream (in case of a FileOutputStream, but not 
-        for a ByteArrayOutputStream, for example) it may improve performance considerably 
-        if you buffer the OutputStream using a BufferedOutputStream: 
+        Depending on the target OutputStream (in case of a FileOutputStream, but not
+        for a ByteArrayOutputStream, for example) it may improve performance considerably
+        if you buffer the OutputStream using a BufferedOutputStream:
         <code>out = new java.io.BufferedOutputStream(out);</code>
         <br/>
         Make sure you properly close the OutputStream when FOP is finished.
       </li>
       <li>
-        Cache the stylesheet. If you use the same stylesheet multiple times 
+        Cache the stylesheet. If you use the same stylesheet multiple times
         you can set up a JAXP <code>Templates</code> object and reuse it each time you do
         the XSL transformation.  (More information can be found
         <link class="fork" href="http://www.javaworld.com/javaworld/jw-05-2003/jw-0502-xsl.html">here</link>.)
@@ -566,7 +566,7 @@ fopFactory.setUserConfig(new File("C:/Te
       If you encounter any suspicious behaviour, please notify us.
     </p>
     <p>
-      There is also a known issue with fonts being jumbled between threads when using 
+      There is also a known issue with fonts being jumbled between threads when using
       the Java2D/AWT renderer (which is used by the -awt and -print output options).
       In general, you cannot safely run multiple threads through the AWT renderer.
     </p>
@@ -574,7 +574,7 @@ fopFactory.setUserConfig(new File("C:/Te
 <section id="examples">
   <title>Examples</title>
   <p>
-   The directory "{fop-dir}/examples/embedding" contains several working examples. 
+   The directory "{fop-dir}/examples/embedding" contains several working examples.
   </p>
   <section id="ExampleFO2PDF">
     <title>ExampleFO2PDF.java</title>
@@ -588,104 +588,104 @@ file to PDF using FOP.
   </section>
   <section id="ExampleXML2FO">
     <title>ExampleXML2FO.java</title>
-    <p>This 
+    <p>This
         <link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2FO.java?view=markup">
             example</link>
-has nothing to do with FOP. It is there to show you how an XML 
+has nothing to do with FOP. It is there to show you how an XML
 file can be converted to XSL-FO using XSLT. The JAXP API is used to do the
-transformation. Make sure you've got a JAXP-compliant XSLT processor in your 
+transformation. Make sure you've got a JAXP-compliant XSLT processor in your
 classpath (ex. <link href="http://xml.apache.org/xalan-j">Xalan</link>).
     </p>
     <figure src="images/EmbeddingExampleXML2FO.png" alt="Example XML to XSL-FO"/>
   </section>
   <section id="ExampleXML2PDF">
     <title>ExampleXML2PDF.java</title>
-    <p>This 
+    <p>This
         <link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2PDF.java?view=markup">
         example</link>
-demonstrates how you can convert an arbitrary XML file to PDF 
-using XSLT and XSL-FO/FOP. It is a combination of the first two examples 
-above. The example uses JAXP to transform the XML file to XSL-FO and FOP to 
+demonstrates how you can convert an arbitrary XML file to PDF
+using XSLT and XSL-FO/FOP. It is a combination of the first two examples
+above. The example uses JAXP to transform the XML file to XSL-FO and FOP to
 transform the XSL-FO to PDF.
     </p>
     <figure src="images/EmbeddingExampleXML2PDF.png" alt="Example XML to PDF (via XSL-FO)"/>
     <p>
-The output (XSL-FO) from the XSL transformation is piped through to FOP using 
-SAX events. This is the most efficient way to do this because the 
-intermediate result doesn't have to be saved somewhere. Often, novice users 
-save the intermediate result in a file, a byte array or a DOM tree. We 
-strongly discourage you to do this if it isn't absolutely necessary. The 
+The output (XSL-FO) from the XSL transformation is piped through to FOP using
+SAX events. This is the most efficient way to do this because the
+intermediate result doesn't have to be saved somewhere. Often, novice users
+save the intermediate result in a file, a byte array or a DOM tree. We
+strongly discourage you to do this if it isn't absolutely necessary. The
 performance is significantly higher with SAX.
     </p>
   </section>
   <section id="ExampleObj2XML">
     <title>ExampleObj2XML.java</title>
-    <p>This 
+    <p>This
     <link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2XML.java?view=markup">
         example</link>
-is a preparatory example for the next one. It's an example that 
-shows how an arbitrary Java object can be converted to XML. It's an often 
-needed task to do this. Often people create a DOM tree from a Java object and 
+is a preparatory example for the next one. It's an example that
+shows how an arbitrary Java object can be converted to XML. It's an often
+needed task to do this. Often people create a DOM tree from a Java object and
 use that. This is pretty straightforward. The example here, however, shows how
-to do this using SAX, which will probably be faster and not even more 
+to do this using SAX, which will probably be faster and not even more
 complicated once you know how this works.
     </p>
     <figure src="images/EmbeddingExampleObj2XML.png" alt="Example Java object to XML"/>
     <p>
-For this example we've created two classes: ProjectTeam and ProjectMember 
-(found in xml-fop/examples/embedding/java/embedding/model). They represent 
-the same data structure found in 
-xml-fop/examples/embedding/xml/xml/projectteam.xml. We want to serialize to XML a 
-project team with several members which exist as Java objects. 
-Therefore we created the two classes: ProjectTeamInputSource and 
+For this example we've created two classes: ProjectTeam and ProjectMember
+(found in xml-fop/examples/embedding/java/embedding/model). They represent
+the same data structure found in
+xml-fop/examples/embedding/xml/xml/projectteam.xml. We want to serialize to XML a
+project team with several members which exist as Java objects.
+Therefore we created the two classes: ProjectTeamInputSource and
 ProjectTeamXMLReader (in the same place as ProjectTeam above).
     </p>
     <p>
-The XMLReader implementation (regard it as a special kind of XML parser) is 
-responsible for creating SAX events from the Java object. The InputSource 
+The XMLReader implementation (regard it as a special kind of XML parser) is
+responsible for creating SAX events from the Java object. The InputSource
 class is only used to hold the ProjectTeam object to be used.
     </p>
     <p>
-Have a look at the source of ExampleObj2XML.java to find out how this is 
-used. For more detailed information see other resources on JAXP (ex. 
+Have a look at the source of ExampleObj2XML.java to find out how this is
+used. For more detailed information see other resources on JAXP (ex.
 <link class="fork" href="http://java.sun.com/xml/jaxp/dist/1.1/docs/tutorial/xslt/3_generate.html">An older JAXP tutorial</link>).
     </p>
   </section>
   <section id="ExampleObj2PDF">
     <title>ExampleObj2PDF.java</title>
-    <p>This 
+    <p>This
         <link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2PDF.java?view=markup">
             example</link>
-combines the previous and the third to demonstrate 
+combines the previous and the third to demonstrate
 how you can transform a Java object to a PDF directly in one smooth run
-by generating SAX events from the Java object that get fed to an XSL 
-transformation. The result of the transformation is then converted to PDF 
+by generating SAX events from the Java object that get fed to an XSL
+transformation. The result of the transformation is then converted to PDF
 using FOP as before.
     </p>
     <figure src="images/EmbeddingExampleObj2PDF.png" alt="Example Java object to PDF (via XML and XSL-FO)"/>
   </section>
   <section id="ExampleDOM2PDF">
     <title>ExampleDOM2PDF.java</title>
-    <p>This 
+    <p>This
         <link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleDOM2PDF.java?view=markup">
             example</link>
-has FOP use a DOMSource instead of a StreamSource in order to 
+has FOP use a DOMSource instead of a StreamSource in order to
 use a DOM tree as input for an XSL transformation.
     </p>
   </section>
   <section id="ExampleSVG2PDF">
     <title>ExampleSVG2PDF.java (PDF Transcoder example)</title>
-    <p>This 
+    <p>This
         <link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleSVG2PDF.java?view=markup">
             example</link>
-shows the usage of the PDF Transcoder, a sub-application within FOP.  
+shows the usage of the PDF Transcoder, a sub-application within FOP.
 It is used to generate a PDF document from an SVG file.
     </p>
   </section>
   <section id="example-notes">
     <title>Final notes</title>
     <p>
-These examples should give you an idea of what's possible. It should be easy 
+These examples should give you an idea of what's possible. It should be easy
 to adjust these examples to your needs. Also, if you have other examples that you
 think should be added here, please let us know via either the fop-users or fop-dev
 mailing lists.  Finally, for more help please send your questions to the fop-users
@@ -694,4 +694,4 @@ mailing list.
   </section>
 </section>
   </body>
-</document>
+</document>
\ No newline at end of file

Modified: xmlgraphics/site/deploy/fop/trunk/running.html
URL: http://svn.apache.org/viewvc/xmlgraphics/site/deploy/fop/trunk/running.html?rev=955955&r1=955954&r2=955955&view=diff
==============================================================================
--- xmlgraphics/site/deploy/fop/trunk/running.html (original)
+++ xmlgraphics/site/deploy/fop/trunk/running.html Fri Jun 18 11:52:37 2010
@@ -1,638 +1,650 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta content="Apache Forrest" name="Generator">
-<meta name="Forrest-version" content="0.9-dev">
-<meta name="Forrest-skin-name" content="pelt">
-<title>Running Apache FOP</title>
-<link type="text/css" href="../skin/basic.css" rel="stylesheet">
-<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
-<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
-<link type="text/css" href="../skin/profile.css" rel="stylesheet">
-<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
-<link rel="shortcut icon" href="../">
-</head>
-<body onload="init()">
-<script type="text/javascript">ndeSetTextSize();</script>
-<div id="top">
-<!--+
-    |header
-    +-->
-<div class="header">
-<!--+
-    |start group logo
-    +-->
-<div class="grouplogo">
-<a href="http://xmlgraphics.apache.org/"><img class="logoImage" alt="Apache XML Graphics" src="../images/group-logo.gif" title="Apache XML Graphics is responsible for the creation and maintenance of software for managing the conversion of XML formats to graphical output, and the creation and maintenance of related software components, based on software licensed to the Foundation"></a>
-</div>
-<!--+
-    |end group logo
-    +-->
-<!--+
-    |start Project Logo
-    +-->
-<div class="projectlogo">
-<a href="http://xmlgraphics.apache.org/fop/"><img class="logoImage" alt="Apache FOP" src="../images/logo.jpg" title="Apache FOP (Formatting Objects Processor) is the world's first output independent formatter. Output formats currently supported include PDF, PCL, PS, SVG, XML (area tree representation), Print, AWT, MIF and TXT. The primary output target is PDF."></a>
-</div>
-<!--+
-    |end Project Logo
-    +-->
-<!--+
-    |start Search
-    +-->
-<div class="searchbox">
-<form action="http://www.google.com/search" method="get" class="roundtopsmall">
-<input value="xmlgraphics.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">&nbsp; 
-                    <input name="Search" value="Search" type="submit">
-</form>
-</div>
-<!--+
-    |end search
-    +-->
-<!--+
-    |start Tabs
-    +-->
-<ul id="tabs">
-<li>
-<a class="unselected" href="../index.html">Home</a>
-</li>
-<li>
-<a class="unselected" href="../0.94/index.html">Version 0.94</a>
-</li>
-<li>
-<a class="unselected" href="../0.95/index.html">Version 0.95</a>
-</li>
-<li class="current">
-<a class="selected" href="../trunk/index.html">FOP Trunk</a>
-</li>
-<li>
-<a class="unselected" href="../dev/index.html">Development</a>
-</li>
-</ul>
-<!--+
-    |end Tabs
-    +-->
-</div>
-</div>
-<div id="main">
-<div id="publishedStrip">
-<!--+
-    |start Subtabs
-    +-->
-<div id="level2tabs"></div>
-<!--+
-    |end Endtabs
-    +-->
-<script type="text/javascript"><!--
-document.write("Last Published: " + document.lastModified);
-//  --></script>
-</div>
-<!--+
-    |breadtrail
-    +-->
-<div class="breadtrail">
-<a href="http://www.apache.org/">apache.org</a> &gt; <a href="http://xml.apache.org/">XML Federation</a> &gt; <a href="http://xmlgraphics.apache.org/">xmlgraphics.apache.org</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
-</div>
-<!--+
-    |start Menu, mainarea
-    +-->
-<!--+
-    |start Menu
-    +-->
-<div id="menu">
-<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">FOP Trunk (dev)</div>
-<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
-<div class="menuitem">
-<a href="../trunk/index.html">About</a>
-</div>
-<div class="menuitem">
-<a href="../trunk/upgrading.html">Upgrading</a>
-</div>
-<div onclick="SwitchMenu('menu_selected_1.1.3', '../skin/')" id="menu_selected_1.1.3Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Using FOP</div>
-<div id="menu_selected_1.1.3" class="selectedmenuitemgroup" style="display: block;">
-<div class="menuitem">
-<a href="../trunk/compiling.html">Build</a>
-</div>
-<div class="menuitem">
-<a href="../trunk/configuration.html">Configure</a>
-</div>
-<div class="menupage">
-<div class="menupagetitle">Run</div>
-</div>
-<div class="menuitem">
-<a href="../trunk/embedding.html">Embed</a>
-</div>
-<div class="menuitem">
-<a href="../trunk/servlets.html">Servlets</a>
-</div>
-<div class="menuitem">
-<a href="../trunk/anttask.html">Ant Task</a>
-</div>
-</div>
-<div onclick="SwitchMenu('menu_1.1.4', '../skin/')" id="menu_1.1.4Title" class="menutitle">Features</div>
-<div id="menu_1.1.4" class="menuitemgroup">
-<div class="menuitem">
-<a href="../trunk/output.html">Output Targets</a>
-</div>
-<div class="menuitem">
-<a href="../trunk/intermediate.html">Intermediate Format</a>
-</div>
-<div class="menuitem">
-<a href="../trunk/pdfencryption.html">PDF Encryption</a>
-</div>
-<div class="menuitem">
-<a href="../trunk/pdfa.html">PDF/A</a>
-</div>
-<div class="menuitem">
-<a href="../trunk/pdfx.html">PDF/X</a>
-</div>
-<div class="menuitem">
-<a href="../trunk/graphics.html">Graphics</a>
-</div>
-<div class="menuitem">
-<a href="../trunk/fonts.html">Fonts</a>
-</div>
-<div class="menuitem">
-<a href="../trunk/hyphenation.html">Hyphenation</a>
-</div>
-<div class="menuitem">
-<a href="../trunk/extensions.html">Extensions</a>
-</div>
-<div class="menuitem">
-<a href="../trunk/events.html">Events</a>
-</div>
-<div class="menuitem">
-<a href="../trunk/metadata.html">Metadata</a>
-</div>
-<div class="menuitem">
-<a href="../trunk/accessibility.html">Accessibility</a>
-</div>
-</div>
-</div>
-<div id="credit"></div>
-<div id="roundbottom">
-<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
-<!--+
-  |alternative credits
-  +-->
-<div id="credit2">
-<a href="http://us.apachecon.com/"><img border="0" title="ApacheCon US 2009" alt="ApacheCon US 2009 - logo" src="http://apache.org/ads/ApacheCon/2009-usa-125x125.png" style="width: 125px;height: 125px;"></a>
-</div>
-</div>
-<!--+
-    |end Menu
-    +-->
-<!--+
-    |start content
-    +-->
-<div id="content">
-<div title="raw XML" class="xmllink">
-<a class="dida" href="running.xml"><img alt="XML - icon" src="../skin/images/xmldoc.gif" class="skin"><br>
-        XML</a>
-</div>
-<div title="Portable Document Format" class="pdflink">
-<a class="dida" href="running.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
-        PDF</a>
-</div>
-<div class="trail">Font size: 
-	          &nbsp;<input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">      
-	          &nbsp;<input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
-	          &nbsp;<input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
-</div>
-<h1>Running Apache FOP</h1>
-<div id="front-matter">
-<div id="minitoc-area">
-<ul class="minitoc">
-<li>
-<a href="#require">System Requirements</a>
-</li>
-<li>
-<a href="#install">Installation</a>
-<ul class="minitoc">
-<li>
-<a href="#install-instruct">Instructions</a>
-</li>
-<li>
-<a href="#install-problems">Problems</a>
-</li>
-</ul>
-</li>
-<li>
-<a href="#standalone-start">Starting FOP as a Standalone Application</a>
-<ul class="minitoc">
-<li>
-<a href="#fop-script">Using the fop script or batch file</a>
-</li>
-<li>
-<a href="#your-own-script">Writing your own script</a>
-</li>
-<li>
-<a href="#jar-option">Running with java's -jar option</a>
-</li>
-<li>
-<a href="#dynamical-classpath">FOP's dynamical classpath construction</a>
-</li>
-</ul>
-</li>
-<li>
-<a href="#check-input">Using Xalan to Check XSL-FO Input</a>
-</li>
-<li>
-<a href="#memory">Memory Usage</a>
-</li>
-<li>
-<a href="#problems">Problems</a>
-</li>
-</ul>
-</div>
-</div>
-    
-<a name="N10011"></a><a name="require"></a>
-<h2 class="underlined_10">System Requirements</h2>
-<div class="section">
-<p>The following software must be installed:</p>
-<ul>
-        
-<li>
-          Java 1.4.x or later Runtime Environment.
-          <ul>
-            
-<li>
-              Many JREs &gt;=1.4 contain older JAXP implementations (which often contain bugs). It's
-              usually a good idea to replace them with a current implementation.
-            </li>
-          
-</ul>
-        
-</li>
-        
-<li>
-          Apache FOP. The <a href="../download.html">FOP distribution</a> includes all libraries that you will 
-          need to run a basic FOP installation. These can be found in the [fop-root]/lib directory. These 
-          libraries include the following:
-          <ul>
-            
-<li>
-<a target="_blank" class="fork" href="http://xmlgraphics.apache.org/commons/">Apache XML Graphics Commons</a>, an shared library for Batik and FOP.</li>
-            
-<li>
-<a target="_blank" class="fork" href="http://xmlgraphics.apache.org/batik/">Apache Batik</a>, an SVG library.</li>
-            
-<li>
-<a class="external" href="http://commons.apache.org/logging/">Apache Commons Logging</a>, a logger abstraction kit.</li>
-            
-<li>
-<a class="external" href="http://commons.apache.org/io/">Apache Commons IO</a>, a library with I/O utilities.</li>
-            
-<li>
-<a class="external" href="http://excalibur.apache.org/framework/">Apache Excalibur/Avalon Framework</a>, for XML configuration handling.</li>
-          
-</ul>
-        
-</li>
-      
-</ul>
-<p>The following software is optional, depending on your needs:</p>
-<ul>
-        
-<li>
-          Graphics libraries. Generally, FOP contains direct support for the most important
-          bitmap image formats (including PNG, JPEG and GIF). See 
-          <a href="graphics.html">FOP: Graphics Formats</a> for details.
-        </li>
-        
-<li>
-          PDF encryption. See <a href="pdfencryption.html">FOP: PDF Encryption</a> for details.
-        </li>
-      
-</ul>
-<p>In addition, the following system requirements apply:</p>
-<ul>
-        
-<li>
-          If you will be using FOP to process SVG, you must do so in a graphical environment. 
-          See <a href="graphics.html#batik">FOP: Graphics (Batik)</a> for details.
-        </li>
-      
-</ul>
-</div>
-    
-<a name="N10075"></a><a name="install"></a>
-<h2 class="underlined_10">Installation</h2>
-<div class="section">
-<a name="N1007B"></a><a name="install-instruct"></a>
-<h3 class="underlined_5">Instructions</h3>
-<p>
-          Basic FOP installation consists of first unzipping the <span class="codefrag">.gz</span> file that is the 
-          distribution medium, then unarchiving the resulting <span class="codefrag">.tar</span> file in a 
-          directory/folder that is convenient on your system. Please consult your operating system 
-          documentation or Zip application software documentation for instructions specific to your 
-          site.
-        </p>
-<a name="N1008B"></a><a name="install-problems"></a>
-<h3 class="underlined_5">Problems</h3>
-<p>
-          Some Mac OSX users have experienced filename truncation problems using Stuffit to unzip 
-          and unarchive their distribution media. This is a legacy of older Mac operating systems, 
-          which had a 31-character pathname limit. Several Mac OSX users have recommended that 
-          Mac OSX users use the shell command <span class="codefrag">tar -xzf</span> instead.
-        </p>
-</div>
-    
-<a name="N10099"></a><a name="standalone-start"></a>
-<h2 class="underlined_10">Starting FOP as a Standalone Application</h2>
-<div class="section">
-<a name="N1009F"></a><a name="fop-script"></a>
-<h3 class="underlined_5">Using the fop script or batch file</h3>
-<p>
-        The usual and recommended practice for starting FOP from the command line is to run the 
-        batch file fop.bat (Windows) or the shell script fop (Unix/Linux).
-        These scripts require that the environment variable JAVA_HOME be 
-        set to a path pointing to the appropriate Java installation on your system. Macintosh OSX 
-        includes a Java environment as part of its distribution. We are told by Mac OSX users that 
-        the path to use in this case is <span class="codefrag">/Library/Java/Home</span>. <strong>Caveat:</strong>
-        We suspect that, as Apple releases new Java environments and as FOP upgrades the minimum 
-        Java requirements, the two will inevitably not match on some systems. Please see 
-        <a class="external" href="http://developer.apple.com/java/faq">Java on Mac OSX FAQ</a> for information as 
-        it becomes available.
-      </p>
-<pre class="code">
-USAGE
-Fop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-rtf|-tiff|-png|-pcl|-ps|-txt|-at [mime]|-print] &lt;outfile&gt;
- [OPTIONS]  
-  -d                debug mode   
-  -x                dump configuration settings  
-  -q                quiet mode  
-  -c cfg.xml        use additional configuration file cfg.xml
-  -l lang           the language to use for user information 
-  -r                relaxed/less strict validation (where available)
-  -dpi xxx          target resolution in dots per inch (dpi) where xxx is a number
-  -s                for area tree XML, down to block areas only
-  -v                to show FOP version being used
-
-  -o [password]     PDF file will be encrypted with option owner password
-  -u [password]     PDF file will be encrypted with option user password
-  -noprint          PDF file will be encrypted without printing permission
-  -nocopy           PDF file will be encrypted without copy content permission
-  -noedit           PDF file will be encrypted without edit content permission
-  -noannotations    PDF file will be encrypted without edit annotation permission
-  -pdfprofile prof  PDF file will be generated with the specified profile
-                    (Examples for prof: PDF/A-1b or PDF/X-3:2003)
-
- [INPUT]  
-  infile            xsl:fo input file (the same as the next) 
-  -fo  infile       xsl:fo input file  
-  -xml infile       xml input file, must be used together with -xsl 
-  -atin infile      area tree input file 
-  -xsl stylesheet   xslt stylesheet 
- 
-  -param name value &lt;value&gt; to use for parameter &lt;name&gt; in xslt stylesheet
-                    (repeat '-param name value' for each parameter)
- 
- [OUTPUT] 
-  outfile           input will be rendered as PDF into outfile
-  -pdf outfile      input will be rendered as PDF (outfile req'd)
-  -pdfa1b outfile   input will be rendered as PDF/A-1b compliant PDF
-                    (outfile req'd, same as "-pdf outfile -pdfprofile PDF/A-1b")
-  -awt              input will be displayed on screen 
-  -rtf outfile      input will be rendered as RTF (outfile req'd)
-  -pcl outfile      input will be rendered as PCL (outfile req'd) 
-  -ps outfile       input will be rendered as PostScript (outfile req'd) 
-  -afp outfile      input will be rendered as AFP (outfile req'd)
-  -tiff outfile     input will be rendered as TIFF (outfile req'd)
-  -png outfile      input will be rendered as PNG (outfile req'd)
-  -txt outfile      input will be rendered as plain text (outfile req'd) 
-  -at [mime] out    representation of area tree as XML (outfile req'd) 
-                    specify optional mime output to allow AT to be converted
-                    to final format later
-  -print            input file will be rendered and sent to the printer 
-                    see options with "-print help" 
-  -out mime outfile input will be rendered using the given MIME type
-                    (outfile req'd) Example: "-out application/pdf D:\out.pdf"
-                    (Tip: "-out list" prints the list of supported MIME types)
-  -mif outfile      input will be rendered as MIF (FrameMaker) (outfile req'd)
-                    Experimental feature - requires additional fop-sandbox.jar.
-  -svg outfile      input will be rendered as an SVG slides file (outfile req'd) 
-                    Experimental feature - requires additional fop-sandbox.jar.
-
-  -foout outfile    input will only be XSL transformed. The intermediate 
-                    XSL-FO file is saved and no rendering is performed. 
-                    (Only available if you use -xml and -xsl parameters)
-
-
- [Examples]
-  Fop foo.fo foo.pdf 
-  Fop -fo foo.fo -pdf foo.pdf (does the same as the previous line)
-  Fop -xml foo.xml -xsl foo.xsl -pdf foo.pdf
-  Fop -xml foo.xml -xsl foo.xsl -foout foo.fo
-  Fop foo.fo -mif foo.mif
-  Fop foo.fo -rtf foo.rtf
-  Fop foo.fo -print or Fop -print foo.fo 
-  Fop foo.fo -awt</pre>
-<p>
-        PDF encryption is only available if FOP was compiled with encryption support 
-        <strong>and</strong> if compatible encryption support is available at run time. 
-        Currently, only the JCE is supported. Check the <a href="pdfencryption.html">Details</a>.
-      </p>
-<a name="N100C1"></a><a name="your-own-script"></a>
-<h3 class="underlined_5">Writing your own script</h3>
-<p>FOP's entry point for your own scripts is the class
-<span class="codefrag">org.apache.fop.cli.Main</span>. The general pattern for the
-        command line is: <span class="codefrag">java -classpath &lt;CLASSPATH&gt;
-        org.apache.fop.cli.Main &lt;arguments&gt;</span>. The arguments
-        consist of the options and infile and outfile specifications
-        as shown above for the standard scripts. You may wish to review
-        the standard scripts to make sure that 
-        you get your environment properly configured. 
-        </p>
-<a name="N100D1"></a><a name="jar-option"></a>
-<h3 class="underlined_5">Running with java's -jar option</h3>
-<p>
-        As an alternative to the start scripts you can run <span class="codefrag">java
-        -jar path/to/build/fop.jar &lt;arguments&gt;</span>, relying on
-        FOP to build the classpath for running FOP dynamically, see <a href="#dynamical-classpath">below</a>. If you use hyphenation,
-        you must put <span class="codefrag">fop-hyph.jar</span> in the <span class="codefrag">lib</span>
-        directory.
-      </p>
-<p>You can also run <span class="codefrag">java -jar path/to/fop.jar
-      &lt;arguments&gt;</span>, relying on the <span class="codefrag">Class-Path</span>
-      entry in the manifest file. This works if you put
-      <span class="codefrag">fop.jar</span> and all jar files from the <span class="codefrag">lib</span>
-      directory in a single directory. If you use hyphenation, you
-      must also put <span class="codefrag">fop-hyph.jar</span> in that directory.</p>
-<p>In both cases the arguments consist of the options and
-        infile and outfile specifications as shown above for the
-        standard scripts.</p>
-<a name="N10100"></a><a name="dynamical-classpath"></a>
-<h3 class="underlined_5">FOP's dynamical classpath construction</h3>
-<p>If FOP is started without a proper classpath, it tries to
-          add its dependencies dynamically. If the system property
-          <span class="codefrag">fop.home</span> contains the name of a directory, then
-          FOP uses that directory as the base directory for its
-          search. Otherwise the current working directory is the base
-          directory. If the base directory is called <span class="codefrag">build</span>,
-          then its parent directory becomes the base directory.</p>
-<p>FOP expects to find <span class="codefrag">fop.jar</span> in the
-          <span class="codefrag">build</span> subdirectory of the base directory, and
-          adds it to the classpath. Subsequently FOP adds all
-          <span class="codefrag">jar</span> files in the lib directory to the
-          classpath. The lib directory is either the <span class="codefrag">lib</span>
-          subdirectory of the base directory, or, if that does not
-          exist, the base directory itself.</p>
-<p>If the system property <span class="codefrag">fop.optional.lib</span>
-          contains the name of a directory, then all <span class="codefrag">jar</span>
-          files in that directory are also added to the classpath. See
-          the methods <span class="codefrag">getJARList</span> and
-          <span class="codefrag">checkDependencies</span> in
-          <span class="codefrag">org.apache.fop.cli.Main</span>.</p>
-</div>
-    
-<a name="N10132"></a><a name="check-input"></a>
-<h2 class="underlined_10">Using Xalan to Check XSL-FO Input</h2>
-<div class="section">
-<p>
-        FOP sessions that use -xml and -xsl input instead of -fo input are actually 
-        controlling two distinct conversions: Tranforming XML to XSL-FO, then formatting 
-        the XSL-FO to PDF (or another FOP output format).
-        Although FOP controls both of these processes, the first is included merely as 
-        a convenience and for performance reasons.
-        Only the second is part of FOP's core processing.
-        If a user has a problem running FOP, it is important to determine which of these 
-        two processes is causing the problem.
-        If the problem is in the first process, the user's stylesheet is likely the cause.
-        The FOP development team does not have resources to help with stylesheet issues, 
-        although we have included links to some useful 
-        <a href="../resources.html#specs">Specifications</a> and 
-        <a href="../resources.html#articles">Books/Articles</a>.
-        If the problem is in the second process, FOP may have a bug or an unimplemented 
-        feature that does require attention from the FOP development team.
-      </p>
-<div class="note">
-<div class="label">Note</div>
-<div class="content">The user is always responsible to provide correct XSL-FO code to FOP.</div>
-</div>
-<p>
-        In the case of using -xml and -xsl input, although the user is responsible for 
-        the XSL-FO code that is FOP's input, it is not visible to the user. To make the 
-        intermediate FO file visible, the FOP distribution includes the "-foout" option 
-        which causes FOP to run only the first (transformation) step, and write the 
-        results to a file. (See also the Xalan command-line below)
-      </p>
-<div class="note">
-<div class="label">Note</div>
-<div class="content">
-        When asking for help on the FOP mailing lists, <em>never</em> attach XML and 
-        XSL to illustrate the issue. Always run the XSLT step (-foout) and send the 
-        resulting XSL-FO file instead. Of course, be sure that the XSL-FO file is 
-        correct before sending it.
-      </div>
-</div>
-<p>
-        The -foout option works the same way as if you would call the 
-        <a class="external" href="http://xml.apache.org/xalan-j/commandline.html">Xalan command-line</a>:
-      </p>
-<p>
-        
-<span class="codefrag">java org.apache.xalan.xslt.Process -IN xmlfile -XSL file -OUT outfile</span>
-      
-</p>
-<p>
-        Note that there are some subtle differences between the FOP and Xalan command-lines.
-      </p>
-</div>
-    
-<a name="N10160"></a><a name="memory"></a>
-<h2 class="underlined_10">Memory Usage</h2>
-<div class="section">
-<p>
-        FOP can consume quite a bit of memory, even though this has been continually improved.
-        This is partly inherent to the formatting process and partly caused by implementation choices.
-        All FO processors currently on the market have memory problems with certain layouts.
-      </p>
-<p>
-        If you are running out of memory when using FOP, here are some ideas that may help:
-      </p>
-<ul>
-        
-<li>
-          Increase memory available to the JVM. See 
-          <a class="external" href="http://java.sun.com/j2se/1.4/docs/tooldocs/solaris/java.html">the -Xmx option</a> 
-          for more information.
-          <div class="warning">
-<div class="label">Warning</div>
-<div class="content">
-            It is usually unwise to increase the memory allocated to the JVM beyond the amount of 
-            physical RAM, as this will generally cause significantly slower performance.
-          </div>
-</div>
-        
-</li>
-        
-<li>
-          Avoid forward references.
-          Forward references are references to some later part of a document.
-          Examples include page number citations which refer to pages which follow the citation, 
-          tables of contents at the beginning of a document, and page numbering schemes that 
-          include the total number of pages in the document 
-          (<a href="../faq.html#pagenum">"page N of TOTAL"</a>).
-          Forward references cause all subsequent pages to be held in memory until the reference 
-          can be resolved, i.e. until the page with the referenced element is encountered.
-          Forward references may be required by the task, but if you are getting a memory 
-          overflow, at least consider the possibility of eliminating them.
-          A table of contents could be replaced by PDF bookmarks instead or moved to the end of 
-          the document (reshuffle the paper could after printing).
-        </li>
-        
-<li>
-          Avoid large images, especially if they are scaled down.
-          If they need to be scaled, scale them in another application upstream from FOP.
-          For many image formats, memory consumption is driven mainly by the size of the image 
-          file itself, not its dimensions (width*height), so increasing the compression rate 
-          may help.
-        </li>
-        
-<li>
-          Use multiple page sequences.
-          FOP starts rendering after the end of a page sequence is encountered.
-          While the actual rendering is done page-by-page, some additional memory is 
-          freed after the page sequence has been rendered.
-          This can be substantial if the page sequence contains lots of FO elements.
-        </li>
-      
-</ul>
-</div>
-    
-<a name="N10187"></a><a name="problems"></a>
-<h2 class="underlined_10">Problems</h2>
-<div class="section">
-<p>If you have problems running FOP, please see the <a href="../gethelp.html">"How to get Help" page</a>.</p>
-</div>
-  
-<span class="version">
-          version 638396</span>
-</div>
-<!--+
-    |end content
-    +-->
-<div class="clearboth">&nbsp;</div>
-</div>
-<div id="footer">
-<!--+
-    |start bottomstrip
-    +-->
-<div class="lastmodified">
-<script type="text/javascript"><!--
-document.write("Last Published: " + document.lastModified);
-//  --></script>
-</div>
-<div class="copyright">
-        Copyright &copy;
-         1999-2009 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
-</div>
-<!--+
-    |end bottomstrip
-    +-->
-</div>
-</body>
-</html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.9-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Running Apache FOP</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+    |header
+    +-->
+<div class="header">
+<!--+
+    |start group logo
+    +-->
+<div class="grouplogo">
+<a href="http://xmlgraphics.apache.org/"><img class="logoImage" alt="Apache XML Graphics" src="../images/group-logo.gif" title="Apache XML Graphics is responsible for the creation and maintenance of software for managing the conversion of XML formats to graphical output, and the creation and maintenance of related software components, based on software licensed to the Foundation"></a>
+</div>
+<!--+
+    |end group logo
+    +-->
+<!--+
+    |start Project Logo
+    +-->
+<div class="projectlogo">
+<a href="http://xmlgraphics.apache.org/fop/"><img class="logoImage" alt="Apache FOP" src="../images/logo.jpg" title="Apache FOP (Formatting Objects Processor) is the world's first output independent formatter. Output formats currently supported include PDF, PCL, PS, SVG, XML (area tree representation), Print, AWT, MIF and TXT. The primary output target is PDF."></a>
+</div>
+<!--+
+    |end Project Logo
+    +-->
+<!--+
+    |start Search
+    +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="xmlgraphics.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">&nbsp; 
+                    <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+    |end search
+    +-->
+<!--+
+    |start Tabs
+    +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="../index.html">Home</a>
+</li>
+<li>
+<a class="unselected" href="../0.94/index.html">Version 0.94</a>
+</li>
+<li>
+<a class="unselected" href="../0.95/index.html">Version 0.95</a>
+</li>
+<li class="current">
+<a class="selected" href="../trunk/index.html">FOP Trunk</a>
+</li>
+<li>
+<a class="unselected" href="../dev/index.html">Development</a>
+</li>
+</ul>
+<!--+
+    |end Tabs
+    +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+    |start Subtabs
+    +-->
+<div id="level2tabs"></div>
+<!--+
+    |end Endtabs
+    +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+//  --></script>
+</div>
+<!--+
+    |breadtrail
+    +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache.org</a> &gt; <a href="http://xml.apache.org/">XML Federation</a> &gt; <a href="http://xmlgraphics.apache.org/">xmlgraphics.apache.org</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+    |start Menu, mainarea
+    +-->
+<!--+
+    |start Menu
+    +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">FOP Trunk (dev)</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../trunk/index.html">About</a>
+</div>
+<div class="menuitem">
+<a href="../trunk/upgrading.html">Upgrading</a>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.1.3', '../skin/')" id="menu_selected_1.1.3Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Using FOP</div>
+<div id="menu_selected_1.1.3" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../trunk/compiling.html">Build</a>
+</div>
+<div class="menuitem">
+<a href="../trunk/configuration.html">Configure</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Run</div>
+</div>
+<div class="menuitem">
+<a href="../trunk/embedding.html">Embed</a>
+</div>
+<div class="menuitem">
+<a href="../trunk/servlets.html">Servlets</a>
+</div>
+<div class="menuitem">
+<a href="../trunk/anttask.html">Ant Task</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.4', '../skin/')" id="menu_1.1.4Title" class="menutitle">Features</div>
+<div id="menu_1.1.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="../trunk/output.html">Output Targets</a>
+</div>
+<div class="menuitem">
+<a href="../trunk/intermediate.html">Intermediate Format</a>
+</div>
+<div class="menuitem">
+<a href="../trunk/pdfencryption.html">PDF Encryption</a>
+</div>
+<div class="menuitem">
+<a href="../trunk/pdfa.html">PDF/A</a>
+</div>
+<div class="menuitem">
+<a href="../trunk/pdfx.html">PDF/X</a>
+</div>
+<div class="menuitem">
+<a href="../trunk/graphics.html">Graphics</a>
+</div>
+<div class="menuitem">
+<a href="../trunk/fonts.html">Fonts</a>
+</div>
+<div class="menuitem">
+<a href="../trunk/hyphenation.html">Hyphenation</a>
+</div>
+<div class="menuitem">
+<a href="../trunk/extensions.html">Extensions</a>
+</div>
+<div class="menuitem">
+<a href="../trunk/events.html">Events</a>
+</div>
+<div class="menuitem">
+<a href="../trunk/metadata.html">Metadata</a>
+</div>
+<div class="menuitem">
+<a href="../trunk/accessibility.html">Accessibility</a>
+</div>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+  |alternative credits
+  +-->
+<div id="credit2">
+<a href="http://us.apachecon.com/"><img border="0" title="ApacheCon US 2009" alt="ApacheCon US 2009 - logo" src="http://apache.org/ads/ApacheCon/2009-usa-125x125.png" style="width: 125px;height: 125px;"></a>
+</div>
+</div>
+<!--+
+    |end Menu
+    +-->
+<!--+
+    |start content
+    +-->
+<div id="content">
+<div title="raw XML" class="xmllink">
+<a class="dida" href="running.xml"><img alt="XML - icon" src="../skin/images/xmldoc.gif" class="skin"><br>
+        XML</a>
+</div>
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="running.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
+        PDF</a>
+</div>
+<div class="trail">Font size: 
+	          &nbsp;<input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">      
+	          &nbsp;<input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
+	          &nbsp;<input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
+</div>
+<h1>Running Apache FOP</h1>
+<div id="front-matter">
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#require">System Requirements</a>
+</li>
+<li>
+<a href="#install">Installation</a>
+<ul class="minitoc">
+<li>
+<a href="#install-instruct">Instructions</a>
+</li>
+<li>
+<a href="#install-problems">Problems</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#standalone-start">Starting FOP as a Standalone Application</a>
+<ul class="minitoc">
+<li>
+<a href="#fop-script">Using the fop script or batch file</a>
+</li>
+<li>
+<a href="#your-own-script">Writing your own script</a>
+</li>
+<li>
+<a href="#jar-option">Running with java's -jar option</a>
+</li>
+<li>
+<a href="#dynamical-classpath">FOP's dynamical classpath construction</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#check-input">Using Xalan to Check XSL-FO Input</a>
+</li>
+<li>
+<a href="#memory">Memory Usage</a>
+</li>
+<li>
+<a href="#problems">Problems</a>
+</li>
+</ul>
+</div>
+</div>
+    
+<a name="N10011"></a><a name="require"></a>
+<h2 class="underlined_10">System Requirements</h2>
+<div class="section">
+<p>The following software must be installed:</p>
+<ul>
+        
+<li>
+          Java 1.4.x or later Runtime Environment.
+          <ul>
+            
+<li>
+              Many JREs &gt;=1.4 contain older JAXP implementations (which often contain bugs). It's
+              usually a good idea to replace them with a current implementation.
+            </li>
+          
+</ul>
+        
+</li>
+        
+<li>
+          Apache FOP. The <a href="../download.html">FOP distribution</a> includes all libraries that you will
+          need to run a basic FOP installation. These can be found in the [fop-root]/lib directory. These
+          libraries include the following:
+          <ul>
+            
+<li>
+<a target="_blank" class="fork" href="http://xmlgraphics.apache.org/commons/">Apache XML Graphics Commons</a>, an shared library for Batik and FOP.</li>
+            
+<li>
+<a target="_blank" class="fork" href="http://xmlgraphics.apache.org/batik/">Apache Batik</a>, an SVG library.</li>
+            
+<li>
+<a class="external" href="http://commons.apache.org/logging/">Apache Commons Logging</a>, a logger abstraction kit.</li>
+            
+<li>
+<a class="external" href="http://commons.apache.org/io/">Apache Commons IO</a>, a library with I/O utilities.</li>
+            
+<li>
+<a class="external" href="http://excalibur.apache.org/framework/">Apache Excalibur/Avalon Framework</a>, for XML configuration handling.</li>
+          
+</ul>
+        
+</li>
+      
+</ul>
+<p>The following software is optional, depending on your needs:</p>
+<ul>
+        
+<li>
+          Graphics libraries. Generally, FOP contains direct support for the most important
+          bitmap image formats (including PNG, JPEG and GIF). See
+          <a href="graphics.html">FOP: Graphics Formats</a> for details.
+        </li>
+        
+<li>
+          PDF encryption. See <a href="pdfencryption.html">FOP: PDF Encryption</a> for details.
+        </li>
+      
+</ul>
+<p>In addition, the following system requirements apply:</p>
+<ul>
+        
+<li>
+          If you will be using FOP to process SVG, you must do so in a graphical environment.
+          See <a href="graphics.html#batik">FOP: Graphics (Batik)</a> for details.
+        </li>
+      
+</ul>
+</div>
+    
+<a name="N10075"></a><a name="install"></a>
+<h2 class="underlined_10">Installation</h2>
+<div class="section">
+<a name="N1007B"></a><a name="install-instruct"></a>
+<h3 class="underlined_5">Instructions</h3>
+<p>
+          Basic FOP installation consists of first unzipping the <span class="codefrag">.gz</span> file that is the
+          distribution medium, then unarchiving the resulting <span class="codefrag">.tar</span> file in a
+          directory/folder that is convenient on your system. Please consult your operating system
+          documentation or Zip application software documentation for instructions specific to your
+          site.
+        </p>
+<a name="N1008B"></a><a name="install-problems"></a>
+<h3 class="underlined_5">Problems</h3>
+<p>
+          Some Mac OSX users have experienced filename truncation problems using Stuffit to unzip
+          and unarchive their distribution media. This is a legacy of older Mac operating systems,
+          which had a 31-character pathname limit. Several Mac OSX users have recommended that
+          Mac OSX users use the shell command <span class="codefrag">tar -xzf</span> instead.
+        </p>
+</div>
+    
+<a name="N10099"></a><a name="standalone-start"></a>
+<h2 class="underlined_10">Starting FOP as a Standalone Application</h2>
+<div class="section">
+<a name="N1009F"></a><a name="fop-script"></a>
+<h3 class="underlined_5">Using the fop script or batch file</h3>
+<p>
+        The usual and recommended practice for starting FOP from the command line is to run the
+        batch file fop.bat (Windows) or the shell script fop (Unix/Linux).
+        These scripts require that the environment variable JAVA_HOME be
+        set to a path pointing to the appropriate Java installation on your system. Macintosh OSX
+        includes a Java environment as part of its distribution. We are told by Mac OSX users that
+        the path to use in this case is <span class="codefrag">/Library/Java/Home</span>. <strong>Caveat:</strong>
+        We suspect that, as Apple releases new Java environments and as FOP upgrades the minimum
+        Java requirements, the two will inevitably not match on some systems. Please see
+        <a class="external" href="http://developer.apple.com/java/faq">Java on Mac OSX FAQ</a> for information as
+        it becomes available.
+      </p>
+<pre class="code">
+USAGE
+Fop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-rtf|-tiff|-png|-pcl|-ps|-txt|-at [mime]|-print] &lt;outfile&gt;
+ [OPTIONS]
+  -version          print FOP version and exit
+  -d                debug mode
+  -x                dump configuration settings
+  -q                quiet mode
+  -c cfg.xml        use additional configuration file cfg.xml
+  -l lang           the language to use for user information
+  -r                relaxed/less strict validation (where available)
+  -dpi xxx          target resolution in dots per inch (dpi) where xxx is a number
+  -s                for area tree XML, down to block areas only
+  -v                run in verbose mode (currently simply print FOP version and continue)
+
+  -o [password]     PDF file will be encrypted with option owner password
+  -u [password]     PDF file will be encrypted with option user password
+  -noprint          PDF file will be encrypted without printing permission
+  -nocopy           PDF file will be encrypted without copy content permission
+  -noedit           PDF file will be encrypted without edit content permission
+  -noannotations    PDF file will be encrypted without edit annotation permission
+  -a                enables accessibility features (Tagged PDF etc., default off)
+  -pdfprofile prof  PDF file will be generated with the specified profile
+                    (Examples for prof: PDF/A-1b or PDF/X-3:2003)
+
+  -conserve         Enable memory-conservation policy (trades memory-consumption for disk I/O)
+                    (Note: currently only influences whether the area tree is serialized.)
+
+ [INPUT]
+  infile            xsl:fo input file (the same as the next)
+                    (use '-' for infile to pipe input from stdin)
+  -fo  infile       xsl:fo input file
+  -xml infile       xml input file, must be used together with -xsl
+  -atin infile      area tree input file
+  -ifin infile      intermediate format input file
+  -imagein infile   image input file (piping through stdin not supported)
+  -xsl stylesheet   xslt stylesheet
+
+  -param name value &lt;value&gt; to use for parameter &lt;name&gt; in xslt stylesheet
+                    (repeat '-param name value' for each parameter)
+
+  -catalog          use catalog resolver for input XML and XSLT files
+ [OUTPUT]
+  outfile           input will be rendered as PDF into outfile
+                    (use '-' for outfile to pipe output to stdout)
+  -pdf outfile      input will be rendered as PDF (outfile req'd)
+  -pdfa1b outfile   input will be rendered as PDF/A-1b compliant PDF
+                    (outfile req'd, same as "-pdf outfile -pdfprofile PDF/A-1b")
+  -awt              input will be displayed on screen
+  -rtf outfile      input will be rendered as RTF (outfile req'd)
+  -pcl outfile      input will be rendered as PCL (outfile req'd)
+  -ps outfile       input will be rendered as PostScript (outfile req'd)
+  -afp outfile      input will be rendered as AFP (outfile req'd)
+  -tiff outfile     input will be rendered as TIFF (outfile req'd)
+  -png outfile      input will be rendered as PNG (outfile req'd)
+  -txt outfile      input will be rendered as plain text (outfile req'd)
+  -at [mime] out    representation of area tree as XML (outfile req'd)
+                    specify optional mime output to allow the AT to be converted
+                    to final format later
+  -if [mime] out    representation of document in intermediate format XML (outfile req'd)
+                    specify optional mime output to allow the IF to be converted
+                    to final format later
+  -print            input file will be rendered and sent to the printer
+                    see options with "-print help"
+  -out mime outfile input will be rendered using the given MIME type
+                    (outfile req'd) Example: "-out application/pdf D:\out.pdf"
+                    (Tip: "-out list" prints the list of supported MIME types)
+  -svg outfile      input will be rendered as an SVG slides file (outfile req'd)
+                    Experimental feature - requires additional fop-sandbox.jar.
+
+  -foout outfile    input will only be XSL transformed. The intermediate
+                    XSL-FO file is saved and no rendering is performed.
+                    (Only available if you use -xml and -xsl parameters)
+
+
+ [Examples]
+  fop foo.fo foo.pdf
+  fop -fo foo.fo -pdf foo.pdf (does the same as the previous line)
+  fop -xml foo.xml -xsl foo.xsl -pdf foo.pdf
+  fop -xml foo.xml -xsl foo.xsl -foout foo.fo
+  fop -xml - -xsl foo.xsl -pdf -
+  fop foo.fo -mif foo.mif
+  fop foo.fo -rtf foo.rtf
+  fop foo.fo -print
+  fop foo.fo -awt</pre>
+<p>
+        PDF encryption is only available if FOP was compiled with encryption support
+        <strong>and</strong> if compatible encryption support is available at run time.
+        Currently, only the JCE is supported. Check the <a href="pdfencryption.html">Details</a>.
+      </p>
+<a name="N100C1"></a><a name="your-own-script"></a>
+<h3 class="underlined_5">Writing your own script</h3>
+<p>FOP's entry point for your own scripts is the class
+<span class="codefrag">org.apache.fop.cli.Main</span>. The general pattern for the
+        command line is: <span class="codefrag">java -classpath &lt;CLASSPATH&gt;
+        org.apache.fop.cli.Main &lt;arguments&gt;</span>. The arguments
+        consist of the options and infile and outfile specifications
+        as shown above for the standard scripts. You may wish to review
+        the standard scripts to make sure that
+        you get your environment properly configured.
+        </p>
+<a name="N100D1"></a><a name="jar-option"></a>
+<h3 class="underlined_5">Running with java's -jar option</h3>
+<p>
+        As an alternative to the start scripts you can run <span class="codefrag">java
+        -jar path/to/build/fop.jar &lt;arguments&gt;</span>, relying on
+        FOP to build the classpath for running FOP dynamically, see <a href="#dynamical-classpath">below</a>. If you use hyphenation,
+        you must put <span class="codefrag">fop-hyph.jar</span> in the <span class="codefrag">lib</span>
+        directory.
+      </p>
+<p>You can also run <span class="codefrag">java -jar path/to/fop.jar
+      &lt;arguments&gt;</span>, relying on the <span class="codefrag">Class-Path</span>
+      entry in the manifest file. This works if you put
+      <span class="codefrag">fop.jar</span> and all jar files from the <span class="codefrag">lib</span>
+      directory in a single directory. If you use hyphenation, you
+      must also put <span class="codefrag">fop-hyph.jar</span> in that directory.</p>
+<p>In both cases the arguments consist of the options and
+        infile and outfile specifications as shown above for the
+        standard scripts.</p>
+<a name="N10100"></a><a name="dynamical-classpath"></a>
+<h3 class="underlined_5">FOP's dynamical classpath construction</h3>
+<p>If FOP is started without a proper classpath, it tries to
+          add its dependencies dynamically. If the system property
+          <span class="codefrag">fop.home</span> contains the name of a directory, then
+          FOP uses that directory as the base directory for its
+          search. Otherwise the current working directory is the base
+          directory. If the base directory is called <span class="codefrag">build</span>,
+          then its parent directory becomes the base directory.</p>
+<p>FOP expects to find <span class="codefrag">fop.jar</span> in the
+          <span class="codefrag">build</span> subdirectory of the base directory, and
+          adds it to the classpath. Subsequently FOP adds all
+          <span class="codefrag">jar</span> files in the lib directory to the
+          classpath. The lib directory is either the <span class="codefrag">lib</span>
+          subdirectory of the base directory, or, if that does not
+          exist, the base directory itself.</p>
+<p>If the system property <span class="codefrag">fop.optional.lib</span>
+          contains the name of a directory, then all <span class="codefrag">jar</span>
+          files in that directory are also added to the classpath. See
+          the methods <span class="codefrag">getJARList</span> and
+          <span class="codefrag">checkDependencies</span> in
+          <span class="codefrag">org.apache.fop.cli.Main</span>.</p>
+</div>
+    
+<a name="N10132"></a><a name="check-input"></a>
+<h2 class="underlined_10">Using Xalan to Check XSL-FO Input</h2>
+<div class="section">
+<p>
+        FOP sessions that use -xml and -xsl input instead of -fo input are actually
+        controlling two distinct conversions: Tranforming XML to XSL-FO, then formatting
+        the XSL-FO to PDF (or another FOP output format).
+        Although FOP controls both of these processes, the first is included merely as
+        a convenience and for performance reasons.
+        Only the second is part of FOP's core processing.
+        If a user has a problem running FOP, it is important to determine which of these
+        two processes is causing the problem.
+        If the problem is in the first process, the user's stylesheet is likely the cause.
+        The FOP development team does not have resources to help with stylesheet issues,
+        although we have included links to some useful
+        <a href="../resources.html#specs">Specifications</a> and
+        <a href="../resources.html#articles">Books/Articles</a>.
+        If the problem is in the second process, FOP may have a bug or an unimplemented
+        feature that does require attention from the FOP development team.
+      </p>
+<div class="note">
+<div class="label">Note</div>
+<div class="content">The user is always responsible to provide correct XSL-FO code to FOP.</div>
+</div>
+<p>
+        In the case of using -xml and -xsl input, although the user is responsible for
+        the XSL-FO code that is FOP's input, it is not visible to the user. To make the
+        intermediate FO file visible, the FOP distribution includes the "-foout" option
+        which causes FOP to run only the first (transformation) step, and write the
+        results to a file. (See also the Xalan command-line below)
+      </p>
+<div class="note">
+<div class="label">Note</div>
+<div class="content">
+        When asking for help on the FOP mailing lists, <em>never</em> attach XML and
+        XSL to illustrate the issue. Always run the XSLT step (-foout) and send the
+        resulting XSL-FO file instead. Of course, be sure that the XSL-FO file is
+        correct before sending it.
+      </div>
+</div>
+<p>
+        The -foout option works the same way as if you would call the
+        <a class="external" href="http://xml.apache.org/xalan-j/commandline.html">Xalan command-line</a>:
+      </p>
+<p>
+        
+<span class="codefrag">java org.apache.xalan.xslt.Process -IN xmlfile -XSL file -OUT outfile</span>
+      
+</p>
+<p>
+        Note that there are some subtle differences between the FOP and Xalan command-lines.
+      </p>
+</div>
+    
+<a name="N10160"></a><a name="memory"></a>
+<h2 class="underlined_10">Memory Usage</h2>
+<div class="section">
+<p>
+        FOP can consume quite a bit of memory, even though this has been continually improved.
+        This is partly inherent to the formatting process and partly caused by implementation choices.
+        All FO processors currently on the market have memory problems with certain layouts.
+      </p>
+<p>
+        If you are running out of memory when using FOP, here are some ideas that may help:
+      </p>
+<ul>
+        
+<li>
+          Increase memory available to the JVM. See
+          <a class="external" href="http://java.sun.com/j2se/1.4/docs/tooldocs/solaris/java.html">the -Xmx option</a>
+          for more information.
+          <div class="warning">
+<div class="label">Warning</div>
+<div class="content">
+            It is usually unwise to increase the memory allocated to the JVM beyond the amount of
+            physical RAM, as this will generally cause significantly slower performance.
+          </div>
+</div>
+        
+</li>
+        
+<li>
+          Avoid forward references.
+          Forward references are references to some later part of a document.
+          Examples include page number citations which refer to pages which follow the citation,
+          tables of contents at the beginning of a document, and page numbering schemes that
+          include the total number of pages in the document
+          (<a href="../faq.html#pagenum">"page N of TOTAL"</a>).
+          Forward references cause all subsequent pages to be held in memory until the reference
+          can be resolved, i.e. until the page with the referenced element is encountered.
+          Forward references may be required by the task, but if you are getting a memory
+          overflow, at least consider the possibility of eliminating them.
+          A table of contents could be replaced by PDF bookmarks instead or moved to the end of
+          the document (reshuffle the paper could after printing).
+        </li>
+        
+<li>
+          Avoid large images, especially if they are scaled down.
+          If they need to be scaled, scale them in another application upstream from FOP.
+          For many image formats, memory consumption is driven mainly by the size of the image
+          file itself, not its dimensions (width*height), so increasing the compression rate
+          may help.
+        </li>
+        
+<li>
+          Use multiple page sequences.
+          FOP starts rendering after the end of a page sequence is encountered.
+          While the actual rendering is done page-by-page, some additional memory is
+          freed after the page sequence has been rendered.
+          This can be substantial if the page sequence contains lots of FO elements.
+        </li>
+      
+</ul>
+</div>
+    
+<a name="N10187"></a><a name="problems"></a>
+<h2 class="underlined_10">Problems</h2>
+<div class="section">
+<p>If you have problems running FOP, please see the <a href="../gethelp.html">"How to get Help" page</a>.</p>
+</div>
+  
+<span class="version">
+          version 955884</span>
+</div>
+<!--+
+    |end content
+    +-->
+<div class="clearboth">&nbsp;</div>
+</div>
+<div id="footer">
+<!--+
+    |start bottomstrip
+    +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+//  --></script>
+</div>
+<div class="copyright">
+        Copyright &copy;
+         1999-2009 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
+</div>
+<!--+
+    |end bottomstrip
+    +-->
+</div>
+</body>
+</html>

Modified: xmlgraphics/site/deploy/fop/trunk/running.pdf
URL: http://svn.apache.org/viewvc/xmlgraphics/site/deploy/fop/trunk/running.pdf?rev=955955&r1=955954&r2=955955&view=diff
==============================================================================
Files xmlgraphics/site/deploy/fop/trunk/running.pdf (original) and xmlgraphics/site/deploy/fop/trunk/running.pdf Fri Jun 18 11:52:37 2010 differ



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org


Mime
View raw message