You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xmlgraphics.apache.org by bu...@apache.org on 2016/06/27 12:02:07 UTC
svn commit: r991520 [2/2] - in /websites/staging/xmlgraphics/trunk/content:
./ fop/0.95/ fop/1.0/ fop/1.1/ fop/2.0/ fop/2.1/ fop/trunk/
Modified: websites/staging/xmlgraphics/trunk/content/fop/2.0/intermediate.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/2.0/intermediate.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/2.0/intermediate.html Mon Jun 27 12:02:06 2016
@@ -507,7 +507,7 @@ h2:hover > .headerlink, h3:hover > .head
<h2 id="usage">Usage of the Area Tree XML format (AT XML)<a class="headerlink" href="#usage" title="Permanent link">¶</a></h2>
<p>As already mentioned, the area tree XML format is generated by using the <strong>XMLRenderer</strong> (MIME type: <strong>application/X-fop-areatree</strong>). So, you basically set the right MIME type for the output format and process your FO files as if you would create a PDF file.</p>
<p>However, there is an important detail to consider: The various Renderers don't all use the same font sources. To be able to create the right area tree for the ultimate output format, you need to create the area tree XML file using the right font setup. This is achieved by telling the XMLRenderer to mimic another renderer. This is done by calling the XMLRenderer's mimicRenderer() method with an instance of the ultimate target renderer as the single parameter. This has a consequence: An area tree XML file rendered with the Java2DRenderer may not look as expected when it was actually generated for the PDF renderer. For renderers that use the same font setup, this restriction does not apply (PDF and PS, for example). Generating the area tree XML format file is the first step.</p>
-<p>The second step is to reparse the file using the <strong>AreaTreeParser</strong> which is found in the org.apache.fop.area package. The pages retrieved from the area tree XML file are added to an AreaTreeModel instance from where they are normally rendered using one of the available Renderer implementations. You can find examples for the area tree XML processing in the <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/">http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/</a> directory in the FOP distribution.</p>
+<p>The second step is to reparse the file using the <strong>AreaTreeParser</strong> which is found in the org.apache.fop.area package. The pages retrieved from the area tree XML file are added to an AreaTreeModel instance from where they are normally rendered using one of the available Renderer implementations. You can find examples for the area tree XML processing in the <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/intermediate/">http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/intermediate/</a> directory in the FOP distribution.</p>
<p>The basic pattern to parse the area tree XML format looks like this:</p>
<div class="codehilite"><pre><span class="n">FopFactory</span> <span class="n">fopFactory</span> <span class="o">=</span> <span class="n">FopFactory</span><span class="o">.</span><span class="na">newInstance</span><span class="o">(</span><span class="k">new</span> <span class="n">File</span><span class="o">(</span><span class="s">"."</span><span class="o">).</span><span class="na">toURI</span><span class="o">());</span>
@@ -539,7 +539,7 @@ h2:hover > .headerlink, h3:hover > .head
<p>This example simply reads an area tree file and renders it to a PDF file. Please note, that in normal FOP operation you're shielded from having to instantiate the FontInfo object yourself. This is normally a task of the AreaTreeHandler which is not present in this scenario. The same applies to the AreaTreeModel instance, in this case an instance of a subclass called RenderPagesModel. RenderPagesModel is ideal in this case as it has very little overhead processing the individual pages. An important line in the example is the call to <code>endDocument()</code> on the AreaTreeModel. This lets the Renderer know that the processing is now finished.</p>
<p>The area tree XML format can also be used from the <a href="running.html#standalone-start">command-line</a> by using the "-atin" parameter for specifying the area tree XML as input file. You can also specify a "mimic renderer" by inserting a MIME type between "-at" and the output file.</p>
<h3 id="concat">Concatenating Documents<a class="headerlink" href="#concat" title="Permanent link">¶</a></h3>
-<p>This initial example is obviously not very useful. It would be faster to create the PDF file directly. As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/examples/embedding/java/embedding/atxml/ExampleConcat.java">ExampleConcat.java</a> example shows you can easily parse multiple area tree files in a row and add the parsed pages to the same AreaTreeModel instance which essentially concatenates all the input document to one single output document.</p>
+<p>This initial example is obviously not very useful. It would be faster to create the PDF file directly. As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/atxml/ExampleConcat.java">ExampleConcat.java</a> example shows you can easily parse multiple area tree files in a row and add the parsed pages to the same AreaTreeModel instance which essentially concatenates all the input document to one single output document.</p>
<h3 id="modifying">Modifying Documents<a class="headerlink" href="#modifying" title="Permanent link">¶</a></h3>
<p>One of the most important use cases for this format is obviously modifying the area tree XML before finally rendering it to the target format. You can easily use XSLT to process the AT XML file according to your needs. Please note, that we will currently not formally describe the area tree XML format. You need to have a good understanding its structure so you don't create any non-parseable files. We may add an XML Schema and more detailed documentation at a later time. You're invited to help us with that.</p>
<p><note>The area tree XML format is sensitive to changes in whitespace. If you're not careful, the modified file may not render correctly.</note></p>
@@ -557,7 +557,7 @@ h2:hover > .headerlink, h3:hover > .head
</li>
</ul>
<p>As with the AT XML, there is an important detail to consider: The various output implementations don't all use the same font sources. To be able to create the right IF for the ultimate output file, you need to create the IF file using the right font setup. This is achieved by telling the IFRenderer (responsible for converting the area tree into calls to the IFDocumentHandler and IFPainter interfaces) to mimic another renderer. This is done by calling the IFSerializer's mimicDocumentHandler() method with an instance of the ultimate target document handler as the single parameter. This has a consequence: An IF file rendered with the Java2DDocumentHandler may not look as expected when it was actually generated for the PDF implementation. For implementations that use the same font setup, this restriction does not apply (PDF and PS, for example). Generating the Intermediate Format file is the first step.</p>
-<p>The second step is to reparse the file using the <strong>IFParser</strong> which is found in the org.apache.fop.render.intermediate package. The IFParser simply takes an IFDocumentHandler instance against which it generates the appropriate calls. The IFParser is implemented as a SAX ContentHandler so you're free to choose the method for post-processing the IF file(s). You can use XSLT or write SAX- or DOM-based code to manipulate the contents. You can find examples for the Intermediate Format processing in the <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/">http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/</a> directory in the FOP distribution.</p>
+<p>The second step is to reparse the file using the <strong>IFParser</strong> which is found in the org.apache.fop.render.intermediate package. The IFParser simply takes an IFDocumentHandler instance against which it generates the appropriate calls. The IFParser is implemented as a SAX ContentHandler so you're free to choose the method for post-processing the IF file(s). You can use XSLT or write SAX- or DOM-based code to manipulate the contents. You can find examples for the Intermediate Format processing in the <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/intermediate/">http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/intermediate/</a> directory in the FOP distribution.</p>
<p>The basic pattern to parse the intermediate format looks like this:</p>
<div class="codehilite"><pre><span class="n">FopFactory</span> <span class="n">fopFactory</span> <span class="o">=</span> <span class="n">FopFactory</span><span class="o">.</span><span class="na">newInstance</span><span class="o">(</span><span class="k">new</span> <span class="n">File</span><span class="o">(</span><span class="s">"."</span><span class="o">).</span><span class="na">toURI</span><span class="o">());</span>
@@ -593,7 +593,7 @@ h2:hover > .headerlink, h3:hover > .head
<p>This example simply reads an intermediate file and renders it to a PDF file. Here IFParser.parse() is used, but you can also just get a SAX ContentHandler by using the IFParser.getContentHandler() method.</p>
<h3 id="concat-if">Concatenating Documents<a class="headerlink" href="#concat-if" title="Permanent link">¶</a></h3>
-<p>This initial example is obviously not very useful. It would be faster to create the PDF file directly (without the intermediate step). As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/ExampleConcat.java">ExampleConcat.java</a> example shows you can easily parse multiple intermediate files in a row and use the IFConcatenator class to concatenate page sequences from multiple source files to a single output file. This particular example does the concatenation on the level of the IFDocumentHandler interface. You could also do this in XSLT or using SAX on the XML level. Whatever suits your process best.</p>
+<p>This initial example is obviously not very useful. It would be faster to create the PDF file directly (without the intermediate step). As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/intermediate/ExampleConcat.java">ExampleConcat.java</a> example shows you can easily parse multiple intermediate files in a row and use the IFConcatenator class to concatenate page sequences from multiple source files to a single output file. This particular example does the concatenation on the level of the IFDocumentHandler interface. You could also do this in XSLT or using SAX on the XML level. Whatever suits your process best.</p>
<h3 id="modifying-if">Modifying Documents<a class="headerlink" href="#modifying-if" title="Permanent link">¶</a></h3>
<p>One of the most important use cases for this format is obviously modifying the intermediate format before finally rendering it to the target format. You can easily use XSLT to process the IF file according to your needs.</p>
<p>There is an XML Schema (located under <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/documentation/intermediate-format-ng/">src/documentation/intermediate-format-ng</a>) that helps you verify that your modified content is correct.</p>
Modified: websites/staging/xmlgraphics/trunk/content/fop/2.0/upgrading.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/2.0/upgrading.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/2.0/upgrading.html Mon Jun 27 12:02:06 2016
@@ -579,7 +579,7 @@ ResourceResolverFactory (a factory class
<p>As stated above, empty table cells <code><fo:table-cell></fo:table-cell></code> are not allowed by the specification. The same applies to empty <code>fo:static-content</code> and <code>fo:block-container</code> elements, for example.</p>
</li>
<li>
-<p>Version 0.20.5 is not XSL-FO compliant with respect to sizing images (<code>external-graphic</code>) or <code>instream-foreign-object</code> objects. If images or SVGs are sized differently in your outputs with the new FOP version check <a href="https://issues.apache.org/jira/browse/FOP-1073">FOP-1073</a> as it contains some hints on what to do. The file <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/fo/basic/images.fo?view=markup">http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/fo/basic/images.fo?view=markup</a> has a number of good examples that show the correct behaviour.</p>
+<p>Version 0.20.5 is not XSL-FO compliant with respect to sizing images (<code>external-graphic</code>) or <code>instream-foreign-object</code> objects. If images or SVGs are sized differently in your outputs with the new FOP version check <a href="https://issues.apache.org/jira/browse/FOP-1073">FOP-1073</a> as it contains some hints on what to do. The file <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/fo/basic/images.fo?view=markup">http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/fo/basic/images.fo?view=markup</a> has a number of good examples that show the correct behaviour.</p>
</li>
<li>
<p>The <code>fox:outline</code> extension is not implemented in the current version: it has been superseded by the bookmark elements from XSL-FO 1.1.</p>
Modified: websites/staging/xmlgraphics/trunk/content/fop/2.1/embedding.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/2.1/embedding.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/2.1/embedding.html Mon Jun 27 12:02:06 2016
@@ -827,28 +827,28 @@ h2:hover > .headerlink, h3:hover > .head
<h2 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">¶</a></h2>
<p>The directory "{fop-dir}/examples/embedding" contains several working examples.</p>
<h3 id="ExampleFO2PDF">ExampleFO2PDF.java<a class="headerlink" href="#ExampleFO2PDF" title="Permanent link">¶</a></h3>
-<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleFO2PDF.java?view=markup">example</a> demonstrates the basic usage pattern to transform an XSL-FO file to PDF using FOP.</p>
+<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/ExampleFO2PDF.java?view=markup">example</a> demonstrates the basic usage pattern to transform an XSL-FO file to PDF using FOP.</p>
<p><img alt="Example XSL-FO to PDF" src="images/EmbeddingExampleFO2PDF.png" /></p>
<h3 id="ExampleXML2FO">ExampleXML2FO.java<a class="headerlink" href="#ExampleXML2FO" title="Permanent link">¶</a></h3>
-<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2FO.java?view=markup">example</a> 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 classpath (ex. <a href="http://xml.apache.org/xalan-j">Xalan</a>).</p>
+<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/ExampleXML2FO.java?view=markup">example</a> 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 classpath (ex. <a href="http://xml.apache.org/xalan-j">Xalan</a>).</p>
<p><img alt="Example XML to XSL-FO" src="images/EmbeddingExampleXML2FO.png" /></p>
<h3 id="ExampleXML2PDF">ExampleXML2PDF.java<a class="headerlink" href="#ExampleXML2PDF" title="Permanent link">¶</a></h3>
-<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2PDF.java?view=markup">example</a> 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>
+<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/ExampleXML2PDF.java?view=markup">example</a> 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>
<p><img alt="Example XML to PDF (via XSL-FO)" src="images/EmbeddingExampleXML2PDF.png" /></p>
<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 performance is significantly higher with SAX.</p>
<h3 id="ExampleObj2XML">ExampleObj2XML.java<a class="headerlink" href="#ExampleObj2XML" title="Permanent link">¶</a></h3>
-<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2XML.java?view=markup">example</a> 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 complicated once you know how this works.</p>
+<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/ExampleObj2XML.java?view=markup">example</a> 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 complicated once you know how this works.</p>
<p><img alt="Example Java object to XML" src="images/EmbeddingExampleObj2XML.png" /></p>
<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 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 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. <a href="http://java.sun.com/xml/jaxp/dist/1.1/docs/tutorial/xslt/3_generate.html">An older JAXP tutorial</a>).</p>
<h3 id="ExampleObj2PDF">ExampleObj2PDF.java<a class="headerlink" href="#ExampleObj2PDF" title="Permanent link">¶</a></h3>
-<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2PDF.java?view=markup">example</a> 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 using FOP as before.</p>
+<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/ExampleObj2PDF.java?view=markup">example</a> 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 using FOP as before.</p>
<p><img alt="Example Java object to PDF (via XML and XSL-FO)" src="images/EmbeddingExampleObj2PDF.png" /></p>
<h3 id="ExampleDOM2PDF">ExampleDOM2PDF.java<a class="headerlink" href="#ExampleDOM2PDF" title="Permanent link">¶</a></h3>
-<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleDOM2PDF.java?view=markup">example</a> has FOP use a DOMSource instead of a StreamSource in order to use a DOM tree as input for an XSL transformation.</p>
+<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/ExampleDOM2PDF.java?view=markup">example</a> has FOP use a DOMSource instead of a StreamSource in order to use a DOM tree as input for an XSL transformation.</p>
<h3 id="ExampleSVG2PDF">ExampleSVG2PDF.java (PDF Transcoder example)<a class="headerlink" href="#ExampleSVG2PDF" title="Permanent link">¶</a></h3>
-<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleSVG2PDF.java?view=markup">example</a> 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>
+<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/ExampleSVG2PDF.java?view=markup">example</a> 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>
<h3 id="ExampleConcat">ExampleConcat.java (IF Concatenation example)<a class="headerlink" href="#ExampleConcat" title="Permanent link">¶</a></h3>
<p>This can be found in the <code>embedding.intermediate</code> package within the examples and describes how IF can be concatenated to produce a document. Because IF has been through FOPs layout engine, it should be visually consistent with FO rendered documents while allowing the user to merge numerous documents together.</p>
<h3 id="example-notes">Final notes<a class="headerlink" href="#example-notes" title="Permanent link">¶</a></h3>
Modified: websites/staging/xmlgraphics/trunk/content/fop/2.1/events.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/2.1/events.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/2.1/events.html Mon Jun 27 12:02:06 2016
@@ -485,7 +485,7 @@ h2:hover > .headerlink, h3:hover > .head
</li>
</ul>
<p>The <code>EventFormatter</code> class can be used to translate the events into human-readable, localized messages.</p>
-<p>A full example of what is shown here can be found in the <code>examples/embedding/java/embedding/events</code> directory in the FOP distribution. The example can also be accessed <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/events/">via the web</a>.</p>
+<p>A full example of what is shown here can be found in the <code>examples/embedding/java/embedding/events</code> directory in the FOP distribution. The example can also be accessed <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/events/">via the web</a>.</p>
<h3 id="write-listener">Writing an EventListener<a class="headerlink" href="#write-listener" title="Permanent link">¶</a></h3>
<p>The following code sample shows a very simple EventListener. It basically just sends all events to System.out (stdout) or System.err (stderr) depending on the event severity.</p>
<div class="codehilite"><pre><span class="kn">import</span> <span class="nn">org.apache.fop.events.Event</span><span class="o">;</span>
Modified: websites/staging/xmlgraphics/trunk/content/fop/2.1/intermediate.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/2.1/intermediate.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/2.1/intermediate.html Mon Jun 27 12:02:06 2016
@@ -507,7 +507,7 @@ h2:hover > .headerlink, h3:hover > .head
<h2 id="usage">Usage of the Area Tree XML format (AT XML)<a class="headerlink" href="#usage" title="Permanent link">¶</a></h2>
<p>As already mentioned, the area tree XML format is generated by using the <strong>XMLRenderer</strong> (MIME type: <strong>application/X-fop-areatree</strong>). So, you basically set the right MIME type for the output format and process your FO files as if you would create a PDF file.</p>
<p>However, there is an important detail to consider: The various Renderers don't all use the same font sources. To be able to create the right area tree for the ultimate output format, you need to create the area tree XML file using the right font setup. This is achieved by telling the XMLRenderer to mimic another renderer. This is done by calling the XMLRenderer's mimicRenderer() method with an instance of the ultimate target renderer as the single parameter. This has a consequence: An area tree XML file rendered with the Java2DRenderer may not look as expected when it was actually generated for the PDF renderer. For renderers that use the same font setup, this restriction does not apply (PDF and PS, for example). Generating the area tree XML format file is the first step.</p>
-<p>The second step is to reparse the file using the <strong>AreaTreeParser</strong> which is found in the org.apache.fop.area package. The pages retrieved from the area tree XML file are added to an AreaTreeModel instance from where they are normally rendered using one of the available Renderer implementations. You can find examples for the area tree XML processing in the <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/">http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/</a> directory in the FOP distribution.</p>
+<p>The second step is to reparse the file using the <strong>AreaTreeParser</strong> which is found in the org.apache.fop.area package. The pages retrieved from the area tree XML file are added to an AreaTreeModel instance from where they are normally rendered using one of the available Renderer implementations. You can find examples for the area tree XML processing in the <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/intermediate/">http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/intermediate/</a> directory in the FOP distribution.</p>
<p>The basic pattern to parse the area tree XML format looks like this:</p>
<div class="codehilite"><pre><span class="n">FopFactory</span> <span class="n">fopFactory</span> <span class="o">=</span> <span class="n">FopFactory</span><span class="o">.</span><span class="na">newInstance</span><span class="o">(</span><span class="k">new</span> <span class="n">File</span><span class="o">(</span><span class="s">"."</span><span class="o">).</span><span class="na">toURI</span><span class="o">());</span>
@@ -539,7 +539,7 @@ h2:hover > .headerlink, h3:hover > .head
<p>This example simply reads an area tree file and renders it to a PDF file. Please note, that in normal FOP operation you're shielded from having to instantiate the FontInfo object yourself. This is normally a task of the AreaTreeHandler which is not present in this scenario. The same applies to the AreaTreeModel instance, in this case an instance of a subclass called RenderPagesModel. RenderPagesModel is ideal in this case as it has very little overhead processing the individual pages. An important line in the example is the call to <code>endDocument()</code> on the AreaTreeModel. This lets the Renderer know that the processing is now finished.</p>
<p>The area tree XML format can also be used from the <a href="running.html#standalone-start">command-line</a> by using the "-atin" parameter for specifying the area tree XML as input file. You can also specify a "mimic renderer" by inserting a MIME type between "-at" and the output file.</p>
<h3 id="concat">Concatenating Documents<a class="headerlink" href="#concat" title="Permanent link">¶</a></h3>
-<p>This initial example is obviously not very useful. It would be faster to create the PDF file directly. As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/examples/embedding/java/embedding/atxml/ExampleConcat.java">ExampleConcat.java</a> example shows you can easily parse multiple area tree files in a row and add the parsed pages to the same AreaTreeModel instance which essentially concatenates all the input document to one single output document.</p>
+<p>This initial example is obviously not very useful. It would be faster to create the PDF file directly. As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/atxml/ExampleConcat.java">ExampleConcat.java</a> example shows you can easily parse multiple area tree files in a row and add the parsed pages to the same AreaTreeModel instance which essentially concatenates all the input document to one single output document.</p>
<h3 id="modifying">Modifying Documents<a class="headerlink" href="#modifying" title="Permanent link">¶</a></h3>
<p>One of the most important use cases for this format is obviously modifying the area tree XML before finally rendering it to the target format. You can easily use XSLT to process the AT XML file according to your needs. Please note, that we will currently not formally describe the area tree XML format. You need to have a good understanding its structure so you don't create any non-parseable files. We may add an XML Schema and more detailed documentation at a later time. You're invited to help us with that.</p>
<p><note>The area tree XML format is sensitive to changes in whitespace. If you're not careful, the modified file may not render correctly.</note></p>
@@ -557,7 +557,7 @@ h2:hover > .headerlink, h3:hover > .head
</li>
</ul>
<p>As with the AT XML, there is an important detail to consider: The various output implementations don't all use the same font sources. To be able to create the right IF for the ultimate output file, you need to create the IF file using the right font setup. This is achieved by telling the IFRenderer (responsible for converting the area tree into calls to the IFDocumentHandler and IFPainter interfaces) to mimic another renderer. This is done by calling the IFSerializer's mimicDocumentHandler() method with an instance of the ultimate target document handler as the single parameter. This has a consequence: An IF file rendered with the Java2DDocumentHandler may not look as expected when it was actually generated for the PDF implementation. For implementations that use the same font setup, this restriction does not apply (PDF and PS, for example). Generating the Intermediate Format file is the first step.</p>
-<p>The second step is to reparse the file using the <strong>IFParser</strong> which is found in the org.apache.fop.render.intermediate package. The IFParser simply takes an IFDocumentHandler instance against which it generates the appropriate calls. The IFParser is implemented as a SAX ContentHandler so you're free to choose the method for post-processing the IF file(s). You can use XSLT or write SAX- or DOM-based code to manipulate the contents. You can find examples for the Intermediate Format processing in the <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/">http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/</a> directory in the FOP distribution.</p>
+<p>The second step is to reparse the file using the <strong>IFParser</strong> which is found in the org.apache.fop.render.intermediate package. The IFParser simply takes an IFDocumentHandler instance against which it generates the appropriate calls. The IFParser is implemented as a SAX ContentHandler so you're free to choose the method for post-processing the IF file(s). You can use XSLT or write SAX- or DOM-based code to manipulate the contents. You can find examples for the Intermediate Format processing in the <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/intermediate/">http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/intermediate/</a> directory in the FOP distribution.</p>
<p>The basic pattern to parse the intermediate format looks like this:</p>
<div class="codehilite"><pre><span class="n">FopFactory</span> <span class="n">fopFactory</span> <span class="o">=</span> <span class="n">FopFactory</span><span class="o">.</span><span class="na">newInstance</span><span class="o">(</span><span class="k">new</span> <span class="n">File</span><span class="o">(</span><span class="s">"."</span><span class="o">).</span><span class="na">toURI</span><span class="o">());</span>
@@ -593,7 +593,7 @@ h2:hover > .headerlink, h3:hover > .head
<p>This example simply reads an intermediate file and renders it to a PDF file. Here IFParser.parse() is used, but you can also just get a SAX ContentHandler by using the IFParser.getContentHandler() method.</p>
<h3 id="concat-if">Concatenating Documents<a class="headerlink" href="#concat-if" title="Permanent link">¶</a></h3>
-<p>This initial example is obviously not very useful. It would be faster to create the PDF file directly (without the intermediate step). As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/ExampleConcat.java">ExampleConcat.java</a> example shows you can easily parse multiple intermediate files in a row and use the IFConcatenator class to concatenate page sequences from multiple source files to a single output file. This particular example does the concatenation on the level of the IFDocumentHandler interface. You could also do this in XSLT or using SAX on the XML level. Whatever suits your process best.</p>
+<p>This initial example is obviously not very useful. It would be faster to create the PDF file directly (without the intermediate step). As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/intermediate/ExampleConcat.java">ExampleConcat.java</a> example shows you can easily parse multiple intermediate files in a row and use the IFConcatenator class to concatenate page sequences from multiple source files to a single output file. This particular example does the concatenation on the level of the IFDocumentHandler interface. You could also do this in XSLT or using SAX on the XML level. Whatever suits your process best.</p>
<h3 id="modifying-if">Modifying Documents<a class="headerlink" href="#modifying-if" title="Permanent link">¶</a></h3>
<p>One of the most important use cases for this format is obviously modifying the intermediate format before finally rendering it to the target format. You can easily use XSLT to process the IF file according to your needs.</p>
<p>There is an XML Schema (located under <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/documentation/intermediate-format-ng/">src/documentation/intermediate-format-ng</a>) that helps you verify that your modified content is correct.</p>
Modified: websites/staging/xmlgraphics/trunk/content/fop/2.1/upgrading.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/2.1/upgrading.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/2.1/upgrading.html Mon Jun 27 12:02:06 2016
@@ -579,7 +579,7 @@ ResourceResolverFactory (a factory class
<p>As stated above, empty table cells <code><fo:table-cell></fo:table-cell></code> are not allowed by the specification. The same applies to empty <code>fo:static-content</code> and <code>fo:block-container</code> elements, for example.</p>
</li>
<li>
-<p>Version 0.20.5 is not XSL-FO compliant with respect to sizing images (<code>external-graphic</code>) or <code>instream-foreign-object</code> objects. If images or SVGs are sized differently in your outputs with the new FOP version check <a href="https://issues.apache.org/jira/browse/FOP-1073">FOP-1073</a> as it contains some hints on what to do. The file <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/fo/basic/images.fo?view=markup">http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/fo/basic/images.fo?view=markup</a> has a number of good examples that show the correct behaviour.</p>
+<p>Version 0.20.5 is not XSL-FO compliant with respect to sizing images (<code>external-graphic</code>) or <code>instream-foreign-object</code> objects. If images or SVGs are sized differently in your outputs with the new FOP version check <a href="https://issues.apache.org/jira/browse/FOP-1073">FOP-1073</a> as it contains some hints on what to do. The file <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/fo/basic/images.fo?view=markup">http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/fo/basic/images.fo?view=markup</a> has a number of good examples that show the correct behaviour.</p>
</li>
<li>
<p>The <code>fox:outline</code> extension is not implemented in the current version: it has been superseded by the bookmark elements from XSL-FO 1.1.</p>
Modified: websites/staging/xmlgraphics/trunk/content/fop/trunk/embedding.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/trunk/embedding.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/trunk/embedding.html Mon Jun 27 12:02:06 2016
@@ -827,28 +827,28 @@ h2:hover > .headerlink, h3:hover > .head
<h2 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">¶</a></h2>
<p>The directory "{fop-dir}/examples/embedding" contains several working examples.</p>
<h3 id="ExampleFO2PDF">ExampleFO2PDF.java<a class="headerlink" href="#ExampleFO2PDF" title="Permanent link">¶</a></h3>
-<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleFO2PDF.java?view=markup">example</a> demonstrates the basic usage pattern to transform an XSL-FO file to PDF using FOP.</p>
+<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/ExampleFO2PDF.java?view=markup">example</a> demonstrates the basic usage pattern to transform an XSL-FO file to PDF using FOP.</p>
<p><img alt="Example XSL-FO to PDF" src="images/EmbeddingExampleFO2PDF.png" /></p>
<h3 id="ExampleXML2FO">ExampleXML2FO.java<a class="headerlink" href="#ExampleXML2FO" title="Permanent link">¶</a></h3>
-<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2FO.java?view=markup">example</a> 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 classpath (ex. <a href="http://xml.apache.org/xalan-j">Xalan</a>).</p>
+<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/ExampleXML2FO.java?view=markup">example</a> 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 classpath (ex. <a href="http://xml.apache.org/xalan-j">Xalan</a>).</p>
<p><img alt="Example XML to XSL-FO" src="images/EmbeddingExampleXML2FO.png" /></p>
<h3 id="ExampleXML2PDF">ExampleXML2PDF.java<a class="headerlink" href="#ExampleXML2PDF" title="Permanent link">¶</a></h3>
-<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2PDF.java?view=markup">example</a> 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>
+<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/ExampleXML2PDF.java?view=markup">example</a> 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>
<p><img alt="Example XML to PDF (via XSL-FO)" src="images/EmbeddingExampleXML2PDF.png" /></p>
<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 performance is significantly higher with SAX.</p>
<h3 id="ExampleObj2XML">ExampleObj2XML.java<a class="headerlink" href="#ExampleObj2XML" title="Permanent link">¶</a></h3>
-<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2XML.java?view=markup">example</a> 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 complicated once you know how this works.</p>
+<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/ExampleObj2XML.java?view=markup">example</a> 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 complicated once you know how this works.</p>
<p><img alt="Example Java object to XML" src="images/EmbeddingExampleObj2XML.png" /></p>
<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 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 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. <a href="http://java.sun.com/xml/jaxp/dist/1.1/docs/tutorial/xslt/3_generate.html">An older JAXP tutorial</a>).</p>
<h3 id="ExampleObj2PDF">ExampleObj2PDF.java<a class="headerlink" href="#ExampleObj2PDF" title="Permanent link">¶</a></h3>
-<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2PDF.java?view=markup">example</a> 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 using FOP as before.</p>
+<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/ExampleObj2PDF.java?view=markup">example</a> 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 using FOP as before.</p>
<p><img alt="Example Java object to PDF (via XML and XSL-FO)" src="images/EmbeddingExampleObj2PDF.png" /></p>
<h3 id="ExampleDOM2PDF">ExampleDOM2PDF.java<a class="headerlink" href="#ExampleDOM2PDF" title="Permanent link">¶</a></h3>
-<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleDOM2PDF.java?view=markup">example</a> has FOP use a DOMSource instead of a StreamSource in order to use a DOM tree as input for an XSL transformation.</p>
+<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/ExampleDOM2PDF.java?view=markup">example</a> has FOP use a DOMSource instead of a StreamSource in order to use a DOM tree as input for an XSL transformation.</p>
<h3 id="ExampleSVG2PDF">ExampleSVG2PDF.java (PDF Transcoder example)<a class="headerlink" href="#ExampleSVG2PDF" title="Permanent link">¶</a></h3>
-<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleSVG2PDF.java?view=markup">example</a> 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>
+<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/ExampleSVG2PDF.java?view=markup">example</a> 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>
<h3 id="ExampleConcat">ExampleConcat.java (IF Concatenation example)<a class="headerlink" href="#ExampleConcat" title="Permanent link">¶</a></h3>
<p>This can be found in the <code>embedding.intermediate</code> package within the examples and describes how IF can be concatenated to produce a document. Because IF has been through FOPs layout engine, it should be visually consistent with FO rendered documents while allowing the user to merge numerous documents together.</p>
<h3 id="example-notes">Final notes<a class="headerlink" href="#example-notes" title="Permanent link">¶</a></h3>
Modified: websites/staging/xmlgraphics/trunk/content/fop/trunk/events.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/trunk/events.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/trunk/events.html Mon Jun 27 12:02:06 2016
@@ -485,7 +485,7 @@ h2:hover > .headerlink, h3:hover > .head
</li>
</ul>
<p>The <code>EventFormatter</code> class can be used to translate the events into human-readable, localized messages.</p>
-<p>A full example of what is shown here can be found in the <code>examples/embedding/java/embedding/events</code> directory in the FOP distribution. The example can also be accessed <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/events/">via the web</a>.</p>
+<p>A full example of what is shown here can be found in the <code>examples/embedding/java/embedding/events</code> directory in the FOP distribution. The example can also be accessed <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/events/">via the web</a>.</p>
<h3 id="write-listener">Writing an EventListener<a class="headerlink" href="#write-listener" title="Permanent link">¶</a></h3>
<p>The following code sample shows a very simple EventListener. It basically just sends all events to System.out (stdout) or System.err (stderr) depending on the event severity.</p>
<div class="codehilite"><pre><span class="kn">import</span> <span class="nn">org.apache.fop.events.Event</span><span class="o">;</span>
Modified: websites/staging/xmlgraphics/trunk/content/fop/trunk/intermediate.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/trunk/intermediate.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/trunk/intermediate.html Mon Jun 27 12:02:06 2016
@@ -507,7 +507,7 @@ h2:hover > .headerlink, h3:hover > .head
<h2 id="usage">Usage of the Area Tree XML format (AT XML)<a class="headerlink" href="#usage" title="Permanent link">¶</a></h2>
<p>As already mentioned, the area tree XML format is generated by using the <strong>XMLRenderer</strong> (MIME type: <strong>application/X-fop-areatree</strong>). So, you basically set the right MIME type for the output format and process your FO files as if you would create a PDF file.</p>
<p>However, there is an important detail to consider: The various Renderers don't all use the same font sources. To be able to create the right area tree for the ultimate output format, you need to create the area tree XML file using the right font setup. This is achieved by telling the XMLRenderer to mimic another renderer. This is done by calling the XMLRenderer's mimicRenderer() method with an instance of the ultimate target renderer as the single parameter. This has a consequence: An area tree XML file rendered with the Java2DRenderer may not look as expected when it was actually generated for the PDF renderer. For renderers that use the same font setup, this restriction does not apply (PDF and PS, for example). Generating the area tree XML format file is the first step.</p>
-<p>The second step is to reparse the file using the <strong>AreaTreeParser</strong> which is found in the org.apache.fop.area package. The pages retrieved from the area tree XML file are added to an AreaTreeModel instance from where they are normally rendered using one of the available Renderer implementations. You can find examples for the area tree XML processing in the <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/">http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/</a> directory in the FOP distribution.</p>
+<p>The second step is to reparse the file using the <strong>AreaTreeParser</strong> which is found in the org.apache.fop.area package. The pages retrieved from the area tree XML file are added to an AreaTreeModel instance from where they are normally rendered using one of the available Renderer implementations. You can find examples for the area tree XML processing in the <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/intermediate/">http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/intermediate/</a> directory in the FOP distribution.</p>
<p>The basic pattern to parse the area tree XML format looks like this:</p>
<div class="codehilite"><pre><span class="n">FopFactory</span> <span class="n">fopFactory</span> <span class="o">=</span> <span class="n">FopFactory</span><span class="o">.</span><span class="na">newInstance</span><span class="o">(</span><span class="k">new</span> <span class="n">File</span><span class="o">(</span><span class="s">"."</span><span class="o">).</span><span class="na">toURI</span><span class="o">());</span>
@@ -539,7 +539,7 @@ h2:hover > .headerlink, h3:hover > .head
<p>This example simply reads an area tree file and renders it to a PDF file. Please note, that in normal FOP operation you're shielded from having to instantiate the FontInfo object yourself. This is normally a task of the AreaTreeHandler which is not present in this scenario. The same applies to the AreaTreeModel instance, in this case an instance of a subclass called RenderPagesModel. RenderPagesModel is ideal in this case as it has very little overhead processing the individual pages. An important line in the example is the call to <code>endDocument()</code> on the AreaTreeModel. This lets the Renderer know that the processing is now finished.</p>
<p>The area tree XML format can also be used from the <a href="running.html#standalone-start">command-line</a> by using the "-atin" parameter for specifying the area tree XML as input file. You can also specify a "mimic renderer" by inserting a MIME type between "-at" and the output file.</p>
<h3 id="concat">Concatenating Documents<a class="headerlink" href="#concat" title="Permanent link">¶</a></h3>
-<p>This initial example is obviously not very useful. It would be faster to create the PDF file directly. As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/examples/embedding/java/embedding/atxml/ExampleConcat.java">ExampleConcat.java</a> example shows you can easily parse multiple area tree files in a row and add the parsed pages to the same AreaTreeModel instance which essentially concatenates all the input document to one single output document.</p>
+<p>This initial example is obviously not very useful. It would be faster to create the PDF file directly. As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/atxml/ExampleConcat.java">ExampleConcat.java</a> example shows you can easily parse multiple area tree files in a row and add the parsed pages to the same AreaTreeModel instance which essentially concatenates all the input document to one single output document.</p>
<h3 id="modifying">Modifying Documents<a class="headerlink" href="#modifying" title="Permanent link">¶</a></h3>
<p>One of the most important use cases for this format is obviously modifying the area tree XML before finally rendering it to the target format. You can easily use XSLT to process the AT XML file according to your needs. Please note, that we will currently not formally describe the area tree XML format. You need to have a good understanding its structure so you don't create any non-parseable files. We may add an XML Schema and more detailed documentation at a later time. You're invited to help us with that.</p>
<p><note>The area tree XML format is sensitive to changes in whitespace. If you're not careful, the modified file may not render correctly.</note></p>
@@ -557,7 +557,7 @@ h2:hover > .headerlink, h3:hover > .head
</li>
</ul>
<p>As with the AT XML, there is an important detail to consider: The various output implementations don't all use the same font sources. To be able to create the right IF for the ultimate output file, you need to create the IF file using the right font setup. This is achieved by telling the IFRenderer (responsible for converting the area tree into calls to the IFDocumentHandler and IFPainter interfaces) to mimic another renderer. This is done by calling the IFSerializer's mimicDocumentHandler() method with an instance of the ultimate target document handler as the single parameter. This has a consequence: An IF file rendered with the Java2DDocumentHandler may not look as expected when it was actually generated for the PDF implementation. For implementations that use the same font setup, this restriction does not apply (PDF and PS, for example). Generating the Intermediate Format file is the first step.</p>
-<p>The second step is to reparse the file using the <strong>IFParser</strong> which is found in the org.apache.fop.render.intermediate package. The IFParser simply takes an IFDocumentHandler instance against which it generates the appropriate calls. The IFParser is implemented as a SAX ContentHandler so you're free to choose the method for post-processing the IF file(s). You can use XSLT or write SAX- or DOM-based code to manipulate the contents. You can find examples for the Intermediate Format processing in the <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/">http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/</a> directory in the FOP distribution.</p>
+<p>The second step is to reparse the file using the <strong>IFParser</strong> which is found in the org.apache.fop.render.intermediate package. The IFParser simply takes an IFDocumentHandler instance against which it generates the appropriate calls. The IFParser is implemented as a SAX ContentHandler so you're free to choose the method for post-processing the IF file(s). You can use XSLT or write SAX- or DOM-based code to manipulate the contents. You can find examples for the Intermediate Format processing in the <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/intermediate/">http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/intermediate/</a> directory in the FOP distribution.</p>
<p>The basic pattern to parse the intermediate format looks like this:</p>
<div class="codehilite"><pre><span class="n">FopFactory</span> <span class="n">fopFactory</span> <span class="o">=</span> <span class="n">FopFactory</span><span class="o">.</span><span class="na">newInstance</span><span class="o">(</span><span class="k">new</span> <span class="n">File</span><span class="o">(</span><span class="s">"."</span><span class="o">).</span><span class="na">toURI</span><span class="o">());</span>
@@ -593,7 +593,7 @@ h2:hover > .headerlink, h3:hover > .head
<p>This example simply reads an intermediate file and renders it to a PDF file. Here IFParser.parse() is used, but you can also just get a SAX ContentHandler by using the IFParser.getContentHandler() method.</p>
<h3 id="concat-if">Concatenating Documents<a class="headerlink" href="#concat-if" title="Permanent link">¶</a></h3>
-<p>This initial example is obviously not very useful. It would be faster to create the PDF file directly (without the intermediate step). As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/ExampleConcat.java">ExampleConcat.java</a> example shows you can easily parse multiple intermediate files in a row and use the IFConcatenator class to concatenate page sequences from multiple source files to a single output file. This particular example does the concatenation on the level of the IFDocumentHandler interface. You could also do this in XSLT or using SAX on the XML level. Whatever suits your process best.</p>
+<p>This initial example is obviously not very useful. It would be faster to create the PDF file directly (without the intermediate step). As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/fop/examples/embedding/java/embedding/intermediate/ExampleConcat.java">ExampleConcat.java</a> example shows you can easily parse multiple intermediate files in a row and use the IFConcatenator class to concatenate page sequences from multiple source files to a single output file. This particular example does the concatenation on the level of the IFDocumentHandler interface. You could also do this in XSLT or using SAX on the XML level. Whatever suits your process best.</p>
<h3 id="modifying-if">Modifying Documents<a class="headerlink" href="#modifying-if" title="Permanent link">¶</a></h3>
<p>One of the most important use cases for this format is obviously modifying the intermediate format before finally rendering it to the target format. You can easily use XSLT to process the IF file according to your needs.</p>
<p>There is an XML Schema (located under <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/documentation/intermediate-format-ng/">src/documentation/intermediate-format-ng</a>) that helps you verify that your modified content is correct.</p>
Modified: websites/staging/xmlgraphics/trunk/content/fop/trunk/upgrading.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/trunk/upgrading.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/trunk/upgrading.html Mon Jun 27 12:02:06 2016
@@ -579,7 +579,7 @@ ResourceResolverFactory (a factory class
<p>As stated above, empty table cells <code><fo:table-cell></fo:table-cell></code> are not allowed by the specification. The same applies to empty <code>fo:static-content</code> and <code>fo:block-container</code> elements, for example.</p>
</li>
<li>
-<p>Version 0.20.5 is not XSL-FO compliant with respect to sizing images (<code>external-graphic</code>) or <code>instream-foreign-object</code> objects. If images or SVGs are sized differently in your outputs with the new FOP version check <a href="https://issues.apache.org/jira/browse/FOP-1073">FOP-1073</a> as it contains some hints on what to do. The file <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/fo/basic/images.fo?view=markup">http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/fo/basic/images.fo?view=markup</a> has a number of good examples that show the correct behaviour.</p>
+<p>Version 0.20.5 is not XSL-FO compliant with respect to sizing images (<code>external-graphic</code>) or <code>instream-foreign-object</code> objects. If images or SVGs are sized differently in your outputs with the new FOP version check <a href="https://issues.apache.org/jira/browse/FOP-1073">FOP-1073</a> as it contains some hints on what to do. The file <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/fo/basic/images.fo?view=markup">http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/fop/examples/fo/basic/images.fo?view=markup</a> has a number of good examples that show the correct behaviour.</p>
</li>
<li>
<p>The <code>fox:outline</code> extension is not implemented in the current version: it has been superseded by the bookmark elements from XSL-FO 1.1.</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org