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 2012/12/04 16:59:44 UTC
svn commit: r840735 [14/19] - in
/websites/staging/xmlgraphics/trunk/content: ./ batik/ batik/dev/
batik/tools/ batik/using/ batik/using/scripting/ commons/ fop/ fop/0.95/
fop/1.0/ fop/1.1/ fop/trunk/
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.1/output.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.1/output.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.1/output.html Tue Dec 4 15:59:34 2012
@@ -341,11 +341,11 @@ $(document).ready(function () {
<div id="items">
</div>
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.1/">1.1</a></div> -->
- <div class="section-content"><h1 id="apachewzxhzdk41-fop-output-formats">Apache™ FOP Output Formats</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk42-fop-output-formats">Apache™ FOP Output Formats</h1>
<p><authors><person email="keiron@aftexsw.com" name="Keiron Liddle"></person><person email="" name="Art Welch"></person></authors></p>
<p>Apache™ FOP supports multiple output formats by using a different renderer for each format. The renderers do not all have the same set of capabilities, sometimes because of the output format itself, sometimes because some renderers get more development attention than others.</p>
-<h2 id="general-information-wzxhzdk49wzxhzdk50">General Information <a id="general"></a></h2>
-<h3 id="fonts-wzxhzdk51wzxhzdk52">Fonts <a id="general-fonts"></a></h3>
+<h2 id="general-information-wzxhzdk50wzxhzdk51">General Information <a id="general"></a></h2>
+<h3 id="fonts-wzxhzdk52wzxhzdk53">Fonts <a id="general-fonts"></a></h3>
<p>Most FOP renderers use a FOP-specific system for font registration. However, the Java2D/AWT and print renderers use the Java AWT package, which gets its font information from the operating system registration. This can result in several differences, including actually using different fonts, and having different font metrics for the same font. The net effect is that the layout of a given FO document can be quite different between renderers that do not use the same font information.</p>
<p>Theoretically, there's some potential to make the output of the PDF/PS renderers match the output of the Java2D-based renderers. If FOP used the font metrics from its own font subsystem but still used Java2D for text painting in the Java2D-based renderers, this could probably be achieved. However, this approach hasn't been implemented, yet.</p>
<p>With a work-around, it is possible to match the PDF/PS output in a Java2D-based renderer pretty closely. The clue is to use the <a href="intermediate.html">intermediate format</a> . The trick is to layout the document using FOP's own font subsystem but then render the document using Java2D. Here are the necessary steps (using the command-line):</p>
@@ -354,22 +354,22 @@ $(document).ready(function () {
<p>Produce an IF file: <code>fop -fo myfile.fo -at application/pdf myfile.at.xml</code> <br></br>Specifying "application/pdf" for the "-at" parameter causes FOP to use FOP's own font subsystem (which is used by the PDF renderer). Note that no PDF file is created in this step.</p>
</li>
<li>
-<p>Render to a PDF file: <code>fop -atin myfile.at.xml -pdf myfile.pdf</code> </p>
+<p>Render to a PDF file: <code>fop -atin myfile.at.xml -pdf myfile.pdf</code></p>
</li>
<li>
<p>Render to a Java2D-based renderer:</p>
</li>
<li>
-<p><code>fop -atin myfile.at.xml -print</code> </p>
+<p><code>fop -atin myfile.at.xml -print</code></p>
</li>
<li>
-<p><code>fop -atin myfile.at.xml -awt</code> </p>
+<p><code>fop -atin myfile.at.xml -awt</code></p>
</li>
<li>
-<p><code>fop -atin myfile.at.xml -tiff myfile.tiff</code> </p>
+<p><code>fop -atin myfile.at.xml -tiff myfile.tiff</code></p>
</li>
</ol>
-<h3 id="output-to-a-printer-or-other-device-wzxhzdk53wzxhzdk54">Output to a Printer or Other Device <a id="general-direct-output"></a></h3>
+<h3 id="output-to-a-printer-or-other-device-wzxhzdk54wzxhzdk55">Output to a Printer or Other Device <a id="general-direct-output"></a></h3>
<p>The most obvious way to print your document is to use the FOP <a href="#print">print renderer</a> , which uses the Java2D API (AWT). However, you can also send output from the Postscript renderer directly to a Postscript device, or output from the PCL renderer directly to a PCL device.</p>
<p>Here are Windows command-line examples for Postscript and PCL:
fop ... -ps \computername\printerfop ... -pcl \computername\printer
@@ -377,62 +377,62 @@ Here is some Java code to accomplish the
proc = Runtime.getRuntime().exec("lp -d" + print_queue + " -o -dp -");
out = proc.getOutputStream();
Set the output MIME type to "application/x-pcl" (MimeConstants.MIME_PCL) and it happily sends the PCL to the UNIX printer queue.</p>
-<h2 id="pdf-wzxhzdk55wzxhzdk56">PDF <a id="pdf"></a></h2>
+<h2 id="pdf-wzxhzdk56wzxhzdk57">PDF <a id="pdf"></a></h2>
<p>PDF is the best supported output format. It is also the most accurate with text and layout. This creates a PDF document that is streamed out as each page is rendered. This means that the internal page index information is stored near the end of the document. The PDF version supported is 1.4. PDF versions are forwards/backwards compatible.</p>
<p>Note that FOP does not currently support PDF/A-1a. Support for <a href="accessibility.html">Tagged PDF</a> , <a href="pdfa.html">PDF/A-1b</a> and <a href="pdfx.html">PDF/X</a> has recently been added, however.</p>
-<h3 id="fonts-wzxhzdk57wzxhzdk58">Fonts <a id="pdf-fonts"></a></h3>
-<p>PDF has a set of fonts that are always available to all PDF viewers; to quote from the PDF Specification: <em>"PDF prescribes a set of 14 standard fonts that can be used without prior definition. These include four faces each of three Latin text typefaces (Courier, Helvetica, and Times), as well as two symbolic fonts (Symbol and ITC Zapf Dingbats). These fonts, or suitable substitute fonts with the same metrics, are guaranteed to be available in all PDF viewer applications."</em> </p>
-<h3 id="post-processing-wzxhzdk59wzxhzdk60">Post-processing <a id="pdf-postprocess"></a></h3>
+<h3 id="fonts-wzxhzdk58wzxhzdk59">Fonts <a id="pdf-fonts"></a></h3>
+<p>PDF has a set of fonts that are always available to all PDF viewers; to quote from the PDF Specification: <em>"PDF prescribes a set of 14 standard fonts that can be used without prior definition. These include four faces each of three Latin text typefaces (Courier, Helvetica, and Times), as well as two symbolic fonts (Symbol and ITC Zapf Dingbats). These fonts, or suitable substitute fonts with the same metrics, are guaranteed to be available in all PDF viewer applications."</em></p>
+<h3 id="post-processing-wzxhzdk60wzxhzdk61">Post-processing <a id="pdf-postprocess"></a></h3>
<p>FOP does not currently support several desirable PDF features: watermarks and signatures. One workaround is to use Adobe Acrobat (the full version, not the Reader) to process the file manually or with scripting that it supports.</p>
<p>Another popular post-processing tool is <a href="http://www.lowagie.com/iText">iText</a> , which has tools for adding security features, document properties, watermarks, and many other features to PDF files.
<warning>Caveat: iText may swallow PDF bookmarks. But <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=37589">Jens Stavnstrup tells us</a> that this doesn't happen if you use iText's PDFStamper.</warning>
Here is some sample code that uses iText to encrypt a FOP-generated PDF. (Note that FOP now supports <a href="pdfencryption.html">PDF encryption</a> . However the principles for using iText for other PDF features are similar.)</p>
-<div class="codehilite"><pre><span class="n">public</span> <span class="n">static</span> <span class="n">void</span> <span class="n">main</span><span class="p">(</span><span class="n">String</span> <span class="n">args</span><span class="o">[]</span><span class="p">)</span> <span class="p">{</span>
- <span class="n">try</span> <span class="p">{</span>
- <span class="n">ByteArrayOutputStream</span> <span class="n">fopout</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ByteArrayOutputStream</span><span class="p">();</span>
- <span class="n">FileOutputStream</span> <span class="n">outfile</span> <span class="o">=</span> <span class="k">new</span> <span class="n">FileOutputStream</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">2</span><span class="p">]);</span>
- <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="n">newInstance</span><span class="p">();</span>
- <span class="n">Fop</span> <span class="n">fop</span> <span class="o">=</span> <span class="n">fopFactory</span><span class="o">.</span><span class="n">newFop</span><span class="p">(</span><span class="n">MimeConstants</span><span class="o">.</span><span class="n">MIME_PDF</span><span class="p">,</span> <span class="n">fopout</span><span class="p">);</span>
-
- <span class="n">Transformer</span> <span class="n">transformer</span> <span class="o">=</span> <span class="n">TransformerFactory</span><span class="o">.</span><span class="n">newInstance</span><span class="p">()</span><span class="o">.</span><span class="n">newTransformer</span><span class="p">(</span>
- <span class="k">new</span> <span class="n">StreamSource</span><span class="p">(</span><span class="k">new</span> <span class="n">File</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">])));</span>
- <span class="n">transformer</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span><span class="k">new</span> <span class="n">StreamSource</span><span class="p">(</span><span class="k">new</span> <span class="n">File</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">])),</span>
- <span class="k">new</span> <span class="n">SAXResult</span><span class="p">(</span><span class="n">fop</span><span class="o">.</span><span class="n">getDefaultHandler</span><span class="p">()));</span>
- <span class="n">PdfReader</span> <span class="n">reader</span> <span class="o">=</span> <span class="k">new</span> <span class="n">PdfReader</span><span class="p">(</span><span class="n">fopout</span><span class="o">.</span><span class="n">toByteArray</span><span class="p">());</span>
- <span class="nb">int</span> <span class="n">n</span> <span class="o">=</span> <span class="n">reader</span><span class="o">.</span><span class="n">getNumberOfPages</span><span class="p">();</span>
- <span class="n">Document</span> <span class="n">document</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Document</span><span class="p">(</span><span class="n">reader</span><span class="o">.</span><span class="n">getPageSizeWithRotation</span><span class="p">(</span><span class="mi">1</span><span class="p">));</span>
- <span class="n">PdfWriter</span> <span class="n">writer</span> <span class="o">=</span> <span class="n">PdfWriter</span><span class="o">.</span><span class="n">getInstance</span><span class="p">(</span><span class="n">document</span><span class="p">,</span> <span class="n">outfile</span><span class="p">);</span>
- <span class="n">writer</span><span class="o">.</span><span class="n">setEncryption</span><span class="p">(</span><span class="n">PdfWriter</span><span class="o">.</span><span class="n">STRENGTH40BITS</span><span class="p">,</span> <span class="s">"pdf"</span><span class="p">,</span> <span class="n">null</span><span class="p">,</span>
- <span class="n">PdfWriter</span><span class="o">.</span><span class="n">AllowCopy</span><span class="p">);</span>
- <span class="n">document</span><span class="o">.</span><span class="nb">open</span><span class="p">();</span>
- <span class="n">PdfContentByte</span> <span class="n">cb</span> <span class="o">=</span> <span class="n">writer</span><span class="o">.</span><span class="n">getDirectContent</span><span class="p">();</span>
- <span class="n">PdfImportedPage</span> <span class="n">page</span><span class="p">;</span>
- <span class="nb">int</span> <span class="n">rotation</span><span class="p">;</span>
- <span class="nb">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
- <span class="k">while</span> <span class="p">(</span><span class="n">i</span> <span class="o"><</span> <span class="n">n</span><span class="p">)</span> <span class="p">{</span>
- <span class="n">i</span><span class="o">++</span><span class="p">;</span>
- <span class="n">document</span><span class="o">.</span><span class="n">setPageSize</span><span class="p">(</span><span class="n">reader</span><span class="o">.</span><span class="n">getPageSizeWithRotation</span><span class="p">(</span><span class="n">i</span><span class="p">));</span>
- <span class="n">document</span><span class="o">.</span><span class="n">newPage</span><span class="p">();</span>
- <span class="n">page</span> <span class="o">=</span> <span class="n">writer</span><span class="o">.</span><span class="n">getImportedPage</span><span class="p">(</span><span class="n">reader</span><span class="p">,</span> <span class="n">i</span><span class="p">);</span>
- <span class="n">rotation</span> <span class="o">=</span> <span class="n">reader</span><span class="o">.</span><span class="n">getPageRotation</span><span class="p">(</span><span class="n">i</span><span class="p">);</span>
- <span class="k">if</span> <span class="p">(</span><span class="n">rotation</span> <span class="o">==</span> <span class="mi">90</span> <span class="o">||</span> <span class="n">rotation</span> <span class="o">==</span> <span class="mi">270</span><span class="p">)</span> <span class="p">{</span>
- <span class="n">cb</span><span class="o">.</span><span class="n">addTemplate</span><span class="p">(</span><span class="n">page</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="n">f</span><span class="p">,</span> <span class="mi">1</span><span class="n">f</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span>
- <span class="n">reader</span><span class="o">.</span><span class="n">getPageSizeWithRotation</span><span class="p">(</span><span class="n">i</span><span class="p">)</span><span class="o">.</span><span class="n">height</span><span class="p">());</span>
- <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
- <span class="n">cb</span><span class="o">.</span><span class="n">addTemplate</span><span class="p">(</span><span class="n">page</span><span class="p">,</span> <span class="mi">1</span><span class="n">f</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="n">f</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
- <span class="p">}</span>
- <span class="n">System</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">println</span><span class="p">(</span><span class="s">"Processed page "</span> <span class="o">+</span> <span class="n">i</span><span class="p">);</span>
- <span class="p">}</span>
- <span class="n">document</span><span class="o">.</span><span class="nb">close</span><span class="p">();</span>
- <span class="p">}</span> <span class="n">catch</span><span class="p">(</span> <span class="n">Exception</span> <span class="n">e</span><span class="p">)</span> <span class="p">{</span>
- <span class="n">e</span><span class="o">.</span><span class="n">printStackTrace</span><span class="p">();</span>
- <span class="p">}</span>
-<span class="p">}</span>
+<div class="codehilite"><pre><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span> <span class="n">args</span><span class="o">[])</span> <span class="o">{</span>
+ <span class="k">try</span> <span class="o">{</span>
+ <span class="n">ByteArrayOutputStream</span> <span class="n">fopout</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ByteArrayOutputStream</span><span class="o">();</span>
+ <span class="n">FileOutputStream</span> <span class="n">outfile</span> <span class="o">=</span> <span class="k">new</span> <span class="n">FileOutputStream</span><span class="o">(</span><span class="n">args</span><span class="o">[</span><span class="mi">2</span><span class="o">]);</span>
+ <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="n">Fop</span> <span class="n">fop</span> <span class="o">=</span> <span class="n">fopFactory</span><span class="o">.</span><span class="na">newFop</span><span class="o">(</span><span class="n">MimeConstants</span><span class="o">.</span><span class="na">MIME_PDF</span><span class="o">,</span> <span class="n">fopout</span><span class="o">);</span>
+
+ <span class="n">Transformer</span> <span class="n">transformer</span> <span class="o">=</span> <span class="n">TransformerFactory</span><span class="o">.</span><span class="na">newInstance</span><span class="o">().</span><span class="na">newTransformer</span><span class="o">(</span>
+ <span class="k">new</span> <span class="nf">StreamSource</span><span class="o">(</span><span class="k">new</span> <span class="n">File</span><span class="o">(</span><span class="n">args</span><span class="o">[</span><span class="mi">1</span><span class="o">])));</span>
+ <span class="n">transformer</span><span class="o">.</span><span class="na">transform</span><span class="o">(</span><span class="k">new</span> <span class="n">StreamSource</span><span class="o">(</span><span class="k">new</span> <span class="n">File</span><span class="o">(</span><span class="n">args</span><span class="o">[</span><span class="mi">0</span><span class="o">])),</span>
+ <span class="k">new</span> <span class="nf">SAXResult</span><span class="o">(</span><span class="n">fop</span><span class="o">.</span><span class="na">getDefaultHandler</span><span class="o">()));</span>
+ <span class="n">PdfReader</span> <span class="n">reader</span> <span class="o">=</span> <span class="k">new</span> <span class="n">PdfReader</span><span class="o">(</span><span class="n">fopout</span><span class="o">.</span><span class="na">toByteArray</span><span class="o">());</span>
+ <span class="kt">int</span> <span class="n">n</span> <span class="o">=</span> <span class="n">reader</span><span class="o">.</span><span class="na">getNumberOfPages</span><span class="o">();</span>
+ <span class="n">Document</span> <span class="n">document</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Document</span><span class="o">(</span><span class="n">reader</span><span class="o">.</span><span class="na">getPageSizeWithRotation</span><span class="o">(</span><span class="mi">1</span><span class="o">));</span>
+ <span class="n">PdfWriter</span> <span class="n">writer</span> <span class="o">=</span> <span class="n">PdfWriter</span><span class="o">.</span><span class="na">getInstance</span><span class="o">(</span><span class="n">document</span><span class="o">,</span> <span class="n">outfile</span><span class="o">);</span>
+ <span class="n">writer</span><span class="o">.</span><span class="na">setEncryption</span><span class="o">(</span><span class="n">PdfWriter</span><span class="o">.</span><span class="na">STRENGTH40BITS</span><span class="o">,</span> <span class="s">"pdf"</span><span class="o">,</span> <span class="kc">null</span><span class="o">,</span>
+ <span class="n">PdfWriter</span><span class="o">.</span><span class="na">AllowCopy</span><span class="o">);</span>
+ <span class="n">document</span><span class="o">.</span><span class="na">open</span><span class="o">();</span>
+ <span class="n">PdfContentByte</span> <span class="n">cb</span> <span class="o">=</span> <span class="n">writer</span><span class="o">.</span><span class="na">getDirectContent</span><span class="o">();</span>
+ <span class="n">PdfImportedPage</span> <span class="n">page</span><span class="o">;</span>
+ <span class="kt">int</span> <span class="n">rotation</span><span class="o">;</span>
+ <span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span>
+ <span class="k">while</span> <span class="o">(</span><span class="n">i</span> <span class="o"><</span> <span class="n">n</span><span class="o">)</span> <span class="o">{</span>
+ <span class="n">i</span><span class="o">++;</span>
+ <span class="n">document</span><span class="o">.</span><span class="na">setPageSize</span><span class="o">(</span><span class="n">reader</span><span class="o">.</span><span class="na">getPageSizeWithRotation</span><span class="o">(</span><span class="n">i</span><span class="o">));</span>
+ <span class="n">document</span><span class="o">.</span><span class="na">newPage</span><span class="o">();</span>
+ <span class="n">page</span> <span class="o">=</span> <span class="n">writer</span><span class="o">.</span><span class="na">getImportedPage</span><span class="o">(</span><span class="n">reader</span><span class="o">,</span> <span class="n">i</span><span class="o">);</span>
+ <span class="n">rotation</span> <span class="o">=</span> <span class="n">reader</span><span class="o">.</span><span class="na">getPageRotation</span><span class="o">(</span><span class="n">i</span><span class="o">);</span>
+ <span class="k">if</span> <span class="o">(</span><span class="n">rotation</span> <span class="o">==</span> <span class="mi">90</span> <span class="o">||</span> <span class="n">rotation</span> <span class="o">==</span> <span class="mi">270</span><span class="o">)</span> <span class="o">{</span>
+ <span class="n">cb</span><span class="o">.</span><span class="na">addTemplate</span><span class="o">(</span><span class="n">page</span><span class="o">,</span> <span class="mi">0</span><span class="o">,</span> <span class="o">-</span><span class="mi">1</span><span class="n">f</span><span class="o">,</span> <span class="mi">1</span><span class="n">f</span><span class="o">,</span> <span class="mi">0</span><span class="o">,</span> <span class="mi">0</span><span class="o">,</span>
+ <span class="n">reader</span><span class="o">.</span><span class="na">getPageSizeWithRotation</span><span class="o">(</span><span class="n">i</span><span class="o">).</span><span class="na">height</span><span class="o">());</span>
+ <span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
+ <span class="n">cb</span><span class="o">.</span><span class="na">addTemplate</span><span class="o">(</span><span class="n">page</span><span class="o">,</span> <span class="mi">1</span><span class="n">f</span><span class="o">,</span> <span class="mi">0</span><span class="o">,</span> <span class="mi">0</span><span class="o">,</span> <span class="mi">1</span><span class="n">f</span><span class="o">,</span> <span class="mi">0</span><span class="o">,</span> <span class="mi">0</span><span class="o">);</span>
+ <span class="o">}</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Processed page "</span> <span class="o">+</span> <span class="n">i</span><span class="o">);</span>
+ <span class="o">}</span>
+ <span class="n">document</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
+ <span class="o">}</span> <span class="k">catch</span><span class="o">(</span> <span class="n">Exception</span> <span class="n">e</span><span class="o">)</span> <span class="o">{</span>
+ <span class="n">e</span><span class="o">.</span><span class="na">printStackTrace</span><span class="o">();</span>
+ <span class="o">}</span>
+<span class="o">}</span>
</pre></div>
<p>Check the iText tutorial and documentation for setting access flags, password, encryption strength and other parameters.</p>
-<h3 id="watermarks-wzxhzdk63wzxhzdk64">Watermarks <a id="pdf-watermark"></a></h3>
+<h3 id="watermarks-wzxhzdk64wzxhzdk65">Watermarks <a id="pdf-watermark"></a></h3>
<p>In addition to the <a href="#pdf-postprocess">PDF Post-processing</a> options, consider the following workarounds:</p>
<ul>
<li>
@@ -442,19 +442,22 @@ Here is some sample code that uses iText
<p>(submitted by Trevor Campbell) Place an image in a region that overlaps the flowing text. For example, make region-before large enough to contain your image. Then include a block (if necessary, use an absolutely positioned block-container) containing the watermark image in the static-content for the region-before. Note that the image will be drawn on top of the normal content.</p>
</li>
</ul>
-<h3 id="extensions-wzxhzdk65wzxhzdk66">Extensions <a id="pdf-extensions"></a></h3>
+<h3 id="extensions-wzxhzdk66wzxhzdk67">Extensions <a id="pdf-extensions"></a></h3>
<p>The PDF Renderer supports some PDF specific extensions which can be embedded into the input FO document. To use the extensions the appropriate namespace must be declared in the fo:root element like this:</p>
-<div class="codehilite"><pre><span class="o"><</span><span class="n">fo:root</span> <span class="n">xmlns:fo</span><span class="o">=</span><span class="s">"http://www.w3.org/1999/XSL/Format"</span>
- <span class="n">xmlns:pdf</span><span class="o">=</span><span class="s">"http://xmlgraphics.apache.org/fop/extensions/pdf"</span><span class="o">></span>
+<div class="codehilite"><pre><span class="nt"><fo:root</span> <span class="na">xmlns:fo=</span><span class="s">"http://www.w3.org/1999/XSL/Format"</span>
+ <span class="na">xmlns:pdf=</span><span class="s">"http://xmlgraphics.apache.org/fop/extensions/pdf"</span><span class="nt">></span>
</pre></div>
-<h4 id="embedded-fileswzxhzdk67wzxhzdk68">Embedded Files<a id="pdf-embedded-file"></a></h4>
+<h4 id="embedded-fileswzxhzdk68wzxhzdk69">Embedded Files<a id="pdf-embedded-file"></a></h4>
<p>It is possible to attach/embed arbitrary files into a PDF file. You can give a name and a description of the file. Example:</p>
-<p><fo:declarations>
- <pdf:embedded-file filename="image.jpg" src="url(file:///C:/Temp/myimage.jpg)" description="My image"/>
- <pdf:embedded-file src="url(file:///C:/Temp/MyTextDoc.odt)"/>
- </fo:declarations></p>
+<div class="codehilite"><pre><span class="nt"><fo:declarations></span>
+ <span class="nt"><pdf:embedded-file</span> <span class="na">filename=</span><span class="s">"image.jpg"</span> <span class="na">src=</span><span class="s">"url(file:///C:/Temp/myimage.jpg)"</span> <span class="na">description=</span><span class="s">"My image"</span><span class="nt">/></span>
+ <span class="nt"><pdf:embedded-file</span> <span class="na">src=</span><span class="s">"url(file:///C:/Temp/MyTextDoc.odt)"</span><span class="nt">/></span>
+<span class="nt"></fo:declarations></span>
+</pre></div>
+
+
<p><code>pdf:embedded-file</code> must be a child of <code>fo:declarations</code> . The "src" property is used to reference the file that is to be embedded. This property uses the "uri-specification" datatype from the XSL-FO specification. The "filename" property is optional. If it is missing the filename is automatically set from the URI/IRI of the "src" property. An optional description can also be added to further describe the file attachment.</p>
<p>It is also possible to reference an embedded file from an <code>fo:basic-link</code> . Use the special "embedded-file:" URI scheme with the filename as single argument after the URI scheme. Example:</p>
<div class="codehilite"><pre><span class="nt"><fo:basic-link</span> <span class="na">external-destination=</span><span class="s">"url(embedded-file:image.jpg)"</span><span class="nt">></span>Attached Image<span class="nt"></fo:basic-link></span>
@@ -462,9 +465,9 @@ Here is some sample code that uses iText
<p>Note: Not all PDF Viewers (including some Acrobat Versions) will open the embedded file when clicking on the link. In that case, the user will have to open he attachment via the separate list of file attachments.</p>
-<h2 id="postscript-wzxhzdk73wzxhzdk74">PostScript <a id="ps"></a></h2>
+<h2 id="postscript-wzxhzdk70wzxhzdk71">PostScript <a id="ps"></a></h2>
<p>The PostScript renderer has been brought up to a similar quality as the PDF renderer, but may still be missing certain features. It provides good support for most text and layout. Images and SVG are not fully supported, yet. Currently, the PostScript renderer generates PostScript Level 3 with most DSC comments. Actually, the only Level 3 features used are the FlateDecode and DCTDecode filter (the latter is used for 1:1 embedding of JPEG images), everything else is Level 2.</p>
-<h3 id="configuration-wzxhzdk75wzxhzdk76">Configuration <a id="ps-configuration"></a></h3>
+<h3 id="configuration-wzxhzdk72wzxhzdk73">Configuration <a id="ps-configuration"></a></h3>
<p>The PostScript renderer configuration currently allows the following settings:</p>
<div class="codehilite"><pre><span class="nt"><renderer</span> <span class="na">mime=</span><span class="s">"application/postscript"</span><span class="nt">></span>
<span class="nt"><auto-rotate-landscape></span>false<span class="nt"></auto-rotate-landscape></span>
@@ -483,7 +486,7 @@ Here is some sample code that uses iText
<p>The default value for the "safe-set-page-device" setting is "false". Setting it to "true" will cause the renderer to invoke a postscript macro which guards against the possibility of invalid/unsupported postscript key/values being issued to the implementing postscript page device.</p>
<p>The default value for the "dsc-compliant" setting is "true". Setting it to "false" will break DSC compliance by minimizing the number of setpagedevice calls in the postscript document output. This feature may be useful when unwanted blank pages are experienced in your postscript output. This problem is caused by the particular postscript implementation issuing unwanted postscript subsystem initgraphics/erasepage calls on each setpagedevice call.</p>
<p>The default value for the "rendering" setting is "quality". Setting it to "size" optimizes rendering for smaller file sizes which can involve minor compromises in rendering quality. For example, solid borders are then painted as plain rectangles instead of the elaborate painting instructions required for mixed-color borders.</p>
-<h3 id="limitations-wzxhzdk77wzxhzdk78">Limitations <a id="ps-limitations"></a></h3>
+<h3 id="limitations-wzxhzdk74wzxhzdk75">Limitations <a id="ps-limitations"></a></h3>
<ul>
<li>
<p>Images and SVG may not be displayed correctly. SVG support is far from being complete. No image transparency is available.</p>
@@ -498,19 +501,19 @@ Here is some sample code that uses iText
<p>PPD support is still missing.</p>
</li>
</ul>
-<h2 id="pcl-wzxhzdk79wzxhzdk80">PCL <a id="pcl"></a></h2>
+<h2 id="pcl-wzxhzdk76wzxhzdk77">PCL <a id="pcl"></a></h2>
<p>This format is for the Hewlett-Packard PCL printers and other printers supporting PCL. It should produce output as close to identical as possible to the printed output of the PDFRenderer within the limitations of the renderer, and output device.</p>
<p>The output created by the PCLRenderer is generic PCL 5, HP GL/2 and PJL. This should allow any device fully supporting PCL 5 to be able to print the output generated by the PCLRenderer. PJL is used to control the print job and switch to the PCL language. PCL 5 is used for text, raster graphics and rectangular fill graphics. HP GL/2 is used for more complex painting operations. Certain painting operations are done off-screen and rendered to PCL as bitmaps because of limitations in PCL 5.</p>
-<h3 id="references-wzxhzdk81wzxhzdk82">References <a id="pcl-references"></a></h3>
+<h3 id="references-wzxhzdk78wzxhzdk79">References <a id="pcl-references"></a></h3>
<ul>
<li>
-<p><a href="http://en.wikipedia.org/wiki/Printer_Control_Language">WikiPedia entry on PCL</a> </p>
+<p><a href="http://en.wikipedia.org/wiki/Printer_Control_Language">WikiPedia entry on PCL</a></p>
</li>
<li>
-<p><a href="http://h20000.www2.hp.com/bizsupport/TechSupport/Document.jsp?objectID=bpl04568">Technical reference documents on PCL from Hewlett-Packard</a> </p>
+<p><a href="http://h20000.www2.hp.com/bizsupport/TechSupport/Document.jsp?objectID=bpl04568">Technical reference documents on PCL from Hewlett-Packard</a></p>
</li>
</ul>
-<h3 id="limitations-wzxhzdk83wzxhzdk84">Limitations <a id="pcl-limitations"></a></h3>
+<h3 id="limitations-wzxhzdk80wzxhzdk81">Limitations <a id="pcl-limitations"></a></h3>
<ul>
<li>
<p>Text or graphics outside the left or top of the printable area are not rendered properly. This is a limitation of PCL, not FOP. In general, things that should print to the left of the printable area are shifted to the right so that they start at the left edge of the printable area.</p>
@@ -537,7 +540,7 @@ Here is some sample code that uses iText
<p>Currently, there's no support for clipping and image transparency, largely because PCL 5 has certain limitations.</p>
</li>
</ul>
-<h3 id="configuration-wzxhzdk85wzxhzdk86">Configuration <a id="pcl-configuration"></a></h3>
+<h3 id="configuration-wzxhzdk82wzxhzdk83">Configuration <a id="pcl-configuration"></a></h3>
<p>The PCL renderer configuration currently allows the following settings:</p>
<div class="codehilite"><pre><span class="nt"><renderer</span> <span class="na">mime=</span><span class="s">"application/x-pcl"</span><span class="nt">></span>
<span class="nt"><rendering></span>quality<span class="nt"></rendering></span>
@@ -551,47 +554,47 @@ Here is some sample code that uses iText
<p>The default value for the "text-rendering" setting is "auto" which paints the base fonts using PCL fonts. Non-base fonts are painted as bitmaps through Java2D. If the mix of painting methods results in unwelcome output, you can set this to "bitmap" which causes all text to be rendered as bitmaps.</p>
<p>The default value for the "disable-pjl" setting is "false". This means that the PCL renderer usually generates PJL commands before and after the document in order to switch a printer into PCL language. PJL commands can be disabled if you set this value to "true".</p>
<p>You can control the output resolution for the PCL using the "target resolution" setting on the FOUserAgent. The actual value will be rounded up to the next supported PCL resolution. Currently, only 300 and 600 dpi are supported which should be enough for most use cases. Note that this setting directly affects the size of the output file and the print quality.</p>
-<h3 id="extensions-wzxhzdk87wzxhzdk88">Extensions <a id="pcl-extensions"></a></h3>
+<h3 id="extensions-wzxhzdk84wzxhzdk85">Extensions <a id="pcl-extensions"></a></h3>
<p>The PCL Renderer supports some PCL specific extensions which can be embedded into the input FO document. To use the extensions the appropriate namespace must be declared in the fo:root element like this:</p>
-<div class="codehilite"><pre> <span class="o"><</span><span class="n">fo:root</span> <span class="n">xmlns:fo</span><span class="o">=</span><span class="s">"http://www.w3.org/1999/XSL/Format"</span>
- <span class="n">xmlns:pcl</span><span class="o">=</span><span class="s">"http://xmlgraphics.apache.org/fop/extensions/pcl"</span><span class="o">></span>
+<div class="codehilite"><pre><span class="nt"><fo:root</span> <span class="na">xmlns:fo=</span><span class="s">"http://www.w3.org/1999/XSL/Format"</span>
+ <span class="na">xmlns:pcl=</span><span class="s">"http://xmlgraphics.apache.org/fop/extensions/pcl"</span><span class="nt">></span>
</pre></div>
-<h4 id="page-source-tray-selectionwzxhzdk89wzxhzdk90">Page Source (Tray selection)<a id="pcl-page-source"></a></h4>
+<h4 id="page-source-tray-selectionwzxhzdk86wzxhzdk87">Page Source (Tray selection)<a id="pcl-page-source"></a></h4>
<p>The page-source extension attribute on fo:simple-page-master allows to select the paper tray the sheet for a particular simple-page-master is to be taken from. Example:</p>
-<div class="codehilite"><pre> <span class="nt"><fo:layout-master-set></span>
- <span class="nt"><fo:simple-page-master</span> <span class="na">master-name=</span><span class="s">"simple"</span> <span class="na">pcl:paper-source=</span><span class="s">"2"</span><span class="nt">></span>
- ...
- <span class="nt"></fo:simple-page-master></span>
- <span class="nt"></fo:layout-master-set></span>
+<div class="codehilite"><pre><span class="nt"><fo:layout-master-set></span>
+ <span class="nt"><fo:simple-page-master</span> <span class="na">master-name=</span><span class="s">"simple"</span> <span class="na">pcl:paper-source=</span><span class="s">"2"</span><span class="nt">></span>
+ ...
+ <span class="nt"></fo:simple-page-master></span>
+<span class="nt"></fo:layout-master-set></span>
</pre></div>
<p>Note: the tray number is a positive integer and the value depends on the target printer. Not all PCL printers support the same paper trays. Usually, "1" is the default tray, "2" is the manual paper feed, "3" is the manual envelope feed, "4" is the "lower" tray and "7" is "auto-select". Consult the technical reference for your printer for all available values.</p>
-<h4 id="output-binwzxhzdk91wzxhzdk92">Output Bin<a id="pcl-output-bin"></a></h4>
+<h4 id="output-binwzxhzdk88wzxhzdk89">Output Bin<a id="pcl-output-bin"></a></h4>
<p>The <code>output-bin</code> extension attribute on fo:simple-page-master allows to select the output bin into which the printed output should be fed. Example:</p>
-<div class="codehilite"><pre> <span class="nt"><fo:layout-master-set></span>
- <span class="nt"><fo:simple-page-master</span> <span class="na">master-name=</span><span class="s">"simple"</span> <span class="na">pcl:output-bin=</span><span class="s">"2"</span><span class="nt">></span>
- ...
- <span class="nt"></fo:simple-page-master></span>
- <span class="nt"></fo:layout-master-set></span>
+<div class="codehilite"><pre><span class="nt"><fo:layout-master-set></span>
+ <span class="nt"><fo:simple-page-master</span> <span class="na">master-name=</span><span class="s">"simple"</span> <span class="na">pcl:output-bin=</span><span class="s">"2"</span><span class="nt">></span>
+ ...
+ <span class="nt"></fo:simple-page-master></span>
+<span class="nt"></fo:layout-master-set></span>
</pre></div>
<p>Note: the output bin number is a positive integer and the value depends on the target printer. Not all PCL printers support the same output bins. Usually, "1" is the upper output bin, "2" is the lower (rear) output bin. Consult the technical reference for your printer for all available values.</p>
-<h4 id="page-duplex-modewzxhzdk93wzxhzdk94">Page Duplex Mode<a id="pcl-duplex-mode"></a></h4>
+<h4 id="page-duplex-modewzxhzdk90wzxhzdk91">Page Duplex Mode<a id="pcl-duplex-mode"></a></h4>
<p>The duplex-mode extension attribute on fo:simple-page-master allows to select the duplex mode to be used for a particular simple-page-master. Example:</p>
-<div class="codehilite"><pre> <span class="nt"><fo:layout-master-set></span>
- <span class="nt"><fo:simple-page-master</span> <span class="na">master-name=</span><span class="s">"simple"</span> <span class="na">pcl:duplex-mode=</span><span class="s">"0"</span><span class="nt">></span>
- ...
- <span class="nt"></fo:simple-page-master></span>
- <span class="nt"></fo:layout-master-set></span>
+<div class="codehilite"><pre><span class="nt"><fo:layout-master-set></span>
+ <span class="nt"><fo:simple-page-master</span> <span class="na">master-name=</span><span class="s">"simple"</span> <span class="na">pcl:duplex-mode=</span><span class="s">"0"</span><span class="nt">></span>
+ ...
+ <span class="nt"></fo:simple-page-master></span>
+<span class="nt"></fo:layout-master-set></span>
</pre></div>
<p>Note: the duplex is a positive integer and the value depends on the target printer. Not all PCL printers support duplexing. Usually, "0" is simplex, "1" is duplex (long-edge binding), "2" is duplex (short-edge binding). Consult the technical reference for your printer for all available values.</p>
-<h2 id="afp-wzxhzdk95wzxhzdk96">AFP <a id="afp"></a></h2>
+<h2 id="afp-wzxhzdk92wzxhzdk93">AFP <a id="afp"></a></h2>
<p>The FOP AFP Renderer deals with creating documents conforming to the IBM AFP document architecture also refered to as MO:DCA (Mixed Object Document Content Architecture).</p>
<p>The mapping of XSL-FO elements to the major MO:DCA structures is as follows:</p>
<table>
@@ -617,19 +620,19 @@ Here is some sample code that uses iText
</tbody>
</table>
<p>FOP creates exactly one Document per Printfile with an optional Resource Group at the beginning. FOP does not create document indices.</p>
-<h3 id="references-wzxhzdk97wzxhzdk98">References <a id="afp-references"></a></h3>
+<h3 id="references-wzxhzdk94wzxhzdk95">References <a id="afp-references"></a></h3>
<ul>
<li>
-<p><a href="http://en.wikipedia.org/wiki/Advanced_Function_Presentation">AFP (Advanced Function Presentation)</a> </p>
+<p><a href="http://en.wikipedia.org/wiki/Advanced_Function_Presentation">AFP (Advanced Function Presentation)</a></p>
</li>
<li>
-<p><a href="http://wiki.apache.org/xmlgraphics-fop/AFPResources">AFP Resources on the FOP WIKI</a> </p>
+<p><a href="http://wiki.apache.org/xmlgraphics-fop/AFPResources">AFP Resources on the FOP WIKI</a></p>
</li>
<li>
-<p><a href="http://wiki.apache.org/xmlgraphics-fop/AFPOutput">Technical notes on AFP output in FOP</a> </p>
+<p><a href="http://wiki.apache.org/xmlgraphics-fop/AFPOutput">Technical notes on AFP output in FOP</a></p>
</li>
</ul>
-<h3 id="limitations-wzxhzdk99wzxhzdk100">Limitations <a id="afp-limitations"></a></h3>
+<h3 id="limitations-wzxhzdk96wzxhzdk97">Limitations <a id="afp-limitations"></a></h3>
<p>This list is most likely badly incomplete.</p>
<ul>
<li>
@@ -639,10 +642,10 @@ Here is some sample code that uses iText
<p>Only IBM outline and raster fonts and to a limited extend the original fonts built into FOP are supported. Support for TrueType fonts may be added later.</p>
</li>
</ul>
-<h3 id="deployment-in-older-environments-wzxhzdk101wzxhzdk102">Deployment in older environments <a id="afp-compatibility"></a></h3>
+<h3 id="deployment-in-older-environments-wzxhzdk98wzxhzdk99">Deployment in older environments <a id="afp-compatibility"></a></h3>
<p>There are still a big number of older (or limited) MO:DCA/IPDS environments in production out there. AFP has grown in functionality over time and not every environment supports the latest features. We're trying to make AFP output work in as many environments as possible. However, to make AFP output work on older environments it is recommended to set to configuration to 1 bit per pixel (see below on how to do this). In this case, all images are converted to bi-level images using IOCA function set 10 (FS10) and are enclosed in page-segments since some implementation cannot deal with IOCA objects directly. If a higher number of bits per pixel is configured, FOP has to switch to at least FS11 which may not work everywhere.</p>
-<h3 id="configuration-wzxhzdk103wzxhzdk104">Configuration <a id="afp-configuration"></a></h3>
-<h4 id="fontswzxhzdk105wzxhzdk106">Fonts<a id="afp-font-config"></a></h4>
+<h3 id="configuration-wzxhzdk100wzxhzdk101">Configuration <a id="afp-configuration"></a></h3>
+<h4 id="fontswzxhzdk102wzxhzdk103">Fonts<a id="afp-font-config"></a></h4>
<p>The AFP Renderer requires special configuration particularly related to fonts. AFP Render configuration is done through the normal FOP configuration file. The MIME type for the AFP Renderer is application/x-afp which means the AFP Renderer section in the FOP configuration file looks like:</p>
<div class="codehilite"><pre><span class="nt"><renderer</span> <span class="na">mime=</span><span class="s">"application/x-afp"</span><span class="nt">></span>
<span class="c"><!-- AFP Renderer --></span>
@@ -667,42 +670,42 @@ Here is some sample code that uses iText
</li>
</ol>
<p>A typical raster font configuration looks like:</p>
-<div class="codehilite"><pre><span class="o"><!--</span> <span class="n">This</span> <span class="n">is</span> <span class="n">an</span> <span class="n">example</span> <span class="n">of</span> <span class="n">mapping</span> <span class="n">actual</span> <span class="n">IBM</span> <span class="n">raster</span> <span class="n">fonts</span> <span class="o">/</span> <span class="n">code</span> <span class="n">pages</span> <span class="n">to</span> <span class="n">a</span> <span class="n">FOP</span> <span class="n">font</span> <span class="o">--></span>
- <span class="sr"><font></span>
- <span class="o"><!--</span> <span class="n">The</span> <span class="n">afp</span><span class="o">-</span><span class="n">font</span> <span class="n">element</span> <span class="n">defines</span> <span class="n">the</span> <span class="n">IBM</span> <span class="n">code</span> <span class="n">page</span><span class="p">,</span> <span class="n">the</span> <span class="n">matching</span> <span class="n">Java</span> <span class="n">encoding</span> <span class="ow">and</span> <span class="n">the</span>
- <span class="n">base</span> <span class="n">URI</span> <span class="k">for</span> <span class="n">the</span> <span class="n">font</span> <span class="o">--></span>
- <span class="o"><</span><span class="n">afp</span><span class="o">-</span><span class="n">font</span> <span class="n">type</span><span class="o">=</span><span class="s">"raster"</span> <span class="n">codepage</span><span class="o">=</span><span class="s">"T1V10500"</span> <span class="n">encoding</span><span class="o">=</span><span class="s">"Cp500"</span> <span class="n">base</span><span class="o">-</span><span class="n">uri</span><span class="o">=</span><span class="s">"fonts/ibm/"</span><span class="o">></span>
- <span class="o"><!--</span> <span class="n">For</span> <span class="n">a</span> <span class="n">raster</span> <span class="n">font</span> <span class="n">a</span> <span class="n">separate</span> <span class="n">element</span> <span class="k">for</span> <span class="nb">each</span> <span class="n">font</span> <span class="n">size</span> <span class="n">is</span> <span class="n">required</span> <span class="n">providing</span>
- <span class="n">the</span> <span class="n">font</span> <span class="n">size</span> <span class="ow">and</span> <span class="n">the</span> <span class="n">corresponding</span> <span class="n">IBM</span> <span class="n">Character</span> <span class="n">set</span> <span class="n">name</span> <span class="o">--></span>
- <span class="o"><</span><span class="n">afp</span><span class="o">-</span><span class="n">raster</span><span class="o">-</span><span class="n">font</span> <span class="n">size</span><span class="o">=</span><span class="s">"7"</span> <span class="n">characterset</span><span class="o">=</span><span class="s">"C0N20070"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">afp</span><span class="o">-</span><span class="n">raster</span><span class="o">-</span><span class="n">font</span> <span class="n">size</span><span class="o">=</span><span class="s">"8"</span> <span class="n">characterset</span><span class="o">=</span><span class="s">"C0N20080"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">afp</span><span class="o">-</span><span class="n">raster</span><span class="o">-</span><span class="n">font</span> <span class="n">size</span><span class="o">=</span><span class="s">"10"</span> <span class="n">characterset</span><span class="o">=</span><span class="s">"C0N20000"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">afp</span><span class="o">-</span><span class="n">raster</span><span class="o">-</span><span class="n">font</span> <span class="n">size</span><span class="o">=</span><span class="s">"11"</span> <span class="n">characterset</span><span class="o">=</span><span class="s">"C0N200A0"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">afp</span><span class="o">-</span><span class="n">raster</span><span class="o">-</span><span class="n">font</span> <span class="n">size</span><span class="o">=</span><span class="s">"12"</span> <span class="n">characterset</span><span class="o">=</span><span class="s">"C0N200B0"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">afp</span><span class="o">-</span><span class="n">raster</span><span class="o">-</span><span class="n">font</span> <span class="n">size</span><span class="o">=</span><span class="s">"14"</span> <span class="n">characterset</span><span class="o">=</span><span class="s">"C0N200D0"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">afp</span><span class="o">-</span><span class="n">raster</span><span class="o">-</span><span class="n">font</span> <span class="n">size</span><span class="o">=</span><span class="s">"16"</span> <span class="n">characterset</span><span class="o">=</span><span class="s">"C0N200F0"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">afp</span><span class="o">-</span><span class="n">raster</span><span class="o">-</span><span class="n">font</span> <span class="n">size</span><span class="o">=</span><span class="s">"18"</span> <span class="n">characterset</span><span class="o">=</span><span class="s">"C0N200H0"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">afp</span><span class="o">-</span><span class="n">raster</span><span class="o">-</span><span class="n">font</span> <span class="n">size</span><span class="o">=</span><span class="s">"20"</span> <span class="n">characterset</span><span class="o">=</span><span class="s">"C0N200J0"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">afp</span><span class="o">-</span><span class="n">raster</span><span class="o">-</span><span class="n">font</span> <span class="n">size</span><span class="o">=</span><span class="s">"24"</span> <span class="n">characterset</span><span class="o">=</span><span class="s">"C0N200N0"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">afp</span><span class="o">-</span><span class="n">raster</span><span class="o">-</span><span class="n">font</span> <span class="n">size</span><span class="o">=</span><span class="s">"30"</span> <span class="n">characterset</span><span class="o">=</span><span class="s">"C0N200T0"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">afp</span><span class="o">-</span><span class="n">raster</span><span class="o">-</span><span class="n">font</span> <span class="n">size</span><span class="o">=</span><span class="s">"36"</span> <span class="n">characterset</span><span class="o">=</span><span class="s">"C0N200Z0"</span><span class="o">/></span>
- <span class="sr"></afp-font></span>
- <span class="o"><!--</span> <span class="n">These</span> <span class="n">are</span> <span class="n">the</span> <span class="n">usual</span> <span class="n">FOP</span> <span class="n">font</span> <span class="n">triplets</span> <span class="n">as</span> <span class="n">they</span> <span class="n">apply</span> <span class="n">to</span> <span class="n">this</span> <span class="n">font</span> <span class="o">--></span>
- <span class="o"><</span><span class="n">font</span><span class="o">-</span><span class="n">triplet</span> <span class="n">name</span><span class="o">=</span><span class="s">"serif"</span> <span class="n">style</span><span class="o">=</span><span class="s">"normal"</span> <span class="n">weight</span><span class="o">=</span><span class="s">"normal"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">font</span><span class="o">-</span><span class="n">triplet</span> <span class="n">name</span><span class="o">=</span><span class="s">"Times"</span> <span class="n">style</span><span class="o">=</span><span class="s">"normal"</span> <span class="n">weight</span><span class="o">=</span><span class="s">"normal"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">font</span><span class="o">-</span><span class="n">triplet</span> <span class="n">name</span><span class="o">=</span><span class="s">"Times-Roman"</span> <span class="n">style</span><span class="o">=</span><span class="s">"normal"</span> <span class="n">weight</span><span class="o">=</span><span class="s">"normal"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">font</span><span class="o">-</span><span class="n">triplet</span> <span class="n">name</span><span class="o">=</span><span class="s">"TimesNewRoman"</span> <span class="n">style</span><span class="o">=</span><span class="s">"normal"</span> <span class="n">weight</span><span class="o">=</span><span class="s">"normal"</span><span class="o">/></span>
-<span class="sr"></font></span>
+<div class="codehilite"><pre><span class="c"><!-- This is an example of mapping actual IBM raster fonts / code pages to a FOP font --></span>
+<span class="nt"><font></span>
+<span class="c"><!-- The afp-font element defines the IBM code page, the matching Java encoding and the</span>
+<span class="c"> base URI for the font --></span>
+ <span class="nt"><afp-font</span> <span class="na">type=</span><span class="s">"raster"</span> <span class="na">codepage=</span><span class="s">"T1V10500"</span> <span class="na">encoding=</span><span class="s">"Cp500"</span> <span class="na">base-uri=</span><span class="s">"fonts/ibm/"</span><span class="nt">></span>
+ <span class="c"><!-- For a raster font a separate element for each font size is required providing</span>
+<span class="c"> the font size and the corresponding IBM Character set name --></span>
+ <span class="nt"><afp-raster-font</span> <span class="na">size=</span><span class="s">"7"</span> <span class="na">characterset=</span><span class="s">"C0N20070"</span><span class="nt">/></span>
+ <span class="nt"><afp-raster-font</span> <span class="na">size=</span><span class="s">"8"</span> <span class="na">characterset=</span><span class="s">"C0N20080"</span><span class="nt">/></span>
+ <span class="nt"><afp-raster-font</span> <span class="na">size=</span><span class="s">"10"</span> <span class="na">characterset=</span><span class="s">"C0N20000"</span><span class="nt">/></span>
+ <span class="nt"><afp-raster-font</span> <span class="na">size=</span><span class="s">"11"</span> <span class="na">characterset=</span><span class="s">"C0N200A0"</span><span class="nt">/></span>
+ <span class="nt"><afp-raster-font</span> <span class="na">size=</span><span class="s">"12"</span> <span class="na">characterset=</span><span class="s">"C0N200B0"</span><span class="nt">/></span>
+ <span class="nt"><afp-raster-font</span> <span class="na">size=</span><span class="s">"14"</span> <span class="na">characterset=</span><span class="s">"C0N200D0"</span><span class="nt">/></span>
+ <span class="nt"><afp-raster-font</span> <span class="na">size=</span><span class="s">"16"</span> <span class="na">characterset=</span><span class="s">"C0N200F0"</span><span class="nt">/></span>
+ <span class="nt"><afp-raster-font</span> <span class="na">size=</span><span class="s">"18"</span> <span class="na">characterset=</span><span class="s">"C0N200H0"</span><span class="nt">/></span>
+ <span class="nt"><afp-raster-font</span> <span class="na">size=</span><span class="s">"20"</span> <span class="na">characterset=</span><span class="s">"C0N200J0"</span><span class="nt">/></span>
+ <span class="nt"><afp-raster-font</span> <span class="na">size=</span><span class="s">"24"</span> <span class="na">characterset=</span><span class="s">"C0N200N0"</span><span class="nt">/></span>
+ <span class="nt"><afp-raster-font</span> <span class="na">size=</span><span class="s">"30"</span> <span class="na">characterset=</span><span class="s">"C0N200T0"</span><span class="nt">/></span>
+ <span class="nt"><afp-raster-font</span> <span class="na">size=</span><span class="s">"36"</span> <span class="na">characterset=</span><span class="s">"C0N200Z0"</span><span class="nt">/></span>
+ <span class="nt"></afp-font></span>
+ <span class="c"><!-- These are the usual FOP font triplets as they apply to this font --></span>
+ <span class="nt"><font-triplet</span> <span class="na">name=</span><span class="s">"serif"</span> <span class="na">style=</span><span class="s">"normal"</span> <span class="na">weight=</span><span class="s">"normal"</span><span class="nt">/></span>
+ <span class="nt"><font-triplet</span> <span class="na">name=</span><span class="s">"Times"</span> <span class="na">style=</span><span class="s">"normal"</span> <span class="na">weight=</span><span class="s">"normal"</span><span class="nt">/></span>
+ <span class="nt"><font-triplet</span> <span class="na">name=</span><span class="s">"Times-Roman"</span> <span class="na">style=</span><span class="s">"normal"</span> <span class="na">weight=</span><span class="s">"normal"</span><span class="nt">/></span>
+ <span class="nt"><font-triplet</span> <span class="na">name=</span><span class="s">"TimesNewRoman"</span> <span class="na">style=</span><span class="s">"normal"</span> <span class="na">weight=</span><span class="s">"normal"</span><span class="nt">/></span>
+<span class="nt"></font></span>
</pre></div>
<p>An outline font configuration is simpler as the individual font size entries are not required. However, the characterset definition is now required within the afp-font element.</p>
-<div class="codehilite"><pre><span class="sr"><font></span>
- <span class="o"><</span><span class="n">afp</span><span class="o">-</span><span class="n">font</span> <span class="n">type</span><span class="o">=</span><span class="s">"outline"</span> <span class="n">codepage</span><span class="o">=</span><span class="s">"T1V10500"</span> <span class="n">encoding</span><span class="o">=</span><span class="s">"Cp500"</span> <span class="n">characterset</span><span class="o">=</span><span class="s">"CZH200 "</span>
- <span class="n">base</span><span class="o">-</span><span class="n">uri</span><span class="o">=</span><span class="s">"file:/fonts/ibm"</span> <span class="o">/></span>
- <span class="o"><</span><span class="n">font</span><span class="o">-</span><span class="n">triplet</span> <span class="n">name</span><span class="o">=</span><span class="s">"sans-serif"</span> <span class="n">style</span><span class="o">=</span><span class="s">"normal"</span> <span class="n">weight</span><span class="o">=</span><span class="s">"normal"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">font</span><span class="o">-</span><span class="n">triplet</span> <span class="n">name</span><span class="o">=</span><span class="s">"Helvetica"</span> <span class="n">style</span><span class="o">=</span><span class="s">"normal"</span> <span class="n">weight</span><span class="o">=</span><span class="s">"normal"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">font</span><span class="o">-</span><span class="n">triplet</span> <span class="n">name</span><span class="o">=</span><span class="s">"any"</span> <span class="n">style</span><span class="o">=</span><span class="s">"normal"</span> <span class="n">weight</span><span class="o">=</span><span class="s">"normal"</span><span class="o">/></span>
+<div class="codehilite"><pre><span class="nt"><font></span>
+ <span class="nt"><afp-font</span> <span class="na">type=</span><span class="s">"outline"</span> <span class="na">codepage=</span><span class="s">"T1V10500"</span> <span class="na">encoding=</span><span class="s">"Cp500"</span> <span class="na">characterset=</span><span class="s">"CZH200 "</span>
+ <span class="na">base-uri=</span><span class="s">"file:/fonts/ibm"</span> <span class="nt">/></span>
+ <span class="nt"><font-triplet</span> <span class="na">name=</span><span class="s">"sans-serif"</span> <span class="na">style=</span><span class="s">"normal"</span> <span class="na">weight=</span><span class="s">"normal"</span><span class="nt">/></span>
+ <span class="nt"><font-triplet</span> <span class="na">name=</span><span class="s">"Helvetica"</span> <span class="na">style=</span><span class="s">"normal"</span> <span class="na">weight=</span><span class="s">"normal"</span><span class="nt">/></span>
+ <span class="nt"><font-triplet</span> <span class="na">name=</span><span class="s">"any"</span> <span class="na">style=</span><span class="s">"normal"</span> <span class="na">weight=</span><span class="s">"normal"</span><span class="nt">/></span>
</pre></div>
@@ -711,7 +714,7 @@ Here is some sample code that uses iText
Previously, the location of the font files was given by the "path" attribute. This is still supported for the time being, but you should move to using the more flexible "base-uri" attribute so you can profit from the power of URI resolvers.
A CID-keyed font (Type 0, double-byte outline font) configuration is much the same as an outline font. However, the characterset definition is now required within the afp-font element.</p>
<div class="codehilite"><pre><span class="nt"><font></span>
- <span class="nt"><afp-font</span> <span class="na">type=</span><span class="s">"CIDKeyed"</span> <span class="na">characterset=</span><span class="s">"CZJHMNU"</span>
+ <span class="nt"><afp-font</span> <span class="na">type=</span><span class="s">"CIDKeyed"</span> <span class="na">characterset=</span><span class="s">"CZJHMNU"</span>
<span class="na">codepage=</span><span class="s">"T1120000"</span> <span class="na">encoding=</span><span class="s">"UnicodeBigUnmarked"</span>
<span class="na">base-uri=</span><span class="s">"file:/fonts/ibm"</span> <span class="nt">/></span>
<span class="nt"><font-triplet</span> <span class="na">name=</span><span class="s">"J-Heisei Mincho"</span> <span class="na">style=</span><span class="s">"normal"</span> <span class="na">weight=</span><span class="s">"normal"</span> <span class="nt">/></span>
@@ -794,121 +797,121 @@ A CID-keyed font (Type 0, double-byte ou
<p>By default, all manually configured fonts are embedded, unless they are matched in the <a href="fonts.html#embedding">section of the configuration file</a> . However, the default fonts shown above will not be embedded.</p>
<p>For double byte EBCDIC encoded character sets, there is an optional tag that must be set to prevent characters from being miscoded. This defaults to "false" if not specified.</p>
-<div class="codehilite"><pre> <span class="o"><</span><span class="n">afp</span><span class="o">-</span><span class="n">font</span> <span class="n">type</span><span class="o">=</span><span class="s">"CIDKeyed"</span> <span class="n">codepage</span><span class="o">=</span><span class="s">"T10835 "</span> <span class="n">encoding</span><span class="o">=</span><span class="s">"Cp937"</span> <span class="n">characterset</span><span class="o">=</span><span class="s">"CZTKAI"</span> <span class="n">ebcdic</span><span class="o">-</span><span class="n">dbcs</span><span class="o">=</span><span class="s">"true"</span><span class="o">/></span>
+<div class="codehilite"><pre><span class="nt"><afp-font</span> <span class="na">type=</span><span class="s">"CIDKeyed"</span> <span class="na">codepage=</span><span class="s">"T10835 "</span> <span class="na">encoding=</span><span class="s">"Cp937"</span> <span class="na">characterset=</span><span class="s">"CZTKAI"</span> <span class="na">ebcdic-dbcs=</span><span class="s">"true"</span><span class="nt">/></span>
</pre></div>
-<h4 id="output-resolutionwzxhzdk108wzxhzdk109">Output Resolution<a id="afp-renderer-resolution-config"></a></h4>
+<h4 id="output-resolutionwzxhzdk105wzxhzdk106">Output Resolution<a id="afp-renderer-resolution-config"></a></h4>
<p>By default the AFP Renderer creates output with a resolution of 240 dpi. This can be overridden by the <renderer-resolution/> configuration element. Example:</p>
-<div class="codehilite"><pre> <span class="nt"><renderer-resolution></span>240<span class="nt"></renderer-resolution></span>
+<div class="codehilite"><pre><span class="nt"><renderer-resolution></span>240<span class="nt"></renderer-resolution></span>
</pre></div>
-<h4 id="line-width-correctionwzxhzdk111wzxhzdk112">Line Width Correction<a id="afp-line-width-correction-config"></a></h4>
+<h4 id="line-width-correctionwzxhzdk108wzxhzdk109">Line Width Correction<a id="afp-line-width-correction-config"></a></h4>
<p>The default line width in AFP is device dependent. This means that a line width specified in, say, a SVG source file may not render the way it was intended. The output AFP line with can be corrected by the <line-width-correction/> configuration element. Example:</p>
-<div class="codehilite"><pre> <span class="nt"><line-width-correction></span>2.5<span class="nt"></line-width-correction></span>
+<div class="codehilite"><pre><span class="nt"><line-width-correction></span>2.5<span class="nt"></line-width-correction></span>
</pre></div>
-<h4 id="imageswzxhzdk114wzxhzdk115">Images<a id="afp-image-config"></a></h4>
+<h4 id="imageswzxhzdk111wzxhzdk112">Images<a id="afp-image-config"></a></h4>
<p>By default the AFP Renderer converts all images to 8 bit grey level. This can be overridden by the <images/> configuration element. Example:</p>
-<div class="codehilite"><pre> <span class="o"><</span><span class="n">images</span> <span class="n">mode</span><span class="o">=</span><span class="s">"color"</span> <span class="o">/></span>
+<div class="codehilite"><pre><span class="nt"><images</span> <span class="na">mode=</span><span class="s">"color"</span> <span class="nt">/></span>
</pre></div>
<p>This will put images as RGB images into the AFP output stream. The default setting is:</p>
-<div class="codehilite"><pre> <span class="o"><</span><span class="n">images</span> <span class="n">mode</span><span class="o">=</span><span class="s">"b+w"</span> <span class="n">bits</span><span class="o">-</span><span class="n">per</span><span class="o">-</span><span class="n">pixel</span><span class="o">=</span><span class="s">"8"</span> <span class="n">native</span><span class="o">=</span><span class="s">"true"</span><span class="o">/></span>
+<div class="codehilite"><pre><span class="nt"><images</span> <span class="na">mode=</span><span class="s">"b+w"</span> <span class="na">bits-per-pixel=</span><span class="s">"8"</span> <span class="na">native=</span><span class="s">"true"</span><span class="nt">/></span>
</pre></div>
<p>Only the values "color" and "b+w" are allowed for the mode attribute.</p>
<p>The bits-per-pixel attribute is ignored if mode is "color". For "b+w" mode is must be 1, 4, or 8.</p>
-<div class="codehilite"><pre> <span class="o"><</span><span class="n">images</span> <span class="n">native</span><span class="o">=</span><span class="s">"true"</span><span class="o">/></span>
+<div class="codehilite"><pre><span class="nt"><images</span> <span class="na">native=</span><span class="s">"true"</span><span class="nt">/></span>
</pre></div>
<p>When the native attribute is specified and set to "true", all image resources will be natively injected into the datastream using an object container rather than being converted into an IOCA FS45 image. Support for native image formats (e.g. JPEG, TIFF, GIF) is not always available on printer implementations so by default this configuration option is set to "false".</p>
<p>Setting <code>cmyk="true"</code> on the <code>images</code> element will enable CMYK colors. This will only have an effect if the color mode is set to "color". Example:</p>
-<div class="codehilite"><pre> <span class="o"><</span><span class="n">images</span> <span class="n">mode</span><span class="o">=</span><span class="s">"color"</span> <span class="n">cmyk</span><span class="o">=</span><span class="s">"true"</span><span class="o">/></span>
+<div class="codehilite"><pre><span class="nt"><images</span> <span class="na">mode=</span><span class="s">"color"</span> <span class="na">cmyk=</span><span class="s">"true"</span><span class="nt">/></span>
</pre></div>
<p>When the color mode is set to 1 bit (bi-level), the "dithering-quality" attribute can be used to select the level of quality to use when converting images to bi-level images. Valid values for this attribute are floating point numbers from 0.0 (fastest) to 1.0 (best), or special values: "minimum" (=0.0), "maximum" (1.0), "medium" (0.5, the default). For the higher settings to work as expected, JAI needs to be present in the classpath. If JAI is present, 0.0 results in a minimal darkness-level switching between white and black. 0.5 does bayer-based dithering and 1.0 will use error-diffusion dithering. The higher the value, the higher the quality and the slower the processing of the images.</p>
-<div class="codehilite"><pre> <span class="o"><</span><span class="n">images</span> <span class="n">mode</span><span class="o">=</span><span class="s">"b+w"</span> <span class="n">bits</span><span class="o">-</span><span class="n">per</span><span class="o">-</span><span class="n">pixel</span><span class="o">=</span><span class="s">"1"</span> <span class="n">dithering</span><span class="o">-</span><span class="n">quality</span><span class="o">=</span><span class="s">"maximum"</span><span class="o">/></span>
+<div class="codehilite"><pre><span class="nt"><images</span> <span class="na">mode=</span><span class="s">"b+w"</span> <span class="na">bits-per-pixel=</span><span class="s">"1"</span> <span class="na">dithering-quality=</span><span class="s">"maximum"</span><span class="nt">/></span>
</pre></div>
<p>When the boolean attribute pseg (default false) is set to true, non-inline FS11 and FS45 IOCA images are wrapped in page segment. This option is provided to support printers/print servers that require this MO:DCA structure.</p>
-<div class="codehilite"><pre> <span class="o"><</span><span class="n">images</span> <span class="n">mode</span><span class="o">=</span><span class="s">"b+w"</span> <span class="n">bits</span><span class="o">-</span><span class="n">per</span><span class="o">-</span><span class="n">pixel</span><span class="o">=</span><span class="s">"8"</span> <span class="n">pseg</span><span class="o">=</span><span class="s">"true"</span><span class="o">/></span>
+<div class="codehilite"><pre><span class="nt"><images</span> <span class="na">mode=</span><span class="s">"b+w"</span> <span class="na">bits-per-pixel=</span><span class="s">"8"</span> <span class="na">pseg=</span><span class="s">"true"</span><span class="nt">/></span>
</pre></div>
<p>Setting the boolean attribute fs45 to true (default false) will force all images to FS45.</p>
-<div class="codehilite"><pre> <span class="o"><</span><span class="n">images</span> <span class="n">mode</span><span class="o">=</span><span class="s">"b+w"</span> <span class="n">bits</span><span class="o">-</span><span class="n">per</span><span class="o">-</span><span class="n">pixel</span><span class="o">=</span><span class="s">"8"</span> <span class="n">fs45</span><span class="o">=</span><span class="s">"true"</span><span class="o">/></span>
+<div class="codehilite"><pre><span class="nt"><images</span> <span class="na">mode=</span><span class="s">"b+w"</span> <span class="na">bits-per-pixel=</span><span class="s">"8"</span> <span class="na">fs45=</span><span class="s">"true"</span><span class="nt">/></span>
</pre></div>
<p>By default, JPEG images are rasterized to a bitmap and the bitmap is included in the AFP doc. However it is possible to encode in a lossless way to maintain maximum quality. But due to lack of support for compression schemes like LZW (patent concerns), bitmap data is currently not compressed resulting in large AFP files. Using the "allow-embedding" attribute on jpeg child element allows the user to pass the JPEG as is in the document. The default is set to "false" since there are compatibility concerns as some AFP printers don't support JPEG decoding. Using the "bitmap-encoding-quality" attribute it is possible to enable lossy compression (JPEG baseline DCT). The default is "1.0" which means lossless encoding. Setting a value lower than 1.0, JPEG compression is enabled and the setting is used as the quality setting when encoding bitmap data. Note that this setting does not always have an effect. Bi-level (1 bit) bitmaps are not compressed using JPEG. Example:</p>
-<div class="codehilite"><pre> <span class="nt"><images</span> <span class="na">mode=</span><span class="s">"color"</span> <span class="na">cmyk=</span><span class="s">"true"</span><span class="nt">></span>
- <span class="nt"><jpeg</span> <span class="na">allow-embedding=</span><span class="s">"false"</span> <span class="na">bitmap-encoding-quality=</span><span class="s">"0.8"</span><span class="nt">/></span>
- <span class="nt"></images></span>
+<div class="codehilite"><pre><span class="nt"><images</span> <span class="na">mode=</span><span class="s">"color"</span> <span class="na">cmyk=</span><span class="s">"true"</span><span class="nt">></span>
+ <span class="nt"><jpeg</span> <span class="na">allow-embedding=</span><span class="s">"false"</span> <span class="na">bitmap-encoding-quality=</span><span class="s">"0.8"</span><span class="nt">/></span>
+<span class="nt"></images></span>
</pre></div>
-<h4 id="goca-vector-graphicswzxhzdk117wzxhzdk118">GOCA (Vector Graphics)<a id="afp-goca-config"></a></h4>
+<h4 id="goca-vector-graphicswzxhzdk114wzxhzdk115">GOCA (Vector Graphics)<a id="afp-goca-config"></a></h4>
<p>Not all AFP implementations support GOCA. Some also have bugs related to GOCA. Therefore, it is desirable to have some control over the generation of GOCA graphics.</p>
<p>GOCA is enabled by default. You can disable GOCA entirely in which case the AFP support falls back to generating bitmaps for vector graphics. Example:</p>
-<div class="codehilite"><pre> <span class="o"><</span><span class="n">goca</span> <span class="n">enabled</span><span class="o">=</span><span class="s">"false"</span><span class="o">/></span>
+<div class="codehilite"><pre><span class="nt"><goca</span> <span class="na">enabled=</span><span class="s">"false"</span><span class="nt">/></span>
</pre></div>
<p>Some AFP implementations have trouble rendering text in GOCA. You can instruct the AFP support to render text as shapes (i.e. use vector graphics to paint text). Example:</p>
-<div class="codehilite"><pre> <span class="o"><</span><span class="n">goca</span> <span class="n">enabled</span><span class="o">=</span><span class="s">"true"</span> <span class="n">text</span><span class="o">=</span><span class="s">"shapes"</span><span class="o">/></span>
+<div class="codehilite"><pre><span class="nt"><goca</span> <span class="na">enabled=</span><span class="s">"true"</span> <span class="na">text=</span><span class="s">"shapes"</span><span class="nt">/></span>
</pre></div>
<p>If you disable GOCA or let text render as shapes, the size of the generated AFP usually increases considerably.</p>
-<h4 id="shadingwzxhzdk119wzxhzdk120">Shading<a id="afp-shading-config"></a></h4>
+<h4 id="shadingwzxhzdk116wzxhzdk117">Shading<a id="afp-shading-config"></a></h4>
<p>By default, filled rectangles are painted using their given color using a PTOCA I-axis rule (DIR). But not all environments handle these colors correctly. That's why a setting is supported that paints the rectangles using an ordered dither pattern (bi-level) with an inline IOCA FS10 image that is used together with the "replicate and trim" mapping. The optional "shading" element can be used to control the shading mode. Its default value is "color". To enable the dithered mode, use "dithered". Example:</p>
-<div class="codehilite"><pre> <span class="nt"><shading></span>dithered<span class="nt"></shading></span>
+<div class="codehilite"><pre><span class="nt"><shading></span>dithered<span class="nt"></shading></span>
</pre></div>
-<h4 id="resource-group-filewzxhzdk121wzxhzdk122">Resource Group File<a id="afp-resource-group-file"></a></h4>
+<h4 id="resource-group-filewzxhzdk118wzxhzdk119">Resource Group File<a id="afp-resource-group-file"></a></h4>
<p>By default the AFP Renderer will place all data resource objects such as images within the document of the main output datastream. An external resource group file where document resources may be specified with the <resource-group-file/> configuration element. Example:</p>
-<div class="codehilite"><pre> <span class="nt"><resource-group-file></span>external_resources.afp<span class="nt"></resource-group-file></span>
+<div class="codehilite"><pre><span class="nt"><resource-group-file></span>external_resources.afp<span class="nt"></resource-group-file></span>
</pre></div>
<p>Be careful when using this option not to overwrite existing resource files from previous rendering runs.</p>
-<h4 id="resource-level-defaultswzxhzdk124wzxhzdk125">Resource Level Defaults<a id="afp-resource-level-defaults"></a></h4>
+<h4 id="resource-level-defaultswzxhzdk121wzxhzdk122">Resource Level Defaults<a id="afp-resource-level-defaults"></a></h4>
<p>By default, bitmap image objects (or page segments derived from them) are put in the print-file-level resource group and GOCA graphics are inlined for compatibility with the AFP Workbench tool.</p>
<p>It is possible to override these defaults, either per image (see the <a href="#afp-foreign-attributes-resource">afp:resource-level</a> extension attribute below) or by specifying different defaults in the configuration:</p>
-<div class="codehilite"><pre><span class="o"><</span><span class="n">default</span><span class="o">-</span><span class="n">resource</span><span class="o">-</span><span class="n">levels</span> <span class="n">goca</span><span class="o">=</span><span class="s">"print-file"</span> <span class="n">bitmap</span><span class="o">=</span><span class="s">"inline"</span><span class="o">/></span>
+<div class="codehilite"><pre><span class="nt"><default-resource-levels</span> <span class="na">goca=</span><span class="s">"print-file"</span> <span class="na">bitmap=</span><span class="s">"inline"</span><span class="nt">/></span>
</pre></div>
<p>"goca" refers to GOCA graphics and "bitmap" refers to IOCA images. The possible values for the attributes are "inline" and "print-file". In the future, additional possibilities may be added.</p>
-<h3 id="extensions-wzxhzdk126wzxhzdk127">Extensions <a id="afp-extensions"></a></h3>
+<h3 id="extensions-wzxhzdk123wzxhzdk124">Extensions <a id="afp-extensions"></a></h3>
<p>The AFP Renderer supports some AFP specific extensions which can be embedded into the input fo document. To use the extensions the appropriate namespace must be declared in the fo:root element like this:</p>
-<div class="codehilite"><pre> <span class="o"><</span><span class="n">fo:root</span> <span class="n">xmlns:fo</span><span class="o">=</span><span class="s">"http://www.w3.org/1999/XSL/Format"</span>
- <span class="n">xmlns:afp</span><span class="o">=</span><span class="s">"http://xmlgraphics.apache.org/fop/extensions/afp"</span><span class="o">></span>
+<div class="codehilite"><pre><span class="nt"><fo:root</span> <span class="na">xmlns:fo=</span><span class="s">"http://www.w3.org/1999/XSL/Format"</span>
+ <span class="na">xmlns:afp=</span><span class="s">"http://xmlgraphics.apache.org/fop/extensions/afp"</span><span class="nt">></span>
</pre></div>
-<h4 id="page-overlay-ipo-extensionwzxhzdk128wzxhzdk129">Page Overlay (IPO) Extension<a id="afp-page-overlay"></a></h4>
+<h4 id="page-overlay-ipo-extensionwzxhzdk125wzxhzdk126">Page Overlay (IPO) Extension<a id="afp-page-overlay"></a></h4>
<p>The include-page-overlay extension element allows to define on a per simple-page-master basis a page overlay resource. Example:</p>
-<div class="codehilite"><pre> <span class="nt"><fo:layout-master-set></span>
- <span class="nt"><fo:simple-page-master</span> <span class="na">master-name=</span><span class="s">"simple"</span><span class="nt">></span>
- <span class="nt"><afp:include-page-overlay</span> <span class="na">name=</span><span class="s">"O1SAMP1 "</span> <span class="na">x=</span><span class="s">"20mm"</span> <span class="na">y=</span><span class="s">"30mm"</span> <span class="nt">/></span>
- ...
- <span class="nt"></fo:simple-page-master></span>
- <span class="nt"></fo:layout-master-set></span>
+<div class="codehilite"><pre><span class="nt"><fo:layout-master-set></span>
+ <span class="nt"><fo:simple-page-master</span> <span class="na">master-name=</span><span class="s">"simple"</span><span class="nt">></span>
+ <span class="nt"><afp:include-page-overlay</span> <span class="na">name=</span><span class="s">"O1SAMP1 "</span> <span class="na">x=</span><span class="s">"20mm"</span> <span class="na">y=</span><span class="s">"30mm"</span> <span class="nt">/></span>
+ ...
+ <span class="nt"></fo:simple-page-master></span>
+<span class="nt"></fo:layout-master-set></span>
</pre></div>
<p>The mandatory name attribute must refer to an 8 character (space padded) resource name that must be known in the AFP processing environment. Optional x and y attributes can be specified to place the Overlay at an offset from the top left of the page.</p>
-<h4 id="page-segment-ips-extensionwzxhzdk130wzxhzdk131">Page Segment (IPS) Extension<a id="afp-page-segment"></a></h4>
+<h4 id="page-segment-ips-extensionwzxhzdk127wzxhzdk128">Page Segment (IPS) Extension<a id="afp-page-segment"></a></h4>
<p>The include-page-segment extension element allows to define resource substitution for fo:external-graphics elements. Example:</p>
<div class="codehilite"><pre><span class="nt"><fo:root</span> <span class="na">xmlns:fo=</span><span class="s">"http://www.w3.org/1999/XSL/Format"</span>
<span class="na">xmlns:afp=</span><span class="s">"http://xmlgraphics.apache.org/fop/extensions/afp"</span><span class="nt">></span>
@@ -924,7 +927,7 @@ A CID-keyed font (Type 0, double-byte ou
<p>The include-page-segment extension element can only occur within a simple-page-master. Multiple include-page-segment extension elements within a simple-page-master are allowed. The mandatory name attribute must refer to an 8 character (space padded) resource name that must be known in the AFP processing environment. The value of the mandatory src attribute is compared against the value of the src attribute in fo:external-graphic elements and if it is identical (string matching is used) in the generated AFP the external graphic is replaced by a reference to the given resource.</p>
<p>The effect here is that whenever FOP encounters the URI specified in the extension, it will effectively generate code to include the page segment with the given name instead of embedding the image referenced by the URI. The URI is still required as the underlying image serves as a provider for the intrinsic size of the image (At the moment, FOP is unable to extract the intrinsic size of the page segment from an AFP resource file). For the image to appear in an AFP viewer or to be printed, the AFP resource must be available on the target device. FOP does not embed the page segment in the generated file. Please also note that page segments cannot be scaled. They are always rendered in their intrinsic size.</p>
<p>The include-page-segment extension element has the optional attribute <em>resource-file</em> . The value of this is a URI to a resource containing a page segment with the declared name. In this case FOP embeds the page segment into the generated document so that the external resource does not have to be supplied in the print job.</p>
-<h4 id="tag-logical-element-tle-extensionwzxhzdk132wzxhzdk133">Tag Logical Element (TLE) Extension<a id="afp-tag-logical-element"></a></h4>
+<h4 id="tag-logical-element-tle-extensionwzxhzdk129wzxhzdk130">Tag Logical Element (TLE) Extension<a id="afp-tag-logical-element"></a></h4>
<p>The tag-logical-element extension element allows to injects TLEs into the AFP output stream. Example:</p>
<div class="codehilite"><pre><span class="nt"><fo:root</span> <span class="na">xmlns:fo=</span><span class="s">"http://www.w3.org/1999/XSL/Format"</span>
<span class="na">xmlns:afp=</span><span class="s">"http://xmlgraphics.apache.org/fop/extensions/afp"</span><span class="nt">></span>
@@ -943,7 +946,7 @@ A CID-keyed font (Type 0, double-byte ou
<p>The tag-logical-element extension element can appear within a simple-page-master (page level) or it can appear as child of page-sequence (page group level). Multiple tag-logical-element extension elements within a simple-page-master or page-sequence are allowed. The name and value attributes are mandatory.</p>
-<h4 id="no-operation-nop-extensionwzxhzdk134wzxhzdk135">No Operation (NOP) Extension<a id="afp-no-operation"></a></h4>
+<h4 id="no-operation-nop-extensionwzxhzdk131wzxhzdk132">No Operation (NOP) Extension<a id="afp-no-operation"></a></h4>
<p>The no-operation extension provides the ability to carry up to 32K of comments or any other type of unarchitected data into the AFP output stream. Example:</p>
<div class="codehilite"><pre><span class="nt"><fo:root</span> <span class="na">xmlns:fo=</span><span class="s">"http://www.w3.org/1999/XSL/Format"</span>
[... 149 lines stripped ...]
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org