diff options
| author | Vincent Hennebert <vhennebert@apache.org> | 2009-09-18 17:10:42 +0000 |
|---|---|---|
| committer | Vincent Hennebert <vhennebert@apache.org> | 2009-09-18 17:10:42 +0000 |
| commit | 0e5a789b6b0604bb9c6cc9b782c22f490917e9f9 (patch) | |
| tree | 70af78b83ebd8d83f4576c8b9329113ee34aae0f /src/documentation/content/xdocs | |
| parent | c5d9b312e01efc7f96a30043d73945594504c7d0 (diff) | |
| parent | 9b49126cd645f4377d1bb56d5078a8d4a0cd491e (diff) | |
| download | xmlgraphics-fop-0e5a789b6b0604bb9c6cc9b782c22f490917e9f9.tar.gz xmlgraphics-fop-0e5a789b6b0604bb9c6cc9b782c22f490917e9f9.zip | |
Merged changes from Trunk up to revision 816269
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/branches/Temp_Accessibility@816718 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/documentation/content/xdocs')
| -rw-r--r-- | src/documentation/content/xdocs/compliance.ihtml | 24 | ||||
| -rw-r--r-- | src/documentation/content/xdocs/quickstartguide.xml | 4 | ||||
| -rw-r--r-- | src/documentation/content/xdocs/resources.xml | 1 | ||||
| -rw-r--r-- | src/documentation/content/xdocs/trunk/embedding.xml | 3 | ||||
| -rw-r--r-- | src/documentation/content/xdocs/trunk/events.xml | 25 | ||||
| -rw-r--r-- | src/documentation/content/xdocs/trunk/extensions.xml | 108 | ||||
| -rw-r--r-- | src/documentation/content/xdocs/trunk/output.xml | 78 |
7 files changed, 222 insertions, 21 deletions
diff --git a/src/documentation/content/xdocs/compliance.ihtml b/src/documentation/content/xdocs/compliance.ihtml index 781299361..0b3a7706a 100644 --- a/src/documentation/content/xdocs/compliance.ihtml +++ b/src/documentation/content/xdocs/compliance.ihtml @@ -533,11 +533,11 @@ <td class="no">no</td> - <td class="no">no</td> + <td class="yes">yes</td> - <td class="no">no</td> + <td class="yes">yes</td> - <td class="no">no</td> + <td class="yes">yes</td> <td align="center"> </td> </tr> @@ -552,11 +552,11 @@ <td class="no">no</td> - <td class="no">no</td> + <td class="yes">yes</td> - <td class="no">no</td> + <td class="yes">yes</td> - <td class="no">no</td> + <td class="yes">yes</td> <td align="center"> </td> </tr> @@ -870,11 +870,11 @@ <td class="no">no</td> - <td class="no">no</td> + <td class="yes">yes</td> - <td class="no">no</td> + <td class="yes">yes</td> - <td class="no">no</td> + <td class="yes">yes</td> <td align="center"> </td> </tr> @@ -1714,11 +1714,11 @@ <td class="partial">partial</td> - <td class="partial">partial</td> + <td class="yes">yes</td> <td align="left"> <ul> - <li>[0.94 and later] Only works as expected with inline-level content.</li> + <li>[0.95] Only works as expected with inline-level content.</li> </ul> </td> </tr> @@ -4827,7 +4827,7 @@ <li>[0.95] works on all implemented FOs, except list- and inline-level FOs.</li> <li>[Trunk] does not work on inline-level FOs.</li> - + <li>[0.95 and earlier] <integer> values are not supported.</li> <li>[Trunk] minimal support for <integer> value.</li> </ul> diff --git a/src/documentation/content/xdocs/quickstartguide.xml b/src/documentation/content/xdocs/quickstartguide.xml index ca205f5a2..7993e4bde 100644 --- a/src/documentation/content/xdocs/quickstartguide.xml +++ b/src/documentation/content/xdocs/quickstartguide.xml @@ -15,13 +15,13 @@ See the License for the specific language governing permissions and limitations under the License. --> -<!-- $Id: gethelp.xml 627324 2008-02-13 09:35:01Z maxberger $ --> +<!-- $Id$ --> <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd"> <document> <header> <title>FOP: Quick Start Guide</title> <subtitle>Everything you need to start using and appreciating Apache FOP quickly.</subtitle> - <version>$Revision: 627324 $</version> + <version>$Revision$</version> </header> <body> <section id="essentials"> diff --git a/src/documentation/content/xdocs/resources.xml b/src/documentation/content/xdocs/resources.xml index 252605d42..db45d7437 100644 --- a/src/documentation/content/xdocs/resources.xml +++ b/src/documentation/content/xdocs/resources.xml @@ -247,6 +247,7 @@ [software] <jump href="http://www.ahmadsoft.org/fopbridge.html">FOP Bridge</jump> is an Eclipse plug-in that allows to convert FO documents using Apache FOP directly inside the Eclipse workbench (LGPL). </li> + <li>[software] <jump href="http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-fo/">Maven Doxia FO Module</jump>. Doxia is a content generation framework which aims to provide its users with powerful techniques for generating static and dynamic content: Doxia can be used in web-based publishing context to generate static sites, in addition to being incorporated into dynamic content generation systems like blogs, wikis and content management systems. Doxia provides a module providing XSL Formatting Objects.</li> </ul> </section> </section> diff --git a/src/documentation/content/xdocs/trunk/embedding.xml b/src/documentation/content/xdocs/trunk/embedding.xml index 95e96104b..362062bbe 100644 --- a/src/documentation/content/xdocs/trunk/embedding.xml +++ b/src/documentation/content/xdocs/trunk/embedding.xml @@ -557,6 +557,9 @@ fopFactory.setUserConfig(new File("C:/Temp/mycfg.xml"));]]></source> Fine-tune your stylesheet to make the XSLT process more efficient and to create XSL-FO that can be processed by FOP more efficiently. Less is more: Try to make use of property inheritance where possible. </li> + <li> + You may also wish to consider trying to reduce <a href="http://xmlgraphics.apache.org/fop/trunk/running.html#memory">memory usage</a>. + </li> </ul> </section> <section id="multithreading"> diff --git a/src/documentation/content/xdocs/trunk/events.xml b/src/documentation/content/xdocs/trunk/events.xml index 51a1bb6cc..dc08b0099 100644 --- a/src/documentation/content/xdocs/trunk/events.xml +++ b/src/documentation/content/xdocs/trunk/events.xml @@ -20,7 +20,7 @@ <document> <header> <title>Events/Processing Feedback</title> - <version>$Revision: 634267 $</version> + <version>$Revision$</version> </header> <body> <section id="introduction"> @@ -152,7 +152,28 @@ foUserAgent.getEventBroadcaster().addEventListener(new SysOutEventListener());]] <p> By default, FOP continues processing even if an image wasn't found. If you have more strict requirements and want FOP to stop if an image is not available, you can - do something like the following: + do something like the following in the simplest case: + </p> + <source><![CDATA[public class MyEventListener implements EventListener { + + public void processEvent(Event event) { + if ("org.apache.fop.events.ResourceEventProducer".equals( + event.getEventGroupID())) { + event.setSeverity(EventSeverity.FATAL); + } else { + //ignore all other events (or do something of your choice) + } + } + +}]]></source> + <p> + Increasing the event severity to FATAL will signal the event broadcaster to throw + an exception and stop further processing. In the above case, all resource-related + events will cause FOP to stop processing. + </p> + <p> + You can also customize the exception to throw (you can may throw a RuntimeException + or subclass yourself) and/or which event to respond to: </p> <source><![CDATA[public class MyEventListener implements EventListener { diff --git a/src/documentation/content/xdocs/trunk/extensions.xml b/src/documentation/content/xdocs/trunk/extensions.xml index 878494ecb..107f6c5b3 100644 --- a/src/documentation/content/xdocs/trunk/extensions.xml +++ b/src/documentation/content/xdocs/trunk/extensions.xml @@ -226,8 +226,114 @@ to following pages. Here is an example of FO code creating such a table-header:< color space the CMYK value is converted to an sRGB value. </p> </section> + <section id="pseudo-color-profiles"> + <title>#CMYK pseudo-profile</title> + <p><code>color rgb-icc(numeric, numeric, numeric, #CMYK, numeric, numeric, numeric, numeric)</code></p> + <p> + The <code>rgb-icc</code> function will respond to a pseudo-profile called "#CMYK" + which indicates a device-specific CMYK color space. The "#CMYK" profile is implicitely + available and doesn't have to be (and cannot be) defined through an + <code>fo:color-profile</code> element. It is provided for compatibility with certain + commercial XSL-FO implementations. Please note that this is not part of the official + specification but rather a convention. The following two color specifications are + equivalent: + </p> + <ul> + <li><code>cmyk(0%,0%,20%,40%)</code></li> + <li><code>rgb-icc(153, 153, 102, #CMYK, 0, 0, 0.2, 0.4)</code></li> + </ul> + </section> + </section> + <section id="prepress"> + <title>Prepress Support</title> + + <p> + This section defines a number of extensions related to + <a href="http://en.wikipedia.org/wiki/Prepress">prepress</a> support. + <code>fox:scale</code> defines a general scale factor for the generated pages. + <code>fox:bleed</code> defines the + <a href="http://en.wikipedia.org/wiki/Bleed_%28printing%29">bleed area</a> for a page. + <code>fox:crop-offset</code> 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. + </p> + <note> + Those extensions have been implemented in the PDF and Java2D renderers only. + </note> + + <section id="scale"> + <title>fox:scale</title> + <p>Value: <number>{1,2}</p> + <p>Initial: 1</p> + <p>Applies to: fo:simple-page-master</p> + <p> + 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. + </p> + </section> + <section id="bleed"> + <title>fox:bleed</title> + <p> + Value: <length>{1,4} + </p> + <p> + Initial: 0pt + </p> + <p>Applies to: fo:simple-page-master</p> + <p> + If there is only one value, it applies to all sides. If there are two values, the top and bottom + bleed widths are set to the first value and the right and left bleed widths are set to the second. + If there are three values, the top is set to the first value, the left and right are set to the second, + and the bottom is set to the third. If there are four values, they apply to the top, right, bottom, and + left, respectively. + (Corresponds to <a href="http://www.w3.org/TR/xsl11/#padding">the definition of + padding</a>). + </p> + <p> + This extension indirectly defines the BleedBox and is calculated by expanding the TrimBox by + the bleed widths. The lengths must be non-negative. + </p> + </section> + <section id="cropOffset"> + <title>fox:crop-offset</title> + <p> + Value: <length>{1,4} + </p> + <p> + Initial: bleed (see below) + </p> + <p>Applies to: fo:simple-page-master</p> + <p> + Same behaviour as with fox:bleed. The initial value is set to the same values as the + fox:bleed property. + </p> + <p> + This extension indirectly defines the MediaBox and is calculated by expanding + the TrimBox by the crop offsets. The lengths must be non-negative. + </p> + </section> + <section id="cropBox"> + <title>fox:crop-box</title> + <p> + Value: [trim-box | bleed-box | media-box] + </p> + <p> + Initial: media-box + </p> + <p>Applies to: fo:simple-page-master</p> + <p> + The crop box controls how Acrobat displays the page (CropBox in PDF) or how the Java2DRenderer sizes + the output media. The PDF specification defines that the CropBox defaults to the MediaBox. This extension + follows that definition. To simplify usage and cover most use cases, the three supported enumeration + values "trim-box", "bleed-box" and "media-box" set the CropBox to one of those three other boxes. + </p> + <p> + If requested in the future, we could offer to specify the CropBox in absolute coordinates rather + than just by referencing another box. + </p> + </section> </section> - </section> </body> </document> diff --git a/src/documentation/content/xdocs/trunk/output.xml b/src/documentation/content/xdocs/trunk/output.xml index c2548b390..9c88c27d0 100644 --- a/src/documentation/content/xdocs/trunk/output.xml +++ b/src/documentation/content/xdocs/trunk/output.xml @@ -422,6 +422,28 @@ out = proc.getOutputStream();]]></source> Consult the technical reference for your printer for all available values. </p> </section> + <section id="pcl-output-bin"> + <title>Output Bin</title> + <p> + The <code>output-bin</code> extension attribute on fo:simple-page-master allows to + select the output bin into which the printed output should be fed. Example: + </p> + <source><![CDATA[ + <fo:layout-master-set> + <fo:simple-page-master master-name="simple" pcl:output-bin="2"> + ... + </fo:simple-page-master> + </fo:layout-master-set> +]]></source> + <p> + Note: the output bin number is a positive integer and the value depends on + the target printer. Not all PCL printers support the same output bins. + Usually, + "1" is the upper output bin, + "2" is the lower (rear) output bin. + Consult the technical reference for your printer for all available values. + </p> + </section> <section id="pcl-duplex-mode"> <title>Page Duplex Mode</title> <p> @@ -651,6 +673,11 @@ out = proc.getOutputStream();]]></source> <font-triplet name="monospace" style="normal" weight="bold"/> <font-triplet name="Courier" style="normal" weight="bold"/> </font>]]></source> + <p> + By default, all manually configured fonts are embedded, unless they are matched in the + <a href="fonts.html#embedding"><code>referenced-fonts</code> section of the configuration file</a>. + However, the default fonts shown above will not be embedded. + </p> </section> <section id="afp-renderer-resolution-config"> <title>Output Resolution</title> @@ -680,6 +707,20 @@ out = proc.getOutputStream();]]></source> Support for native image formats (e.g. JPEG, GIF) is not always available on printer implementations so by default this configuration option is set to "false".</p> </section> + <section id="afp-shading-config"> + <title>Shading</title> + <p> + By default, filled rectangles are painted using their given color using a PTOCA I-axis rule + (DIR). But not all environments handle these colors correctly. That's why a setting is + supported that paints the rectangles using an ordered dither pattern (bi-level) with + an inline IOCA FS10 image that is used together with the "replicate and trim" mapping. + The optional "shading" element can be used to control the shading mode. Its default value + is "color". To enable the dithered mode, use "dithered". Example: + </p> + <source><![CDATA[ + <shading>dithered</shading> +]]></source> + </section> <section id="afp-resource-group-file"> <title>Resource Group File</title> <p>By default the AFP Renderer will place all data resource objects such as images within @@ -816,11 +857,40 @@ out = proc.getOutputStream();]]></source> ]]></source> <p> The invoke-medium-map element is allowed as child of fo:page-sequence (page group - level). 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. + 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. + </p> + </section> + <section id="afp-form-maps"> + <title>Form Maps/Defs</title> + <p> + Apache FOP supports embedding an external form map resource in the + generated AFP output. This is done using the <code>afp:include-form-map</code> + extension. An example: + </p> + <source><![CDATA[ +<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format" + xmlns:afp="http://xmlgraphics.apache.org/fop/extensions/afp"> + [..] + <fo:declarations> + <afp:include-form-map name="F1SAMP1" src="file:f1samp1.fde"/> + </fo:declarations> +]]></source> + <p> + The <code>afp:include-form-map</code> is to be placed as a direct child of + <code>fo:declarations</code>. The <code>name</code> is an AFP resource name + (max. 8 characters) and the <code>src</code> attribute is the URI identifying the + external form map resource. When such a form map is embedded, you can use the + <code>afp:invoke-medium-map</code> extension (described above) to invoke any medium + map included in the form map. </p> + <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> </section> </section> <section id="afp-foreign-attributes"> |