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 2015/05/21 17:08:46 UTC
svn commit: r952197 [2/11] - in /websites/staging/xmlgraphics/trunk/content:
./ fop/2.0/ fop/2.0/images/
Added: websites/staging/xmlgraphics/trunk/content/fop/2.0/complexscripts.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/2.0/complexscripts.html (added)
+++ websites/staging/xmlgraphics/trunk/content/fop/2.0/complexscripts.html Thu May 21 15:08:45 2015
@@ -0,0 +1,991 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <title>Apache(tm) FOP: Complex Scripts</title>
+
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <meta property="og:image" content="http://www.apache.org/images/asf_logo.gif" />
+<!--
+ <link rel="stylesheet" type="text/css" media="screen" href="http://www.apache.org/css/style.css">
+-->
+ <link rel="stylesheet" type="text/css" media="screen" href="//www.apache.org/css/code.css">
+ <link href="/css/profile.css" rel="stylesheet" type="text/css" />
+ <link href="/css/xmlgraphics.css" rel="stylesheet" type="text/css" />
+ <link href="/css/print.css" rel="stylesheet" type="text/css" media="print" />
+
+ <script src="//code.jquery.com/jquery.min.js"></script>
+ <script type="text/javascript" src="/js/jquery.stoc.js"></script>
+ <script>
+ $(document).ready(function(){
+ $('ul#navigation a').each(function() {
+ if (this.href === window.location.href)
+ { $(this). attr('id', 'forefront');}
+ });
+ $('ul#navigation a#forefront').each(function() {
+
+ });
+ })
+ $(function(){
+ $("#items").stoc({ search: "#content", stocTitle: "<h3>Page Contents</h3>" });
+ });
+ </script>
+
+
+
+
+
+ <style>
+ .highlight {color: red;}
+ </style>
+
+ </head>
+
+ <body>
+
+ <div id="banner">
+ </div>
+
+ <div id="navigation">
+ <p><a href="/"><img alt="Apache XML Graphics Project Logo" src="/images/apache-xml-graphics.gif" title="Apache XML Graphics Project" /></a></p>
+<h1 id="apachewzxhzdk2-fop">Apache™ FOP</h1>
+<ul>
+<li><a href="/fop/">FOP Home</a></li>
+<li><a href="/fop/download.html">Download</a></li>
+<li><a href="/fop/quickstartguide.html">Quick Start Guide</a></li>
+<li><a href="/fop/compliance.html">Compliance</a></li>
+<li><a href="/fop/gethelp.html">Getting Help</a></li>
+<li><a href="/fop/faq.html">FAQs</a></li>
+<li><a href="/fop/maillist.html">Mailing Lists</a></li>
+<li><a href="/fop/license.html">License</a></li>
+<li>
+<h2 id="resources">Resources</h2>
+<ul>
+<li><a href="/fop/fo.html">XSL-FO</a></li>
+<li><a href="/fop/examples.html">Examples</a></li>
+<li><a href="/fop/bugs.html">Bugs</a></li>
+<li><a href="http://wiki.apache.org/xmlgraphics-fop/FrontPage">Wiki</a></li>
+<li><a href="/fop/resources.html">Other</a></li>
+</ul>
+</li>
+<li>
+<h2 id="project">Project</h2>
+<ul>
+<li><a href="/fop/news.html">News</a></li>
+<li><a href="/fop/team.html">Who We Are</a></li>
+<li><a href="/fop/status.html">Status</a></li>
+<li><a href="/fop/knownissues.html">Known Issues</a></li>
+<li><a href="/fop/changes.html">Changes</a></li>
+</ul>
+</li>
+<li>
+<h2 id="versions">Versions</h2>
+<ul>
+<li>
+<h2 id="fop-trunk-dev">FOP Trunk (dev)</h2>
+<ul>
+<li><a href="/fop/trunk/">Overview</a></li>
+<li><a href="/fop/trunk/upgrading.html">Upgrading</a></li>
+<li>
+<h3 id="using-apachewzxhzdk7-fop">Using Apache™ FOP</h3>
+<ul>
+<li><a href="/fop/trunk/compiling.html">Build</a></li>
+<li><a href="/fop/trunk/configuration.html">Configure</a></li>
+<li><a href="/fop/trunk/running.html">Run</a></li>
+<li><a href="/fop/trunk/embedding.html">Embed</a></li>
+<li><a href="/fop/trunk/servlets.html">Servlets</a></li>
+<li><a href="/fop/trunk/anttask.html">Ant Task</a></li>
+</ul>
+</li>
+<li>
+<h3 id="features">Features</h3>
+<ul>
+<li><a href="/fop/trunk/accessibility.html">Accessibility</a></li>
+<li><a href="/fop/trunk/complexscripts.html">Complex Scripts</a></li>
+<li><a href="/fop/trunk/events.html">Events</a></li>
+<li><a href="/fop/trunk/extensions.html">Extensions</a></li>
+<li><a href="/fop/trunk/fonts.html">Fonts</a></li>
+<li><a href="/fop/trunk/graphics.html">Graphics</a></li>
+<li><a href="/fop/trunk/hyphenation.html">Hyphenation</a></li>
+<li><a href="/fop/trunk/intermediate.html">Intermediate Format</a></li>
+<li><a href="/fop/trunk/metadata.html">Metadata</a></li>
+<li><a href="/fop/trunk/output.html">Output Targets</a></li>
+<li><a href="/fop/trunk/pdfa.html">PDF/A</a></li>
+<li><a href="/fop/trunk/pdfx.html">PDF/X</a></li>
+<li><a href="/fop/trunk/pdfencryption.html">PDF Encryption</a></li>
+<li><a href="/fop/fop-pdf-images.html">PDF Images</a></li>
+<li><a href="/fop/trunk/whitespacemanagement.html">Whitespace Management</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<h2 id="fop-11">FOP 1.1</h2>
+<ul>
+<li><a href="/fop/1.1/">FOP 1.1 Overview</a></li>
+<li><a href="/fop/1.1/releaseNotes_1.1.html">Release Notes</a></li>
+<li><a href="/fop/1.1/changes_1.1.html">Changes (1.1)</a></li>
+<li><a href="/fop/1.1/knownissues_overview.html">Known Issues</a></li>
+<li><a href="/fop/1.1/upgrading.html">Upgrading</a></li>
+<li>
+<h3 id="using-apache-fop-11">Using Apache FOP 1.1</h3>
+<ul>
+<li><a href="/fop/1.1/compiling.html">Build</a></li>
+<li><a href="/fop/1.1/configuration.html">Configure</a></li>
+<li><a href="/fop/1.1/running.html">Run</a></li>
+<li><a href="/fop/1.1/embedding.html">Embed</a></li>
+<li><a href="/fop/1.1/servlets.html">Servlets</a></li>
+<li><a href="/fop/1.1/anttask.html">Ant Task</a></li>
+</ul>
+</li>
+<li>
+<h3 id="features_1">Features</h3>
+<ul>
+<li><a href="/fop/1.1/accessibility.html">Accessibility</a></li>
+<li><a href="/fop/1.1/complexscripts.html">Complex Scripts</a></li>
+<li><a href="/fop/1.1/events.html">Events</a></li>
+<li><a href="/fop/1.1/extensions.html">Extensions</a></li>
+<li><a href="/fop/1.1/fonts.html">Fonts</a></li>
+<li><a href="/fop/1.1/graphics.html">Graphics</a></li>
+<li><a href="/fop/1.1/hyphenation.html">Hyphenation</a></li>
+<li><a href="/fop/1.1/intermediate.html">Intermediate Format</a></li>
+<li><a href="/fop/1.1/metadata.html">Metadata</a></li>
+<li><a href="/fop/1.1/output.html">Output Targets</a></li>
+<li><a href="/fop/1.1/pdfa.html">PDF/A</a></li>
+<li><a href="/fop/1.1/pdfx.html">PDF/X</a></li>
+<li><a href="/fop/1.1/pdfencryption.html">PDF Encryption</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<h2 id="fop-10">FOP 1.0</h2>
+<ul>
+<li><a href="/fop/1.0/">FOP 1.0 Overview</a></li>
+<li><a href="/fop/1.0/releaseNotes_1.0.html">Release Notes</a></li>
+<li><a href="/fop/1.0/changes_1.0.html">Changes (1.0)</a></li>
+<li><a href="/fop/1.0/knownissues_overview.html">Known Issues</a></li>
+<li><a href="/fop/1.0/upgrading.html">Upgrading</a></li>
+<li>
+<h3 id="using-apache-fop-10">Using Apache FOP 1.0</h3>
+<ul>
+<li><a href="/fop/1.0/compiling.html">Build</a></li>
+<li><a href="/fop/1.0/configuration.html">Configure</a></li>
+<li><a href="/fop/1.0/running.html">Run</a></li>
+<li><a href="/fop/1.0/embedding.html">Embed</a></li>
+<li><a href="/fop/1.0/servlets.html">Servlets</a></li>
+<li><a href="/fop/1.0/anttask.html">Ant Task</a></li>
+</ul>
+</li>
+<li>
+<h3 id="features_2">Features</h3>
+<ul>
+<li><a href="/fop/1.0/output.html">Output Targets</a></li>
+<li><a href="/fop/1.0/intermediate.html">Intermediate Format</a></li>
+<li><a href="/fop/1.0/pdfencryption.html">PDF Encryption</a></li>
+<li><a href="/fop/1.0/pdfa.html">PDF/A</a></li>
+<li><a href="/fop/1.0/pdfx.html">PDF/X</a></li>
+<li><a href="/fop/1.0/graphics.html">Graphics</a></li>
+<li><a href="/fop/1.0/fonts.html">Fonts</a></li>
+<li><a href="/fop/1.0/hyphenation.html">Hyphenation</a></li>
+<li><a href="/fop/1.0/extensions.html">Extensions</a></li>
+<li><a href="/fop/1.0/events.html">Events</a></li>
+<li><a href="/fop/1.0/metadata.html">Metadata</a></li>
+<li><a href="/fop/1.0/accessibility.html">Accessibility</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<h2 id="fop-development">FOP Development</h2>
+<ul>
+<li><a href="/fop/dev/">General Info</a></li>
+<li>
+<h2 id="design">Design</h2>
+<ul>
+<li><a href="/fop/dev/design/">Design Info</a></li>
+</ul>
+</li>
+<li>
+<h2 id="core-process">Core Process</h2>
+<ul>
+<li><a href="/fop/dev/design/startup.html">Startup</a></li>
+<li><a href="/fop/dev/design/parsing.html">XML Parsing</a></li>
+<li><a href="/fop/dev/design/fotree.html">FO Tree</a></li>
+<li><a href="/fop/dev/design/properties.html">Properties</a></li>
+<li><a href="/fop/dev/design/layout.html">Layout</a></li>
+<li><a href="/fop/dev/design/breakpos.html">Break Possibility</a></li>
+<li><a href="/fop/dev/design/areas.html">Area Tree</a></li>
+<li><a href="/fop/dev/design/renderers.html">Renderers</a></li>
+</ul>
+</li>
+<li>
+<h2 id="miscellaneous">Miscellaneous</h2>
+<ul>
+<li><a href="/fop/dev/design/images.html">Images</a></li>
+<li><a href="/fop/dev/design/pdf-library.html">PDF Library</a></li>
+<li><a href="/fop/dev/design/svg.html">SVG</a></li>
+<li><a href="/fop/dev/design/embedding.html">Embedding</a></li>
+<li><a href="/fop/dev/design/extending.html">Extending</a></li>
+<li><a href="/fop/dev/design/optimise.html">Optimisations</a></li>
+<li><a href="/fop/dev/design/useragent.html">User Agent</a></li>
+</ul>
+</li>
+<li><a href="http://wiki.apache.org/xmlgraphics-fop/FOPProjectPages">Unresolved (Wiki)</a></li>
+<li><a href="/fop/dev/svg.html">SVG</a></li>
+<li><a href="/fop/dev/extensions.html">Extensions</a></li>
+<li>
+<h2 id="develop">Develop</h2>
+<ul>
+<li><a href="/fop/dev/implement.html">Walk-Thru</a></li>
+<li><a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20FOP%20AND%20description%20~%20%22\%22[patch]\%22%22%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29">Patch Queue</a></li>
+<li><a href="/fop/dev/conventions.html">Conventions</a></li>
+</ul>
+</li>
+<li>
+<h2 id="test">Test</h2>
+<ul>
+<li><a href="/fop/dev/testing.html">Testing</a></li>
+</ul>
+</li>
+<li>
+<h2 id="deploy">Deploy</h2>
+<ul>
+<li><a href="/fop/dev/doc.html">Doc Mgmt</a></li>
+<li><a href="/fop/dev/release.html">Release</a></li>
+<li><a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20FOP%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29">Bugs</a></li>
+</ul>
+</li>
+<li>
+<h2 id="resources_1">Resources</h2>
+<ul>
+<li><a href="/fop/dev/faq.html">FAQs</a></li>
+<li><a href="/fop/dev/tools.html">Tools</a></li>
+<li><a href="http://svn.apache.org/viewvc/xmlgraphics/fop">ViewVC</a></li>
+</ul>
+</li>
+<li>
+<h2 id="subpackages">SubPackages</h2>
+<ul>
+<li><a href="/fop/dev/rtflib.html">RTFlib</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<h1 id="apachewzxhzdk3-xml-graphics">Apache™ XML Graphics</h1>
+<ul>
+<li>
+<h2 id="project-overview">Project Overview</h2>
+<ul>
+<li><a href="/team.html">Who We Are</a></li>
+<li><a href="/legal.html">Legal Stuff</a></li>
+<li><a href="/charter.html">Project Charter</a></li>
+<li><a href="/mail.html">Mailing Lists</a></li>
+<li><a href="/repo.html">Code Repositories</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">ASF Sponsorship Program</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">ASF Thanks</a></li>
+<li><a href="http://www.apache.org/licenses/">Licenses</a></li>
+<li><a href="/security.html">Apache XML Graphics Security</a></li>
+<li><a href="http://www.apache.org/security/">ASF Security</a></li>
+</ul>
+</li>
+</ul>
+<h1 id="sub-projects">Sub Projects</h1>
+<ul>
+<li><a href="/batik/">Apache Batik</a></li>
+<li><a href="/commons/">Apache XML Graphics Commons</a></li>
+</ul>
+<h3 id="search-apache-xml-graphics">Search Apache XML Graphics</h3>
+<form name="search" id="search" action="http://www.google.com/search" method="get">
+ <input value="xmlgraphics.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" />
+ <input type="submit" id="submit" value="Search" />
+</form>
+
+<h3 id="apachecon-n-america">ApacheCon N. America</h3>
+<p><a href="http://na.apachecon.com/"><img alt="ApacheCon North America" src="https://farm8.staticflickr.com/7566/15408186664_d08f3881c9_t.jpg" title="ApacheCon North America" /></a></p>
+<ul>
+<li><strong><a href="http://na.apachecon.com/">ApacheCon NA</a></strong></li>
+</ul>
+<h3 id="apachecon-europe">ApacheCon Europe</h3>
+<p><a href="http://apachecon.eu/" title="ApacheCon Europe"><img alt="ApacheCon Europe" src="http://www.apache.org/ads/ApacheCon/2014-eu-234x60.png" width="225" /></a></p>
+<ul>
+<li><strong><a href="http://apachecon.eu/">ApacheCon Europe</a></strong></li>
+</ul>
+<p>Hope to see you there!</p>
+<script>
+$(document).ready(function () {
+ $('#navigation :header').click(function () {
+ var text = $(this).siblings('ul');
+ if (text.is(':hidden')) {
+ text.slideDown('200');
+ } else {
+ text.slideUp('200');
+ }
+ });
+ if ($('#navigation :header').siblings('ul')) {
+ $('#navigation :header').not('#search-apache-xml-graphics, #apachewzxhzdk3-xml-graphics, #sub-projects').append(' »');
+ }
+ $('#navigation > ul > li > ul > li ul').hide();
+ $('#project-overview').next().hide();
+ $('#versions').next().show();
+ var str=location.href.toLowerCase();
+ $("#navigation li a").each(function() {
+ if (str.indexOf(this.href.toLowerCase()) > -1) {
+ $(this).parents().slideDown('200');
+ $("li.highlight").removeClass("highlight");
+ $(this).parent().addClass("highlight");
+ }
+ });
+})
+</script>
+ </div>
+
+ <div id="bannertext" style="border-bottom: 2px dashed #666666; height: 70px;">
+ <a href="/fop/"><img src="/images/apache-fop-logo.jpg" alt="The Apache FOP Project" width="120" height="65" style="float:left; margin-right: 15px;" /></a>
+ <h2>The Apache™ FOP Project</h2>
+ </div><!-- <h1>Apache(tm) FOP: Complex Scripts</h1> -->
+
+
+
+ <div id="content" class="grid_16">
+ <div id="items">
+ </div>
+ <!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/2.0/">2.0</a></div> -->
+ <div class="section-content"><h1 id="apachewzxhzdk3-fop-complex-scripts">Apache™ FOP: Complex Scripts</h1>
+<h2 id="overview">Overview</h2>
+<p>This page describes the <a href="http://en.wikipedia.org/wiki/Complex_scripts">complex scripts</a> features of Apache™ FOP, which include:</p>
+<ul>
+<li>
+<p>Support for languages written with right-to-left scripts, such as Arabic and Hebrew scripts.</p>
+</li>
+<li>
+<p>Support for languages written with South Asian and Southeast Asian scripts, such as Devanagari, Khmer, Tamil, Thai, and others.</p>
+</li>
+<li>
+<p>Support for advanced substitution, reordering, and positioning of glyphs according to language and script sensitive rules.</p>
+</li>
+<li>
+<p>Support for advanced number to string formatting.</p>
+</li>
+</ul>
+<h2 id="Disabling-complex-scripts">Disabling complex scripts</h2>
+<p>Complex script features are enabled by default. If some application of FOP does not require this support, then it can be disabled in three ways:</p>
+<ol>
+<li>
+<p><strong>Command line:</strong></p>
+<p>The command line option <code>-nocs</code> turns off complex script features:</p>
+<div class="codehilite"><pre><span class="n">fop</span> <span class="o">-</span><span class="n">nocs</span> <span class="o">-</span><span class="n">fo</span> <span class="n">mydocument</span><span class="p">.</span><span class="n">fo</span> <span class="o">-</span><span class="n">pdf</span> <span class="n">mydocument</span><span class="p">.</span><span class="n">pdf</span>
+</pre></div>
+
+
+</li>
+<li>
+<p><strong>Embedding:</strong></p>
+<div class="codehilite"><pre><span class="n">userAgent</span><span class="o">.</span><span class="na">setComplexScriptFeaturesEnabled</span><span class="o">(</span><span class="kc">false</span><span class="o">);</span>
+</pre></div>
+
+
+</li>
+<li>
+<p><strong>Optional setting in fop.xconf file:</strong></p>
+<div class="codehilite"><pre><span class="nt"><fop</span> <span class="na">version=</span><span class="s">"1.0"</span><span class="nt">></span>
+ <span class="nt"><complex-scripts</span> <span class="na">disabled=</span><span class="s">"true"</span><span class="nt">/></span>
+ ...
+<span class="nt"></fop></span>`
+</pre></div>
+
+
+</li>
+</ol>
+<p>When complex scripts features are enabled, additional information related to bidirectional level resolution, the association between characters and glyphs, and glyph position adjustments are added to the internal, parsed representation of the XSL-FO tree and its corresponding formatted area tree. This additional information will somewhat increase the memory requirements for processing documents that use these features.</p>
+<p><note>A document author need not make explicit use of any complex scripts feature in order for this additional information to be created. For example, if the author makes use of a font that contains OpenType GSUB and/or GPOS tables, then those tables will be automatically used unless complex scripts features are disabled.</note></p>
+<h2 id="source">Changes to your XSL-FO input files</h2>
+<p>In most circumstances, XSL-FO content does not need to change in order to make use of complex scripts features; however, in certain contexts, fully automatic processing is not sufficient. In these cases, an author may make use of the following XSL-FO constructs:</p>
+<ul>
+<li>
+<p>The <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#script">script</a> property.</p>
+</li>
+<li>
+<p>The <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#language">language</a> property.</p>
+</li>
+<li>
+<p>The <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#writing-mode">writing-mode</a> property.</p>
+</li>
+<li>
+<p>The number to string conversion properties: <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#format">format</a>, <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#grouping-separator">grouping-separator</a>, <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#grouping-size">grouping-size</a>, <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#letter-value">letter-value</a>, and <code>fox:number-conversion-features</code>.</p>
+</li>
+<li>
+<p>The <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#fo_bidi-override">fo:bidi-override</a> element.</p>
+</li>
+<li>
+<p>Explicit bidirectional control characters: U+200E LRM, U+200F RLM, U+202A LRE, U+202B RLE, U+202C PDF, U+202D LRO, U+202E RLO.</p>
+</li>
+<li>
+<p>Explicit join control characters: U+200C ZWNJ and U+200D ZWJ.</p>
+</li>
+</ul>
+<h2 id="details">Authoring Details</h2>
+<p>The complex scripts related effects of the above enumerated XSL-FO constructs are more fully described in the following sub-sections.</p>
+<h3 id="script_property">Script Property</h3>
+<p>In order to apply font specific complex script features, it is necessary to know the script that applies to the text undergoing layout processing. This script is determined using the following algorithm:</p>
+<ol>
+<li>
+<p>If the FO element that governs the text specifies a <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#script">http://www.w3.org/TR/2006/REC-xsl11-20061205/#script</a> property and its value is not the empty string or <code>"auto"</code>, then that script is used.</p>
+</li>
+<li>
+<p>Otherwise, the dominant script of the text is determined automatically by finding the script whose constituent characters appear most frequently in the text.</p>
+</li>
+</ol>
+<p>In case the automatic algorithm does not produce the desired results, an author may explicitly specify a <code>script</code> property with the desired script. If specified, it must be one of the four-letter script code specified in <a href="http://unicode.org/iso15924/iso15924-codes.html">ISO 15924 Code List</a> or in the <a href="#extended_script_codes">Extended Script Codes</a> table. Comparison of script codes is performed in a case-insensitive manner, so it does not matter what case is used when specifying these codes in an XSL-FO document.</p>
+<h4 id="standard_script_codes">Standard Script Codes</h4>
+<p>The following table enumerates the standard ISO 15924 4-letter codes recognized by FOP.</p>
+<table>
+<thead>
+<tr>
+<th>Code</th>
+<th>Script</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>arab</code></td>
+<td>Arabic</td>
+</tr>
+<tr>
+<td><code>beng</code></td>
+<td>Bengali</td>
+</tr>
+<tr>
+<td><code>bopo</code></td>
+<td>Bopomofo</td>
+</tr>
+<tr>
+<td><code>cyrl</code></td>
+<td>Cyrillic</td>
+</tr>
+<tr>
+<td><code>deva</code></td>
+<td>Devanagari</td>
+</tr>
+<tr>
+<td><code>ethi</code></td>
+<td>Ethiopic</td>
+</tr>
+<tr>
+<td><code>geor</code></td>
+<td>Georgian</td>
+</tr>
+<tr>
+<td><code>grek</code></td>
+<td>Greek</td>
+</tr>
+<tr>
+<td><code>gujr</code></td>
+<td>Gujarati</td>
+</tr>
+<tr>
+<td><code>guru</code></td>
+<td>Gurmukhi</td>
+</tr>
+<tr>
+<td><code>hang</code></td>
+<td>Hangul</td>
+</tr>
+<tr>
+<td><code>hani</code></td>
+<td>Han</td>
+</tr>
+<tr>
+<td><code>hebr</code></td>
+<td>Hebrew</td>
+</tr>
+<tr>
+<td><code>hira</code></td>
+<td>Hiragana</td>
+</tr>
+<tr>
+<td><code>kana</code></td>
+<td>Katakana</td>
+</tr>
+<tr>
+<td><code>knda</code></td>
+<td>Kannada</td>
+</tr>
+<tr>
+<td><code>khmr</code></td>
+<td>Khmer</td>
+</tr>
+<tr>
+<td><code>laoo</code></td>
+<td>Lao</td>
+</tr>
+<tr>
+<td><code>latn</code></td>
+<td>Latin</td>
+</tr>
+<tr>
+<td><code>mlym</code></td>
+<td>Malayalam</td>
+</tr>
+<tr>
+<td><code>mymr</code></td>
+<td>Burmese</td>
+</tr>
+<tr>
+<td><code>mong</code></td>
+<td>Mongolian</td>
+</tr>
+<tr>
+<td><code>orya</code></td>
+<td>Oriya</td>
+</tr>
+<tr>
+<td><code>sinh</code></td>
+<td>Sinhalese</td>
+</tr>
+<tr>
+<td><code>taml</code></td>
+<td>Tamil</td>
+</tr>
+<tr>
+<td><code>telu</code></td>
+<td>Telugu</td>
+</tr>
+<tr>
+<td><code>thai</code></td>
+<td>Thai</td>
+</tr>
+<tr>
+<td><code>tibt</code></td>
+<td>Tibetan</td>
+</tr>
+<tr>
+<td><code>zmth</code></td>
+<td>Math</td>
+</tr>
+<tr>
+<td><code>zsym</code></td>
+<td>Symbol</td>
+</tr>
+<tr>
+<td><code>zyyy</code></td>
+<td>Undetermined</td>
+</tr>
+<tr>
+<td><code>zzzz</code></td>
+<td>Uncoded</td>
+</tr>
+</tbody>
+</table>
+<h4 id="extended_script_codes">Extended Script Codes</h4>
+<p>The following table enumerates a number of non-standard extended script codes recognized by FOP.</p>
+<table>
+<thead>
+<tr>
+<th>Code</th>
+<th>Script</th>
+<th>Comments</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>bng2</code></td>
+<td>Bengali</td>
+<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
+</tr>
+<tr>
+<td><code>dev2</code></td>
+<td>Devanagari</td>
+<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
+</tr>
+<tr>
+<td><code>gur2</code></td>
+<td>Gurmukhi</td>
+<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
+</tr>
+<tr>
+<td><code>gjr2</code></td>
+<td>Gujarati</td>
+<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
+</tr>
+<tr>
+<td><code>knd2</code></td>
+<td>Kannada</td>
+<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
+</tr>
+<tr>
+<td><code>mlm2</code></td>
+<td>Malayalam</td>
+<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
+</tr>
+<tr>
+<td><code>ory2</code></td>
+<td>Oriya</td>
+<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
+</tr>
+<tr>
+<td><code>tml2</code></td>
+<td>Tamil</td>
+<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
+</tr>
+<tr>
+<td><code>tel2</code></td>
+<td>Telugu</td>
+<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
+</tr>
+</tbody>
+</table>
+<p><warning>Explicit use of one of the above extended script codes is not portable, and should be limited to use with FOP only.</warning></p>
+<p><note>When performing automatic script determination, FOP selects the OpenType Indic Version 2 script codes by default. If the author requires Version 1 behavior, then an explicit, non-extension script code should be specified in a governing <code>script</code> property.</note></p>
+<h3 id="language_property">Language Property</h3>
+<p>Certain fonts that support complex script features can make use of language information in order for language specific processing rules to be applied. For example, a font designed for the Arabic script may support typographic variations according to whether the written language is Arabic, Farsi (Persian), Sindhi, Urdu, or another language written with the Arabic script. In order to apply these language specific features, the author may explicitly mark the text with a <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#language">http://www.w3.org/TR/2006/REC-xsl11-20061205/#language</a> property.</p>
+<p>When specifying the <code>language</code> property, the value of the property must be either an <a href="http://en.wikipedia.org/wiki/List_of_ISO_639-2_codes">ISO639-2 3-letter code</a> or an <a href="http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO639-1 2-letter code</a>. Comparison of language codes is performed in a case-insensitive manner, so it does not matter what case is used when specifying these codes in an XSL-FO document.</p>
+<h3 id="writing_mode_property">Writing Mode Property</h3>
+<p>The <code>writing-mode</code> property is used to determine the axes and direction of the inline progression direction, the block progression direction, the column progression direction (in tables and flows), the shift direction, region placement, the resolution of writing-mode relative property values (such as start, end, before, after), and the default block (paragraph) bidirectionality level.</p>
+<p>The <code>writing-mode</code> property is inherited, so it can appear on any XSL-FO element type; however, it applies (semantically) only to the following element types:</p>
+<ul>
+<li>
+<p><code>fo:page-sequence</code></p>
+</li>
+<li>
+<p><code>fo:simple-page-master</code></p>
+</li>
+<li>
+<p><code>fo:region-*</code></p>
+</li>
+<li>
+<p><code>fo:block-container</code></p>
+</li>
+<li>
+<p><code>fo:inline-container</code></p>
+</li>
+<li>
+<p><code>fo:table</code></p>
+</li>
+</ul>
+<p>If it is not specified on one of these element types, but is specified on an ancestor element, then the value specified on that ancestor element (the inherited value) is used; otherwise, the initial value <code>lr-tb</code> is used.</p>
+<p>At present, only the following values of the <code>writing-mode</code> property are supported:</p>
+<ul>
+<li>
+<p><code>lr-tb</code></p>
+</li>
+<li>
+<p><code>rl-tb</code></p>
+</li>
+<li>
+<p><code>lr</code></p>
+</li>
+<li>
+<p><code>rl</code></p>
+</li>
+</ul>
+<p>Writing modes that employ a vertical inline progression direction are not yet supported.</p>
+<h3 id="number_conversion_properties">Number Conversion Properties</h3>
+<h3 id="bidi_override_element">Bidi Override Element</h3>
+<p>The <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#fo_bidi-override">fo:bidi-override</a> element may be used to override default bidirectional processing behavior, including default embedding levels and default character directionality. In the absence of either this element or use of explicit <a href="#bidi_controls">Bidi Control Characters</a>, the default behavior prescribed by the <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#fo_bidi-override">Unicode Bidirectional Algorithm</a> applies.</p>
+<h3 id="bidi_controls">Bidi Control Characters</h3>
+<p>In addition to the use of the <a href="#bidi_override_element">Bidi Override Element</a>, an author may make use of the following explicit Unicode Bidi Control Characters:</p>
+<ul>
+<li>
+<p>U+200E - LEFT-TO-RIGHT MARK (LRM)</p>
+</li>
+<li>
+<p>U+200F - RIGHT-TO-LEFT MARK (RLM)</p>
+</li>
+<li>
+<p>U+202A - LEFT-TO-RIGHT EMBEDDING (LRE)</p>
+</li>
+<li>
+<p>U+202B - RIGHT-TO-LEFT EMBEDDING (RLE)</p>
+</li>
+<li>
+<p>U+202C - POP DIRECTIONAL FORMATTING (PDF)</p>
+</li>
+<li>
+<p>U+202D - LEFT-TO-RIGHT OVERRIDE (LRO)</p>
+</li>
+<li>
+<p>U+202E - RIGHT-TO-LEFT OVERRIDE (RLO)</p>
+</li>
+</ul>
+<p>If an embedding or override is not terminated (using U+202C PDF) prior to the end of a <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#d0e4879">delimited text range</a>, then it is automatically terminated by FOP.</p>
+<h3 id="join_controls">Join Control Characters</h3>
+<p>In order to prevent joining behavior in contexts where joining occurs by default, for example, between U+0628 ARABIC LETTER BEH and U+0646 ARABIC LETTER NOON, an author may used a U+200C ZERO WIDTH NON-JOINER (ZWNJ).</p>
+<p>Conversely, in order to force joining behavior in contexts where joining does not occur by default, for example, between U+0628 ARABIC LETTER BEH and U+0020 SPACE, an author may used a U+200D ZERO WIDTH JOINER (ZWJ).</p>
+<p>The behavior of ZWNJ and ZWJ is script specific. See <a href="http://www.unicode.org/versions/Unicode6.1.0/ch08.pdf">The Unicode Standard, Chapter 8, Middle Eastern Scripts</a> for information on the use of these control characters with the Arabic script. See <a href="http://www.unicode.org/versions/Unicode6.1.0/ch09.pdf">The Unicode Standard, Chapter 9, South Asian Scripts - I</a> for information on the use of these control characters with common Indic scripts.</p>
+<h2 id="supported_scripts">Supported Scripts</h2>
+<p>Support for specific complex scripts is enumerated in the following table. Support for those marked as not being supported is expected to be added in future revisions.</p>
+<table>
+<thead>
+<tr>
+<th>Script</th>
+<th>Support</th>
+<th>Tested</th>
+<th>Comments</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Arabic_alphabet">Arabic</a></td>
+<td>full</td>
+<td>full</td>
+<td></td>
+</tr>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Bengali_alphabet">Bengali</a></td>
+<td>none</td>
+<td>none</td>
+<td></td>
+</tr>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Burmese_alphabet">Burmese</a></td>
+<td>none</td>
+<td>none</td>
+<td></td>
+</tr>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Devanagari_alphabet">Devanagari</a></td>
+<td>partial</td>
+<td>partial</td>
+<td>join controls (ZWJ, ZWNJ) not yet supported</td>
+</tr>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Khmer_alphabet">Khmer</a></td>
+<td>none</td>
+<td>none</td>
+<td></td>
+</tr>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Gujarati_alphabet">Gujarati</a></td>
+<td>partial</td>
+<td>none</td>
+<td>pre-alpha</td>
+</tr>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Gurmukhī_alphabet">Gurmukhi</a></td>
+<td>partial</td>
+<td>none</td>
+<td>pre-alpha</td>
+</tr>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Hebrew_alphabet">Hebrew</a></td>
+<td>full</td>
+<td>partial</td>
+<td></td>
+</tr>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Kannada_alphabet">Kannada</a></td>
+<td>none</td>
+<td>none</td>
+<td></td>
+</tr>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Lao_alphabet">Lao</a></td>
+<td>none</td>
+<td>none</td>
+<td></td>
+</tr>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Malayalam_alphabet">Malayalam</a></td>
+<td>none</td>
+<td>none</td>
+<td></td>
+</tr>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Mongolian_script">Mongolian</a></td>
+<td>none</td>
+<td>none</td>
+<td></td>
+</tr>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Oriya_script">Oriya</a></td>
+<td>none</td>
+<td>none</td>
+<td></td>
+</tr>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Tamil_alphabet">Tamil</a></td>
+<td>none</td>
+<td>none</td>
+<td></td>
+</tr>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Telugu_alphabet">Telugu</a></td>
+<td>none</td>
+<td>none</td>
+<td></td>
+</tr>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Tibetan_alphabet">Tibetan</a></td>
+<td>none</td>
+<td>none</td>
+<td></td>
+</tr>
+<tr>
+<td><a href="http://en.wikipedia.org/wiki/Thai_alphabet">Thai</a></td>
+<td>none</td>
+<td>none</td>
+<td></td>
+</tr>
+</tbody>
+</table>
+<h2 id="supported_fonts">Supported Fonts</h2>
+<p>Support for specific fonts is enumerated in the following sub-sections. If a given font is not listed, then it has not been tested with these complex scripts features.</p>
+<h3 id="fonts_arabic">Arabic Fonts</h3>
+<table>
+<thead>
+<tr>
+<th>Font</th>
+<th>Version</th>
+<th>Glyphs</th>
+<th>Comments</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="http://www.microsoft.com/typography/fonts/family.aspx?FID=24">Arial Unicode MS</a></td>
+<td><a href="http://www.microsoft.com/typography/fonts/font.aspx?FMID=1081">1.01</a></td>
+<td>50377</td>
+<td>limited GPOS support</td>
+</tr>
+<tr>
+<td><a href="http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=ArabicFonts">Lateef</a></td>
+<td>1.0</td>
+<td>1147</td>
+<td>language features for Kurdish (KUR), Sindhi (SND), Urdu (URD)</td>
+</tr>
+<tr>
+<td><a href="http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=ArabicFonts">Scheherazade</a></td>
+<td>1.0</td>
+<td>1197</td>
+<td>language features for Kurdish (KUR), Sindhi (SND), Urdu (URD)</td>
+</tr>
+<tr>
+<td><a href="http://www.microsoft.com/typography/fonts/family.aspx?FID=261">Simplified Arabic</a></td>
+<td><a href="http://www.microsoft.com/typography/fonts/font.aspx?FMID=867">1.01</a></td>
+<td></td>
+<td>contains invalid, out of order coverage table entries</td>
+</tr>
+<tr>
+<td><a href="http://www.microsoft.com/typography/fonts/font.aspx?FID=261">Simplified Arabic</a></td>
+<td><a href="http://www.microsoft.com/typography/fonts/font.aspx?FMID=1645">5.00</a></td>
+<td>414</td>
+<td>lacks GPOS support</td>
+</tr>
+<tr>
+<td><a href="http://www.microsoft.com/typography/fonts/font.aspx?FID=261">Simplified Arabic</a></td>
+<td>5.92</td>
+<td>473</td>
+<td>includes GPOS for advanced position adjustment</td>
+</tr>
+<tr>
+<td><a href="http://www.microsoft.com/typography/fonts/family.aspx?FID=264">Traditional Arabic</a></td>
+<td><a href="http://www.microsoft.com/typography/fonts/family.aspx?FMID=877">1.01</a></td>
+<td>530</td>
+<td>lacks GPOS support</td>
+</tr>
+<tr>
+<td><a href="http://www.microsoft.com/typography/fonts/font.aspx?FID=264">Traditional Arabic</a></td>
+<td><a href="http://www.microsoft.com/typography/fonts/font.aspx?FMID=1658">5.00</a></td>
+<td>530</td>
+<td>lacks GPOS support</td>
+</tr>
+<tr>
+<td><a href="http://www.microsoft.com/typography/fonts/font.aspx?FID=264">Traditional Arabic</a></td>
+<td>5.92</td>
+<td>589</td>
+<td>includes GPOS for advanced position adjustment</td>
+</tr>
+</tbody>
+</table>
+<h3 id="devanagari_fonts">Devanagari Fonts</h3>
+<table>
+<thead>
+<tr>
+<th>Font</th>
+<th>Version</th>
+<th>Glyphs</th>
+<th>Comments</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="http://www.microsoft.com/typography/fonts/family.aspx?FID=370">Aparajita</a></td>
+<td><a href="http://www.microsoft.com/typography/fonts/font.aspx?FMID=1700">1.00</a></td>
+<td>706</td>
+<td></td>
+</tr>
+<tr>
+<td><a href="http://www.microsoft.com/typography/fonts/family.aspx?FID=374">Kokila</a></td>
+<td><a href="http://www.microsoft.com/typography/fonts/font.aspx?FMID=1749">1.00</a></td>
+<td>706</td>
+<td></td>
+</tr>
+<tr>
+<td><a href="http://www.microsoft.com/typography/fonts/family.aspx?FID=243">Mangal</a></td>
+<td><a href="http://www.microsoft.com/typography/fonts/font.aspx?FMID=1759">5.01</a></td>
+<td>885</td>
+<td>designed for use in user interfaces</td>
+</tr>
+<tr>
+<td><a href="http://www.microsoft.com/typography/fonts/family.aspx?FID=384">Utsaah</a></td>
+<td><a href="http://www.microsoft.com/typography/fonts/font.aspx?FMID=1811">1.00</a></td>
+<td>706</td>
+<td></td>
+</tr>
+</tbody>
+</table>
+<h2 id="limitations">Other Limitations</h2>
+<p>Complex scripts support in Apache FOP is relatively new, so there are certain limitations. Please help us identify and close any gaps.</p>
+<ul>
+<li>
+<p>Only the PDF output format fully supports complex scripts features at the present time.</p>
+</li>
+<li>
+<p>Shaping context does not extend across an element boundary. This limitation prevents the use of <code>fo:character</code>, <code>fo:inline</code> or <code>fo:wrapper</code> in order to colorize individual Arabic letters without affecting shaping behavior across the element boundary.</p>
+</li>
+</ul>
+<h2 id="links">Related Links</h2>
+<p>In addition to the XSL-FO specification, a number of external resources provide guidance about authoring documents that employ complex scripts and the features described above:</p>
+<ul>
+<li>
+<p><a href="http://www.unicode.org/">The Unicode Standard</a></p>
+</li>
+<li>
+<p><a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#fo_bidi-override">Unicode Bidirectional Algorithm</a></p>
+</li>
+<li>
+<p><a href="http://www.microsoft.com/typography/otspec/ttochap1.htm">OpenType Advanced Typographic Extensions</a></p>
+</li>
+<li>
+<p><a href="http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=CmplxRndExamples">Examples of Complex Rendering</a></p>
+</li>
+</ul></div>
+ </div>
+
+ <div class="clear"></div>
+
+ <div id="footer">
+ <div class="copyright">
+ <div style="float:left; padding: 7px;">
+ <a title="Apache Software Foundation" href="http://www.apache.org"><img id="asf-feather-logo" alt="Apache Software Foundation" src="/images/feather-small.gif" width="100" /></a>
+ </div>
+ <p>
+ Copyright © 2013 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache, Apache XML Graphics, Apache FOP, Apache Batik, the Apache feather logo, and the
+ Apache XML Graphics logos are trademarks of <a href="http://www.apache.org">The Apache
+ Software Foundation</a>. All other marks mentioned may be trademarks or registered
+ trademarks of their respective owners.
+ <br />
+ </p>
+ </div>
+ </div>
+
+
+ </body>
+</html>
Added: websites/staging/xmlgraphics/trunk/content/fop/2.0/configuration.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/2.0/configuration.html (added)
+++ websites/staging/xmlgraphics/trunk/content/fop/2.0/configuration.html Thu May 21 15:08:45 2015
@@ -0,0 +1,727 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <title>Apache(tm) FOP: Configuration</title>
+
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <meta property="og:image" content="http://www.apache.org/images/asf_logo.gif" />
+<!--
+ <link rel="stylesheet" type="text/css" media="screen" href="http://www.apache.org/css/style.css">
+-->
+ <link rel="stylesheet" type="text/css" media="screen" href="//www.apache.org/css/code.css">
+ <link href="/css/profile.css" rel="stylesheet" type="text/css" />
+ <link href="/css/xmlgraphics.css" rel="stylesheet" type="text/css" />
+ <link href="/css/print.css" rel="stylesheet" type="text/css" media="print" />
+
+ <script src="//code.jquery.com/jquery.min.js"></script>
+ <script type="text/javascript" src="/js/jquery.stoc.js"></script>
+ <script>
+ $(document).ready(function(){
+ $('ul#navigation a').each(function() {
+ if (this.href === window.location.href)
+ { $(this). attr('id', 'forefront');}
+ });
+ $('ul#navigation a#forefront').each(function() {
+
+ });
+ })
+ $(function(){
+ $("#items").stoc({ search: "#content", stocTitle: "<h3>Page Contents</h3>" });
+ });
+ </script>
+
+
+
+
+
+ <style>
+ .highlight {color: red;}
+ </style>
+
+ </head>
+
+ <body>
+
+ <div id="banner">
+ </div>
+
+ <div id="navigation">
+ <p><a href="/"><img alt="Apache XML Graphics Project Logo" src="/images/apache-xml-graphics.gif" title="Apache XML Graphics Project" /></a></p>
+<h1 id="apachewzxhzdk2-fop">Apache™ FOP</h1>
+<ul>
+<li><a href="/fop/">FOP Home</a></li>
+<li><a href="/fop/download.html">Download</a></li>
+<li><a href="/fop/quickstartguide.html">Quick Start Guide</a></li>
+<li><a href="/fop/compliance.html">Compliance</a></li>
+<li><a href="/fop/gethelp.html">Getting Help</a></li>
+<li><a href="/fop/faq.html">FAQs</a></li>
+<li><a href="/fop/maillist.html">Mailing Lists</a></li>
+<li><a href="/fop/license.html">License</a></li>
+<li>
+<h2 id="resources">Resources</h2>
+<ul>
+<li><a href="/fop/fo.html">XSL-FO</a></li>
+<li><a href="/fop/examples.html">Examples</a></li>
+<li><a href="/fop/bugs.html">Bugs</a></li>
+<li><a href="http://wiki.apache.org/xmlgraphics-fop/FrontPage">Wiki</a></li>
+<li><a href="/fop/resources.html">Other</a></li>
+</ul>
+</li>
+<li>
+<h2 id="project">Project</h2>
+<ul>
+<li><a href="/fop/news.html">News</a></li>
+<li><a href="/fop/team.html">Who We Are</a></li>
+<li><a href="/fop/status.html">Status</a></li>
+<li><a href="/fop/knownissues.html">Known Issues</a></li>
+<li><a href="/fop/changes.html">Changes</a></li>
+</ul>
+</li>
+<li>
+<h2 id="versions">Versions</h2>
+<ul>
+<li>
+<h2 id="fop-trunk-dev">FOP Trunk (dev)</h2>
+<ul>
+<li><a href="/fop/trunk/">Overview</a></li>
+<li><a href="/fop/trunk/upgrading.html">Upgrading</a></li>
+<li>
+<h3 id="using-apachewzxhzdk7-fop">Using Apache™ FOP</h3>
+<ul>
+<li><a href="/fop/trunk/compiling.html">Build</a></li>
+<li><a href="/fop/trunk/configuration.html">Configure</a></li>
+<li><a href="/fop/trunk/running.html">Run</a></li>
+<li><a href="/fop/trunk/embedding.html">Embed</a></li>
+<li><a href="/fop/trunk/servlets.html">Servlets</a></li>
+<li><a href="/fop/trunk/anttask.html">Ant Task</a></li>
+</ul>
+</li>
+<li>
+<h3 id="features">Features</h3>
+<ul>
+<li><a href="/fop/trunk/accessibility.html">Accessibility</a></li>
+<li><a href="/fop/trunk/complexscripts.html">Complex Scripts</a></li>
+<li><a href="/fop/trunk/events.html">Events</a></li>
+<li><a href="/fop/trunk/extensions.html">Extensions</a></li>
+<li><a href="/fop/trunk/fonts.html">Fonts</a></li>
+<li><a href="/fop/trunk/graphics.html">Graphics</a></li>
+<li><a href="/fop/trunk/hyphenation.html">Hyphenation</a></li>
+<li><a href="/fop/trunk/intermediate.html">Intermediate Format</a></li>
+<li><a href="/fop/trunk/metadata.html">Metadata</a></li>
+<li><a href="/fop/trunk/output.html">Output Targets</a></li>
+<li><a href="/fop/trunk/pdfa.html">PDF/A</a></li>
+<li><a href="/fop/trunk/pdfx.html">PDF/X</a></li>
+<li><a href="/fop/trunk/pdfencryption.html">PDF Encryption</a></li>
+<li><a href="/fop/fop-pdf-images.html">PDF Images</a></li>
+<li><a href="/fop/trunk/whitespacemanagement.html">Whitespace Management</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<h2 id="fop-11">FOP 1.1</h2>
+<ul>
+<li><a href="/fop/1.1/">FOP 1.1 Overview</a></li>
+<li><a href="/fop/1.1/releaseNotes_1.1.html">Release Notes</a></li>
+<li><a href="/fop/1.1/changes_1.1.html">Changes (1.1)</a></li>
+<li><a href="/fop/1.1/knownissues_overview.html">Known Issues</a></li>
+<li><a href="/fop/1.1/upgrading.html">Upgrading</a></li>
+<li>
+<h3 id="using-apache-fop-11">Using Apache FOP 1.1</h3>
+<ul>
+<li><a href="/fop/1.1/compiling.html">Build</a></li>
+<li><a href="/fop/1.1/configuration.html">Configure</a></li>
+<li><a href="/fop/1.1/running.html">Run</a></li>
+<li><a href="/fop/1.1/embedding.html">Embed</a></li>
+<li><a href="/fop/1.1/servlets.html">Servlets</a></li>
+<li><a href="/fop/1.1/anttask.html">Ant Task</a></li>
+</ul>
+</li>
+<li>
+<h3 id="features_1">Features</h3>
+<ul>
+<li><a href="/fop/1.1/accessibility.html">Accessibility</a></li>
+<li><a href="/fop/1.1/complexscripts.html">Complex Scripts</a></li>
+<li><a href="/fop/1.1/events.html">Events</a></li>
+<li><a href="/fop/1.1/extensions.html">Extensions</a></li>
+<li><a href="/fop/1.1/fonts.html">Fonts</a></li>
+<li><a href="/fop/1.1/graphics.html">Graphics</a></li>
+<li><a href="/fop/1.1/hyphenation.html">Hyphenation</a></li>
+<li><a href="/fop/1.1/intermediate.html">Intermediate Format</a></li>
+<li><a href="/fop/1.1/metadata.html">Metadata</a></li>
+<li><a href="/fop/1.1/output.html">Output Targets</a></li>
+<li><a href="/fop/1.1/pdfa.html">PDF/A</a></li>
+<li><a href="/fop/1.1/pdfx.html">PDF/X</a></li>
+<li><a href="/fop/1.1/pdfencryption.html">PDF Encryption</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<h2 id="fop-10">FOP 1.0</h2>
+<ul>
+<li><a href="/fop/1.0/">FOP 1.0 Overview</a></li>
+<li><a href="/fop/1.0/releaseNotes_1.0.html">Release Notes</a></li>
+<li><a href="/fop/1.0/changes_1.0.html">Changes (1.0)</a></li>
+<li><a href="/fop/1.0/knownissues_overview.html">Known Issues</a></li>
+<li><a href="/fop/1.0/upgrading.html">Upgrading</a></li>
+<li>
+<h3 id="using-apache-fop-10">Using Apache FOP 1.0</h3>
+<ul>
+<li><a href="/fop/1.0/compiling.html">Build</a></li>
+<li><a href="/fop/1.0/configuration.html">Configure</a></li>
+<li><a href="/fop/1.0/running.html">Run</a></li>
+<li><a href="/fop/1.0/embedding.html">Embed</a></li>
+<li><a href="/fop/1.0/servlets.html">Servlets</a></li>
+<li><a href="/fop/1.0/anttask.html">Ant Task</a></li>
+</ul>
+</li>
+<li>
+<h3 id="features_2">Features</h3>
+<ul>
+<li><a href="/fop/1.0/output.html">Output Targets</a></li>
+<li><a href="/fop/1.0/intermediate.html">Intermediate Format</a></li>
+<li><a href="/fop/1.0/pdfencryption.html">PDF Encryption</a></li>
+<li><a href="/fop/1.0/pdfa.html">PDF/A</a></li>
+<li><a href="/fop/1.0/pdfx.html">PDF/X</a></li>
+<li><a href="/fop/1.0/graphics.html">Graphics</a></li>
+<li><a href="/fop/1.0/fonts.html">Fonts</a></li>
+<li><a href="/fop/1.0/hyphenation.html">Hyphenation</a></li>
+<li><a href="/fop/1.0/extensions.html">Extensions</a></li>
+<li><a href="/fop/1.0/events.html">Events</a></li>
+<li><a href="/fop/1.0/metadata.html">Metadata</a></li>
+<li><a href="/fop/1.0/accessibility.html">Accessibility</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<h2 id="fop-development">FOP Development</h2>
+<ul>
+<li><a href="/fop/dev/">General Info</a></li>
+<li>
+<h2 id="design">Design</h2>
+<ul>
+<li><a href="/fop/dev/design/">Design Info</a></li>
+</ul>
+</li>
+<li>
+<h2 id="core-process">Core Process</h2>
+<ul>
+<li><a href="/fop/dev/design/startup.html">Startup</a></li>
+<li><a href="/fop/dev/design/parsing.html">XML Parsing</a></li>
+<li><a href="/fop/dev/design/fotree.html">FO Tree</a></li>
+<li><a href="/fop/dev/design/properties.html">Properties</a></li>
+<li><a href="/fop/dev/design/layout.html">Layout</a></li>
+<li><a href="/fop/dev/design/breakpos.html">Break Possibility</a></li>
+<li><a href="/fop/dev/design/areas.html">Area Tree</a></li>
+<li><a href="/fop/dev/design/renderers.html">Renderers</a></li>
+</ul>
+</li>
+<li>
+<h2 id="miscellaneous">Miscellaneous</h2>
+<ul>
+<li><a href="/fop/dev/design/images.html">Images</a></li>
+<li><a href="/fop/dev/design/pdf-library.html">PDF Library</a></li>
+<li><a href="/fop/dev/design/svg.html">SVG</a></li>
+<li><a href="/fop/dev/design/embedding.html">Embedding</a></li>
+<li><a href="/fop/dev/design/extending.html">Extending</a></li>
+<li><a href="/fop/dev/design/optimise.html">Optimisations</a></li>
+<li><a href="/fop/dev/design/useragent.html">User Agent</a></li>
+</ul>
+</li>
+<li><a href="http://wiki.apache.org/xmlgraphics-fop/FOPProjectPages">Unresolved (Wiki)</a></li>
+<li><a href="/fop/dev/svg.html">SVG</a></li>
+<li><a href="/fop/dev/extensions.html">Extensions</a></li>
+<li>
+<h2 id="develop">Develop</h2>
+<ul>
+<li><a href="/fop/dev/implement.html">Walk-Thru</a></li>
+<li><a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20FOP%20AND%20description%20~%20%22\%22[patch]\%22%22%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29">Patch Queue</a></li>
+<li><a href="/fop/dev/conventions.html">Conventions</a></li>
+</ul>
+</li>
+<li>
+<h2 id="test">Test</h2>
+<ul>
+<li><a href="/fop/dev/testing.html">Testing</a></li>
+</ul>
+</li>
+<li>
+<h2 id="deploy">Deploy</h2>
+<ul>
+<li><a href="/fop/dev/doc.html">Doc Mgmt</a></li>
+<li><a href="/fop/dev/release.html">Release</a></li>
+<li><a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20FOP%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29">Bugs</a></li>
+</ul>
+</li>
+<li>
+<h2 id="resources_1">Resources</h2>
+<ul>
+<li><a href="/fop/dev/faq.html">FAQs</a></li>
+<li><a href="/fop/dev/tools.html">Tools</a></li>
+<li><a href="http://svn.apache.org/viewvc/xmlgraphics/fop">ViewVC</a></li>
+</ul>
+</li>
+<li>
+<h2 id="subpackages">SubPackages</h2>
+<ul>
+<li><a href="/fop/dev/rtflib.html">RTFlib</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<h1 id="apachewzxhzdk3-xml-graphics">Apache™ XML Graphics</h1>
+<ul>
+<li>
+<h2 id="project-overview">Project Overview</h2>
+<ul>
+<li><a href="/team.html">Who We Are</a></li>
+<li><a href="/legal.html">Legal Stuff</a></li>
+<li><a href="/charter.html">Project Charter</a></li>
+<li><a href="/mail.html">Mailing Lists</a></li>
+<li><a href="/repo.html">Code Repositories</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">ASF Sponsorship Program</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">ASF Thanks</a></li>
+<li><a href="http://www.apache.org/licenses/">Licenses</a></li>
+<li><a href="/security.html">Apache XML Graphics Security</a></li>
+<li><a href="http://www.apache.org/security/">ASF Security</a></li>
+</ul>
+</li>
+</ul>
+<h1 id="sub-projects">Sub Projects</h1>
+<ul>
+<li><a href="/batik/">Apache Batik</a></li>
+<li><a href="/commons/">Apache XML Graphics Commons</a></li>
+</ul>
+<h3 id="search-apache-xml-graphics">Search Apache XML Graphics</h3>
+<form name="search" id="search" action="http://www.google.com/search" method="get">
+ <input value="xmlgraphics.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" />
+ <input type="submit" id="submit" value="Search" />
+</form>
+
+<h3 id="apachecon-n-america">ApacheCon N. America</h3>
+<p><a href="http://na.apachecon.com/"><img alt="ApacheCon North America" src="https://farm8.staticflickr.com/7566/15408186664_d08f3881c9_t.jpg" title="ApacheCon North America" /></a></p>
+<ul>
+<li><strong><a href="http://na.apachecon.com/">ApacheCon NA</a></strong></li>
+</ul>
+<h3 id="apachecon-europe">ApacheCon Europe</h3>
+<p><a href="http://apachecon.eu/" title="ApacheCon Europe"><img alt="ApacheCon Europe" src="http://www.apache.org/ads/ApacheCon/2014-eu-234x60.png" width="225" /></a></p>
+<ul>
+<li><strong><a href="http://apachecon.eu/">ApacheCon Europe</a></strong></li>
+</ul>
+<p>Hope to see you there!</p>
+<script>
+$(document).ready(function () {
+ $('#navigation :header').click(function () {
+ var text = $(this).siblings('ul');
+ if (text.is(':hidden')) {
+ text.slideDown('200');
+ } else {
+ text.slideUp('200');
+ }
+ });
+ if ($('#navigation :header').siblings('ul')) {
+ $('#navigation :header').not('#search-apache-xml-graphics, #apachewzxhzdk3-xml-graphics, #sub-projects').append(' »');
+ }
+ $('#navigation > ul > li > ul > li ul').hide();
+ $('#project-overview').next().hide();
+ $('#versions').next().show();
+ var str=location.href.toLowerCase();
+ $("#navigation li a").each(function() {
+ if (str.indexOf(this.href.toLowerCase()) > -1) {
+ $(this).parents().slideDown('200');
+ $("li.highlight").removeClass("highlight");
+ $(this).parent().addClass("highlight");
+ }
+ });
+})
+</script>
+ </div>
+
+ <div id="bannertext" style="border-bottom: 2px dashed #666666; height: 70px;">
+ <a href="/fop/"><img src="/images/apache-fop-logo.jpg" alt="The Apache FOP Project" width="120" height="65" style="float:left; margin-right: 15px;" /></a>
+ <h2>The Apache™ FOP Project</h2>
+ </div><!-- <h1>Apache(tm) FOP: Configuration</h1> -->
+
+
+
+ <div id="content" class="grid_16">
+ <div id="items">
+ </div>
+ <!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/2.0/">2.0</a></div> -->
+ <div class="section-content"><h1 id="apachewzxhzdk12-fop-configuration">Apache™ FOP: Configuration</h1>
+<h2 id="general">Configuration File Basics</h2>
+<p>The Apache™ FOP configuration file is an XML file containing a variety of settings that are useful for controlling FOP's behavior, and for helping it find resources that you wish it to use.</p>
+<p>The easiest way to get started using a FOP configuration file is to copy the sample found at <code>{fop-dir}/conf/fop.xconf</code> to a location of your choice, and then to edit it according to your needs. It contains templates for the various configuration options, most of which are commented out. Remove the comments and change the settings for entries that you wish to use. Be sure to follow any instructions, including comments which specify the value range. Also, since the configuration file is XML, be sure to keep it well-formed.</p>
+<h3 id="general-available">Making Configuration Available to FOP</h3>
+<p>After creating your configuration file, you must tell FOP how to find it:</p>
+<ul>
+<li>
+<p>If running FOP from the command-line, see the "-c" command-line option in <a href="running.html">Running FOP</a>.</p>
+</li>
+<li>
+<p>If running FOP as an embedded application, see <a href="embedding.html#config-external">Embedding, Using a Configuration File</a>.</p>
+</li>
+</ul>
+<p>See <a href="embedding.html#config-internal">Setting the Configuration Programmatically</a> for instructions on how to do so in an embedded environment.</p>
+<h2 id="general-elements">Summary of the General Configuration Options</h2>
+<table>
+<thead>
+<tr>
+<th>Element</th>
+<th>Data Type (for the value)</th>
+<th>Description</th>
+<th>Default Value</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>base<sup id="fnref:1"><a class="footnote-ref" href="#fn:1" rel="footnote">1</a></sup></td>
+<td>URL or directory</td>
+<td>Specifies the base URL based on which relative URL will be resolved.</td>
+<td>current directory</td>
+</tr>
+<tr>
+<td>font-base<sup id="fnref:1"><a class="footnote-ref" href="#fn:1" rel="footnote">1</a></sup></td>
+<td>URL or directory</td>
+<td>Specifies the base URL based on which relative font URLs will be resolved.</td>
+<td>base URL/directory (above)</td>
+</tr>
+<tr>
+<td>hyphenation-base<sup id="fnref:1"><a class="footnote-ref" href="#fn:1" rel="footnote">1</a></sup></td>
+<td>URL or directory</td>
+<td>Specifies the base URL based on which relative URLs to hyphenation pattern files will be resolved. If not specified, support for user-supplied hyphenation patterns remains disabled.</td>
+<td>disabled</td>
+</tr>
+<tr>
+<td>hyphenation-pattern</td>
+<td>String, attribute lang, attribute country (optional)</td>
+<td>Register a file name for the hyphenation pattern for the mentioned language and country. Language ll and country CC must both consist of two letters.</td>
+<td>ll_CC</td>
+</tr>
+<tr>
+<td>source-resolution</td>
+<td>Integer, dpi</td>
+<td>Resolution in dpi (dots per inch) which is used internally to determine the pixel size for SVG images and bitmap images without resolution information.</td>
+<td>72 dpi</td>
+</tr>
+<tr>
+<td>target-resolution</td>
+<td>Integer, dpi</td>
+<td>Resolution in dpi (dots per inch) used to specify the output resolution for bitmap images generated by bitmap renderers (such as the TIFF renderer) and by bitmaps generated by Apache Batik for filter effects and such.</td>
+<td>72 dpi</td>
+</tr>
+<tr>
+<td>strict-configuration</td>
+<td>Boolean (true, false)</td>
+<td>Setting this option to 'true' will cause FOP to strictly verify the contents of the FOP configuration file to ensure that defined resources (such as fonts and base URLs/directories) are valid and available to FOP. Any errors found will cause FOP to immediately raise an exception.</td>
+<td>false</td>
+</tr>
+<tr>
+<td>strict-validation</td>
+<td>Boolean (true, false)</td>
+<td>Setting this option to 'false' causes FOP to be more forgiving about XSL-FO validity, for example, you're allowed to specify a border on a region-body which is supported by some FO implementations but is non-standard. Note that such a border would currently have no effect in Apache FOP.</td>
+<td>true</td>
+</tr>
+<tr>
+<td>break-indent-inheritance</td>
+<td>Boolean (true, false)</td>
+<td>Setting this option to 'true' causes FOP to use an alternative rule set to determine text indents specified through margins, start-indent and end-indent. Many commercial FO implementations have chosen to break the XSL specification in this aspect. This option tries to mimic their behaviour. Please note that Apache FOP may still not behave exactly like those implementations either because FOP has not fully matched the desired behaviour and because the behaviour among the commercial implementations varies. The default for this option (i.e. false) is to behave exactly like the specification describes.</td>
+<td>false</td>
+</tr>
+<tr>
+<td>complex-scripts</td>
+<td>attribute disabled (optional)</td>
+<td>If present and if an attribute 'disabled' is specified with the value 'false', then complex script features are disabled. The same result can be obtained on an FOP per-invocation basis by specifying a '-nocs' command line option when invoking FOP. When complex script features are disabled, all bidirectional processing and complex character to glyph mapping processing is disabled; in addition, the loading of GDEF, GSUB, and GPOS advanced typographic tables is disabled for OpenType and TrueType fonts. Unless disabled by this mechanism or by use of the '-nocs' command line option, complex script features will be enabled by default.</td>
+<td>n/a</td>
+</tr>
+<tr>
+<td>default-page-settings</td>
+<td>n/a</td>
+<td>Specifies the default width and height of a page if "auto" is specified for either or both values. Use "height" and "width" attributes on the default-page-settings element to specify the two values.</td>
+<td>"height" 11 inches, "width" 8.26 inches</td>
+</tr>
+<tr>
+<td>use-cache</td>
+<td>boolean (true, false)</td>
+<td>All fonts information that has been gathered as a result of "directory" or "auto-detect" font configurations will be cached for future rendering runs. This setting should improve performance on systems where fonts have been configured using the "directory" or "auto-detect" tag mechanisms. By default this option is switched on.</td>
+<td>true</td>
+</tr>
+<tr>
+<td>cache-file</td>
+<td>String</td>
+<td>This option specifies the file/directory path of the fop cache file. This file is currently only used to cache font triplet information for future reference.</td>
+<td>${base}/conf/fop.cache</td>
+</tr>
+<tr>
+<td>renderers</td>
+<td>(see text below)</td>
+<td>Contains the configuration for each renderer. See below.</td>
+<td>N/A</td>
+</tr>
+</tbody>
+</table>
+<p>This is an excerpt from the example configuration file coming with FOP:</p>
+<div class="codehilite"><pre><span class="nt"><fop</span> <span class="na">version=</span><span class="s">"1.0"</span><span class="nt">></span>
+
+ <span class="c"><!-- Strict user configuration --></span>
+ <span class="nt"><strict-configuration></span>true<span class="nt"></strict-configuration></span>
+
+ <span class="c"><!-- Strict FO validation --></span>
+ <span class="nt"><strict-validation></span>true<span class="nt"></strict-validation></span>
+
+ <span class="c"><!-- Base URL for resolving relative URLs --></span>
+ <span class="nt"><base></span>./<span class="nt"></base></span>
+
+ <span class="c"><!-- Font Base URL for resolving relative font URLs --></span>
+ <span class="nt"><font-base></span>./<span class="nt"></font-base></span>
+
+ <span class="c"><!-- Source resolution in dpi (dots/pixels per inch) for determining the size of pixels in SVG and bitmap images, default: 72dpi --></span>
+ <span class="nt"><source-resolution></span>72<span class="nt"></source-resolution></span>
+ <span class="c"><!-- Target resolution in dpi (dots/pixels per inch) for specifying the target resolution for generated bitmaps, default: 72dpi --></span>
+ <span class="nt"><target-resolution></span>72<span class="nt"></target-resolution></span>
+
+ <span class="c"><!-- default page-height and page-width, in case</span>
+<span class="c"> value is specified as auto --></span>
+ <span class="nt"><default-page-settings</span> <span class="na">height=</span><span class="s">"11in"</span> <span class="na">width=</span><span class="s">"8.26in"</span><span class="nt">/></span>
+
+ <span class="c"><!-- Use file name nl_Bel instead of the default nl_BE --></span>
+ <span class="nt"><hyphenation-pattern</span> <span class="na">lang=</span><span class="s">"nl"</span> <span class="na">country=</span><span class="s">"BE"</span><span class="nt">></span>nl_Bel<span class="nt"></hyphenation-pattern></span>
+
+ <span class="c"><!-- etc. etc..... --></span>
+<span class="nt"></fop></span>
+</pre></div>
+
+
+<h2 id="image-loading">Image Loading Customization</h2>
+<p>Apache FOP uses the image loading framework from <a href="http://xmlgraphics.apache.org/commons/">Apache XML Graphics Commons</a> to load images using various plug-ins. Every image loader plug-in has a hard-coded usage penalty that influences which solution is chosen if there are multiple possibilities to load an image. Sometimes, though, these penalties need to be tweaked and this can be done in the FOP configuration. An example:</p>
+<div class="codehilite"><pre><span class="nt"><fop</span> <span class="na">version=</span><span class="s">"1.0"</span><span class="nt">></span>
+ [..]
+ <span class="nt"><image-loading></span>
+ <span class="nt"><penalty</span> <span class="na">value=</span><span class="s">"10000"</span>
+ <span class="na">class=</span><span class="s">"org.apache.xmlgraphics.image.loader.impl.ImageLoaderRawCCITTFax"</span><span class="nt">/></span>
+ <span class="nt"><penalty</span> <span class="na">value=</span><span class="s">"INFINITE"</span>
+ <span class="na">class=</span><span class="s">"org.apache.xmlgraphics.image.loader.impl.ImageLoaderInternalTIFF"</span><span class="nt">/></span>
+ <span class="nt"></image-loading></span>
+ <span class="nt"><renderers....</span>
+<span class="err"></fop</span><span class="nt">></span>
+</pre></div>
+
+
+<p>The first penalty element increases the penalty for the raw CCITT loader. This practically forces the decoding of CCITT compressed TIFF images except if there are no TIFF codecs available.</p>
+<p>The second penalty element sets an "infinite" penalty for the TIFF loader using the internal TIFF codec. This practically disables that plug-in as it will never be chosen as a possible solution.</p>
+<p>Negative penalties are possible to promote a plug-in but a negative penalty sum will be treated as zero penalty in most cases. For more details on the image loading framework, please consult the documentation there.</p>
+<p>The ImageLoaderPNG and ImageLoaderRawPNG have a hard-coded penalty of 1000 and as such the ImageLoaderImageIO image loader will be selected by default when loading PNGs unless the latter is disabled by awarding a INFINITE penalty to it, or one of the former two is promoted by awarding a strong negative penalty (say, -10000) to it.</p>
+<div class="codehilite"><pre><span class="nt"><fop</span> <span class="na">version=</span><span class="s">"1.0"</span><span class="nt">></span>
+ [..]
+ <span class="nt"><image-loading></span>
+ <span class="nt"><penalty</span> <span class="na">value=</span><span class="s">"-10000"</span>
+ <span class="na">class=</span><span class="s">"org.apache.xmlgraphics.image.loader.impl.ImageLoaderRawPNG"</span><span class="nt">/></span>
+ <span class="nt"><penalty</span> <span class="na">value=</span><span class="s">"INFINITE"</span>
+ <span class="na">class=</span><span class="s">"org.apache.xmlgraphics.image.loader.impl.ImageLoaderPNG"</span><span class="nt">/></span>
+ <span class="nt"><penalty</span> <span class="na">value=</span><span class="s">"INFINITE"</span>
+ <span class="na">class=</span><span class="s">"org.apache.xmlgraphics.image.loader.impl.imageio.ImageLoaderImageIO"</span><span class="nt">/></span>
+ <span class="nt"></image-loading></span>
+ <span class="nt"><renderers....</span>
+<span class="err"></fop</span><span class="nt">></span>
+</pre></div>
+
+
+<h2 id="renderers">Renderer configuration</h2>
+<p>Each Renderer has its own configuration section which is identified by the MIME type the Renderer is written for, ex. "application/pdf" for the PDF Renderer.</p>
+<p>The configuration for the PDF Renderer could look like this:</p>
+<div class="codehilite"><pre><span class="nt"><renderers></span>
+ <span class="nt"><renderer</span> <span class="na">mime=</span><span class="s">"application/pdf"</span><span class="nt">></span>
+ <span class="nt"><filterList></span>
+ <span class="c"><!-- provides compression using zlib flate (default is on) --></span>
+ <span class="nt"><value></span>flate<span class="nt"></value></span>
+ <span class="nt"></filterList></span>
+ <span class="nt"><fonts></span>
+ <span class="nt"><font</span> <span class="na">metrics-url=</span><span class="s">"arial.xml"</span> <span class="na">kerning=</span><span class="s">"yes"</span> <span class="na">embed-url=</span><span class="s">"arial.ttf"</span><span class="nt">></span>
+ <span class="nt"><font-triplet</span> <span class="na">name=</span><span class="s">"Arial"</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">"ArialMT"</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>
+ <span class="nt"><font</span> <span class="na">metrics-url=</span><span class="s">"arialb.xml"</span> <span class="na">kerning=</span><span class="s">"yes"</span> <span class="na">embed-url=</span><span class="s">"arialb.ttf"</span><span class="nt">></span>
+ <span class="nt"><font-triplet</span> <span class="na">name=</span><span class="s">"Arial"</span> <span class="na">style=</span><span class="s">"normal"</span> <span class="na">weight=</span><span class="s">"bold"</span><span class="nt">/></span>
+ <span class="nt"><font-triplet</span> <span class="na">name=</span><span class="s">"ArialMT"</span> <span class="na">style=</span><span class="s">"normal"</span> <span class="na">weight=</span><span class="s">"bold"</span><span class="nt">/></span>
+ <span class="nt"></font></span>
+ <span class="nt"></fonts></span>
+ <span class="nt"></renderer></span>
+
+ <span class="nt"><renderer</span> <span class="na">mime=</span><span class="s">"application/postscript"</span><span class="nt">></span>
+ <span class="c"><!-- etc. etc..... --></span>
+</pre></div>
+
+
+<p>The details on the font configuration can be found on the separate <a href="fonts.html">Fonts</a> page. Note especially the section entitled <a href="fonts.html#register">Register Fonts with FOP</a>.</p>
+<h3 id="pdf-renderer">Special Settings for the PDF Renderer</h3>
+<p>The configuration element for the PDF renderer contains two elements. One is for the font configuration (please follow the link above) and one is for the "filter list". The filter list controls how the individual objects in a PDF file are encoded. By default, all objects get "flate" encoded (i.e. simply compressed with the same algorithm that is also used in ZIP files). Most users don't need to change that setting. For debugging purposes, it may be desired not to compress the internal objects at all so the generated PDF commands can be read. In that case, you can simply use the following filter list. The second filter list (type="image") ensures that all images still get compressed but also ASCII-85 encoded so the produced PDF file is still easily readable in a text editor.</p>
+<div class="codehilite"><pre><span class="nt"><renderer</span> <span class="na">mime=</span><span class="s">"application/pdf"</span><span class="nt">></span>
+ <span class="nt"><filterList></span>
+ <span class="nt"><value></span>null<span class="nt"></value></span>
+ <span class="nt"></filterList></span>
+ <span class="nt"><filterList</span> <span class="na">type=</span><span class="s">"image"</span><span class="nt">></span>
+ <span class="nt"><value></span>flate<span class="nt"></value></span>
+ <span class="nt"><value></span>ascii-85<span class="nt"></value></span>
+ <span class="nt"></filterList></span>
+
+ <span class="nt"><fonts....</span>
+<span class="err"></renderer</span><span class="nt">></span>
+</pre></div>
+
+
+<p>Another (optional) setting specific to the PDF Renderer is an output color profile, an ICC color profile which indicates the target color space the PDF file is generated for. This setting is mainly used in conjunction with the <a href="pdfx.html">PDF/X</a> feature. An example:</p>
+<div class="codehilite"><pre><span class="nt"><renderer</span> <span class="na">mime=</span><span class="s">"application/pdf"</span><span class="nt">></span>
+ <span class="nt"><filterList...</span>
+
+ <span class="err"><output-profile</span><span class="nt">></span>C:\FOP\Color\EuropeISOCoatedFOGRA27.icc<span class="nt"></output-profile></span>
+
+ <span class="nt"><fonts....</span>
+<span class="err"></renderer</span><span class="nt">></span>
+</pre></div>
+
+
+<p>Some people don't have high requirements on color fidelity but instead want the smallest PDF file sizes possible. In this case it's possible to disable the default sRGB color space which XSL-FO requires. This will cause RGB colors to be generated as device-specific RGB. Please note that this option is unavailable (and will cause an error) if you enable PDF/A or PDF/X functionality or if you specify an output profile. This setting will make the PDF about 4KB smaller. To disable the sRGB color space add the following setting:</p>
+<div class="codehilite"><pre><span class="nt"><renderer</span> <span class="na">mime=</span><span class="s">"application/pdf"</span><span class="nt">></span>
+ <span class="nt"><filterList...</span>
+
+ <span class="err"><disable-srgb-colorspace</span><span class="nt">></span>true<span class="nt"></disable-srgb-colorspace></span>
+
+ <span class="nt"><fonts....</span>
+<span class="err"></renderer</span><span class="nt">></span>
+</pre></div>
+
+
+<p>FOP supports encryption of PDF output, thanks to Patrick C. Lankswert. This feature is commonly used to prevent unauthorized viewing, printing, editing, copying text from the document and doing annotations. It is also possible to ask the user for a password in order to view the contents. Note that there already exist third party applications which can decrypt an encrypted PDF without effort and allow the aforementioned operations, therefore the degree of protection is limited. For further information about features and restrictions regarding PDF encryption, look at the documentation coming with Adobe Acrobat or the technical documentation on the Adobe web site.</p>
+<div class="codehilite"><pre><span class="nt"><renderer</span> <span class="na">mime=</span><span class="s">"application/pdf"</span><span class="nt">></span>
+ <span class="nt"><encryption-params></span>
+ <span class="nt"><encryption-length></span>128<span class="nt"></encryption-length></span>
+ <span class="nt"><user-password></span>testuserpass<span class="nt"></user-password></span>
+ <span class="nt"><owner-password></span>testownerpass<span class="nt"></owner-password></span>
+ <span class="nt"><noprint/></span>
+ <span class="nt"><nocopy/></span>
+ <span class="nt"><noedit/></span>
+ <span class="nt"><noannotations/></span>
+ <span class="nt"><nofillinforms/></span>
+ <span class="nt"><noaccesscontent/></span>
+ <span class="nt"><noassembledoc/></span>
+ <span class="nt"><noprinthq/></span>
+ <span class="nt"></encryption-params></span>
+<span class="nt"></renderer></span>
+</pre></div>
+
+
+<p>By default FOP produces PDF files of version 1.4, but this can be changed in order to benefit from features that appeared in newer versions of PDF. At the moment, only a few features from PDF 1.5 have been implemented, but the configuration element will accept any value between 1.4 and 1.7. This is the value that will appear in the PDF header, although only features up to 1.5 will actually be used.</p>
+<div class="codehilite"><pre><span class="nt"><renderer</span> <span class="na">mime=</span><span class="s">"application/pdf"</span><span class="nt">></span>
+ <span class="nt"><version></span>1.5<span class="nt"></version></span>
+ <span class="c"><!-- Versions 1.4, 1.5, 1.6 and 1.7 are accepted, all other values are invalid --></span>
+<span class="nt"></renderer></span>
+</pre></div>
+
+
+<h3 id="ps-renderer">Special Settings for the PostScript Renderer</h3>
+<p>Besides the normal font configuration (the same "fonts" element as for the PDF renderer) the PostScript renderer has an additional setting to force landscape pages to be rotated to fit on a page inserted into the printer in portrait mode. Set the value to "true" to activate this feature. The default is "false". Example:</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>true<span class="nt"></auto-rotate-landscape></span>
+
+ <span class="nt"><fonts></span>
+ <span class="nt"><font</span> <span class="na">metrics-url=</span><span class="s">"arial.xml"</span> <span class="na">kerning=</span><span class="s">"yes"</span> <span class="na">embed-url=</span><span class="s">"arial.ttf"</span><span class="nt">></span>
+ <span class="nt"><font-triplet</span> <span class="na">name=</span><span class="s">"Arial"</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">"ArialMT"</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>
+ <span class="nt"><font</span> <span class="na">metrics-url=</span><span class="s">"arialb.xml"</span> <span class="na">kerning=</span><span class="s">"yes"</span> <span class="na">embed-url=</span><span class="s">"arialb.ttf"</span><span class="nt">></span>
+ <span class="nt"><font-triplet</span> <span class="na">name=</span><span class="s">"Arial"</span> <span class="na">style=</span><span class="s">"normal"</span> <span class="na">weight=</span><span class="s">"bold"</span><span class="nt">/></span>
+ <span class="nt"><font-triplet</span> <span class="na">name=</span><span class="s">"ArialMT"</span> <span class="na">style=</span><span class="s">"normal"</span> <span class="na">weight=</span><span class="s">"bold"</span><span class="nt">/></span>
+ <span class="nt"></font></span>
+ <span class="nt"></fonts></span>
+<span class="nt"></renderer></span>
+</pre></div>
+
+
+<h3 id="pcl-renderer">Special Settings for the PCL Renderer</h3>
+<p>Non-standard fonts for the PCL renderer are made available through the Java2D subsystem which means that you don't have to do any custom font configuration in this case but you have to use the font names offered by Java.</p>
+<p>Additionally, there are certain settings that control how the renderer handles various elements.</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>
+ <span class="nt"><text-rendering></span>bitmap<span class="nt"></text-rendering></span>
+<span class="nt"></renderer></span>
+</pre></div>
+
+
+<p>The default value for the "rendering" setting is "speed" which causes borders to be painted as plain rectangles. In this mode, no special borders (dotted, dashed etc.) are available. If you want support for all border modes, set the value to "quality" as indicated above. This will cause the borders to be painted as bitmaps.</p>
+<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>
+<h3 id="afp-renderer">Special Settings for the AFP Renderer</h3>
+<p>Additionally, there are certain settings that control how the renderer handles various elements.</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="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>
+ <span class="nt"><renderer-resolution></span>240<span class="nt"></renderer-resolution></span>
+ <span class="nt"><line-width-correction></span>2.5<span class="nt"></line-width-correction></span>
+
+ <span class="c"><!-- a default external resource group file --></span>
+ <span class="nt"><resource-group-file></span>resources.afp<span class="nt"></resource-group-file></span>
+<span class="nt"></renderer></span>
+</pre></div>
+
+
+<p>The default value for the images "mode" setting is "b+w" (black and white). When the images "mode" setting is "b+w" a "bits-per-pixel" setting can be provided to aid the grayscale conversion process. With this setting all images referenced in your source document are converted to an IOCA FS45 grayscale bitmap image form. When the setting is "color" all images are converted to an IOCA FS45 color bitmap image form. When "native" setting is "true", all images encountered (TIFF, GIF, JPEG and Encapsulated Postscript etc.) will be embedded directly in the datastream in their native form using a MO:DCA Object Container.</p>
+<p>The default value for the "renderer-resolution" is 240 dpi.</p>
+<p>The default line width is device dependent and may need to be fine tuned so that the output matches the expected result. The default correction value is 2.5.</p>
+<p>By default if there is no configuration definition for "resource-group-file", external resources will be placed in a file called resources.afp.</p>
+<h2 id="When-it-does-not-work">When it does not work</h2>
+<p>FOP searches the configuration file for the information it expects, at the position it expects. When that information is not present, FOP will not complain, it will just continue. When there is other information in the file, FOP will not complain, it will just ignore it. That means that when your configuration information is in the file but in a different XML element, or in a different XML path, than FOP expects, it will be silently ignored.</p>
+<p>Check the following possibilities:</p>
+<ul>
+<li>
+<p>The format of the configuration file has changed considerably between FOP 0.20.5 and FOP 1.0 and its beta versions. Did you convert your file to the new format?</p>
+</li>
+<li>
+<p>The FOP distribution contains a schema for configuration files, at src/foschema/fop-configuration.xsd. Did you validate your configuration file against it? Add the following schema location to the <code>schema</code> element:</p>
+<p>:::xml
+<fop
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:noNamespaceSchemaLocation=
+ "http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/foschema/fop-configuration.xsd?view=co"></p>
+</li>
+</ul>
+<p>and run the configuration file through a validating schema parser. Note that the schema cannot detect all errors, and that it is stricter about the order of some elements than FOP itself is.</p>
+<ul>
+<li>Run FOP in debug mode (command line option <code>-d</code>). This makes FOP report which configuration information it finds. Check if FOP finds what you expect.</li>
+</ul>
+<div class="footnote">
+<hr />
+<ol>
+<li id="fn:1">
+<p>Relative URIs for those properties are evaluated relative to the base URI of the configuration file. If the configuration is provided programmatically, the base URI can be set with <code>FopFactory.setUserConfigBaseURI</code> ; default is the current working directory. <a class="footnote-backref" href="#fnref:1" rev="footnote" title="Jump back to footnote 1 in the text">↩</a></p>
+</li>
+</ol>
+</div></div>
+ </div>
+
+ <div class="clear"></div>
+
+ <div id="footer">
+ <div class="copyright">
+ <div style="float:left; padding: 7px;">
+ <a title="Apache Software Foundation" href="http://www.apache.org"><img id="asf-feather-logo" alt="Apache Software Foundation" src="/images/feather-small.gif" width="100" /></a>
+ </div>
+ <p>
+ Copyright © 2013 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache, Apache XML Graphics, Apache FOP, Apache Batik, the Apache feather logo, and the
+ Apache XML Graphics logos are trademarks of <a href="http://www.apache.org">The Apache
+ Software Foundation</a>. All other marks mentioned may be trademarks or registered
+ trademarks of their respective owners.
+ <br />
+ </p>
+ </div>
+ </div>
+
+
+ </body>
+</html>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org