You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xmlgraphics.apache.org by vh...@apache.org on 2014/07/24 18:21:24 UTC
svn commit: r1613173 [14/15] - in /xmlgraphics/site/trunk/content: ./ batik/
batik/dev/ batik/tools/ batik/using/ batik/using/scripting/ commons/ fop/
fop/0.95/ fop/1.0/ fop/1.1/ fop/dev/ fop/dev/design/ fop/trunk/
Modified: xmlgraphics/site/trunk/content/fop/trunk/extensions.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/extensions.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/extensions.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/extensions.mdtext Thu Jul 24 16:21:20 2014
@@ -9,13 +9,13 @@ The extensions documented here are inclu
<note>All extensions require the correct use of an appropriate namespace in your input document.</note>
-## SVG {#svg}
+## SVG { #svg}
Please see the [SVG documentation](graphics.html#svg) for more details.
-## FO Extensions {#fo-extensions}
+## FO Extensions { #fo-extensions}
-### Namespace {#fox-namespace}
+### Namespace { #fox-namespace}
By convention, FO extensions in FOP use the "fox" namespace prefix. To use any of the FO extensions, add a namespace entry for `http://xmlgraphics.apache.org/fop/extensions` to the root element:
@@ -23,11 +23,11 @@ By convention, FO extensions in FOP use
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
xmlns:fox="http://xmlgraphics.apache.org/fop/extensions">
-### PDF Bookmarks {#bookmarks}
+### PDF Bookmarks { #bookmarks}
In old versions of Apache FOP there was a `fox:outline` element which was used to create outlines in PDF files. The redesigned code makes use of the [bookmark feature defined in the W3C XSL 1.1 standard](http://www.w3.org/TR/xsl11/#fo_bookmark-tree).
-### Anchors or Named Destinations {#named-destinations}
+### Anchors or Named Destinations { #named-destinations}
Use the fox:destination element to define "named destinations" inside a PDF document. These are useful as fragment identifiers, e.g. "http://server/document.pdf#anchor-name". fox:destination elements can be placed almost anywhere in the fo document, including a child of root, a block-level element, or an inline-level element. For the destination to actually work, it must correspond to an "id" attribute on some fo element within the document. In other words, the "id" attribute actually creates the "view" within the PDF document. The fox:destination simply gives that view an independent name.
@@ -38,7 +38,7 @@ Use the fox:destination element to defin
<warning>It is possible that in some future release of FOP, *all* elements with "id" attributes will generate named-destinations, which will eliminate the need for fox:destination.</warning>
-### Table Continuation Label {#table-continue-label}
+### Table Continuation Label { #table-continue-label}
In old versions of Apache FOP, there was a `fox:continued-label` element which was used to insert a message when a table went over several pages.
This extension element will not be reimplemented for the redesigned code.
@@ -48,11 +48,11 @@ The redesigned code makes use of the [`f
This feature is described in the [Accessibility](accessibility.html#fox:header) section.
-### fox:orphan-content-limit and fox:widow-content-limit {#widow-orphan-content-limit}
+### fox:orphan-content-limit and fox:widow-content-limit { #widow-orphan-content-limit}
The two proprietary extension properties, `fox:orphan-content-limit` and `fox:widow-content-limit`, are used to improve the layout of list-blocks and tables. If you have a table with many entries, you don't want a single row to be left over on a page. You will want to make sure that at least two or three lines are kept together. The properties take an absolute length which specifies the area at the beginning (`fox:widow-content-limit`) or at the end (`fox:orphan-content-limit`) of a table or list-block. The properties are inherited and only have an effect on `fo:table` and `fo:list-block`. An example: `fox:widow-content-limit="3 * 1.2em"` would make sure the you'll have at least three lines (assuming `line-height="1.2"`) together on a table or list-block.
-### fox:external-document {#external-document}
+### fox:external-document { #external-document}
<note>This feature is incomplete. Support for multi-page documents will be added shortly. At the moment, only single-page images will work. And this will not work with RTF output.</note>
@@ -62,7 +62,7 @@ The `fox:external-document` element is s
(layout-master-set, declarations?, bookmark-tree?, (page-sequence|page-sequence-wrapper|fox:external-document|fox:destination)+)
-#### Specification {#Specification}
+#### Specification { #Specification}
The `fox:external-document` extension formatting object is used to specify how to create a (sub-)sequence of pages within a document. The content of these pages comes from the individual subimages/pages of an image or paged document (for example: multi-page TIFF in the form of faxes or scanned documents, or PDF files). The formatting object creates the necessary areas to display one image per page.
@@ -115,7 +115,7 @@ Datatype "page-set": Value: auto | <inte
For this, XInclude is recommended.
-### Free-form Transformation for fo:block-container {#transform}
+### Free-form Transformation for fo:block-container { #transform}
For `fo:block-container` elements whose `absolute-position` set to "absolute" or "fixed" you can use the extension attribute `fox:transform` to apply a free-form transformation to the whole block-container. The content of the `fox:transform` attribute is the same as for [SVG's transform attribute](http://www.w3.org/TR/SVG/coords.html#TransformAttribute). The transformation specified here is performed in addition to other implicit transformations of the block-container (resulting from top, left and other properties) and after them.
@@ -123,17 +123,17 @@ Examples: `fox:transform="rotate(45)"` w
<note>This extension attribute doesn't work for all output formats! It's currently only supported for PDF, PS and Java2D-based renderers.</note>
-### Color functions {#color-functions}
+### Color functions { #color-functions}
XSL-FO supports specifying color using the rgb(), rgb-icc() and system-color() functions. Apache FOP provides additional color functions for special use cases. Please note that using these functions compromises the interoperability of an FO document.
-#### cmyk() {#color-function-cmyk}
+#### cmyk() { #color-function-cmyk}
`color cmyk(numeric, numeric, numeric, numeric)`
This function will construct a color in device-specific CMYK color space. The numbers must be between 0.0 and 1.0. For output formats that don't support device-specific color space the CMYK value is converted to an sRGB value.
-#### #CMYK pseudo-profile {#pseudo-color-profiles}
+#### #CMYK pseudo-profile { #pseudo-color-profiles}
`color rgb-icc(numeric, numeric, numeric, #CMYK, numeric, numeric, numeric, numeric)`
@@ -144,7 +144,7 @@ The `rgb-icc` function will respond to a
- `rgb-icc(153, 153, 102, #CMYK, 0, 0, 0.2, 0.4)`
-### Rounded Corners {#rounded-corners}
+### Rounded Corners { #rounded-corners}
Rounded corners on block areas can be specified with the `fox:border-*-*-radius` properties. Each corner can be specified with two radii that define a quarter ellipse that defines the shape of the corner of the outer border edge (in accordance with the [W3 CSS3 Recommendation](http://www.w3.org/TR/css3-background/#the-border-radius)).
The property `fox:border-BP-IP-radius` specifies the radius of the corner connecting border segment *BP* is one of '*before|after*' and *IP* is one of 'start|end*', and takes one or two values. A single value will generate circular corners. Two values define elliptic corners where the first value defines the radius in the *Inline Progression Direction*, and the second the radius in the *Block Progression Direction*.
@@ -159,13 +159,13 @@ The example fo `examples/fo/advanced/rou
- Rounded corners on tables are not directly supported. To set rounded corners at the table level the table must have the property `border-collapse` property set to `separate`
-### Prepress Support {#prepress}
+### Prepress Support { #prepress}
This section defines a number of extensions related to [prepress](http://en.wikipedia.org/wiki/Prepress) support. `fox:scale` defines a general scale factor for the generated pages. `fox:bleed` defines the [bleed area](http://en.wikipedia.org/wiki/Bleed_%28printing%29) for a page. `fox:crop-offset` defines the outer edges of the area in which crop marks, registration marks, color bars and page information are placed. For details, please read on below.
<note>Those extensions have been implemented in the PDF and Java2D renderers only.</note>
-#### fox:scale {#scale}
+#### fox:scale { #scale}
Value: <number>{1,2}
@@ -175,7 +175,7 @@ Applies to: fo:simple-page-master
This property specifies a scale factor along resp. the x and y axes. If only one number is provided it is used for both the x and y scales. A scale factor smaller than 1 shrinks the page. A scale factor greater than 1 enlarges the page.
-#### fox:bleed {#bleed}
+#### fox:bleed { #bleed}
Value: <length>{1,4}
@@ -187,7 +187,7 @@ If there is only one value, it applies t
This extension indirectly defines the BleedBox and is calculated by expanding the TrimBox by the bleed widths. The lengths must be non-negative.
-#### fox:crop-offset {#cropOffset}
+#### fox:crop-offset { #cropOffset}
Value: <length>{1,4}
@@ -199,7 +199,7 @@ Same behaviour as with fox:bleed. The in
This extension indirectly defines the MediaBox and is calculated by expanding the TrimBox by the crop offsets. The lengths must be non-negative.
-#### fox:crop-box {#cropBox}
+#### fox:crop-box { #cropBox}
Value: [trim-box | bleed-box | media-box]
@@ -211,15 +211,15 @@ The crop box controls how Acrobat displa
If requested in the future, we could offer to specify the CropBox in absolute coordinates rather than just by referencing another box.
-### Background Images {#backgroundimages}
+### Background Images { #backgroundimages}
Background images can be resized on the fly using these two extensions:
-#### fox:background-image-width {#backgroundImageWidth}
+#### fox:background-image-width { #backgroundImageWidth}
Value: length
-#### fox:background-image-height {#backgroundImageHeight}
+#### fox:background-image-height { #backgroundImageHeight}
Value: length
Modified: xmlgraphics/site/trunk/content/fop/trunk/fonts.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/fonts.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/fonts.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/fonts.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ Title: Apache(tm) FOP: Fonts
#Apache™ FOP: Fonts
<authors><person email="" name="Jeremias Märki"></person><person email="" name="Tore Engvig"></person><person email="" name="Adrian Cumiskey"></person><person email="" name="Max Berger"></person></authors>
-## Summary {#intro}
+## Summary { #intro}
The following table summarizes the font capabilities of the various Apache™ FOP renderers:
@@ -19,7 +19,7 @@ The following table summarizes the font
| TXT | yes (used for layout but not for output) | no | yes (used for layout but not for output) | no |
| XML | yes | no | yes | n/a |
-## Base-14 Fonts {#Base-14-Fonts}
+## Base-14 Fonts { #Base-14-Fonts}
The Adobe PostScript and PDF Specification specify a set of 14 fonts that must be available to every PostScript interpreter and PDF reader: Helvetica (normal, bold, italic, bold italic), Times (normal, bold, italic, bold italic), Courier (normal, bold, italic, bold italic), Symbol and ZapfDingbats.
@@ -35,21 +35,21 @@ The following font family names are hard
Please note that recent versions of Adobe Acrobat Reader replace "Helvetica" with "Arial" and "Times" with "Times New Roman" internally. GhostScript replaces "Helvetica" with "Nimbus Sans L" and "Times" with "Nimbus Roman No9 L". Other document viewers may do similar font substitutions. If you need to make sure that there are no such substitutions, you need to specify an explicit font and embed it in the target document.
-## Missing Fonts {#missing-fonts}
+## Missing Fonts { #missing-fonts}
When FOP does not have a specific font at its disposal (because it's not installed in the operating system or set up in FOP's configuration), the font is replaced with "any". "any" is internally mapped to the Base-14 font "Times" (see above).
-## Missing Glyphs {#missing-glyphs}
+## Missing Glyphs { #missing-glyphs}
Every font contains a particular set of [glyphs](http://en.wikipedia.org/wiki/Glyph). If no glyph can be found for a given character, FOP will issue a warning and use the glpyh for "#" (if available) instead. Before it does that, it consults a (currently hard-coded) registry of glyph substitution groups (see Glyphs.java in Apache XML Graphics Commons). This registry can supply alternative glyphs in some cases (like using space when a no-break space is requested). But there's no guarantee that the result will be as expected (for example, in the case of hyphens and similar glyphs). A better way is to use a font that has all the necessary glyphs. This glyph substitution is only a last resort.
-## Java2D/AWT/Operating System Fonts {#awt}
+## Java2D/AWT/Operating System Fonts { #awt}
The Java2D family of renderers (Java2D, AWT, Print, TIFF, PNG), use the Java AWT subsystem for font metric information. Through operating system registration, the AWT subsystem knows what fonts are available on the system, and the font metrics for each one.
When working with one of these output formats and you're missing a font, just install it in your operating system and they should be available for these renderers. Please note that this is not true for other output formats such as PDF or PostScript.
-## Custom Fonts {#custom}
+## Custom Fonts { #custom}
Support for custom fonts is highly output format dependent (see above table). This section shows how to add Type 1, TrueType (TTF) and OpenType (OTF) fonts to the PDF, PostScript and Java2D-based renderers. Other renderers (like AFP) support other font formats. Details in this case can be found on the page about [output formats](output.html).
@@ -57,7 +57,7 @@ In earlier FOP versions, it was always n
More information about fonts can be found at [Adobe Font Technical Notes](http://www.adobe.com/devnet/font.html).
-## Bulk Font Configuration {#bulk}
+## Bulk Font Configuration { #bulk}
If you want FOP to use custom fonts, you need to tell it where to find them. This is done in the configuration file and once per renderer (because each output format is a little different). For convenience, FOP allows bulk registering of fonts; you can either tell FOP to find your operating system fonts or you can specify directories that it will search for support fonts. These fonts will then automatically be registered.
@@ -79,7 +79,7 @@ If you want FOP to use custom fonts, you
<note>Review the documentation for [FOP Configuration](configuration.html) for instructions on making the FOP configuration available to FOP when it runs. Otherwise, FOP has no way of finding your custom font information. It is currently not possible to easily configure fonts from Java code.</note>
-### Register Fonts with FOP {#register}
+### Register Fonts with FOP { #register}
You must tell FOP how to find and use the font files by registering them in the [FOP Configuration](configuration.html). Add entries for your custom fonts, regardless of font type, to the configuration file in a manner similar to the following:
@@ -125,7 +125,7 @@ You must tell FOP how to find and use th
- If a fop.xconf is not used, or the "embed-url" attribute is missing, the fonts are referenced (and the default Base-14 is used in this case).
-### TrueType Collections {#truetype-collections-metrics}
+### TrueType Collections { #truetype-collections-metrics}
TrueType collections (.ttc files) contain more than one font. The individual sub-fonts of a TrueType Collection can be selected using the "sub-font" attribute on the "font" element. Example:
@@ -134,7 +134,7 @@ TrueType collections (.ttc files) contai
<font-triplet name="GulimChe" style="normal" weight="normal"/>
</font>
-### Auto-Detect and auto-embed feature {#autodetect}
+### Auto-Detect and auto-embed feature { #autodetect}
When the "auto-detect" flag is set in the configuration, FOP will automatically search for fonts in the default paths for your operating system.
@@ -147,13 +147,13 @@ FOP will also auto-detect fonts which ar
This feature allows you to create JAR files containing fonts. The JAR files can be added to fop by providem them in the classpath, e.g. copying them into the lib/ directory.
-#### The font cache {#font-cache}
+#### The font cache { #font-cache}
Apache FOP maintains a cache file that is used to speed up auto-detection. This file is usually found in the ".fop" directory under the user's home directory. It's called "fop-fonts.cache". When the user's home directory is not writable, the font cache file is put in the directory for temporary files.
If there was a problem loading a particular font, it is flagged in the cache file so it is not loaded anymore. So, if a font is actually around but is still not found by Apache FOP, it's worth a try to delete the font cache file which forces Apache FOP to reparse all fonts.
-### Referencing Fonts {#referencing_fonts}
+### Referencing Fonts { #referencing_fonts}
By default, all fonts are embedded if an output format supports font embedding. In some cases, however, it is preferred that some fonts are only referenced. When working with referenced fonts it is important to be in control of the target environment where the produced document is consumed, i.e. the necessary fonts have to be installed there.
@@ -177,7 +177,7 @@ At the moment, you can only match fonts
The `referenced-fonts` element can be placed either inside the general `fonts` element (right under the root) or in the `fonts` element under the renderer configuration. In the first case, matches apply to all renderers. In the second case, matches only apply to the renderer where the element was specified. Both cases can be used at the same time.
-### Embedding Fonts {#embedding_fonts}
+### Embedding Fonts { #embedding_fonts}
Some notes related to embedded fonts:
@@ -187,7 +187,7 @@ Some notes related to embedded fonts:
- When embedding TrueType (ttf) or TrueType Collections (ttc), a subset of the original font, containing only the glyphs used, is embedded in the output document. That's the default, but if you specify encoding-mode="single-byte" (see above), the complete font is embedded.
-### Font Substitution {#font_substitution}
+### Font Substitution { #font_substitution}
When a `<substitutions/>` section is defined in the configuration, FOP will re-map any font-family references found in your FO input to a given substitution font.
@@ -213,7 +213,7 @@ For example you could make all FO font-f
</fonts>
</fop>
-## Font Selection Strategies {#selection}
+## Font Selection Strategies { #selection}
There are two font selection strategies: character-by-character or auto. The default is auto.
@@ -229,6 +229,6 @@ Auto selected the first font from the li
Character-by-Character is NOT yet supported!
-## Font List Command-Line Tool {#font-list}
+## Font List Command-Line Tool { #font-list}
FOP contains a small command-line tool that lets you generate a list of all configured fonts. Its class name is: `org.apache.fop.tools.fontlist.FontListMain`. Run it with the "-?" parameter to get help for the various options.
\ No newline at end of file
Modified: xmlgraphics/site/trunk/content/fop/trunk/graphics.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/graphics.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/graphics.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/graphics.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ Title: Apache(tm) FOP: Graphics Formats
#Apache™ FOP: Graphics Formats
-## Introduction {#introduction}
+## Introduction { #introduction}
Some noteworthy features of the image handling subsystem are:
@@ -16,7 +16,7 @@ Some noteworthy features of the image ha
The actual [image loading framework](http://xmlgraphics.apache.org/commons/image-loader.html) does not reside in Apache FOP, but in [XML Graphics Commons](http://xmlgraphics.apache.org/commons/).
-## Overview of Graphics Support {#support-overview}
+## Overview of Graphics Support { #support-overview}
The table below summarizes the *theoretical* support for graphical formats within FOP. In other words, within the constraints of the limitations listed here, these formats *should* 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.
@@ -40,7 +40,7 @@ Legend:
<note>[JAI Image I/O Tools](http://jai-imageio.dev.java.net/) is not the same as the [JAI library](http://java.sun.com/javase/technologies/desktop/media/jai/) ! The former simply exposes JAI's codecs using the Image I/O API but does not include all the image manipulation functionality.</note>
-### Map of supported image formats by output format {#format-map}
+### Map of supported image formats by output format { #format-map}
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:
@@ -63,17 +63,17 @@ Legend:
- [2]: Supported without the need to decode the image, but only for certain subtypes.
-## Graphics Packages {#packages}
+## Graphics Packages { #packages}
-### XML Graphics Commons Native {#native}
+### XML Graphics Commons Native { #native}
[XML Graphics Commons](http://xmlgraphics.apache.org/commons/) 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.
-### FOP Native {#fop-native}
+### FOP Native { #fop-native}
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 [Apache Batik](http://xmlgraphics.apache.org/batik/).
-### Apache Batik {#batik}
+### Apache Batik { #batik}
[Apache Batik](http://xmlgraphics.apache.org/batik/) will later receive the SVG and WMF plug-ins for the image loading framework that are currently hosted inside FOP.
@@ -90,47 +90,47 @@ Here are some workarounds:
- Install a toolkit which emulates AWT without the need for an underlying X server. One example is the [PJA toolkit](http://www.eteks.com/pja/en), which is free and comes with detailed installation instructions.
-### Image I/O {#imageio}
+### Image I/O { #imageio}
The image loading framework in [XML Graphics Commons](http://xmlgraphics.apache.org/commons/) provides a wrapper to load images through the [JDK's Image I/O API](http://java.sun.com/j2se/1.4.2/docs/guide/imageio/index.html) (JSR 015). Image I/O allows to dynamically add additional image codecs. An example of such an add-on library are the [JAI Image I/O Tools](http://java.sun.com/products/java-media/jai/) available from Sun.
-## Details on image formats {#image-formats}
+## Details on image formats { #image-formats}
-### BMP {#bmp}
+### BMP { #bmp}
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.
-### EMF {#emf}
+### EMF { #emf}
Windows Enhanced Metafiles (EMF) are only supported in RTF output where they are embedded without decoding.
-### EPS {#eps}
+### EPS { #eps}
Apache FOP allows to use EPS files when generating PostScript output only.
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.
-### GIF {#gif}
+### GIF { #gif}
GIF images are supported through an Image I/O codec. Transparency is supported but not guaranteed to work with every output format.
-### JPEG {#jpeg}
+### JPEG { #jpeg}
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.
-### PNG {#png}
+### PNG { #png}
PNG images are supported both through an Image I/O codec (ImageLoaderImageIO) and through native support. FOP native support is possible with PDF and PS output, and can be enabled either through an internal codec (ImageLoaderPNG) or by directly handling undecoded images (ImageLoaderRawPNG). More information is available in the [wiki page](http://wiki.apache.org/xmlgraphics-fop/HowTo/ImageLoaderRawPNG). Transparency is supported but not guaranteed to work with every output format.
-### SVG {#svg}
+### SVG { #svg}
-#### Introduction {#svg-intro}
+#### Introduction { #svg-intro}
FOP uses [Apache Batik](#batik) for SVG support. This format can be handled as an `fo:instream-foreign-object` or in a separate file referenced with `fo:external-graphic`.
<note>Batik's SVG Rasterizer utility may also be used to convert standalone SVG documents into PDF. For more information please see the [SVG Rasterizer documentation](http://xmlgraphics.apache.org/batik/svgrasterizer.html) on the Batik site.</note>
-#### Placing SVG Graphics into PDF {#svg-pdf-graphics}
+#### Placing SVG Graphics into PDF { #svg-pdf-graphics}
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.
@@ -138,7 +138,7 @@ There are a number of SVG things that ca
Currently transparency is limited in PDF so some SVG images that contain effects or graphics with transparent areas may not be displayed correctly.
-#### Placing SVG Text into PDF and PostScript {#svg-pdf-text}
+#### Placing SVG Text into PDF and PostScript { #svg-pdf-text}
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 [text.svg](../dev/svg/text.svg) / [text.pdf](../dev/svg/text.pdf) / [text.png](../dev/svg/text.png) 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.
@@ -146,13 +146,13 @@ When there's no support to paint text us
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.
-#### Scaling {#svg-scaling}
+#### Scaling { #svg-scaling}
Currently, SVG images are rendered with the dimensions specified *in the SVG file*, 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.
If you use pixels to specify the size of an SVG graphic the "source resolution" setting in the [configuration](configuration.html) 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.
-#### Known Problems {#svg-problems}
+#### Known Problems { #svg-problems}
- 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.
@@ -163,17 +163,17 @@ If you use pixels to specify the size of
- 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.
-### TIFF {#tiff}
+### TIFF { #tiff}
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.
There may be some limitation concerning images in the CMYK color space.
-### WMF {#wmf}
+### WMF { #wmf}
Windows Metafiles (WMF) are supported through classes in [Apache Batik](http://xmlgraphics.apache.org/batik/). At the moment, support for this format is experimental and may not always work as expected.
-## Graphics Resolution {#resolution}
+## Graphics Resolution { #resolution}
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).
@@ -181,11 +181,11 @@ Please note that not all images contain
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 [configuration](configuration.html) if SVG filters are applied. This can be used as a work-around to resample images in FO documents.
-## Page selection for multi-page formats {#page-selection}
+## Page selection for multi-page formats { #page-selection}
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: `http://localhost/images/myimage.tiff#page=3`). This feature is only available if the ImageLoaderImageIO is the chosen image loader (this may require disabling or downgrading, by awarding it a penalty, the ImageLoaderRawCCITTFax image loader).
-## Image caching {#caching}
+## Image caching { #caching}
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.
Modified: xmlgraphics/site/trunk/content/fop/trunk/hyphenation.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/hyphenation.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/hyphenation.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/hyphenation.mdtext Thu Jul 24 16:21:20 2014
@@ -3,9 +3,9 @@ Title: Apache(tm) FOP: Hyphenation
#Apache™ FOP: Hyphenation
-## Hyphenation Support {#support}
+## Hyphenation Support { #support}
-### Introduction {#intro}
+### Introduction { #intro}
Apache™ FOP uses Liang's hyphenation algorithm, well known from TeX. It needs language specific pattern and other data for operation.
@@ -13,7 +13,7 @@ Because of [licensing issues](#license-i
<note>If you have made improvements to an existing Apache™ 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 [FOP User mailing list](../maillist.html#fop-user).</note>
-### License Issues {#license-issues}
+### License Issues { #license-issues}
Many of the hyphenation files distributed with TeX and its offspring are licenced under the [LaTeX Project Public License (LPPL)](http://www.latex-project.org/lppl.html), 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.
@@ -21,11 +21,11 @@ Although Apache FOP cannot redistribute
<warning>The user is responsible to settle license issues for hyphenation pattern files that are obtained from non-Apache sources.</warning>
-### Sources of Custom Hyphenation Pattern Files {#sources}
+### Sources of Custom Hyphenation Pattern Files { #sources}
The most important source of hyphenation pattern files is the [CTAN TeX Archive](http://www.ctan.org/tex-archive/language/hyphenation/).
-### Installing Custom Hyphenation Patterns {#install}
+### Installing Custom Hyphenation Patterns { #install}
To install a custom hyphenation pattern for use with FOP:
@@ -55,7 +55,7 @@ and run Ant with build target `jar-hyphe
<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 [<hyphenation-dir>](configuration.html#hyphenation-dir) configuration option programmatically (option 3).</warning>
-## Hyphenation Patterns {#patterns}
+## Hyphenation Patterns { #patterns}
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 [OFFO's Hyphenation page](http://offo.sourceforge.net/hyphenation/index.html) 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 [FOP User mailing list](../maillist.html#fop-user), either confirming their accuracy, or raising specific problems that we can address.</warning>
Modified: xmlgraphics/site/trunk/content/fop/trunk/index.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/index.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/index.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/index.mdtext Thu Jul 24 16:21:20 2014
@@ -3,16 +3,16 @@ Title: Apache(tm) FOP Trunk (Development
#Apache™ FOP Trunk (Development code)
-## Introduction {#intro}
+## Introduction { #intro}
Apache™ **FOP Trunk** is the name for the current development code as found in the [Subversion repository](http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/). This section of the FOP web site provides the documentation for this version.
The Apache FOP team is proud to present to you this production quality codebase. It has taken over three years to get this far and over two years without a new release from the FOP project. We're still in the process of adding new features. We welcome any feedback you might have and even more, any other form of help to get the project forward.
-## Upgrading from an earlier version {#upgrading}
+## Upgrading from an earlier version { #upgrading}
If you're upgrading to this version from an earlier version of FOP, please read the information contained on the [Upgrading page](upgrading.html) !
-## Download {#download}
+## Download { #download}
Nightly builds of trunk code can be downloaded here: [Nightly Snapshots](http://ci.apache.org/projects/xmlgraphics/fop/snapshots/).
\ No newline at end of file
Modified: xmlgraphics/site/trunk/content/fop/trunk/intermediate.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/intermediate.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/intermediate.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/intermediate.mdtext Thu Jul 24 16:21:20 2014
@@ -4,7 +4,7 @@ Title: Apache(tm) FOP: Intermediate Form
<note>Please note that the intermediate formats described here are **advanced features** and can be ignored by most users of Apache™ FOP.</note>
-## Introduction {#introduction}
+## Introduction { #introduction}
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 [XSL-FO specification in chapter 1.1.2](http://www.w3.org/TR/2001/REC-xsl-20011015/slice1.html#section-N742-Formatting). 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).
@@ -12,11 +12,11 @@ The second intermediate format (which we
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.
-## Which Intermediate Format to choose? {#which-if}
+## Which Intermediate Format to choose? { #which-if}
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:
-### Area Tree XML (AT XML) {#strengths-at}
+### Area Tree XML (AT XML) { #strengths-at}
- 1:1 representation of FOP's area tree in XML.
@@ -25,7 +25,7 @@ Both formats have their use cases, so th
- Used in FOP's layout engine test suite for regression testing.
-### Intermediate Format (IF) {#strengths-if}
+### Intermediate Format (IF) { #strengths-if}
- Highly optimized for speed.
@@ -40,11 +40,11 @@ Both formats have their use cases, so th
More technical information about the two formats can be found on the [FOP Wiki](http://wiki.apache.org/xmlgraphics-fop/AreaTreeIntermediateXml/NewDesign).
-## Architectural Overview {#architecture}
+## Architectural Overview { #architecture}
-## Usage of the Area Tree XML format (AT XML) {#usage}
+## Usage of the Area Tree XML format (AT XML) { #usage}
As already mentioned, the area tree XML format is generated by using the **XMLRenderer** (MIME type: **application/X-fop-areatree**). 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.
@@ -84,21 +84,21 @@ This example simply reads an area tree f
The area tree XML format can also be used from the [command-line](running.html#standalone-start) 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.
-### Concatenating Documents {#concat}
+### Concatenating Documents { #concat}
This initial example is obviously not very useful. It would be faster to create the PDF file directly. As the [ExampleConcat.java](http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/examples/embedding/java/embedding/atxml/ExampleConcat.java) 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.
-### Modifying Documents {#modifying}
+### Modifying Documents { #modifying}
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.
<note>The area tree XML format is sensitive to changes in whitespace. If you're not careful, the modified file may not render correctly.</note>
-### Advanced Use {#advanced}
+### Advanced Use { #advanced}
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 `setTransformerHandler()` 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 `getContentHandler()`).
-## Usage of the Intermediate Format (IF) {#usage-if}
+## Usage of the Intermediate Format (IF) { #usage-if}
The Intermediate Format (IF) is generated by the **IFSerializer** (MIME type: **application/X-fop-intermediate-format**). 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.
@@ -148,11 +148,11 @@ The basic pattern to parse the intermedi
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.
-### Concatenating Documents {#concat-if}
+### Concatenating Documents { #concat-if}
This initial example is obviously not very useful. It would be faster to create the PDF file directly (without the intermediate step). As the [ExampleConcat.java](http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/ExampleConcat.java) 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.
-### Modifying Documents {#modifying-if}
+### Modifying Documents { #modifying-if}
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.
@@ -160,6 +160,6 @@ There is an XML Schema (located under [s
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.
-### Advanced Use {#advanced-if}
+### Advanced Use { #advanced-if}
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 `getContentHandler()`).
Modified: xmlgraphics/site/trunk/content/fop/trunk/metadata.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/metadata.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/metadata.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/metadata.mdtext Thu Jul 24 16:21:20 2014
@@ -3,17 +3,17 @@ Title: Apache(tm) FOP: Metadata
#Apache™ FOP: Metadata
-## Overview {#overview}
+## Overview { #overview}
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 [XMP (eXtensible Metadata Platform, specified by Adobe)](http://www.adobe.com/products/xmp/). 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.
-## Embedding XMP in an XSL-FO document {#xmp-in-fo}
+## Embedding XMP in an XSL-FO document { #xmp-in-fo}
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.
Document-level metadata can be specified in the `fo:declarations` element. XMP specification recommends to use `x:xmpmeta`, `rdf:RDF`, and `rdf:Description` elements as shown in example below. Both `x:xmpmeta` and `rdf:RDF` elements are recognized as the top-level element introducing an XMP fragment (as per the XMP specification).
-### Example {#xmp-example}
+### Example { #xmp-example}
:::xml
[..]
@@ -41,7 +41,7 @@ Document-level metadata can be specified
<note>`fo:declarations` **must** be declared after `fo:layout-master-set` and before the first `page-sequence`.</note>
-## Implementation in Apache FOP {#xmp-impl-in-fop}
+## Implementation in Apache FOP { #xmp-impl-in-fop}
Currently, XMP support is only available for PDF output.
@@ -66,7 +66,7 @@ The mapping between the Info and the Met
<note>The "Subject" used to be mapped to `dc:subject` in the initial publication of PDF/A-1 (ISO 19005-1). In the [Technical Corrigendum 1](http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=45613) this was changed to map to `dc:description["x-default"]`.</note>
-### Namespaces {#namespaces}
+### Namespaces { #namespaces}
Metadata is made of property sets where each property set uses a different namespace URI.
@@ -82,7 +82,7 @@ Please refer to the [XMP Specification](
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.
-## Links {#links}
+## Links { #links}
- [Adobe's Extensible Metadata Platform (XMP) website](http://www.adobe.com/products/xmp/)
Modified: xmlgraphics/site/trunk/content/fop/trunk/output.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/output.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/output.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/output.mdtext Thu Jul 24 16:21:20 2014
@@ -4,9 +4,9 @@ Title: Apache(tm) FOP Output Formats
Apache™ FOP supports multiple output formats by using a different renderer for each format. The renderers do not all have the same set of capabilities, sometimes because of the output format itself, sometimes because some renderers get more development attention than others.
-## General Information {#general}
+## General Information { #general}
-### Fonts {#general-fonts}
+### Fonts { #general-fonts}
Most FOP renderers use a FOP-specific system for font registration. However, the Java2D/AWT and print renderers use the Java AWT package, which gets its font information from the operating system registration. This can result in several differences, including actually using different fonts, and having different font metrics for the same font. The net effect is that the layout of a given FO document can be quite different between renderers that do not use the same font information.
@@ -34,7 +34,7 @@ With a work-around, it is possible to ma
- `fop -atin myfile.at.xml -tiff myfile.tiff`
-### Output to a Printer or Other Device {#general-direct-output}
+### Output to a Printer or Other Device { #general-direct-output}
The most obvious way to print your document is to use the FOP [print renderer](#print), which uses the Java2D API (AWT). However, you can also send output from the Postscript renderer directly to a Postscript device, or output from the PCL renderer directly to a PCL device.
@@ -52,19 +52,19 @@ Here is some Java code to accomplish the
Set the output MIME type to "`application/x-pcl`" (`MimeConstants.MIME_PCL`) and it happily sends the PCL to the UNIX printer queue.
-## PDF {#pdf}
+## PDF { #pdf}
PDF is the best supported output format. It is also the most accurate with text and layout. This creates a PDF document that is streamed out as each page is rendered. This means that the internal page index information is stored near the end of the document. The PDF version supported is 1.4. PDF versions are forwards/backwards compatible.
Note that FOP does not currently support PDF/A-1a. Support for [Tagged PDF](accessibility.html), [PDF/A-1b](pdfa.html) and [PDF/X](pdfx.html) has recently been added, however.
-### Fonts {#pdf-fonts}
+### Fonts { #pdf-fonts}
PDF has a set of fonts that are always available to all PDF viewers; to quote from the PDF Specification:
*"PDF prescribes a set of 14 standard fonts that can be used without prior definition. These include four faces each of three Latin text typefaces (Courier, Helvetica, and Times), as well as two symbolic fonts (Symbol and ITC Zapf Dingbats). These fonts, or suitable substitute fonts with the same metrics, are guaranteed to be available in all PDF viewer applications."*
-### Post-processing {#pdf-postprocess}
+### Post-processing { #pdf-postprocess}
FOP does not currently support several desirable PDF features: watermarks and signatures. One workaround is to use Adobe Acrobat (the full version, not the Reader) to process the file manually or with scripting that it supports.
@@ -117,7 +117,7 @@ Here is some sample code that uses iText
Check the iText tutorial and documentation for setting access flags, password, encryption strength and other parameters.
-### Watermarks {#pdf-watermark}
+### Watermarks { #pdf-watermark}
In addition to the [PDF Post-processing](#pdf-postprocess) options, consider the following workarounds:
@@ -126,7 +126,7 @@ In addition to the [PDF Post-processing]
- (submitted by Trevor Campbell) Place an image in a region that overlaps the flowing text. For example, make region-before large enough to contain your image. Then include a block (if necessary, use an absolutely positioned block-container) containing the watermark image in the static-content for the region-before. Note that the image will be drawn on top of the normal content.
-### Extensions {#pdf-extensions}
+### Extensions { #pdf-extensions}
The PDF Renderer supports some PDF specific extensions which can be embedded into the input FO document. To use the extensions the appropriate namespace must be declared in the fo:root element like this:
@@ -134,7 +134,7 @@ The PDF Renderer supports some PDF speci
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
xmlns:pdf="http://xmlgraphics.apache.org/fop/extensions/pdf">
-#### Embedded Files {#pdf-embedded-file}
+#### Embedded Files { #pdf-embedded-file}
It is possible to attach/embed arbitrary files into a PDF file. You can give a name and a description of the file. Example:
@@ -172,11 +172,11 @@ FO document using the `pdf:info` extensi
Each custom property must be specified using the `pdf:name` element. Remember that the property name must be different to the reserved keywords, which are Title, Author, Subject, Keywords, Creator, Producer, CreationDate, ModDate and Trapped.
-## PostScript {#ps}
+## PostScript { #ps}
The PostScript renderer has been brought up to a similar quality as the PDF renderer, but may still be missing certain features. Currently, the PostScript renderer generates PostScript Level 3 with most DSC comments. Actually, the only Level 3 features used are the FlateDecode and DCTDecode filter (the latter is used for 1:1 embedding of JPEG images), everything else is Level 2.
-### Configuration {#ps-configuration}
+### Configuration { #ps-configuration}
The PostScript renderer configuration currently allows the following settings:
@@ -202,7 +202,7 @@ The default value for the "dsc-compliant
The default value for the "rendering" setting is "quality". Setting it to "size" optimizes rendering for smaller file sizes which can involve minor compromises in rendering quality. For example, solid borders are then painted as plain rectangles instead of the elaborate painting instructions required for mixed-color borders.
-### Limitations {#ps-limitations}
+### Limitations { #ps-limitations}
- Type 1 fonts, also known as PostScript fonts, are always fully embedded.
@@ -210,20 +210,20 @@ The default value for the "rendering" se
- PPD support is still missing.
-## PCL {#pcl}
+## PCL { #pcl}
This format is for the Hewlett-Packard PCL printers and other printers supporting PCL. It should produce output as close to identical as possible to the printed output of the PDFRenderer within the limitations of the renderer, and output device.
The output created by the PCLRenderer is generic PCL 5, HP GL/2 and PJL. This should allow any device fully supporting PCL 5 to be able to print the output generated by the PCLRenderer. PJL is used to control the print job and switch to the PCL language. PCL 5 is used for text, raster graphics and rectangular fill graphics. HP GL/2 is used for more complex painting operations. Certain painting operations are done off-screen and rendered to PCL as bitmaps because of limitations in PCL 5.
-### References {#pcl-references}
+### References { #pcl-references}
- [WikiPedia entry on PCL](http://en.wikipedia.org/wiki/Printer_Control_Language)
- [Technical reference documents on PCL from Hewlett-Packard](http://h20000.www2.hp.com/bizsupport/TechSupport/Document.jsp?objectID=bpl04568)
-### Limitations {#pcl-limitations}
+### Limitations { #pcl-limitations}
- Text or graphics outside the left or top of the printable area are not rendered properly. This is a limitation of PCL, not FOP. In general, things that should print to the left of the printable area are shifted to the right so that they start at the left edge of the printable area.
@@ -242,7 +242,7 @@ The output created by the PCLRenderer is
- Currently, there's no support for clipping and image transparency, largely because PCL 5 has certain limitations.
-### Configuration {#pcl-configuration}
+### Configuration { #pcl-configuration}
The PCL renderer configuration currently allows the following settings:
@@ -261,7 +261,7 @@ The default value for the "disable-pjl"
You can control the output resolution for the PCL using the "target resolution" setting on the FOUserAgent. The actual value will be rounded up to the next supported PCL resolution. Currently, only 300 and 600 dpi are supported which should be enough for most use cases. Note that this setting directly affects the size of the output file and the print quality.
-### Extensions {#pcl-extensions}
+### Extensions { #pcl-extensions}
The PCL Renderer supports some PCL specific extensions which can be embedded into the input FO document. To use the extensions the appropriate namespace must be declared in the fo:root element like this:
@@ -269,7 +269,7 @@ The PCL Renderer supports some PCL speci
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
xmlns:pcl="http://xmlgraphics.apache.org/fop/extensions/pcl">
-#### Page Source (Tray selection) {#pcl-page-source}
+#### Page Source (Tray selection) { #pcl-page-source}
The page-source extension attribute on fo:simple-page-master allows to select the paper tray the sheet for a particular simple-page-master is to be taken from. Example:
@@ -282,7 +282,7 @@ The page-source extension attribute on f
Note: the tray number is a positive integer and the value depends on the target printer. Not all PCL printers support the same paper trays. Usually, "1" is the default tray, "2" is the manual paper feed, "3" is the manual envelope feed, "4" is the "lower" tray and "7" is "auto-select". Consult the technical reference for your printer for all available values.
-#### Output Bin {#pcl-output-bin}
+#### Output Bin { #pcl-output-bin}
The `output-bin` extension attribute on fo:simple-page-master allows to select the output bin into which the printed output should be fed. Example:
@@ -295,7 +295,7 @@ The `output-bin` extension attribute on
Note: the output bin number is a positive integer and the value depends on the target printer. Not all PCL printers support the same output bins. Usually, "1" is the upper output bin, "2" is the lower (rear) output bin. Consult the technical reference for your printer for all available values.
-#### Page Duplex Mode {#pcl-duplex-mode}
+#### Page Duplex Mode { #pcl-duplex-mode}
The duplex-mode extension attribute on fo:simple-page-master allows to select the duplex mode to be used for a particular simple-page-master. Example:
@@ -308,7 +308,7 @@ The duplex-mode extension attribute on f
Note: the duplex is a positive integer and the value depends on the target printer. Not all PCL printers support duplexing. Usually, "0" is simplex, "1" is duplex (long-edge binding), "2" is duplex (short-edge binding). Consult the technical reference for your printer for all available values.
-## AFP {#afp}
+## AFP { #afp}
The FOP AFP Renderer deals with creating documents conforming to the IBM AFP document architecture also refered to as MO:DCA (Mixed Object Document Content Architecture).
@@ -322,7 +322,7 @@ The mapping of XSL-FO elements to the ma
FOP creates exactly one Document per Printfile with an optional Resource Group at the beginning. FOP does not create document indices.
-### References {#afp-references}
+### References { #afp-references}
- [AFP (Advanced Function Presentation)](http://en.wikipedia.org/wiki/Advanced_Function_Presentation)
@@ -331,7 +331,7 @@ FOP creates exactly one Document per Pri
- [Technical notes on AFP output in FOP](http://wiki.apache.org/xmlgraphics-fop/AFPOutput)
-### Limitations {#afp-limitations}
+### Limitations { #afp-limitations}
This list is most likely badly incomplete.
@@ -340,13 +340,13 @@ This list is most likely badly incomplet
- Only IBM outline and raster fonts and to a limited extend the original fonts built into FOP are supported. Support for TrueType fonts may be added later.
-### Deployment in older environments {#afp-compatibility}
+### Deployment in older environments { #afp-compatibility}
There are still a big number of older (or limited) MO:DCA/IPDS environments in production out there. AFP has grown in functionality over time and not every environment supports the latest features. We're trying to make AFP output work in as many environments as possible. However, to make AFP output work on older environments it is recommended to set to configuration to 1 bit per pixel (see below on how to do this). In this case, all images are converted to bi-level images using IOCA function set 10 (FS10) and are enclosed in page-segments since some implementation cannot deal with IOCA objects directly. If a higher number of bits per pixel is configured, FOP has to switch to at least FS11 which may not work everywhere.
-### Configuration {#afp-configuration}
+### Configuration { #afp-configuration}
-#### Fonts {#afp-font-config}
+#### Fonts { #afp-font-config}
The AFP Renderer requires special configuration particularly related to fonts. AFP Render configuration is done through the normal FOP configuration file. The MIME type for the AFP Renderer is application/x-afp which means the AFP Renderer section in the FOP configuration file looks like:
@@ -503,14 +503,14 @@ For double byte EBCDIC encoded character
:::xml
<afp-font type="CIDKeyed" codepage="T10835 " encoding="Cp937" characterset="CZTKAI" ebcdic-dbcs="true"/>
-#### Output Resolution {#afp-renderer-resolution-config}
+#### Output Resolution { #afp-renderer-resolution-config}
By default the AFP Renderer creates output with a resolution of 240 dpi. This can be overridden by the <renderer-resolution/> configuration element. Example:
:::xml
<renderer-resolution>240</renderer-resolution>
-#### Images {#afp-image-config}
+#### Images { #afp-image-config}
By default the AFP Renderer converts all images to 8 bit grey level. This can be overridden by the <images/> configuration element. Example:
@@ -560,7 +560,7 @@ By default, JPEG images are rasterized t
IOCA image data placed in the AFP Resource Group (i.e. non-inline images) is wrapped in a Page Segment for single-bit and monochrome images.
-#### GOCA (Vector Graphics) {#afp-goca-config}
+#### GOCA (Vector Graphics) { #afp-goca-config}
Not all AFP implementations support GOCA. Some also have bugs related to GOCA. Therefore, it is desirable to have some control over the generation of GOCA graphics.
@@ -576,14 +576,14 @@ Some AFP implementations have trouble re
If you disable GOCA or let text render as shapes, the size of the generated AFP usually increases considerably.
-#### Shading {#afp-shading-config}
+#### Shading { #afp-shading-config}
By default, filled rectangles are painted using their given color using a PTOCA I-axis rule (DIR). But not all environments handle these colors correctly. That's why a setting is supported that paints the rectangles using an ordered dither pattern (bi-level) with an inline IOCA FS10 image that is used together with the "replicate and trim" mapping. The optional "shading" element can be used to control the shading mode. Its default value is "color". To enable the dithered mode, use "dithered". Example:
:::xml
<shading>dithered</shading>
-#### Resource Group File {#afp-resource-group-file}
+#### Resource Group File { #afp-resource-group-file}
By default the AFP Renderer will place all data resource objects such as images within the document of the main output datastream. An external resource group file where document resources may be specified with the <resource-group-file/> configuration element. Example:
@@ -592,7 +592,7 @@ By default the AFP Renderer will place a
<note>Be careful when using this option not to overwrite existing resource files from previous rendering runs.</note>
-#### Resource Level Defaults {#afp-resource-level-defaults}
+#### Resource Level Defaults { #afp-resource-level-defaults}
By default, bitmap image objects (or page segments derived from them) are put in the print-file-level resource group and GOCA graphics are inlined for compatibility with the AFP Workbench tool.
@@ -603,7 +603,7 @@ It is possible to override these default
"goca" refers to GOCA graphics and "bitmap" refers to IOCA images. The possible values for the attributes are "inline" and "print-file". In the future, additional possibilities may be added.
-### Extensions {#afp-extensions}
+### Extensions { #afp-extensions}
The AFP Renderer supports some AFP specific extensions which can be embedded into the input fo document. To use the extensions the appropriate namespace must be declared in the fo:root element like this:
@@ -611,7 +611,7 @@ The AFP Renderer supports some AFP speci
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
xmlns:afp="http://xmlgraphics.apache.org/fop/extensions/afp">
-#### Page Overlay (IPO) Extension {#afp-page-overlay}
+#### Page Overlay (IPO) Extension { #afp-page-overlay}
The include-page-overlay extension element allows to define on a per simple-page-master basis a page overlay resource. Example:
@@ -625,7 +625,7 @@ The include-page-overlay extension eleme
The mandatory name attribute must refer to an 8 character (space padded) resource name that must be known in the AFP processing environment. Optional x and y attributes can be specified to place the Overlay at an offset from the top left of the page.
-#### Page Segment (IPS) Extension {#afp-page-segment}
+#### Page Segment (IPS) Extension { #afp-page-segment}
The include-page-segment extension element allows to define resource substitution for fo:external-graphics elements. Example:
@@ -645,7 +645,7 @@ The effect here is that whenever FOP enc
The include-page-segment extension element has the optional attribute *resource-file*. The value of this is a URI to a resource containing a page segment with the declared name. In this case FOP embeds the page segment into the generated document so that the external resource does not have to be supplied in the print job.
-#### Tag Logical Element (TLE) Extension {#afp-tag-logical-element}
+#### Tag Logical Element (TLE) Extension { #afp-tag-logical-element}
The tag-logical-element extension element allows to injects TLEs into the AFP output stream. Example:
@@ -667,7 +667,7 @@ The tag-logical-element extension elemen
The tag-logical-element extension element can appear within a simple-page-master (page level) or it can appear as child of page-sequence (page group level). Multiple tag-logical-element extension elements within a simple-page-master or page-sequence are allowed. The name and value attributes are mandatory. The `encoding` attribute specifying a CCSID encoding is optional.
-#### No Operation (NOP) Extension {#afp-no-operation}
+#### No Operation (NOP) Extension { #afp-no-operation}
The no-operation extension provides the ability to carry up to 32K of comments or any other type of unarchitected data into the AFP output stream. Example:
@@ -682,7 +682,7 @@ The no-operation extension provides the
The no-operation extension element can appear as child of `simple-page-master` (appears after "Begin Page" BPG), `page-sequence` (appears after "Begin Named Page Group" BNG and `declarations` (appears after "Begin Document" BDT). Multiple no-operation extension elements inside the same formatting object are allowed. Each NOP will appear right after the respective "Begin" field indicated above even if it is specified as the last child under its parent. The order inside the parent will be maintained. The "placement" attribute can be used to have the NOP appear before the "End" field of the object rather than after the "Begin" field. Specify `placement="before-end"` to do that. Please note that, at the moment, this only has an effect for NOPs that are children of the `page-sequence` formatting object. The "name" attribute is mandatory but will not appear inside the AFP stream.
-#### Invoke Medium Map (IMM) Extension {#afp-invoke-medium-map}
+#### Invoke Medium Map (IMM) Extension { #afp-invoke-medium-map}
The invoke-medium-map extension allows to generate IMM fields (Invoke Medium Map) in the generated AFP output. Example:
@@ -697,7 +697,7 @@ The invoke-medium-map extension allows t
The invoke-medium-map element is allowed as child of fo:page-sequence (page group level) or fo:simple-page-master. It is NOT supported on document level (fo:root), yet. FOP also doesn't support specifying medium maps inside XML (using BMM/EMM). It can only reference an existing medium map by name. The medium map has to be constructed through different means and available on the target platform.
-#### Form Maps/Defs {#afp-form-maps}
+#### Form Maps/Defs { #afp-form-maps}
Apache FOP supports embedding an external form map resource in the generated AFP output. This is done using the `afp:include-form-map` extension. An example:
@@ -713,9 +713,9 @@ The `afp:include-form-map` is to be plac
<note>Apache FOP doesn't support a way to define a form map or medium map using XML means inside an XSL-FO document. You will have to build the form map with some third-party tool.</note>
-### Foreign Attributes {#afp-foreign-attributes}
+### Foreign Attributes { #afp-foreign-attributes}
-#### Resource {#afp-foreign-attributes-resource}
+#### Resource { #afp-foreign-attributes-resource}
The resource foreign attributes provides the ability to name and control where data object resources (e.g. images/scalable vector graphics) will reside in the AFP output. The afp foreign attributes are only used in conjuntion with <fo:external-graphic/> and <instream-foreign-object/>. Example:
@@ -745,7 +745,7 @@ The resource-level attribute where the r
-## RTF {#rtf}
+## RTF { #rtf}
JFOR, an open source XSL-FO to RTF converter has been integrated into Apache FOP. This will create an RTF (rich text format) document that will attempt to contain as much information from the XSL-FO document as possible. It should be noted that is not possible (due to RTF's limitations) to map all XSL-FO features to RTF. For complex documents, the RTF output will never reach the feature level from PDF, for example. Thus, using RTF output is only recommended for simple documents such as letters.
@@ -775,27 +775,27 @@ These are some known restrictions compar
- percentages are not supported everywhere
-## XML (Area Tree XML) {#xml}
+## XML (Area Tree XML) { #xml}
This is primarily for testing and verification. The XML created is simply a representation of the internal area tree put into XML. We use that to verify the functionality of FOP's layout engine.
The other use case of the Area Tree XML is as FOP's "intermediate format". More information on that can be found on the page dedicated to the [Intermediate Format](intermediate.html).
-## Java2D/AWT {#awt}
+## Java2D/AWT { #awt}
The Java2DRenderer provides the basic functionality for all Java2D-based output formats (AWT viewer, direct print, PNG, TIFF).
The AWT viewer shows a window with the pages displayed inside a Java graphic. It displays one page at a time. The fonts used for the formatting and viewing depend on the fonts available to your JRE.
-## Print {#print}
+## Print { #print}
It is possible to directly print the document from the command line. This is done with the same code that renders to the Java2D/AWT renderer.
-### Known issues {#print-issues}
+### Known issues { #print-issues}
If you run into the problem that the printed output is incomplete on Windows: this often happens to users printing to a PCL printer. There seems to be an incompatibility between Java and certain PCL printer drivers on Windows. Since most network-enabled laser printers support PostScript, try switching to the PostScript printer driver for that printer model.
-## Bitmap (TIFF/PNG) {#bitmap}
+## Bitmap (TIFF/PNG) { #bitmap}
It is possible to directly create bitmap images from the individual pages generated by the layout engine. This is done with the same code that renders to the Java2D/AWT renderer.
@@ -803,7 +803,7 @@ Currently, two output formats are suppor
The quality of the bitmap depends on the target resolution setting on the FOUserAgent and on further settings described below.
-### Configuration {#bitmap-configuration}
+### Configuration { #bitmap-configuration}
The TIFF and PNG renderer configuration currently allows the following settings:
@@ -838,7 +838,7 @@ The default value for the `"anti-aliasin
The default value for the `"rendering"` setting is `"true"`. You can set this value to `"false"` to improve rendering speeds a bit at the loss of some image quality. If this setting has an actual effect depends on the JVM's Java2D backend.
-### TIFF-specific Configuration {#tiff-configuration}
+### TIFF-specific Configuration { #tiff-configuration}
In addition to the above values the TIFF renderer configuration allows some additional settings:
@@ -877,7 +877,7 @@ This setting may override any setting ma
The default value for the `"single-strip"` is `"false"` resulting in the RowsPerStrip Tiff Tag equal to the number of rows. If set to `"true"` RowsPerStrip is set to 1.
-### Runtime Rendering Options {#bitmap-rendering-options}
+### Runtime Rendering Options { #bitmap-rendering-options}
The IF-based bitmap output implementations support a rendering option with the key "target-bitmap-size" (value: java.awt.Dimension) that allows to force the pages to be proportionally fit into a bitmap of a given size. This can be used to produce thumbnails or little preview images of the individual pages. An example:
@@ -885,7 +885,7 @@ The IF-based bitmap output implementatio
userAgent.getRenderingOptions().put(
"target-bitmap-size", new Dimension(320, 200));
-## TXT {#txt}
+## TXT { #txt}
The text renderer produces plain ASCII text output that attempts to match the output of the PDFRenderer as closely as possible. This was originally developed to accommodate an archive system that could only accept plain text files, and is primarily useful for getting a quick-and-dirty view of the document text. The renderer is very limited, so do not be surprised if it gives unsatisfactory results.
@@ -898,19 +898,19 @@ Because FOP lays the text onto a grid du
- line-height="10pt"
-## Output Formats in the Sandbox {#sandbox}
+## Output Formats in the Sandbox { #sandbox}
Due to the state of certain renderers we moved some of them to a "sandbox" area until they are ready for more serious use. The renderers and FOEventHandlers in the sandbox can be found under src/sandbox and are compiled into build/fop-sandbox.jar during the main build. The output formats in the sandbox are marked as such below.
-### MIF {#mif}
+### MIF { #mif}
<warning>The MIF handler is in the sandbox and not yet functional in FOP Trunk!!! Please help us ressurrect this feature.</warning>
This format is the Maker Interchange Format which is used by Adobe Framemaker.
-### SVG {#svg}
+### SVG { #svg}
<warning>The SVG renderer is in the sandbox and may not work as expected in FOP Trunk!!! Please help us improve this feature.</warning>
This format creates an SVG document that has links between the pages. This is primarily for slides and creating svg images of pages. Large documents will create SVG files that are far too large for an SVG viewer to handle. Since FO documents usually have text the SVG document will have a large number of text elements. The font information for the text is obtained from the JVM in the same way as for the AWT viewer. If the SVG is viewed on a system where the fonts are different, such as another platform, then the page may look wrong.
-## Wish list {#wishlist}
+## Wish list { #wishlist}
Apache FOP is easily extensible and allows you to add new output formats to enhance FOP's functionality. There's a number of output formats which are on our wish list. We're looking for volunteers to help us implement them.
Modified: xmlgraphics/site/trunk/content/fop/trunk/pdfa.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/pdfa.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/pdfa.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/pdfa.mdtext Thu Jul 24 16:21:20 2014
@@ -3,13 +3,13 @@ Title: Apache(tm) FOP: PDF/A (ISO 19005)
#Apache™ FOP: PDF/A (ISO 19005)
<authors><person email="jeremias@apache.org" name="Jeremias Märki"></person></authors>
-## Overview {#overview}
+## Overview { #overview}
PDF/A is a standard which turns PDF into an "electronic document file format for long-term preservation". PDF/A-1 is the first part of the standard and is documented in [ISO 19005-1:2005(E)](http://www.iso.org/iso/en/CatalogueDetailPage.CatalogueDetail?CSNUMBER=38920&ICS1=37&ICS2=100&ICS3=99). Work on PDF/A-2 is in progress at [AIIM](http://www.aiim.org/standards.asp?ID=25013).
Design documentation on PDF/A can be found on FOP's Wiki on the [PDFAConformanceNotes](http://wiki.apache.org/xmlgraphics-fop/PDFAConformanceNotes) page.
-## Implementation Status {#status}
+## Implementation Status { #status}
**PDF/A-1b** is implemented to the degree that FOP supports the creation of the elements described in ISO 19005-1.
@@ -17,13 +17,13 @@ Tests have been performed against jHove
**PDF/A-1a** is based on PDF-A-1b and adds accessibility features (such as Tagged PDF). This format is available within the limitation described on the [Accessibility page](accessibility.html).
-## Usage (command line) {#command-line}
+## Usage (command line) { #command-line}
To activate PDF/A-1b from the command-line, specify "-pdfprofile PDF/A-1b" as a parameter. If there is a violation of one of the validation rules for PDF/A, an error message is presented and the processing stops.
PDF/A-1a is enabled by specifying "-pdfprofile PDF/A-1a".
-## Usage (embedded) {#embedded}
+## Usage (embedded) { #embedded}
When FOP is embedded in another Java application you can set a special option on the renderer options in the user agent to activate the PDF/A-1b profile. Here's an example:
@@ -36,7 +36,7 @@ If one of the validation rules of PDF/A
For PDF/A-1a, just use the string "PDF/A-1a" instead of "PDF/A-1b".
-## PDF/A in Action {#rules}
+## PDF/A in Action { #rules}
There are a number of things that must be looked after if you activate a PDF/A profile. If you receive a PDFConformanceException, have a look at the following list (not necessarily comprehensive):
@@ -56,11 +56,11 @@ There are a number of things that must b
<note>There are additional requirements if you want to enabled PDF/A-1a (Tagged PDF). This is particularly the specification of the natural language and alternative descriptions for images. Please refer to the [Accessibility page](accessibility.html) for details.</note>
-## PDF profile compatibility {#profile-compatibility}
+## PDF profile compatibility { #profile-compatibility}
The PDF profiles "PDF/X-3:2003" and "PDF/A-1b" (or "PDF/A-1a") are compatible and can both be activated at the same time.
-## Interoperability {#interoperability}
+## Interoperability { #interoperability}
There has been some confusion about the namespace for the PDF/A indicator in the XMP metadata. At least three variants have been seen in the wild:
Modified: xmlgraphics/site/trunk/content/fop/trunk/pdfencryption.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/pdfencryption.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/pdfencryption.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/pdfencryption.mdtext Thu Jul 24 16:21:20 2014
@@ -3,13 +3,13 @@ Title: Apache(tm) FOP: PDF encryption.
#Apache™ FOP: PDF encryption.
<authors><person email="pietsch@apache.org" name="J.Pietschmann"></person><person email="jeremias@apache.org" name="Jeremias Märki"></person></authors>
-## Overview {#Overview}
+## Overview { #Overview}
Apache™ FOP supports encryption of PDF output, thanks to Patrick C. Lankswert and others. 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.
-## Usage (fop.xconf) {#fopxconf}
+## Usage (fop.xconf) { #fopxconf}
<renderer mime="application/pdf">
<encryption-params>
@@ -25,7 +25,7 @@ For further information about features a
</renderer>
-## Usage (command line) {#commandline}
+## Usage (command line) { #commandline}
Encryption is enabled by supplying any of the encryption related options.
@@ -48,7 +48,7 @@ Further restrictions can be imposed by u
| `-noassembledoc` | disable assembling documents |
| `-noprinthq` | disable high quality printing |
-## Usage (embedded) {#embedded}
+## Usage (embedded) { #embedded}
When FOP is embedded in another Java application you need to set an options map on the renderer. These are the supported options:
@@ -134,6 +134,6 @@ Alternatively, you can set each value se
The password length is restricted to a maximum of 32 bytes if the encryption-length is 128 or less, and to a maximum of 127 bytes if the encryption-length is 256 (longer passwords will be truncated to the maximum allowed).
-## Environment {#Environment}
+## Environment { #Environment}
The PDF encryption implemented in FOP does not need external libraries to perform encryption. A recent JDK (1.5+) is sufficient. However, encryption using keys with 256 bits requires the installation of the JCE Unlimited Strength Jurisdiction Policy files from Oracle.
Modified: xmlgraphics/site/trunk/content/fop/trunk/pdfx.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/pdfx.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/pdfx.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/pdfx.mdtext Thu Jul 24 16:21:20 2014
@@ -3,13 +3,13 @@ Title: Apache(tm) FOP: PDF/X (ISO 15930)
#Apache™ FOP: PDF/X (ISO 15930)
<authors><person email="jeremias@apache.org" name="Jeremias Märki"></person></authors>
-## Overview {#overview}
+## Overview { #overview}
<warning>Support for PDF/X is available beginning with version 0.93. This feature is new and may not be 100% complete, yet. Feedback is welcome.</warning>
PDF/X is a standard which faciliates prepress digital data exchange using PDF. Currently, only PDF/X-3:2003 is implemented out of the many different flavours of PDF/X profiles. PDF/X-3:2003 is documented in [ISO 15930-6:2003(E)](http://www.iso.org/iso/en/CatalogueDetailPage.CatalogueDetail?CSNUMBER=39940&ICS1=37&ICS2=100&ICS3=99). More info on PDF/X can be found on the [PDF/X info site](http://www.pdfx.info/).
-## Implementation Status {#status}
+## Implementation Status { #status}
**PDF/X-3:2003** is implemented to the degree that FOP supports the creation of the elements described in ISO 15930-6.
@@ -17,11 +17,11 @@ An important restriction of the current
Tests have been performed against Adobe Acrobat 7.0.7 (Preflight function). Note that there are bugs in Adobe Acrobat which cause false alarms if both PDF/A-1b and PDF/X-3:2003 are activated at the same time.
-## Usage (command line) {#command-line}
+## Usage (command line) { #command-line}
To activate PDF/X-3:2003 from the command-line, specify "-pdfprofile PDF/X-3:2003" as a parameter. If there is a violation of one of the validation rules for PDF/X, an error message is presented and the processing stops.
-## Usage (embedded) {#embedded}
+## Usage (embedded) { #embedded}
When FOP is embedded in another Java application you can set a special option on the renderer options in the user agent to activate the PDF/A-1b profile. Here's an example:
@@ -33,7 +33,7 @@ When FOP is embedded in another Java app
If one of the validation rules of PDF/X is violated, an PDFConformanceException (descendant of RuntimeException) is thrown.
-## PDF/X in Action {#rules}
+## PDF/X in Action { #rules}
There are a number of things that must be looked after if you activate a PDF/X profile. If you receive a PDFConformanceException, have a look at the following list (not necessarily comprehensive):
@@ -50,6 +50,6 @@ There are a number of things that must b
- PDF is forced to version 1.4 if PDF/X-3:2003 is activated.
-## PDF profile compatibility {#profile-compatibility}
+## PDF profile compatibility { #profile-compatibility}
The PDF profiles "PDF/X-3:2003" and "PDF/A-1b" are compatible and can both be activated at the same time.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org