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/10/24 06:09:13 UTC
svn commit: r835962 [4/14] - in /websites/staging/xmlgraphics/trunk/content:
./ batik/ commons/ fop/ fop/0.95/ fop/1.0/ fop/1.1/ fop/dev/
fop/dev/design/ fop/trunk/
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/graphics.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/graphics.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/graphics.html Wed Oct 24 04:09:09 2012
@@ -330,9 +330,9 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.0/">1.0</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-graphics-formats">Apache(tm) FOP: Graphics Formats</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-graphics-formats">Apache™ FOP: Graphics Formats</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="introduction-wzxhzdk2wzxhzdk3">Introduction <a id="introduction"></a></h2>
+<h2 id="introduction-wzxhzdk3wzxhzdk4">Introduction <a id="introduction"></a></h2>
<p>Some noteworthy features of the image handling subsystem are:</p>
<ul>
<li>
@@ -346,7 +346,7 @@ $(document).ready(function () {
</li>
</ul>
<p>The actual <a href="http://xmlgraphics.apache.org/commons/image-loader.html">image loading framework</a> does not reside in Apache FOP, but in <a href="http://xmlgraphics.apache.org/commons/">XML Graphics Commons</a> .</p>
-<h2 id="overview-of-graphics-support-wzxhzdk4wzxhzdk5">Overview of Graphics Support <a id="support-overview"></a></h2>
+<h2 id="overview-of-graphics-support-wzxhzdk5wzxhzdk6">Overview of Graphics Support <a id="support-overview"></a></h2>
<p>The table below summarizes the <em>theoretical</em> support for graphical formats within FOP. In other words, within the constraints of the limitations listed here, these formats <em>should</em> work. However, many of them have not been tested, and there may be limitations that have not yet been discovered or documented. The packages needed to support some formats are not included in the FOP distribution and must be installed separately. Follow the links in the "Support Through" columns for more details.</p>
<table>
<thead>
@@ -424,7 +424,7 @@ $(document).ready(function () {
<a href="http://jai-imageio.dev.java.net/">JAI Image I/O Tools</a> is not the same as the <a href="http://java.sun.com/javase/technologies/desktop/media/jai/">JAI library</a> ! The former simply exposes JAI's codecs using the Image I/O API but does not include all the image manipulation functionality.</p>
</li>
</ul>
-<h2 id="map-of-supported-image-formats-by-output-format-wzxhzdk6wzxhzdk7">Map of supported image formats by output format # <a id="format-map"></a></h2>
+<h2 id="map-of-supported-image-formats-by-output-format-wzxhzdk7wzxhzdk8">Map of supported image formats by output format # <a id="format-map"></a></h2>
<p>Not all image formats are supported for all output formats! For example, while you can use EPS (Encapsulated PostScript) files when you generate PostScript output, this format will not be supported by any other output format. Here's an overview of which image formats are supported by which output format:</p>
<table>
<thead>
@@ -531,12 +531,12 @@ $(document).ready(function () {
<p>[2]: Supported without the need to decode the image, but only for certain subtypes.</p>
</li>
</ul>
-<h2 id="graphics-packages-wzxhzdk8wzxhzdk9">Graphics Packages <a id="packages"></a></h2>
-<h3 id="xml-graphics-commons-native-wzxhzdk10wzxhzdk11">XML Graphics Commons Native # <a id="native"></a></h3>
+<h2 id="graphics-packages-wzxhzdk9wzxhzdk10">Graphics Packages <a id="packages"></a></h2>
+<h3 id="xml-graphics-commons-native-wzxhzdk11wzxhzdk12">XML Graphics Commons Native # <a id="native"></a></h3>
<p><a href="http://xmlgraphics.apache.org/commons/">XML Graphics Commons</a> supports a number of graphic file formats natively as basic functionality: all bitmap formats for which there are Image I/O codecs available (JPEG, PNG, GIF, TIFF, etc.), EPS and EMF.</p>
-<h3 id="fop-native-wzxhzdk12wzxhzdk13">FOP Native # <a id="fop-native"></a></h3>
+<h3 id="fop-native-wzxhzdk13wzxhzdk14">FOP Native # <a id="fop-native"></a></h3>
<p>FOP has no native image plug-ins for the image loading framework of its own but currently hosts the Batik-dependent SVG and WMF plug-ins until they can be moved to <a href="http://xmlgraphics.apache.org/batik/">Apache Batik</a> .</p>
-<h3 id="apache-batik-wzxhzdk14wzxhzdk15">Apache Batik # <a id="batik"></a></h3>
+<h3 id="apache-batik-wzxhzdk15wzxhzdk16">Apache Batik # <a id="batik"></a></h3>
<p><a href="http://xmlgraphics.apache.org/batik/">Apache Batik</a> will later receive the SVG and WMF plug-ins for the image loading framework that are currently hosted inside FOP.</p>
<p>Current FOP distributions include a distribution of the <a href="http://xmlgraphics.apache.org/batik/">Apache Batik</a> . Because Batik's API changes frequently, it is highly recommended that you use the version that ships with FOP, at least when running FOP.
<warning>Batik must be run in a graphical environment.</warning>
@@ -553,41 +553,41 @@ Batik must be run in a graphical environ
<p>Install a toolkit which emulates AWT without the need for an underlying X server. One example is the <a href="http://www.eteks.com/pja/en">PJA toolkit</a> , which is free and comes with detailed installation instructions.</p>
</li>
</ul>
-<h3 id="image-io-wzxhzdk18wzxhzdk19">Image I/O # <a id="imageio"></a></h3>
+<h3 id="image-io-wzxhzdk19wzxhzdk20">Image I/O # <a id="imageio"></a></h3>
<p>The image loading framework in <a href="http://xmlgraphics.apache.org/commons/">XML Graphics Commons</a> provides a wrapper to load images through the <a href="http://java.sun.com/j2se/1.4.2/docs/guide/imageio/index.html">JDK's Image I/O API</a> (JSR 015). Image I/O allows to dynamically add additional image codecs. An example of such an add-on library are the <a href="http://java.sun.com/products/java-media/jai/">JAI Image I/O Tools</a> available from Sun.</p>
-<h2 id="details-on-image-formats-wzxhzdk20wzxhzdk21">Details on image formats <a id="image-formats"></a></h2>
-<h3 id="bmp-wzxhzdk22wzxhzdk23">BMP # <a id="bmp"></a></h3>
+<h2 id="details-on-image-formats-wzxhzdk21wzxhzdk22">Details on image formats <a id="image-formats"></a></h2>
+<h3 id="bmp-wzxhzdk23wzxhzdk24">BMP # <a id="bmp"></a></h3>
<p>BMP images are supported through an Image I/O codec. There may be limitations of the codec which are outside the control of Apache FOP.</p>
-<h3 id="emf-wzxhzdk24wzxhzdk25">EMF # <a id="emf"></a></h3>
+<h3 id="emf-wzxhzdk25wzxhzdk26">EMF # <a id="emf"></a></h3>
<p>Windows Enhanced Metafiles (EMF) are only supported in RTF output where they are embedded without decoding.</p>
-<h3 id="eps-wzxhzdk26wzxhzdk27">EPS # <a id="eps"></a></h3>
+<h3 id="eps-wzxhzdk27wzxhzdk28">EPS # <a id="eps"></a></h3>
<p>Apache FOP allows to use EPS files when generating PostScript output only.</p>
<p>Other output targets can't be supported at the moment because FOP lacks a PostScript interpreter. Furthermore, FOP is currently not able to parse the preview bitmaps sometimes contained in EPS files.</p>
-<h3 id="gif-wzxhzdk28wzxhzdk29">GIF # <a id="gif"></a></h3>
+<h3 id="gif-wzxhzdk29wzxhzdk30">GIF # <a id="gif"></a></h3>
<p>GIF images are supported through an Image I/O codec. Transparency is supported but not guaranteed to work with every output format.</p>
-<h3 id="jpeg-wzxhzdk31wzxhzdk32">JPEG # <a id="jpeg"></a></h3>
+<h3 id="jpeg-wzxhzdk32wzxhzdk33">JPEG # <a id="jpeg"></a></h3>
<p>FOP native support (i.e. the handling of undecoded images) of JPEG does not include all variants, especially those containing unusual color lookup tables and color profiles. If you have trouble with a JPEG image in FOP, try opening it with an image processing program (such as Photoshop or Gimp) and then saving it. Specifying 24-bit color output may also help. For the PDF and PostScript renderers most JPEG images can be passed through without decompression. User reports indicate that grayscale, RGB, and CMYK color spaces are all rendered properly. However, for other output formats, the JPEG images have to be decompressed. Tests have shown that there are some limitation in some Image I/O codecs concerning images in the CMYK color space. Work-arounds are in place but may not always work as expected.</p>
-<h3 id="png-wzxhzdk34wzxhzdk35">PNG # <a id="png"></a></h3>
+<h3 id="png-wzxhzdk35wzxhzdk36">PNG # <a id="png"></a></h3>
<p>PNG images are supported through an Image I/O codec. Transparency is supported but not guaranteed to work with every output format.</p>
-<h3 id="svg-wzxhzdk37wzxhzdk38">SVG # <a id="svg"></a></h3>
-<h4 id="introduction-wzxhzdk39wzxhzdk40">Introduction ## <a id="svg-intro"></a></h4>
+<h3 id="svg-wzxhzdk38wzxhzdk39">SVG # <a id="svg"></a></h3>
+<h4 id="introduction-wzxhzdk40wzxhzdk41">Introduction ## <a id="svg-intro"></a></h4>
<p>FOP uses <a href="#batik">Apache Batik</a> for SVG support. This format can be handled as an <code>fo:instream-foreign-object</code> or in a separate file referenced with <code>fo:external-graphic</code> .
Batik's SVG Rasterizer utility may also be used to convert standalone SVG documents into PDF. For more information please see the <a href="http://xmlgraphics.apache.org/batik/svgrasterizer.html">SVG Rasterizer documentation</a> on the Batik site.</p>
-<h3 id="placing-svg-graphics-into-pdf-wzxhzdk41wzxhzdk42">Placing SVG Graphics into PDF ## <a id="svg-pdf-graphics"></a></h3>
+<h3 id="placing-svg-graphics-into-pdf-wzxhzdk42wzxhzdk43">Placing SVG Graphics into PDF ## <a id="svg-pdf-graphics"></a></h3>
<p>The SVG is rendered into PDF by using PDF commands to draw and fill lines and curves. This means that the graphical objects created with this remain as vector graphics. The same applies to PostScript output. For other output formats the SVG graphic may be converted to a bitmap image.</p>
<p>There are a number of SVG things that cannot be converted directly into PDF. Parts of the graphic such as effects, patterns and images are inserted into the PDF as a raster graphic. The resolution of these raster images can be controlled through the "target resolution" setting in the <a href="configuration.html">configuration</a> .</p>
<p>Currently transparency is limited in PDF so some SVG images that contain effects or graphics with transparent areas may not be displayed correctly.</p>
-<h4 id="placing-svg-text-into-pdf-and-postscript-wzxhzdk43wzxhzdk44">Placing SVG Text into PDF and PostScript ## <a id="svg-pdf-text"></a></h4>
+<h4 id="placing-svg-text-into-pdf-and-postscript-wzxhzdk44wzxhzdk45">Placing SVG Text into PDF and PostScript ## <a id="svg-pdf-text"></a></h4>
<p>If possible, Batik will use normal PDF or PostScript text when inserting text. It does this by checking if the text can be drawn normally and the font is supported. This example svg <a href="../dev/svg/text.svg">text.svg</a> / <a href="../dev/svg/text.pdf">text.pdf</a> / <a href="../dev/svg/text.png">text.png</a> shows how various types and effects with text are handled. Note that SVG font support is not yet implemented. Furthermore, text handling in PostScript output is inferior to PDF output - more text will be painted as shapes in PS than in PDF.</p>
<p>When there's no support to paint text using native text operations, text is converted and drawn as a set of shapes by Batik, using the stroking text painter. This means that a typical character will have about 10 curves (each curve consists of at least 20 characters). This can make the output files large and when it is viewed the viewer may not normally draw those fine curves very well (In Adobe Acrobat, turning on "Smooth Line Art" in the preferences will fix this). Copy/paste functionality will not be supported in this case. If the text is inserted into the output file using the inbuilt text commands it will use a single character.</p>
<p>Note that because SVG text can be rendered as either text or a vector graphic, you may need to consider settings in your viewer for both. The Acrobat viewer has both "smooth line art" and "smooth text" settings that may need to be set for SVG images to be displayed nicely on your screen (see Edit / Preferences / Display). This setting will not affect the printing of your document, which should be OK in any case, but will only affect the quality of the screen display.</p>
-<h4 id="font-selection-notes-wzxhzdk45wzxhzdk46">Font selection notes ## <a id="svg-font-selection"></a></h4>
+<h4 id="font-selection-notes-wzxhzdk46wzxhzdk47">Font selection notes ## <a id="svg-font-selection"></a></h4>
<p>Apache Batik uses the AWT/Java2D subsystem as font source while FOP has its own font subsystem. Great care has been taken that font selection does the best possible choices. But it must be noted when creating PDF or PostScript that a font used in SVG graphics needs to be registered with the operating system as well as in FOP's configuration. By using FOP's font auto-detection, you simply have to install the font in the operating system and not care about anything else. This is less of an issue if you create formats like TIFFs, PNGs or PCL because in these cases SVG graphics are usually rendered to bitmaps which means that on both sides (Batik and FOP), AWT/Java2D is used as the single font source.</p>
<p>Whenever an SVG is converted into a PDF or PostScript file, the font that has been used inside Batik has to be mapped to a font used by the actual output format. Features like font substitution in FOP may need to be taken into account but can also be an advantage when working around font mapping issues. Like for XSL-FO content, you'll get a warning if a particular font could not be found and had to be substituted, or if a particular glyph is missing in a font.</p>
-<h4 id="scaling-wzxhzdk47wzxhzdk48">Scaling ## <a id="svg-scaling"></a></h4>
+<h4 id="scaling-wzxhzdk48wzxhzdk49">Scaling ## <a id="svg-scaling"></a></h4>
<p>Currently, SVG images are rendered with the dimensions specified <em>in the SVG file</em> , within the viewport specified in the fo:external-graphic element. For everything to work properly, the two should be equal. The SVG standard leaves this issue as an implementation detail. Additional scaling options are available through XSL-FO means.</p>
<p>If you use pixels to specify the size of an SVG graphic the "source resolution" setting in the <a href="configuration.html">configuration</a> will be used to determine the size of a pixel. The use of pixels to specify sizes is discouraged as they may be interpreted differently in different environments.</p>
-<h4 id="known-problems-wzxhzdk49wzxhzdk50">Known Problems ## <a id="svg-problems"></a></h4>
+<h4 id="known-problems-wzxhzdk50wzxhzdk51">Known Problems ## <a id="svg-problems"></a></h4>
<ul>
<li>
<p>Soft mask transparency is combined with white so that it looks better on PDF 1.3 viewers but this causes the soft mask to be slightly lighter or darker on PDF 1.4 viewers.</p>
@@ -602,18 +602,18 @@ Batik's SVG Rasterizer utility may also
<p>Uniform transparency for images and other SVG elements that are converted into a raster graphic are not drawn properly in PDF. The image is opaque.</p>
</li>
</ul>
-<h3 id="tiff-wzxhzdk51wzxhzdk52">TIFF # <a id="tiff"></a></h3>
+<h3 id="tiff-wzxhzdk52wzxhzdk53">TIFF # <a id="tiff"></a></h3>
<p>FOP can embed TIFF images without decompression into PDF, PostScript and AFP if they have either CCITT T.4, CCITT T.6, or JPEG compression. Otherwise, a TIFF-capable Image I/O codec is necessary for decoding the image.</p>
<p>There may be some limitation concerning images in the CMYK color space.</p>
-<h3 id="wmf-wzxhzdk54wzxhzdk55">WMF # <a id="wmf"></a></h3>
+<h3 id="wmf-wzxhzdk55wzxhzdk56">WMF # <a id="wmf"></a></h3>
<p>Windows Metafiles (WMF) are supported through classes in <a href="http://xmlgraphics.apache.org/batik/">Apache Batik</a> . At the moment, support for this format is experimental and may not always work as expected.</p>
-<h2 id="graphics-resolution-wzxhzdk56wzxhzdk57">Graphics Resolution <a id="resolution"></a></h2>
+<h2 id="graphics-resolution-wzxhzdk57wzxhzdk58">Graphics Resolution <a id="resolution"></a></h2>
<p>Some bitmapped image file formats store a dots-per-inch (dpi) or other resolution values. FOP tries to use this resolution information whenever possible to determine the image's intrinsic size. This size is used during the layout process when it is not superseded by an explicit size on fo:external-graphic (content-width and content-height properties).</p>
<p>Please note that not all images contain resolution information. If it's not available the source resolution set on the FopFactory (or through the user configuration XML) is used. The default here is 72 dpi.</p>
<p>Bitmap images are generally embedded into the output format at their original resolution (as is). No resampling of the image is performed. Explicit resampling is on our wishlist, but hasn't been implemented, yet. Bitmaps included in SVG graphics may be resampled to the resolution specified in the "target resolution" setting in the <a href="configuration.html">configuration</a> if SVG filters are applied. This can be used as a work-around to resample images in FO documents.</p>
-<h2 id="page-selection-for-multi-page-formats-wzxhzdk58wzxhzdk59">Page selection for multi-page formats <a id="page-selection"></a></h2>
+<h2 id="page-selection-for-multi-page-formats-wzxhzdk59wzxhzdk60">Page selection for multi-page formats <a id="page-selection"></a></h2>
<p>Some image formats such as TIFF support multiple pages/sub-images per file. You can select a particular page using a special URI fragment in the form: <uri>#page=<nr> (for example: <code>http://localhost/images/myimage.tiff#page=3</code> )</p>
-<h2 id="image-caching-wzxhzdk62wzxhzdk63">Image caching <a id="caching"></a></h2>
+<h2 id="image-caching-wzxhzdk63wzxhzdk64">Image caching <a id="caching"></a></h2>
<p>FOP caches images between runs. There is one cache per FopFactory instance. The URI is used as a key to identify images which means that when a particular URI appears again, the image is taken from the cache. If you have a servlet that generates a different image each time it is called with the same URI you need to use a constantly changing dummy parameter on the URI to avoid caching.</p>
<p>The image cache has been improved considerably in the redesigned code. Therefore, resetting the image cache should be a thing of the past. If you still experience OutOfMemoryErrors, please notify us.</p>
<p>If all else fails, the image cache can be cleared like this: <code>fopFactory.getImageManager().getCache().clearCache();</code> </p></div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/hyphenation.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/hyphenation.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/hyphenation.html Wed Oct 24 04:09:09 2012
@@ -330,20 +330,20 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.0/">1.0</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-hyphenation">Apache(tm) FOP: Hyphenation</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-hyphenation">Apache™ FOP: Hyphenation</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="hyphenation-support-wzxhzdk2wzxhzdk3">Hyphenation Support <a id="support"></a></h2>
-<h3 id="introduction-wzxhzdk4wzxhzdk5">Introduction # <a id="intro"></a></h3>
+<h2 id="hyphenation-support-wzxhzdk3wzxhzdk4">Hyphenation Support <a id="support"></a></h2>
+<h3 id="introduction-wzxhzdk5wzxhzdk6">Introduction # <a id="intro"></a></h3>
<p>Apache™ FOP uses Liang's hyphenation algorithm, well known from TeX. It needs language specific pattern and other data for operation.</p>
<p>Because of <a href="#license-issues">licensing issues</a> (and for convenience), all hyphenation patterns for FOP are made available through the <a href="http://offo.sourceforge.net/hyphenation/index.html">Objects For Formatting Objects</a> project.
If you have made improvements to an existing FOP hyphenation pattern, or if you have created one from scratch, please consider contributing these to OFFO so that they can benefit other FOP users as well. Please inquire on the <a href="../maillist.html#fop-user">FOP User mailing list</a> .</p>
-<h2 id="license-issues-wzxhzdk7wzxhzdk8">License Issues # <a id="license-issues"></a></h2>
+<h2 id="license-issues-wzxhzdk8wzxhzdk9">License Issues # <a id="license-issues"></a></h2>
<p>Many of the hyphenation files distributed with TeX and its offspring are licenced under the <a href="http://www.latex-project.org/lppl.html">LaTeX Project Public License (LPPL)</a> , which prevents them from being distributed with Apache software. The LPPL puts restrictions on file names in redistributed derived works which we feel can't guarantee. Some hyphenation pattern files have other or additional restrictions, for example against use for commercial purposes.</p>
<p>Although Apache FOP cannot redistribute hyphenation pattern files that do not conform with its license scheme, that does not necessarily prevent users from using such hyphenation patterns with FOP. However, it does place on the user the responsibility for determining whether the user can rightly use such hyphenation patterns under the hyphenation pattern license.
<warning>The user is responsible to settle license issues for hyphenation pattern files that are obtained from non-Apache sources.</warning></p>
-<h2 id="sources-of-custom-hyphenation-pattern-files-wzxhzdk11wzxhzdk12">Sources of Custom Hyphenation Pattern Files # <a id="sources"></a></h2>
+<h2 id="sources-of-custom-hyphenation-pattern-files-wzxhzdk12wzxhzdk13">Sources of Custom Hyphenation Pattern Files # <a id="sources"></a></h2>
<p>The most important source of hyphenation pattern files is the <a href="http://www.ctan.org/tex-archive/language/hyphenation/">CTAN TeX Archive</a> .</p>
-<h3 id="installing-custom-hyphenation-patterns-wzxhzdk13wzxhzdk14">Installing Custom Hyphenation Patterns # <a id="install"></a></h3>
+<h3 id="installing-custom-hyphenation-patterns-wzxhzdk14wzxhzdk15">Installing Custom Hyphenation Patterns # <a id="install"></a></h3>
<p>To install a custom hyphenation pattern for use with FOP:</p>
<ol>
<li>
@@ -382,7 +382,7 @@ and run Ant with build target <code>jar-
</li>
</ol>
<p><warning>Either of these three options will ensure hyphenation is working when using FOP from the command-line. If FOP is being embedded, remember to add the location(s) of the hyphenation JAR(s) to the CLASSPATH (option 1 and 2) or to set the <a href="configuration.html#hyphenation-dir"><hyphenation-dir></a> configuration option programmatically (option 3).</warning></p>
-<h1 id="hyphenation-patterns-wzxhzdk18wzxhzdk19">Hyphenation Patterns <a id="patterns"></a></h1>
+<h1 id="hyphenation-patterns-wzxhzdk19wzxhzdk20">Hyphenation Patterns <a id="patterns"></a></h1>
<p>If you would like to build your own hyphenation pattern files, or modify existing ones, this section will help you understand how to do so. Even when creating a pattern file from scratch, it may be beneficial to start with an existing file and modify it. See <a href="http://offo.sourceforge.net/hyphenation/index.html">OFFO's Hyphenation page</a> for examples. Here is a brief explanation of the contents of FOP's hyphenation patterns:
<warning>The remaining content of this section should be considered "draft" quality. It was drafted from theoretical literature, and has not been tested against actual FOP behavior. It may contain errors or omissions. Do not rely on these instructions without testing everything stated here. If you use these instructions, please provide feedback on the <a href="../maillist.html#fop-user">FOP User mailing list</a> , either confirming their accuracy, or raising specific problems that we can address.</warning></p>
<ul>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/index.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/index.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/index.html Wed Oct 24 04:09:09 2012
@@ -330,16 +330,16 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.0/">1.0</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-version-10">Apache(tm) FOP Version 1.0</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-version-10">Apache™ FOP Version 1.0</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="introduction-wzxhzdk2wzxhzdk3">Introduction <a id="intro"></a></h2>
+<h2 id="introduction-wzxhzdk3wzxhzdk4">Introduction <a id="intro"></a></h2>
<p>The Apache™ FOP team is proud to present to you this production quality codebase. FOP 1.0 provides a good subset of the W3C XSL-FO 1.0 and 1.1 Standards. Its stable, 1.0 designation provides added recognition as the productive tool it has been for years.</p>
<p>We remain committed to improving the tool, and we continue to add new features. We welcome any feedback you might have and even more, any other form of help to get the project forward.</p>
<p>This release contains many bug fixes and new features compared to the previous version. To see what has changed since the last release, please visit the <a href="changes_1.0.html">Changes Page</a> and the <a href="releaseNotes_1.0.html">Release Notes</a> .</p>
<p>This release implements a good subset of the W3C XSL-FO 1.0 and 1.1 Standards. For a detailed overview of FOP's compliance, visit the <a href="../compliance.html">compliance page</a> .</p>
-<h2 id="upgrading-from-an-earlier-version-wzxhzdk5wzxhzdk6">Upgrading from an earlier version <a id="upgrading"></a></h2>
+<h2 id="upgrading-from-an-earlier-version-wzxhzdk6wzxhzdk7">Upgrading from an earlier version <a id="upgrading"></a></h2>
<p>If you're upgrading to this version from an earlier version of FOP, please read the information contained on the <a href="upgrading.html">Upgrading page</a> !</p>
-<h2 id="download-wzxhzdk7wzxhzdk8">Download <a id="download"></a></h2>
+<h2 id="download-wzxhzdk8wzxhzdk9">Download <a id="download"></a></h2>
<p>To download this version, please visit the <a href="../download.html">download page</a> .</p></div>
</div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/intermediate.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/intermediate.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/intermediate.html Wed Oct 24 04:09:09 2012
@@ -330,16 +330,16 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.0/">1.0</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-intermediate-format">Apache(tm) FOP: Intermediate Format</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk2-fop-intermediate-format">Apache™ FOP: Intermediate Format</h1>
<p><version>$Revision: 1298724 $</version>
Please note that the intermediate formats described here are <strong>advanced features</strong> and can be ignored by most users of Apache™ FOP.</p>
-<h1 id="introduction-wzxhzdk5wzxhzdk6">Introduction <a id="introduction"></a></h1>
+<h1 id="introduction-wzxhzdk6wzxhzdk7">Introduction <a id="introduction"></a></h1>
<p>Apache FOP now provides two different so-called intermediate formats. The first one (let's call it the area tree XML format) is basically a 1:1 XML representation of FOP's area tree as generated by the layout engine. The area tree is conceptually defined in the <a href="http://www.w3.org/TR/2001/REC-xsl-20011015/slice1.html#section-N742-Formatting">XSL-FO specification in chapter 1.1.2</a> . Even though the area tree is mentioned in the XSL-FO specification, this part is not standardized. Therefore, the area tree XML format is a FOP-proprietary XML file format. The area tree XML can be generated through the area tree XML Renderer (the XMLRenderer).</p>
<p>The second intermediate format (which we shall name exactly like this: the intermediate format) is a recent addition which tries to meet a slightly different set of goals. It is highly optimized for speed.</p>
<p>The intermediate format can be used to generate intermediate documents that are modified before they are finally rendered to their ultimate output format. Modifications include adjusting and changing trait values, adding or modifying area objects, inserting prefabricated pages, overlays, imposition (n-up, rotation, scaling etc.). Multiple IF files can be combined to a single output file.</p>
-<h2 id="which-intermediate-format-to-choose-wzxhzdk7wzxhzdk8">Which Intermediate Format to choose? <a id="which-if"></a></h2>
+<h2 id="which-intermediate-format-to-choose-wzxhzdk8wzxhzdk9">Which Intermediate Format to choose? <a id="which-if"></a></h2>
<p>Both formats have their use cases, so the choice you will make will depend on your particular situation. Here is a list of strengths and use cases for both formats:</p>
-<h3 id="area-tree-xml-at-xml-wzxhzdk9wzxhzdk10">Area Tree XML (AT XML) # <a id="strengths-at"></a></h3>
+<h3 id="area-tree-xml-at-xml-wzxhzdk10wzxhzdk11">Area Tree XML (AT XML) # <a id="strengths-at"></a></h3>
<ul>
<li>
<p>1:1 representation of FOP's area tree in XML.</p>
@@ -351,7 +351,7 @@ Please note that the intermediate format
<p>Used in FOP's layout engine test suite for regression testing.</p>
</li>
</ul>
-<h3 id="intermediate-format-if-wzxhzdk11wzxhzdk12">Intermediate Format (IF) # <a id="strengths-if"></a></h3>
+<h3 id="intermediate-format-if-wzxhzdk12wzxhzdk13">Intermediate Format (IF) # <a id="strengths-if"></a></h3>
<ul>
<li>
<p>Highly optimized for speed.</p>
@@ -370,9 +370,9 @@ Please note that the intermediate format
</li>
</ul>
<p>More technical information about the two formats can be found on the <a href="http://wiki.apache.org/xmlgraphics-fop/AreaTreeIntermediateXml/NewDesign">FOP Wiki</a> .</p>
-<h2 id="architectural-overview-wzxhzdk13wzxhzdk14">Architectural Overview <a id="architecture"></a></h2>
+<h2 id="architectural-overview-wzxhzdk14wzxhzdk15">Architectural Overview <a id="architecture"></a></h2>
<p><figure alt="Diagram with an architectural overview over the intermediate formats" src="images/if-architecture-overview.png"></figure></p>
-<h1 id="usage-of-the-area-tree-xml-format-at-xml-wzxhzdk17wzxhzdk18">Usage of the Area Tree XML format (AT XML) <a id="usage"></a></h1>
+<h1 id="usage-of-the-area-tree-xml-format-at-xml-wzxhzdk18wzxhzdk19">Usage of the Area Tree XML format (AT XML) <a id="usage"></a></h1>
<p>As already mentioned, the area tree XML format is generated by using the <strong>XMLRenderer</strong> (MIME type: <strong>application/X-fop-areatree</strong> ). So, you basically set the right MIME type for the output format and process your FO files as if you would create a PDF file.</p>
<p>However, there is an important detail to consider: The various Renderers don't all use the same font sources. To be able to create the right area tree for the ultimate output format, you need to create the area tree XML file using the right font setup. This is achieved by telling the XMLRenderer to mimic another renderer. This is done by calling the XMLRenderer's mimicRenderer() method with an instance of the ultimate target renderer as the single parameter. This has a consequence: An area tree XML file rendered with the Java2DRenderer may not look as expected when it was actually generated for the PDF renderer. For renderers that use the same font setup, this restriction does not apply (PDF and PS, for example). Generating the area tree XML format file is the first step.</p>
<p>The second step is to reparse the file using the <strong>AreaTreeParser</strong> which is found in the org.apache.fop.area package. The pages retrieved from the area tree XML file are added to an AreaTreeModel instance from where they are normally rendered using one of the available Renderer implementations. You can find examples for the area tree XML processing in the <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/"></a> directory in the FOP distribution.</p>
@@ -405,14 +405,14 @@ try {
}
This example simply reads an area tree file and renders it to a PDF file. Please note, that in normal FOP operation you're shielded from having to instantiate the FontInfo object yourself. This is normally a task of the AreaTreeHandler which is not present in this scenario. The same applies to the AreaTreeModel instance, in this case an instance of a subclass called RenderPagesModel. RenderPagesModel is ideal in this case as it has very little overhead processing the individual pages. An important line in the example is the call to <code>endDocument()</code> on the AreaTreeModel. This lets the Renderer know that the processing is now finished.</p>
<p>The area tree XML format can also be used from the <a href="running.html#standalone-start">command-line</a> by using the "-atin" parameter for specifying the area tree XML as input file. You can also specify a "mimic renderer" by inserting a MIME type between "-at" and the output file.</p>
-<h3 id="concatenating-documents-wzxhzdk19wzxhzdk20">Concatenating Documents # <a id="concat"></a></h3>
+<h3 id="concatenating-documents-wzxhzdk20wzxhzdk21">Concatenating Documents # <a id="concat"></a></h3>
<p>This initial example is obviously not very useful. It would be faster to create the PDF file directly. As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/examples/embedding/java/embedding/atxml/ExampleConcat.java">ExampleConcat.java</a> example shows you can easily parse multiple area tree files in a row and add the parsed pages to the same AreaTreeModel instance which essentially concatenates all the input document to one single output document.</p>
-<h3 id="modifying-documents-wzxhzdk21wzxhzdk22">Modifying Documents # <a id="modifying"></a></h3>
+<h3 id="modifying-documents-wzxhzdk22wzxhzdk23">Modifying Documents # <a id="modifying"></a></h3>
<p>One of the most important use cases for this format is obviously modifying the area tree XML before finally rendering it to the target format. You can easily use XSLT to process the AT XML file according to your needs. Please note, that we will currently not formally describe the area tree XML format. You need to have a good understanding its structure so you don't create any non-parseable files. We may add an XML Schema and more detailed documentation at a later time. You're invited to help us with that.
The area tree XML format is sensitive to changes in whitespace. If you're not careful, the modified file may not render correctly.</p>
-<h2 id="advanced-use-wzxhzdk23wzxhzdk24">Advanced Use # <a id="advanced"></a></h2>
+<h2 id="advanced-use-wzxhzdk24wzxhzdk25">Advanced Use # <a id="advanced"></a></h2>
<p>The generation of the area tree format as well as it parsing process has been designed to allow for maximum flexibility and optimization. Please note that you can call <code>setTransformerHandler()</code> on XMLRenderer to give the XMLRenderer your own TransformerHandler instance in case you would like to do custom serialization (to a W3C DOM, for example) and/or to directly modify the area tree using XSLT. The AreaTreeParser on the other side allows you to retrieve a ContentHandler instance where you can manually send SAX events to to start the parsing process (see <code>getContentHandler()</code> ).</p>
-<h2 id="usage-of-the-intermediate-format-if-wzxhzdk25wzxhzdk26">Usage of the Intermediate Format (IF) <a id="usage-if"></a></h2>
+<h2 id="usage-of-the-intermediate-format-if-wzxhzdk26wzxhzdk27">Usage of the Intermediate Format (IF) <a id="usage-if"></a></h2>
<p>The Intermediate Format (IF) is generated by the <strong>IFSerializer</strong> (MIME type: <strong>application/X-fop-intermediate-format</strong> ). So, you basically set the right MIME type for the output format and process your FO files as if you would create a PDF file.</p>
<p>The IFSerializer is an implementation of the <strong>IFDocumentHandler</strong> and <strong>IFPainter</strong> interfaces. The <strong>IFRenderer</strong> class is responsible for converting FOP's area tree into calls against these two interfaces.</p>
<ul>
@@ -456,13 +456,13 @@ try {
out.close();
}
This example simply reads an intermediate file and renders it to a PDF file. Here IFParser.parse() is used, but you can also just get a SAX ContentHandler by using the IFParser.getContentHandler() method.</p>
-<h3 id="concatenating-documents-wzxhzdk27wzxhzdk28">Concatenating Documents # <a id="concat-if"></a></h3>
+<h3 id="concatenating-documents-wzxhzdk28wzxhzdk29">Concatenating Documents # <a id="concat-if"></a></h3>
<p>This initial example is obviously not very useful. It would be faster to create the PDF file directly (without the intermediate step). As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/ExampleConcat.java">ExampleConcat.java</a> example shows you can easily parse multiple intermediate files in a row and use the IFConcatenator class to concatenate page sequences from multiple source files to a single output file. This particular example does the concatenation on the level of the IFDocumentHandler interface. You could also do this in XSLT or using SAX on the XML level. Whatever suits your process best.</p>
-<h3 id="modifying-documents-wzxhzdk29wzxhzdk30">Modifying Documents # <a id="modifying-if"></a></h3>
+<h3 id="modifying-documents-wzxhzdk30wzxhzdk31">Modifying Documents # <a id="modifying-if"></a></h3>
<p>One of the most important use cases for this format is obviously modifying the intermediate format before finally rendering it to the target format. You can easily use XSLT to process the IF file according to your needs.</p>
<p>There is an XML Schema (located under <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/documentation/intermediate-format-ng/">src/documentation/intermediate-format-ng</a> ) that helps you verify that your modified content is correct.</p>
<p>For certain output formats there's a caveat: Formats like AFP and PCL do not support arbitrary transformations on the IF's "viewport" and "g" elements. Possible are only rotations in 90 degree steps and translations.</p>
-<h3 id="advanced-use-wzxhzdk31wzxhzdk32">Advanced Use # <a id="advanced-if"></a></h3>
+<h3 id="advanced-use-wzxhzdk32wzxhzdk33">Advanced Use # <a id="advanced-if"></a></h3>
<p>The generation of the intermediate format as well as it parsing process has been designed to allow for maximum flexibility and optimization. So rather than just passing in a StreamResult to IFSerializer's setResult() method, you can also use a SAXResult or a DOMResult. And as you've already seen , the IFParser on the other side allows you to retrieve a ContentHandler instance where you can manually send SAX events to start the parsing process (see <code>getContentHandler()</code> ).</p></div>
</div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/knownissues_overview.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/knownissues_overview.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/knownissues_overview.html Wed Oct 24 04:09:09 2012
@@ -330,9 +330,9 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.0/">1.0</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-known-issues">Apache(tm) FOP: Known Issues</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-known-issues">Apache™ FOP: Known Issues</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="known-issues-wzxhzdk2wzxhzdk3">Known issues <a id="Known+issues"></a></h2>
+<h2 id="known-issues-wzxhzdk3wzxhzdk4">Known issues <a id="Known+issues"></a></h2>
<p>This page lists currently known issues in the current release.</p>
<p>For additional information on known issues in Apache™ FOP, please have a look at the following pages, too:</p>
<ul>
@@ -344,11 +344,11 @@ $(document).ready(function () {
</li>
</ul>
<p>Apache™ FOP has an extensive automated testing infrastructure. Parts of this infrastructure are several sets of test cases. When a test case is listed in disabled-testcases.xml it is disabled in the JUnit tests during the normal build process. This indicates a problem in the current codebase. When a bug is fixed or a missing feature is added the entry for the relevant test case(s) are removed.</p>
-<h3 id="fo-tree-wzxhzdk6wzxhzdk7">FO Tree # <a id="FO+Tree"></a></h3>
+<h3 id="fo-tree-wzxhzdk7wzxhzdk8">FO Tree # <a id="FO+Tree"></a></h3>
<p>This section lists disabled test cases in the test suite for the FO tree tests, at the time of the release.</p>
<p><strong>demo-test-failure.fo</strong> (demo test failure):<br></br> <em>TODO: Add missing description in disabled-testcases.xml!</em> </p>
<p><strong>from-table-column_marker.fo</strong> (Markers and core function evaluation):<br></br>The code currently evaluates this function according to the column in which the marker appears in the source document, rather than the column it is retrieved in.</p>
-<h3 id="layout-engine-wzxhzdk12wzxhzdk13">Layout Engine # <a id="Layout+Engine"></a></h3>
+<h3 id="layout-engine-wzxhzdk13wzxhzdk14">Layout Engine # <a id="Layout+Engine"></a></h3>
<p>This section lists disabled test cases in the test suite for the layout engine tests, at the time of the release.</p>
<p><strong>basic-link_external-destination_2.xml</strong> (External link around an SVG not properly sized):<br></br>The bpd trait of the inlineparent area for the basic-link is not sized correctly if it wraps an image that is higher than the nominal line.</p>
<p><strong>block-container_space-before_space-after_3.xml</strong> (Auto-height block-containers produce fences):<br></br>Block-containers with no height currently don't create a fence for spaces as they should (they behave like a normal block).</p>
@@ -384,7 +384,7 @@ $(document).ready(function () {
<p><strong>table_border-width_conditionality.xml</strong> (Border conditionality on table):<br></br>The code should be ok, but the test case uses shorthands and therefore is probably not expressing the indended outcome according to the spec. The test case should be revisited.</p>
<p><strong>block_shy_linebreaking_hyph.xml</strong> (Soft hyphen with normal hyphenation enabled):<br></br>A soft hyphen should be a preferred as break compared to a normal hyphenation point but is not.</p>
<p><strong>keep_within-page_multi-column_overflow.xml</strong> (Page-keep not respected in multi-column layout):<br></br>The block should cause overflow in the last column on the page, rather than be broken.</p>
-<h3 id="other-known-issues-wzxhzdk84wzxhzdk85">Other known issues # <a id="Other+known+issues"></a></h3>
+<h3 id="other-known-issues-wzxhzdk85wzxhzdk86">Other known issues # <a id="Other+known+issues"></a></h3>
<p>This section lists other known issues.</p>
<ul>
<li>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/metadata.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/metadata.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/metadata.html Wed Oct 24 04:09:09 2012
@@ -330,15 +330,15 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.0/">1.0</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-metadata">Apache(tm) FOP: Metadata</h1>
-<h2 id="overview-wzxhzdk0wzxhzdk1">Overview <a id="overview"></a></h2>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-metadata">Apache™ FOP: Metadata</h1>
+<h2 id="overview-wzxhzdk1wzxhzdk2">Overview <a id="overview"></a></h2>
<p>Document metadata is an important tool for categorizing and finding documents. Various formats support different kinds of metadata representation and to different levels. One of the more popular and flexible means of representing document or object metadata is <a href="http://www.adobe.com/products/xmp/">XMP (eXtensible Metadata Platform, specified by Adobe)</a> . PDF 1.4 introduced the use of XMP. The XMP specification lists recommendation for embedding XMP metdata in other document and image formats. Given its flexibility it makes sense to make use this approach in the XSL-FO context. Unfortunately, unlike SVG which also refers to XMP, XSL-FO doesn't recommend a preferred way of specifying document and object metadata. Therefore, there's no portable way to represent metadata in XSL-FO documents. Each implementation does it differently.</p>
-<h2 id="embedding-xmp-in-an-xsl-fo-document-wzxhzdk2wzxhzdk3">Embedding XMP in an XSL-FO document <a id="xmp-in-fo"></a></h2>
+<h2 id="embedding-xmp-in-an-xsl-fo-document-wzxhzdk3wzxhzdk4">Embedding XMP in an XSL-FO document <a id="xmp-in-fo"></a></h2>
<p>As noted above, there's no officially recommended way to embed metadata in XSL-FO. Apache FOP supports embedding XMP in XSL-FO. Currently, only support for document-level metadata is implemented. Object-level metadata will be implemented when there's interest.</p>
<p>Document-level metadata can be specified in the <code>fo:declarations</code> element. XMP specification recommends to use <code>x:xmpmeta</code> , <code>rdf:RDF</code> , and <code>rdf:Description</code> elements as shown in example below. Both <code>x:xmpmeta</code> and <code>rdf:RDF</code> elements are recognized as the top-level element introducing an XMP fragment (as per the XMP specification).</p>
-<h3 id="example-wzxhzdk4wzxhzdk5">Example # <a id="xmp-example"></a></h3>
+<h3 id="example-wzxhzdk5wzxhzdk6">Example # <a id="xmp-example"></a></h3>
<p class="."></p>
-<h1 id="implementation-in-apache-fop-wzxhzdk6wzxhzdk7">Implementation in Apache FOP <a id="xmp-impl-in-fop"></a></h1>
+<h1 id="implementation-in-apache-fop-wzxhzdk7wzxhzdk8">Implementation in Apache FOP <a id="xmp-impl-in-fop"></a></h1>
<p>Currently, XMP support is only available for PDF output.</p>
<p>Originally, you could set some metadata information through FOP's FOUserAgent by using its set*() methods (like setTitle(String) or setAuthor(String). These values are directly used to set value in the PDF Info object. Since PDF 1.4, adding metadata as an XMP document to a PDF is possible. That means that there are now two mechanisms in PDF that hold metadata.</p>
<p>Apache FOP now synchronizes the Info and the Metadata object in PDF, i.e. when you set the title and the author through the FOUserAgent, the two values will end up in the (old) Info object and in the new Metadata object as XMP content. If instead of FOUserAgent, you embed XMP metadata in the XSL-FO document (as shown above), the XMP metadata will be used as-is in the PDF Metadata object and some values from the XMP metadata will be copied to the Info object to maintain backwards-compatibility for PDF readers that don't support XMP metadata.</p>
@@ -431,7 +431,7 @@ $(document).ready(function () {
</table>
<p>Please refer to the <a href="http://partners.adobe.com/public/developer/en/xmp/sdk/XMPspecification.pdf">XMP Specification</a> for information on other metadata namespaces.</p>
<p>Property sets (Namespaces) not listed here are simply passed through to the final document (if supported). That is useful if you want to specify a custom metadata schema.</p>
-<h2 id="links-wzxhzdk8wzxhzdk9">Links <a id="links"></a></h2>
+<h2 id="links-wzxhzdk9wzxhzdk10">Links <a id="links"></a></h2>
<ul>
<li>
<p><a href="http://www.adobe.com/products/xmp/">Adobe's Extensible Metadata Platform (XMP) website</a> </p>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org