You are viewing a plain text version of this content. The canonical link for it is here.
Posted to fop-commits@xmlgraphics.apache.org by je...@apache.org on 2005/10/25 21:50:57 UTC

svn commit: r328462 [2/3] - in /xmlgraphics/fop/trunk/src/documentation/content/xdocs: ./ 0.20.5/ 0.90/ dev/ dev/design/ trunk/

Copied: xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/embedding.xml (from r328299, xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.20.5/embedding.xml)
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/embedding.xml?p2=xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/embedding.xml&p1=xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.20.5/embedding.xml&r1=328299&r2=328462&rev=328462&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.20.5/embedding.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/embedding.xml Tue Oct 25 12:49:46 2005
@@ -1,6 +1,6 @@
 <?xml version="1.0" standalone="no"?>
 <!--
-  Copyright 1999-2004 The Apache Software Foundation
+  Copyright 1999-2005 The Apache Software Foundation
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -15,312 +15,416 @@
   limitations under the License.
 -->
 <!-- $Id$ -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
-    "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/core/context/resources/schema/dtd/document-v12.dtd">
-
-
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
 <!-- Embedding FOP -->
 <document>
   <header>
-    <title>FOP: Embedding</title>
+    <title>Apache FOP: Embedding</title>
     <subtitle>How to Embed FOP in a Java application</subtitle>
     <version>$Revision$</version>
   </header>
 
-    <body>
+  <body>
   <section id="overview">
     <title>Overview</title>
-    <p>Review <link href="running.html">Running FOP</link> for important information that applies to embedded applications as well as command-line use, such as options and performance.
+    <p>
+      Review <a href="running.html">Running FOP</a> for important information that applies 
+      to embedded applications as well as command-line use, such as options and performance.
+    </p>
+    <p>
+      To embed Apache FOP in your application, instantiate org.apache.fop.apps.Fop.
+      You'll tell FOP in the constructor which output format (i.e. Renderer) to use.
+      Afterwards, you'll set the OutputStream to use to output the results of the
+      rendering (where applicable). You can customize FOP's behaviour by supplying
+      your own FOUserAgent instance. The FOUserAgent can, for example, be used to
+      set your own Renderer instance (details below). Finally, you retrieve a SAX 
+      DefaultHandler instance from the Fop instance to which you can send your
+      FO file.
     </p>
-  <p>To embed FOP in your application, instantiate org.apache.fop.apps.Driver.
-     Once this class is
-     instantiated, methods are called to set the
-     Renderer to use
-     and the OutputStream to use to output the results of the
-     rendering (where applicable). In the case of the Renderer and
-     ElementMapping(s), the Driver may be supplied either with the
-     object itself, or the name of the class, in which case Driver will
-     instantiate the class itself. The advantage of the latter is it
-     enables runtime determination of Renderer and ElementMapping(s).
-  </p>
   </section>
   <section id="basics">
-    <title>Basics</title>
-  <p>The simplest way to use Driver is to instantiate it with the
-     InputSource and OutputStream, then set the renderer desired and
-     call the run method.
-  </p>
-  <p>Here is an example use of Driver which outputs PDF:
-  </p>
-    <source><![CDATA[
-import org.apache.fop.apps.Driver;
-
-/*..*/
-
-Driver driver = new Driver(new InputSource(args[0]),
-                           new FileOutputStream(args[1]));
-driver.setRenderer(Driver.RENDER_PDF);
-driver.run();]]></source>
-  <p>
-In the example above, args[0] contains the path to an XSL-FO file, while 
-args[1] contains a path for the target PDF file.
-  </p>
- <section id="basic-logging">
-    <title>Logging</title>
+    <title>Basic Usage Pattern</title>
     <p>
-      You also need to set up logging. Global logging for all FOP
-      processes is managed by MessageHandler. Per-instance logging
-      is handled by Driver. You want to set both using an implementation
-      of org.apache.avalon.framework.logger.Logger. See 
-      <jump href="#logging">below</jump> for more information.
+      Apache FOP relies heavily on JAXP. It uses SAX events exclusively to receive the XSL-FO 
+      input document. It is therefore a good idea that you know a few things about JAXP (which
+      is a good skill anyway). Let's look at the basic usage pattern for FOP...
     </p>
-    <p>
-      Call <code>setLogger(Logger)</code> always immediately after 
-      instantiating the Driver object. See here:
+    <p>Here is the basic pattern to render an XSL-FO file to PDF:
     </p>
     <source><![CDATA[
-import org.apache.avalon.framework.logger.Logger; 
-import org.apache.avalon.framework.logger.ConsoleLogger; 
+import org.apache.fop.apps.Fop;
+import org.apache.fop.fo.Constants;
 
 /*..*/
 
-Driver driver = new Driver();
-Logger logger = new ConsoleLogger(ConsoleLogger.LEVEL_INFO);
-MessageHandler.setScreenLogger(logger);
-driver.setLogger(logger);]]></source>
-  </section>
-  
-  <section id="basic-logging-new-version">
-    <title>Logging (Upcoming FOP 1.0 Version only)</title>
-    <p>
-      Logging is handled automatically via Jakarta Commons-Logging, which uses
-      JDK logging by default.  No special driver configuration is needed.
-      For specialized configuration of Commons-Logging (e.g. to use a
-      different logger or to change logging levels), please see the  
-      <fork href="http://jakarta.apache.org/commons/logging/">Jakarta Commons-Logging</fork>
-      site.
-    </p>
-  </section>
+// Step 1: Construct fop with desired output format
+Fop fop = new Fop(Constants.RENDER_PDF);
 
-  <section id="render">
-    <title>Processing XSL-FO</title>
+// Step 2: Setup output stream.
+// Note: Using BufferedOutputStream for performance reasons (helpful with FileOutputStreams).
+OutputStream out = new BufferedOutputStream(new FileOutputStream(new File("C:/Temp/myfile.pdf")));
+try {
+  fop.setOutputStream(out);
+
+  // Step 3: Setup JAXP using identity transformer
+  TransformerFactory factory = TransformerFactory.newInstance();
+  Transformer transformer = factory.newTransformer(); // identity transformer
+           
+  // Step 4: Setup input and output for XSLT transformation 
+  // Setup input stream
+  Source src = new StreamSource(new File("C:/Temp/myfile.fo"));
+
+  // Resulting SAX events (the generated FO) must be piped through to FOP
+  Result res = new SAXResult(fop.getDefaultHandler());
+            
+  // Step 5: Start XSLT transformation and FOP processing
+  transformer.transform(src, res);
+
+} finally {
+  //Clean-up
+  out.close();
+}]]></source>
     <p>
-      Once the Driver is set up, one of the <code>render()</code> methods
-      is called. Depending on whether DOM or an InputSource is being used, the
-      invocation of the method is either <code>render(Document)</code> or
-      <code>render(Parser, InputSource)</code> respectively.
+      Let's discuss these 5 steps in detail:
     </p>
+    <ul>
+      <li>
+        <strong>Step 1:</strong> You create a new Fop instance and set it up for PDF 
+        output.
+      </li>
+      <li>
+        <strong>Step 2:</strong> You tell FOP where to save the generated PDF file 
+        later. It's a good idea to buffer the OutputStream as demonstrated to improve 
+        performance.
+      </li>
+      <li>
+        <strong>Step 3:</strong> We recommend that you use JAXP Transformers even 
+        if you don't do XSLT transformations to generate the XSL-FO file. This way 
+        you can always use the same basic pattern. The example here sets up an 
+        "identity transformer" which just passes the input (Source) unchanged to the 
+        output (Result). You don't have to work with a SAXParser if you don't do any 
+        XSLT transformations.
+      </li>
+      <li>
+        <strong>Step 4:</strong> Here you set up the input and output for the XSLT 
+        transformation. The Source object is set up to load the "myfile.fo" file. 
+        The Result is set up so the output of the XSLT transformation is sent to FOP. 
+        The FO file is sent to FOP in the form of SAX events which is the most efficient 
+        way. Please always avoid saving intermediate results to a file or a memory buffer 
+        because that affects performance negatively.
+      </li>
+      <li>
+        <strong>Step 5:</strong> Finally, we start the XSLT transformation by starting 
+        the JAXP Transformer. As soon as the JAXP Transformer starts to send its output 
+        to FOP, FOP itself starts its processing in the background. When the 
+        <code>transform()</code> method returns FOP will also have finished converting 
+        the FO file to a PDF file and you can close the OutputStream.
+        <note label="Tip!">
+          It's a good idea to enclose the whole conversion in a try..finally statement. If
+          you close the OutputStream in the finally section, this will make sure that the
+          OutputStream is properly closed even if an exception occurs during the conversion.
+        </note>
+      </li>
+    </ul>
     <p>
-      <strong>Another possibility may be used to build the FO Tree: You can
-      call <code>getContentHandler()</code> and fire the SAX events yourself.
-      </strong>
-      You don't have to call <code>run()</code> or <code>render()</code> on the 
-      Driver object if you use <code>getContentHandler()</code>.
+      If you're not totally familiar with JAXP Transformers, please have a look at the 
+      <a href="#examples">Embedding examples</a> below. The section contains examples
+      for all sorts of use cases. If you look at all of them in turn you should be able
+      to see the patterns in use and the flexibility this approach offers without adding
+      too much complexity.
     </p>
-    <p>Here is an example use of Driver:</p>
-    <source><![CDATA[
-Driver driver = new Driver();
-//Setup logging here: driver.setLogger(...
-driver.setRenderer(Driver.RENDER_PDF);
-driver.setInputSource(new FileInputSource(args[0]));
-driver.setOutputStream(new FileOutputStream(args[1]));
-driver.run();]]></source>
-  </section>
-
-  <section id="render-with-xslt">
-    <title>Processing XSL-FO generated from XML+XSLT</title>
-    <p>
-      If you want to process XSL-FO generated from XML using XSLT we recommend 
-      using standard JAXP to do the XSLT part and piping the generated SAX 
-      events directly through to FOP. Here's how this would look like:
-    </p>
-    <source><![CDATA[
-Driver driver = new Driver();
-//Setup logging here: driver.setLogger(...
-driver.setRenderer(Driver.RENDER_PDF);
-
-//Setup the OutputStream for FOP
-driver.setOutputStream(new java.io.FileOutputStream(outFile));
-
-//Make sure the XSL transformation's result is piped through to FOP
-Result res = new SAXResult(driver.getContentHandler());
-
-//Setup XML input
-Source src = new StreamSource(xmlFile);
-
-//Setup Transformer
-Source xsltSrc = new StreamSource(xslFile);
-TransformerFactory transformerFactory = TransformerFactory.newInstance();
-Transformer transformer = transformerFactory.newTransformer(xsltSrc);
-
-//Start the transformation and rendering process
-transformer.transform(src, res);]]></source>
-    <note>There's no need to call <code>run()</code> or <code>render()</code>.</note>
     <p>
       This may look complicated at first, but it's really just the combination of an 
       XSL transformation and a FOP run. It's also easy to comment out the FOP part
       for debugging purposes, for example when you're tracking down a bug in your 
       stylesheet. You can easily write the XSL-FO output from the XSL transformation
-      to a file to check if that part generates the expected output.
+      to a file to check if that part generates the expected output. An example for that
+      can be found in the <a href="#examples">Embedding examples</a> (See "ExampleXML2FO").
     </p>
-    <p>
-      For fully working examples of the above and hints to some interesting 
-      possibilities, see the <link href="#examples">examples section</link> below.
-    </p>
-  </section>
-  </section>
-  <section id="logging">
-    <title>Controlling logging</title>
-    <p>
-      Current FOP 0.20.x production uses the
-      <fork href="http://avalon.apache.org/framework/api/org/apache/avalon/framework/logger/package-summary.html">Logger package</fork>
-      from Apache Avalon Framework to do logging. See the 
-      <fork href="http://avalon.apache.org/framework/">Apache Avalon Framework</fork>
-      for more information.
-    </p>
-    <p>
-      Per default FOP uses the SimpleLog which logs to System.out. If you want to do logging using a
-      logging framework (such as LogKit, Log4J or JDK 1.4 Logging) you can set a
-      different Logger implementation on the Driver object. Here's an example how you would use LogKit:
-    </p>
-    <source><![CDATA[
-Hierarchy hierarchy = Hierarchy.getDefaultHierarchy();
-PatternFormatter formatter = new PatternFormatter(
-    "[%{priority}]: %{message}\n%{throwable}" );
-
-LogTarget target = null;
-target = new StreamTarget(System.out, formatter);
-
-hierarchy.setDefaultLogTarget(target);
-log = hierarchy.getLoggerFor("fop");
-log.setPriority(Priority.INFO);
+    <note>
+      Please be aware that you should not reuse a Fop instance for additional rendering runs.
+      Recreate a new instance for each rendering run. This is a relatively inexpensive 
+      operation and will be further optimized shortly.
+    </note>
+    <section id="basic-logging">
+      <title>Logging</title>
+      <p>
+        Logging is now a little different than it was in FOP 0.20.5. We've switched from
+        Avalon Logging to <a href="ext:jakarta/commons/logging">Jakarta Commons Logging</a>.
+        While with Avalon Logging the loggers were directly given to FOP, FOP now retrieves
+        its logger(s) through a statically available LogFactory. This is similar to the
+        general pattern that you use when you work with Apache Log4J directly, for example.
+        We call this "static logging" (Commons Logging, Log4J) as opposed to "instance logging" 
+        (Avalon Logging). This has a consequence: You can't give FOP a logger for each
+        processing run anymore. The log output of multiple, simultaneously running FOP instances
+        is sent to the same logger.
+      </p>
+      <note>
+        We know this may be an issue in multi-threaded server environments if you'd like to 
+        know what's going on in every single FOP processing run. We're planning to add an
+        additional feedback facility to FOP which can be used to obtain all sorts of specific
+        feedback (validation messages, layout problems etc.). "Static logging" is mainly 
+        interesting for a developer working on FOP and for advanced users who are debugging 
+        FOP. We don't consider the logging output to be useful to normal FOP users. Please
+        have some patience until we can add this feature or jump in and help us build it. We've
+        set up a <a href="http://wiki.apache.org/xmlgraphics-fop/ProcessingFeedback">Wiki page</a>
+        which documents what we're going to build.
+      </note>
+      <p>
+        By default, <a href="ext:jakarta/commons/logging">Jakarta Commons Logging</a> uses
+        JDK logging (available in JDKs 1.4 or higher) as its backend. You can configure Commons
+        Logging to use an alternative backend, for example Log4J. Please consult the
+        <a href="ext:jakarta/commons/logging">documentation for Jakarta Commons Logging</a> on
+        how to configure altentive backends.
+      </p>
+    </section>
+  
+    <section id="render">
+      <title>Processing XSL-FO</title>
+      <p>
+        Once the Fop instance is set up, call <code>getDefaultHandler()</code> to obtain a SAX 
+        DefaultHandler instance to which you can send the SAX events making up the XSL-FO 
+        document you'd like to render. FOP processing starts as soon as the DefaultHandler's
+        <code>startDocument()</code> methods is called. Processing stops again when the
+        DefaultHandler's <code>endDocument()</code> method is called. Please refer to the basic
+        usage pattern shown above to render a simply XSL-FO document.
+      </p>
+    </section>
 
-driver.setLogger(new org.apache.avalon.framework.logger.LogKitLogger(log));]]></source>
-    <p>
-      The LogKitLogger class implements the Logger interface so all logging calls are being redirected to LogKit.
-      More information on Jakarta LogKit can be found <fork href="http://jakarta.apache.org/avalon/logkit/index.html">here</fork>.
-    </p>
-    <p>
-      Similar implementations exist for Log4J (org.apache.avalon.framework.logger.Log4JLogger) and
-      JDK 1.4 logging (org.apache.avalon.framework.logger.Jdk14Logger).
-    </p>
-    <p>
-      If you want FOP to be totally silent you can also set an org.apache.avalon.framework.logger.NullLogger instance.
-    </p>
-    <p>
-      If you want to use yet another logging facility you simply have to create a class that 
-      implements org.apache.avalon.framework.logging.Logger and set it on the Driver object. 
-      See the existing implementations in Avalon Framework for examples.
-    </p>
+    <section id="render-with-xslt">
+      <title>Processing XSL-FO generated from XML+XSLT</title>
+      <p>
+        If you want to process XSL-FO generated from XML using XSLT we recommend 
+        again using standard JAXP to do the XSLT part and piping the generated SAX 
+        events directly through to FOP. The only thing you'd change to do that 
+        on the basic usage pattern above is to set up the Transformer differently:
+      </p>
+      <source><![CDATA[
+  //before (without XSLT):
+  //Transformer transformer = factory.newTransformer(); // identity transformer
+  
+  //after (with XSLT):
+  Source xslt = new StreamSource(new File("mystylesheet.xsl"));
+  Transformer transformer = factory.newTransformer(xslt);]]></source>
+    </section>
   </section>
   <section id="input">
     <title>Input Sources</title>
     <p>
       The input XSL-FO document is always handled internally as SAX (see the 
-      <link href="design/parsing.html">Parsing Design Document</link> for the rationale).
-      However, the input itself can be provided in a variety of ways to FOP, 
-      which normalizes the input (if necessary) into SAX events:
+      <a href="../dev/design/parsing.html">Parsing Design Document</a> for the rationale).
+    </p>
+    <p>
+      However, you may not always have your input document available as a SAX stream. 
+      But with JAXP it's easy to convert different input sources to a SAX stream so you
+      can pipe it into FOP. That sounds more difficult than it is. You simply have
+      to set up the right Source instance as input for the JAXP transformation. 
+      A few examples:
     </p>
     <ul>
-      <li><strong>SAX Events through SAX Handler</strong>: <code>FOTreeBuilder</code> is the SAX Handler which is obtained through <code>getContentHandler</code> on <code>Driver</code>.</li>
-      <li><strong>DOM (which is converted into SAX Events)</strong>: The conversion of a DOM tree is done via the <code>render(Document)</code> method on <code>Driver</code>.</li>
-      <li><strong>Data Source (which is parsed and converted into SAX Events)</strong>: The <code>Driver</code> can take an <code>InputSource</code> as input.
-This can use a <code>Stream</code>, <code>String</code> etc.</li>
-      <li><strong>XML+XSLT Transformation</strong> (which is transformed using an XSLT Processor and the result is fired as SAX Events: <code>XSLTInputHandler</code> is used as an <code>InputSource</code> in the render(<code>XMLReader</code>, <code>InputSource</code>) method on <code>Driver</code>.</li>
+      <li>
+        <strong>URL:</strong> <code>Source src = new StreamSource("http://localhost:8080/testfile.xml");</code>
+      </li>
+      <li>
+        <strong>File:</strong> <code>Source src = new StreamSource(new File("C:/Temp/myinputfile.xml"));</code>
+      </li>
+      <li>
+        <strong>String:</strong> <code>Source src = new StreamSource(new StringReader(myString)); //myString is a String</code>
+      </li>
+      <li>
+        <strong>InputStream:</strong> <code>Source src = new StreamSource(new MyInputStream(something));</code>
+      </li>
+      <li>
+        <strong>Byte Array:</strong> <code>Source src = new StreamSource(new ByteArrayInputStream(myBuffer)); //myBuffer is a byte[] here</code>
+      </li>
+      <li>
+        <strong>DOM:</strong> <code>Source src = new DOMSource(myDocument); //myDocument is a Document or a Node</code>
+      </li>
+      <li>
+        <strong>Java Objects:</strong> Please have a look at the <a href="#examples">Embedding examples</a> which contains an example for this.
+      </li>
     </ul>
     <p>
       There are a variety of upstream data manipulations possible.
       For example, you may have a DOM and an XSL stylesheet; or you may want to
       set variables in the stylesheet. Interface documentation and some cookbook 
       solutions to these situations are provided in 
-      <fork href="http://xml.apache.org/xalan-j/usagepatterns.html">Xalan Basic Usage Patterns</fork>.
+      <a href="http://xml.apache.org/xalan-j/usagepatterns.html">Xalan Basic Usage Patterns</a>.
     </p>
+  </section>
+  <section id="config-internal">
+    <title>Configuring Apache FOP Programmatically</title>
     <p>
-      See the <link href="#examples">Examples</link> for some variations on input. 
+      Apache FOP provides a class called FOUserAgent which is used to customize FOP's
+      behaviour. If you wish to do that, the first step is to create your own instance
+      of FOUserAgent and pass that to the Fop constructor:
     </p>
+    <source><![CDATA[
+FOUserAgent userAgent = new FOUserAgent();
+Fop fop = new Fop(Constants.RENDER_PS, userAgent);]]></source>
+    <p>
+      You can do all sorts of things on the user agent:
+    </p>
+    <ul>
+      <li>
+        <p>
+          The <strong>base URL</strong> to use when resolving relative URLs. Example:
+        </p>
+        <source>userAgent.setBaseURL("file://C:/Temp/");</source>
+      </li>
+      <li>
+        <p>
+          Disable <strong>strict validation</strong>. When disabled FOP is less strict about the rules established by the XSL-FO specification. Example:
+        </p>
+        <source>userAgent.setStrictValidation(false);</source>
+      </li>
+      <li>
+        <p>
+          Set the <strong>producer</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. The default producer is "Apache FOP". Example:
+        </p>
+        <source>userAgent.setProducer("MyKillerApplication");</source>
+      </li>
+      <li>
+        <p>
+          Set the <strong>creating user</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
+        </p>
+        <source>userAgent.setCreator("John Doe");</source>
+      </li>
+      <li>
+        <p>
+          Set the <strong>author</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
+        </p>
+        <source>userAgent.setAuthor("John Doe");</source>
+      </li>
+      <li>
+        <p>
+          Override the <strong>creation date and time</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
+        </p>
+        <source>userAgent.setCreationDate(new Date());</source>
+      </li>
+      <li>
+        <p>
+          Set the <strong>title</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
+        </p>
+        <source>userAgent.setTitle("Invoice No 138716847");</source>
+      </li>
+      <li>
+        <p>
+          Set the <strong>keywords</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
+        </p>
+        <source>userAgent.setKeywords("XML XSL-FO");</source>
+      </li>
+      <li>
+        <p>
+          Set the <strong>internal resolution</strong> for the document. This is used when creating bitmap images, for example. Example:
+        </p>
+        <source>userAgent.setResolution(300); //=300dpi (dots/pixels per Inch)</source>
+      </li>
+      <li>
+        <p>
+          Set <strong>your own Renderer instance</strong>. If you want to supply your own renderer or 
+          configure a Renderer in a special way you can give the instance to the FOUserAgent. Normally,
+          the Renderer instance is created by FOP. Example:
+        </p>
+        <source>userAgent.setRendererOverride(myRenderer); //myRenderer is an org.apache.fop.render.Renderer</source>
+      </li>
+      <li>
+        <p>
+          Set <strong>your own FOEventHandler instance</strong>. If you want to supply your own FOEventHandler or 
+          configure an FOEventHandler subclass in a special way you can give the instance to the FOUserAgent. Normally, 
+          the FOEventHandler instance is created by FOP. Example:
+        </p>
+        <source>userAgent.setFOEventHandlerOverride(myFOEventHandler); //myFOEventHandler is an org.apache.fop.fo.FOEventHandler</source>
+      </li>
+      <li>
+        <p>
+          Manually add a <strong>ElementMapping instance</strong>. If you want to supply a special FOP extension
+          you can give the instance to the FOUserAgent. Normally, the FOP extensions can be automatically detected 
+          (see the documentation on extension for more info).
+        </p>
+        <source>userAgent.addElementMapping(myElementMapping); //myElementMapping is a org.apache.fop.fo.ElementMapping</source>
+      </li>
+      <li>
+        <p>
+          Set a <strong>URIResolver</strong> for custom URI resolution. By supplying a JAXP URIResolver you can add
+          custom URI resolution functionality to FOP. For example, you can use 
+          <a href="ext:xml.apache.org/commons/resolver">Apache XML Commons Resolver</a> to make use of XCatalogs.
+        </p>
+        <source>userAgent.setURIResolver(myResolver); //myResolver is a javax.xml.transform.URIResolver</source>
+      </li>
+      <li>
+        <p>
+          Set the <strong>parameters for PDF encryption</strong> for the document. If you create PDF files you can 
+          instantiate and set an org.apache.fop.pdf.PDFEncryptionParams object. Example:
+        </p>
+        <source>userAgent.setPDFEncryptionParams(new PDFEncryptionParams(null, "owner", false, false, true, true));</source>
+      </li>
+    </ul>
+    <note>
+      You should not reuse an FOUserAgent instance between FOP rendering runs although you can. Especially
+      in multi-threaded environment, this is a bad idea.
+    </note>
   </section>
   <section id="config-external">
     <title>Using a Configuration File</title>
     <p>
-      To access an external configuration:
+      Instead of setting the parameters manually in code as shown above you can also set 
+      many values from an XML configuration file:
     </p>
     <source><![CDATA[
-import org.apache.fop.apps.Options;
+import org.apache.avalon.framework.configuration.Configuration;
+import org.apache.avalon.framework.configuration.DefaultConfigurationBuilder;
 
 /*..*/
 
-userConfigFile = new File(userConfig);
-options = new Options(userConfigFile);]]></source>
-    <note>
-        This is all you need to do, it sets up a static configuration class.
-    </note>
+DefaultConfigurationBuilder cfgBuilder = new DefaultConfigurationBuilder();
+Configuration cfg = cfgBuilder.buildFromFile(new File("C:/Temp/mycfg.xml"));
+userAgent.setUserConfig(cfg);]]></source>
     <p>
-      No further reference to the <code>options</code> variable is necessary.
-      The "options = " is actually not even necessary.
-    </p>
-    <p>
-      See <link href="#multithreading">Multithreading FOP</link> for issues related to changing configuration in a multithreaded environment.
-    </p>
-  </section>
-  <section id="config-internal">
-    <title>Setting the Configuration Programmatically</title>
-    <p>
-      If you wish to set configuration options from within your embedded application, use the <code>Configuration.put</code> method. Here is an example that sets the "baseDir" configuration in a Unix environment:
-    </p>
-    <source>org.apache.fop.configuration.Configuration.put("baseDir","/my/base/dir");</source>
-    <p>
-      Here is another that sets baseDir in a Windows environment:
-    </p>
-    <source>org.apache.fop.configuration.Configuration.put("baseDir","C:\my\base\dir");</source>
-    <p>
-      See <link href="#multithreading">Multithreading FOP</link> for issues related to changing configuration in a multithreaded environment.
+      The layout of the configuration file is described on the <a href="configuration.html">Configuration page</a>.
     </p>
   </section>
   <section id="hints">
     <title>Hints</title>
     <section id="object-reuse">
       <title>Object reuse</title>
-     <p>
-If FOP is going to be used multiple times within your application
-it may be useful to reuse certain objects to save time.
-     </p>
-     <p>
-The renderers and the driver can both be reused. A renderer is reusable
-once the previous render has been completed. The driver is reuseable
-after the rendering is complete and the <code>reset()</code> method is called.
-You will need to setup the driver again with a new OutputStream,
-IntputStream and renderer.
+      <p>
+        At the moment, the Fop instances shouldn't be reused. Please recreate
+        Fop and FOUserAgent instances for each rendering run until further notice.
+        We will likely add an additional object which will carry information
+        and configuration which can be reused between rendering runs to further
+        optimize this.
      </p>
     </section>
     <section id="awt">
       <title>AWT issues</title>
       <p>
-        If your XSL-FO files contain SVG then Batik will be used. When Batik is
+        If your XSL-FO files contain SVG then Apache Batik will be used. When Batik is
         initialised it uses certain classes in <code>java.awt</code> that
-        intialises the java AWT classes. This means that a daemon thread
+        intialise the Java AWT classes. This means that a daemon thread
         is created by the JVM and on Unix it will need to connect to a
         DISPLAY.
       </p>
       <p>
         The thread means that the Java application may not automatically quit
         when finished, you will need to call <code>System.exit()</code>. These
-        issues should be fixed in the upcoming JDK 1.4.
+        issues should be fixed in the JDK 1.4.
       </p>
       <p>
         If you run into trouble running FOP on a head-less server, please see the
-        <link href="graphics.html#batik">notes on Batik</link>.
+        <a href="graphics.html#batik">notes on Batik</a>.
       </p>
     </section>
     <section id="render-info">
       <title>Getting information on the rendering process</title>
       <p>
-To get the number of pages that were rendered by FOP you can call 
-<code>Driver.getResults()</code>. This returns a FormattingResults object 
-where you can lookup the number of pages produced. It also gives you the 
-page-sequences that were produced along with their id attribute and their 
-number of pages. This is particularly useful if you render multiple 
-documents (each enclosed by a page-sequence) and have to know the number of 
-pages of each document.
+        To get the number of pages that were rendered by FOP you can call 
+        <code>Fop.getResults()</code>. This returns a <code>FormattingResults</code> object 
+        where you can lookup the number of pages produced. It also gives you the 
+        page-sequences that were produced along with their id attribute and their 
+        number of pages. This is particularly useful if you render multiple 
+        documents (each enclosed by a page-sequence) and have to know the number of 
+        pages of each document.
       </p>
     </section>
   </section>
@@ -338,7 +442,7 @@
         Depending on the target OutputStream (in case of an FileOutputStream, but not 
         for a ByteArrayOutputStream, for example) it may improve performance considerably 
         if you buffer the OutputStream using a BufferedOutputStream: 
-        <code>driver.setOutputStream(new java.io.BufferedOutputStream(out));</code>
+        <code>fop.setOutputStream(new java.io.BufferedOutputStream(out));</code>
         <br/>
         Make sure you properly close the OutputStream when FOP is finished.
       </li>
@@ -346,10 +450,10 @@
         Cache the stylesheet. If you use the same stylesheet multiple times 
         you can setup a JAXP <code>Templates</code> object and reuse it each time you do
         the XSL transformation.  (More information can be found
-        <fork href="http://www.javaworld.com/javaworld/jw-05-2003/jw-0502-xsl.html">here</fork>.)
+        <a class="fork" href="http://www.javaworld.com/javaworld/jw-05-2003/jw-0502-xsl.html">here</a>.)
       </li>
       <li>
-        Use an XSLT compiler like <fork href="http://xml.apache.org/xalan-j/xsltc_usage.html">XSLTC</fork>
+        Use an XSLT compiler like <a class="fork" href="http://xml.apache.org/xalan-j/xsltc_usage.html">XSLTC</a>
         that comes with Xalan-J.
       </li>
     </ul>
@@ -357,42 +461,28 @@
   <section id="multithreading">
     <title>Multithreading FOP</title>
     <p>
-      FOP is not currently completely thread safe.
-Although the relevant methods of the Driver object are synchronized, FOP uses static
-variables for configuration data and loading images.
-Here are some tips to mitigate these problems:
+      Apache FOP may currently not be completely thread safe.
+      FOP uses some static variables (for example for the image cache). This code 
+      has not been fully tested for multi-threading issues, yet.
+    </p>
+    <p>
+      There is also a known issue with fonts being jumbled between threads when using 
+      the Java2D/AWT renderer (which is used by the -awt and -print output options).
+      In general, you cannot safely run multiple threads through the AWT renderer.
     </p>
-    <ul>
-      <li>
-        To avoid having your threads blocked, create a Driver object for each thread.
-      </li>
-      <li>
-        If possible, do not change the configuration data while there is a Driver object rendering.
-        Setup the configuration only once, preferably in the <code>init()</code> method of the servlet.
-      </li>
-      <li>
-        If you must change the configuration data more often, or if you have multiple 
-        servlets within the same webapp using FOP, consider implementing a singleton 
-        class to encapsulate the configuration settings and to run FOP in synchronized methods.
-      </li>
-    </ul>
-    <p>There is also a known issue with fonts being jumbled between threads when using the AWT renderer (which is used by the -awt and -print output options).
-In general, you cannot safely run multiple threads through the AWT renderer.</p>
   </section>
 <section id="examples">
   <title>Examples</title>
   <p>
-The directory "{fop-dir}/examples/embedding" contains several working examples. 
-In contrast to the examples above the examples here primarily use JAXP for 
-XML access. This may be easier to understand for people familiar with JAXP.
+   The directory "{fop-dir}/examples/embedding" contains several working examples. 
+   In contrast to the examples above the examples here primarily use JAXP for 
+   XML access. This may be easier to understand for people familiar with JAXP.
   </p>
   <section id="ExampleFO2PDF">
     <title>ExampleFO2PDF.java</title>
-    <p>This example
-        <fork href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/tags/fop-0_20_5/examples/embedding/java/embedding/ExampleFO2PDF.java?view=markup">
-            (current 0.20.5)</fork>
-        <fork href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleFO2PDF.java?view=markup">
-            (future 1.0dev)</fork>
+    <p>This
+        <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleFO2PDF.java?view=markup">
+            example</a>
 demonstrates the basic usage pattern to transform an XSL-FO
 file to PDF using FOP.
     </p>
@@ -400,25 +490,21 @@
   </section>
   <section id="ExampleXML2FO">
     <title>ExampleXML2FO.java</title>
-    <p>This example
-        <fork href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/tags/fop-0_20_5/examples/embedding/java/embedding/ExampleXML2FO.java?view=markup">
-            (current 0.20.5)</fork>
-        <fork href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2FO.java?view=markup">
-            (future 1.0dev)</fork>
+    <p>This 
+        <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2FO.java?view=markup">
+            example</a>
 has nothing to do with FOP. It is there to show you how an XML 
 file can be converted to XSL-FO using XSLT. The JAXP API is used to do the
 transformation. Make sure you've got a JAXP-compliant XSLT processor in your 
-classpath (ex. <fork href="http://xml.apache.org/xalan-j">Xalan</fork>).
+classpath (ex. <a href="http://xml.apache.org/xalan-j">Xalan</a>).
     </p>
     <figure src="images/EmbeddingExampleXML2FO.png" alt="Example XML to XSL-FO"/>
   </section>
   <section id="ExampleXML2PDF">
     <title>ExampleXML2PDF.java</title>
-    <p>This example
-        <fork href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/tags/fop-0_20_5/examples/embedding/java/embedding/ExampleXML2PDF.java?view=markup">
-        (current 0.20.5)</fork>
-        <fork href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2PDF.java?view=markup">
-        (future 1.0dev)</fork>
+    <p>This 
+        <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2PDF.java?view=markup">
+        example</a>
 demonstrates how you can convert an arbitrary XML file to PDF 
 using XSLT and XSL-FO/FOP. It is a combination of the first two examples 
 above. The example uses JAXP to transform the XML file to XSL-FO and FOP to 
@@ -436,11 +522,9 @@
   </section>
   <section id="ExampleObj2XML">
     <title>ExampleObj2XML.java</title>
-    <p>This example
-    <fork href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/tags/fop-0_20_5/examples/embedding/java/embedding/ExampleObj2XML.java?view=markup">
-        (current 0.20.5)</fork>
-    <fork href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2XML.java?view=markup">
-        (future 1.0dev)</fork>
+    <p>This 
+    <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2XML.java?view=markup">
+        example</a>
 is a preparatory example for the next one. It's an example that 
 shows how an arbitrary Java object can be converted to XML. It's an often 
 needed task to do this. Often people create a DOM tree from a Java object and 
@@ -466,16 +550,14 @@
     <p>
 Have a look at the source of ExampleObj2XML.java to find out how this is 
 used. For more detailed information see other resources on JAXP (ex. 
-<fork href="http://java.sun.com/xml/jaxp/dist/1.1/docs/tutorial/xslt/3_generate.html">An older JAXP tutorial</fork>).
+<a class="fork" href="http://java.sun.com/xml/jaxp/dist/1.1/docs/tutorial/xslt/3_generate.html">An older JAXP tutorial</a>).
     </p>
   </section>
   <section id="ExampleObj2PDF">
     <title>ExampleObj2PDF.java</title>
-    <p>This example
-        <fork href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/tags/fop-0_20_5/examples/embedding/java/embedding/ExampleObj2PDF.java?view=markup">
-            (current 0.20.5)</fork>
-        <fork href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2PDF.java?view=markup">
-            (future 1.0dev)</fork>
+    <p>This 
+        <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2PDF.java?view=markup">
+            example</a>
 combines the previous and the third to demonstrate 
 how you can transform a Java object to a PDF directly in one smooth run
 by generating SAX events from the Java object that get fed to an XSL 
@@ -486,20 +568,18 @@
   </section>
   <section id="ExampleDOM2PDF">
     <title>ExampleDOM2PDF.java</title>
-    <p>This example
-        <fork href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/tags/fop-0_20_5/examples/embedding/java/embedding/ExampleDOM2PDF.java?view=markup">
-            (current 0.20.5)</fork>
-        <fork href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleDOM2PDF.java?view=markup">
-            (future 1.0dev)</fork>
+    <p>This 
+        <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleDOM2PDF.java?view=markup">
+            example</a>
 has FOP use a DOMSource instead of a StreamSource in order to 
 use a DOM tree as input for an XSL transformation.
     </p>
   </section>
   <section id="ExampleSVG2PDF">
     <title>ExampleSVG2PDF.java (PDF Transcoder example)</title>
-    <p>This example
-        <fork href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleSVG2PDF.java?view=markup">
-            (applies to 0.20.5 and future 1.0dev)</fork>
+    <p>This 
+        <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleSVG2PDF.java?view=markup">
+            example</a>
 shows use of the PDF Transcoder, a sub-application within FOP.  
 It is used to generate a PDF document from an SVG file.
     </p>
@@ -509,12 +589,12 @@
     <p>
 These examples should give you an idea of what's possible. It should be easy 
 to adjust these examples to your needs. Also, if you have other examples that you
-think should be added here, please let us know via either the FOP-USER or FOP-DEV
-mailing lists.  Finally, for more help please send your questions to the FOP-USER
+think should be added here, please let us know via either the fop-users or fop-dev
+mailing lists.  Finally, for more help please send your questions to the fop-users
 mailing list.
     </p>
   </section>
 </section>
-    </body>
+  </body>
 </document>
 

Copied: xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/extensions.xml (from r328299, xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.20.5/extensions.xml)
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/extensions.xml?p2=xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/extensions.xml&p1=xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.20.5/extensions.xml&r1=328299&r2=328462&rev=328462&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.20.5/extensions.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/extensions.xml Tue Oct 25 12:49:46 2005
@@ -1,6 +1,6 @@
 <?xml version="1.0" standalone="no"?>
 <!--
-  Copyright 1999-2004 The Apache Software Foundation
+  Copyright 1999-2005 The Apache Software Foundation
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -15,60 +15,56 @@
   limitations under the License.
 -->
 <!-- $Id$ -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
-    "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/core/context/resources/schema/dtd/document-v12.dtd">
-
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
   <header>
     <title>Standard FOP Extensions</title>
     <version>$Revision$</version>
   </header>
   <body>
-    <p>By "extension", we mean any data that can be placed in the input XML document that is not addressed by the XSL-FO standard.
-By having a mechanism for supporting extensions, FOP is able to add features that are not covered in the specification.</p>
-      <p>The extensions documented here are included with FOP, and are automatically available to you. If you wish to add an extension of your own to FOP, please see the <link href="dev/extensions.html">Developers' Extension Page</link>.</p>
+    <p>
+      By "extension", we mean any data that can be placed in the input XML document that 
+      is not addressed by the XSL-FO standard.
+      By having a mechanism for supporting extensions, FOP is able to add features that 
+      are not covered in the specification.
+    </p>
+    <p>
+      The extensions documented here are included with FOP, and are automatically available 
+      to you. If you wish to add an extension of your own to FOP, please see the 
+      <a href="../dev/extensions.html">Developers' Extension Page</a>.
+    </p>
     <note>All extensions required the correct use of an appropriate namespace in your input document.</note>
-      <section id="svg">
-        <title>SVG</title>
-        <p>
-Please see the <link href="graphics.html#svg">SVG documentation</link> for more details.
-        </p>
-      </section>
+    <section id="svg">
+      <title>SVG</title>
+      <p>
+        Please see the <a href="graphics.html#svg">SVG documentation</a> for more details.
+      </p>
+    </section>
     <section id="fo-extensions">
       <title>FO Extensions</title>
       <section id="fox-namespace">
         <title>Namespace</title>
-        <p>By convention, FO extensions in FOP use the "fox:" namespace identifier.
-To use any of the FO extensions, add a namespace entry for http://xml.apache.org/fop/extensions
-to the root element:</p>
-<source><![CDATA[<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
+        <p>
+          By convention, FO extensions in FOP use the "fox" namespace prefix.
+          To use any of the FO extensions, add a namespace entry for 
+          <code>http://xml.apache.org/fop/extensions</code> to the root element:
+        </p>
+        <source><![CDATA[<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
                xmlns:fox="http://xml.apache.org/fop/extensions">]]></source>
+        <note>Currently, no extensions are implemented in FOP Trunk which use the FOP extension namespace.</note>
       </section>
       <section id="bookmarks">
         <title>PDF Bookmarks</title>
         <p>
-You can provide outlines inside the root object (but outside any
-page-sequences or other formatting objects). Here's an example of an outline
-entry:
-        </p>
-        <source>
-<![CDATA[<fox:outline internal-destination="sec3">
-    <fox:label>Running FOP</fox:label>
-
-    <fox:outline internal-destination="sec3-1">
-      <fox:label>Prerequisites</fox:label>
-    </fox:outline>
-  </fox:outline>
-</fo:root>]]></source>
-        <p>
-It works similarly to a basic-link. There is also an external-destination
-property, but it isn't supported currently. See the pdfoutline.fo file in
-examples/fo/basic for a more complete example.
+          In previous versions of Apache FOP there was a <code>fox:outline</code> element
+          which was used to create outlines in PDF files. The redesigned code makes use
+          of the new <a href="http://www.w3.org/TR/xsl11/#fo_bookmark-tree">bookmark feature defined in the latest XSL 1.1 working draft</a>.
         </p>
       </section>
       <section id="named-destinations">
         <title>Anchors or Named Destinations</title>
-        <p>Use the fox:destination element to define "named destinations" inside a PDF document.
+        <p>This extension element hasn't been reimplemented for the redesigned code, yet.</p>
+        <!--p>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.
@@ -81,11 +77,12 @@
 <fo:block id="table-of-contents">Table of Contents</fo:block>]]></source>
         <warning>It is possible that in some future release of FOP, <em>all </em>elements with
 "id" attributes will generate named-destinations, which will eliminate the need for
-fox:destination.</warning>
+fox:destination.</warning-->
       </section>
       <section id="table-continue-label">
         <title>Table Continuation Label</title>
-        <p>Use the fox:continued-label element to create content in table-header and
+        <p>This extension element hasn't been reimplemented for the redesigned code, yet.</p>
+        <!--p>Use the fox:continued-label element to create content in table-header and
 table-footer cells that will appear only on pages after the first page that the table
 appears. fox:continued-label is itself inline content, and is a container of fo:inline
 content. This content will be laid out only if the table does not fit on a single page and flows
@@ -101,7 +98,7 @@
       <fo:block>Header column 2 with no continued label</fo:block>
     </fo:table-cell>
   </fo:table-row>
-</fo:table-header>]]></source>
+</fo:table-header>]]></source-->
       </section>
     </section>
   </body>

Copied: xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/fonts.xml (from r328299, xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.20.5/fonts.xml)
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/fonts.xml?p2=xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/fonts.xml&p1=xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.20.5/fonts.xml&r1=328299&r2=328462&rev=328462&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.20.5/fonts.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/fonts.xml Tue Oct 25 12:49:46 2005
@@ -1,6 +1,6 @@
 <?xml version="1.0" standalone="no"?>
 <!--
-  Copyright 1999-2004 The Apache Software Foundation
+  Copyright 1999-2005 The Apache Software Foundation
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -15,11 +15,10 @@
   limitations under the License.
 -->
 <!-- $Id$ -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
-    "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/core/context/resources/schema/dtd/document-v12.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
   <header>
-    <title>FOP: Fonts</title>
+    <title>Apache FOP: Fonts</title>
     <version>$Revision$</version>
     <authors>
       <person name="Jeremias Märki" email=""/>
@@ -50,15 +49,15 @@
           <td>yes</td>
           <td>no</td>
           <td>yes</td>
-          <td>no</td>
+          <td>yes</td>
         </tr>
-        <tr>
+        <!--tr> NOT AVAILABLE YET!!!
           <td>PCL</td>
           <td>yes (modified)</td>
           <td>no</td>
           <td>no</td>
           <td>no</td>
-        </tr>
+        </tr-->
         <tr>
           <td>TXT</td>
           <td>yes (used for layout but not for output)</td>
@@ -123,8 +122,8 @@
       <p>Support for custom fonts is added by creating font metric files (written in XML) from the actual font files, and registering them with FOP. Currently only Type 1 and TrueType fonts can be added.
 More information about fonts can be found at:</p>
       <ul>
-        <li><link href="http://partners.adobe.com/asn/developer/type/ftypes.html">Adobe font types</link></li>
-        <li><link href="http://partners.adobe.com/asn/developer/technotes/fonts.html">Adobe Font Technote</link>
+        <li><a href="http://partners.adobe.com/asn/developer/type/ftypes.html">Adobe font types</a></li>
+        <li><a href="http://partners.adobe.com/asn/developer/technotes/fonts.html">Adobe Font Technote</a>
 </li>
       </ul>
       <section id="type1-metrics">
@@ -225,26 +224,30 @@
       </section>
       <section id="register">
         <title>Register Fonts with FOP</title>
-        <p>You must tell FOP how to find and use the font metrics files by registering them in the <link href="configuration.html">FOP Configuration</link>. Add entries for your custom fonts, regardless of font type, to the configuration file in a manner similar to the following:</p>
-        <source><![CDATA[<font metrics-file="FTL_____.xml" kerning="yes"
-      embed-file="C:\myfonts\FTL_____.pfb">
+        <p>You must tell FOP how to find and use the font metrics files by registering them in the <a href="configuration.html">FOP Configuration</a>. Add entries for your custom fonts, regardless of font type, to the configuration file in a manner similar to the following:</p>
+        <source><![CDATA[<font metrics-url="file:C:/myfonts/FTL_____.xml" kerning="yes"
+      embed-url="file:C:/myfonts/FTL_____.pfb">
   <font-triplet name="FrutigerLight" style="normal" weight="normal"/>
 </font>]]></source>
-        <note>Review the documentation for <link href="configuration.html">FOP Configuration</link> for instructions on making the FOP configuration available to FOP when it runs. Otherwise, FOP has no way of finding your custom font information.</note>
+        <note>Review the documentation for <a href="configuration.html">FOP Configuration</a> for instructions on making the FOP configuration available to FOP when it runs. Otherwise, FOP has no way of finding your custom font information.</note>
         <ul>
-          <li>Starting with FOP version 0.20.5 you can use URLs for the paths to the font files.
-Relative URLs are resolved relative to the fontBaseDir property (or baseDir) if available. See <link href="configuration.html">FOP: Configuration</link> for more information.</li>
-          <li>The "kerning" and "embed-file" attributes are optional. Kerning is currently not used at all. If embedding is off, the output will position the text correctly (from the metrics file), but it will not be displayed or printed correctly unless the viewer has the applicable font available to their local system.</li>
-          <li>When setting the embed-file attribute for Type 1 fonts, be sure to specify the PFB (actual font data), not PFM (font metrics) file that you used to generate the XML font metrics file.</li>
+          <li>
+            URLs are used to access the font metric and font files.
+            <!--Relative URLs are resolved relative to the fontBaseDir property (or baseDir) if available.-->
+            See <a href="configuration.html">FOP: Configuration</a> for more information.
+            <note>Relative font URLs are currently not possible. You need to specify absolute URLs. Patches are welcome! :-)</note>
+          </li>
+          <li>The "kerning" and "embed-url" attributes are optional. Kerning is currently not used at all. If embedding is off, the output will position the text correctly (from the metrics file), but it will not be displayed or printed correctly unless the viewer has the applicable font available to their local system.</li>
+          <li>When setting the embed-url attribute for Type 1 fonts, be sure to specify the PFB (actual font data), not PFM (font metrics) file that you used to generate the XML font metrics file.</li>
         </ul>
-        <note>Cocoon users will need to setup the config, see FOPSerializer for more information.</note>
+        <!--note>Cocoon users will need to setup the config, see FOPSerializer for more information.</note-->
       </section>
       <section id="embedding">
         <title>Embedding</title>
-        <note>The PostScript renderer does not yet support font embedding.</note>
+        <note>The PostScript renderer does not yet support TrueType fonts, but can embed Type 1 fonts.</note>
         <note>The font is simply embedded into the PDF file, it is not converted.</note>
-        <p>Font embedding is enabled in the userconfig.xml file and controlled by the embed-file attribute.
-If you don't specify the embed-file attribute the font will not be embedded, but will only be referenced.</p>
+        <p>Font embedding is enabled in the userconfig.xml file and controlled by the embed-url attribute.
+If you don't specify the embed-url attribute the font will not be embedded, but will only be referenced.</p>
         <p>When FOP embeds a font, it adds a prefix to the fontname to ensure that the name will not match the fontname of an installed font.
 This is helpful with older versions of Acrobat Reader that preferred installed fonts over embedded fonts.</p>
         <p>When embedding PostScript fonts, the entire font is always embedded.</p>
@@ -255,7 +258,7 @@
         <p>One workaround for this behavior is to use the "-enc ansi" option when generating metrics with TTFReader.
 This will cause the whole font to be embedded in the pdf document.
 Characters will be WinAnsi encoded (as specified in the PDF spec), so you lose the ability to use characters from other character sets.
-See <link href="#ttf-encoding">Table of TTF Encoding Options</link> for more details.</p>
+See <a href="#ttf-encoding">Table of TTF Encoding Options</a> for more details.</p>
       </section>
     </section>
   </body>

Copied: xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/graphics.xml (from r328299, xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.20.5/graphics.xml)
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/graphics.xml?p2=xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/graphics.xml&p1=xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.20.5/graphics.xml&r1=328299&r2=328462&rev=328462&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.20.5/graphics.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/graphics.xml Tue Oct 25 12:49:46 2005
@@ -1,6 +1,6 @@
 <?xml version="1.0" standalone="no"?>
 <!--
-  Copyright 1999-2004 The Apache Software Foundation
+  Copyright 1999-2005 The Apache Software Foundation
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -15,11 +15,10 @@
   limitations under the License.
 -->
 <!-- $Id$ -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
-    "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/core/context/resources/schema/dtd/document-v12.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
   <header>
-    <title>FOP: Graphics Formats</title>
+    <title>Apache FOP: Graphics Formats</title>
     <version>$Revision$</version>
   </header>
   <body>
@@ -32,44 +31,86 @@
         <tr>
           <th>Format</th>
           <th>Type</th>
-          <th>Support Thru</th>
+          <th><a href="#native">FOP native support</a></th>
+          <th><a href="#batik">Batik SVG</a></th>
+          <th><a href="#batik-codecs">Batik codecs</a></th>
+          <th><a href="#imageio">Image I/O</a></th>
+          <th><a href="#jai">JAI</a></th>
+          <th><a href="#jimi">JIMI</a></th>
         </tr>
         <tr>
-          <td><link href="#bmp">BMP</link> (Microsoft Windows Bitmap)</td>
+          <td><a href="#bmp">BMP</a> (Microsoft Windows Bitmap)</td>
           <td>bitmap</td>
-          <td><link href="#native">FOP native</link></td>
+          <td>X</td>
+          <td></td>
+          <td></td>
+          <td></td>
+          <td></td>
+          <td></td>
         </tr>
         <tr>
-          <td><link href="#eps">EPS</link> (Encapsulated PostScript)</td>
+          <td><a href="#eps">EPS</a> (Encapsulated PostScript)</td>
           <td>metafile (both bitmap and vector), probably most frequently used for vector drawings</td>
-          <td><link href="#native">FOP native</link> (limited support, see restrictions below)</td>
+          <td>(X)</td>
+          <td></td>
+          <td></td>
+          <td></td>
+          <td></td>
+          <td></td>
         </tr>
         <tr>
           <td>GIF (Graphics Interchange Format)</td>
           <td>bitmap</td>
-          <td><link href="#native">FOP native</link></td>
+          <td>X</td>
+          <td></td>
+          <td></td>
+          <td>X</td>
+          <td>X</td>
+          <td>X</td>
         </tr>
         <tr>
-          <td><link href="#jpeg">JPEG</link> (Joint Photographic Experts Group)</td>
+          <td><a href="#jpeg">JPEG</a> (Joint Photographic Experts Group)</td>
           <td>bitmap</td>
-          <td><link href="#native">FOP native</link></td>
+          <td>(X)</td>
+          <td></td>
+          <td></td>
+          <td></td>
+          <td></td>
+          <td></td>
         </tr>
         <tr>
-          <td><link href="#png">PNG</link> (Portable Network Graphic)</td>
+          <td><a href="#png">PNG</a> (Portable Network Graphic)</td>
           <td>bitmap</td>
-          <td><link href="#jimi">JIMI</link> or <link href="#jai">JAI</link></td>
+          <td></td>
+          <td></td>
+          <td>X</td>
+          <td></td>
+          <td></td>
+          <td></td>
         </tr>
         <tr>
-          <td><link href="#svg">SVG</link> (Scalable Vector Graphics)</td>
+          <td><a href="#svg">SVG</a> (Scalable Vector Graphics)</td>
           <td>vector (with embedded bitmaps)</td>
-          <td><link href="#batik">Batik</link></td>
+          <td></td>
+          <td>X</td>
+          <td></td>
+          <td></td>
+          <td></td>
+          <td></td>
         </tr>
         <tr>
-          <td><link href="#tiff">TIFF</link> (Tag Image Format File)</td>
+          <td><a href="#tiff">TIFF</a> (Tag Image Format File)</td>
           <td>bitmap</td>
-          <td><link href="#native">FOP native</link> or <link href="#jai">JAI</link>, depending on the subformat. See <link href="#tiff">TIFF</link> for more details.(JIMI also supports TIFF, but this has not been implemented within FOP).</td>
+          <td>(X)</td>
+          <td></td>
+          <td>X</td>
+          <td></td>
+          <td>X</td>
+          <td></td>
+          <!--td><a href="#native">FOP native</a> or <a href="#jai">JAI</a>, depending on the subformat. See <a href="#tiff">TIFF</a> for more details.(JIMI also supports TIFF, but this has not been implemented within FOP).</td-->
         </tr>
       </table>
+      <note>"(X)" means restricted support. Please see the details below.</note>
     </section>
     <section id="packages">
       <title>Graphics Packages</title>
@@ -79,10 +120,25 @@
           FOP has native ability to handle some graphic file formats.
         </p>
       </section>
+      <section id="batik-codecs">
+        <title>Batik codecs</title>
+        <p>
+          Apache Batik contains codecs for PNG and TIFF access. FOP can use these.
+        </p>
+      </section>
+      <section id="imageio">
+        <title>Image I/O (JDK 1.4 or higher)</title>
+        <p>
+          For JDKs 1.4 or higher, FOP provides a wrapper to load images through the 
+          <a class="fork" href="http://java.sun.com/j2se/1.4.2/docs/guide/imageio/index.html">JDK's Image I/O API</a> (JSR 015).
+          Image I/O allows to dynamically add additional image codecs. An example of such an add-on library are the
+          <a class="fork" href="http://java.sun.com/products/java-media/jai/">JAI Image I/O Tools</a> available from Sun.
+        </p>
+      </section>
       <section id="jimi">
         <title>JIMI</title>
         <p>
-          Because of licensing issues, the JIMI image library is not included in the FOP distribution. First, <fork href="http://java.sun.com/products/jimi">download</fork> and install it.
+          Because of licensing issues, the JIMI image library is not included in the FOP distribution. First, <a class="fork" href="http://java.sun.com/products/jimi">download</a> and install it.
 Then, copy the file "JimiProClasses.zip" from the archive to {fop-install-dir}/lib/jimi-1.0.jar. Please note that FOP binary distributions are compiled with JIMI support, so there is no need for you to build FOP to add the support. If jimi-1.0.jar is installed in the right place, it will automatically be used by FOP, otherwise it will not.
         </p>
       </section>
@@ -91,13 +147,13 @@
         <warning>JAI support is available for Release 0.20.5 and later. The comments in this section do not apply to releases earlier than 0.20.5.</warning>
         <p>
           FOP has been compiled with JAI support, but JAI is not included in the FOP distribution.
-To use it, install <link href="http://java.sun.com/products/java-media/jai">JAI</link>, then copy the jai_core.jar and the jai_codec.jar files to {fop-install-dir}/lib.
-JAI is much faster than JIMI, but is not available for all platforms. See <link href="http://java.sun.com/products/java-media/jai/forDevelopers/jaifaq.html#platforms">What platforms are supported?</link> on the JAI FAQ page for more details.
+To use it, install <a href="http://java.sun.com/products/java-media/jai">JAI</a>, then copy the jai_core.jar and the jai_codec.jar files to {fop-install-dir}/lib.
+JAI is much faster than JIMI, but is not available for all platforms. See <a href="http://java.sun.com/products/java-media/jai/forDevelopers/jaifaq.html#platforms">What platforms are supported?</a> on the JAI FAQ page for more details.
         </p>
       </section>
       <section id="batik">
         <title>Batik</title>
-        <p>Current FOP distributions include a distribution of the Apache Software Foundation's <jump href="http://xml.apache.org/batik">Batik</jump> version 1.5beta4.
+        <p>Current FOP distributions include a distribution of the Apache <a class="fork" href="ext:batik">Batik</a> version 1.6.
 It is automatically installed with FOP.
 Because Batik's API changes frequently, it is highly recommended that you use the version that ships with FOP, at least when running FOP.</p>
         <warning>Batik must be run in a graphical environment.</warning>
@@ -108,7 +164,7 @@
         <ul>
           <li>If you are using JDK 1.4, start it with the <code>-Djava.awt.headless=true</code> command line option.</li>
           <li>Install an X server which provides an in-memory framebuffer without actually using a screen device or any display hardware. One example is Xvfb.</li>
-          <li>Install a toolkit which emulates AWT without the need for an underlying X server. One example is the <link href="http://www.eteks.com/pja/en">PJA toolkit</link>, which is free and comes with detailed installation instructions.</li>
+          <li>Install a toolkit which emulates AWT without the need for an underlying X server. One example is the <a href="http://www.eteks.com/pja/en">PJA toolkit</a>, which is free and comes with detailed installation instructions.</li>
         </ul>
       </section>
     </section>
@@ -131,7 +187,8 @@
       </ul>
       <p>
         Other output targets can't be supported at the moment because
-        FOP lacks a PostScript interpreter.
+        FOP lacks a PostScript interpreter. Furthermore, FOP is not able
+        to parse the preview bitmaps sometimes contained in EPS files.
       </p>
     </section>
     <section id="jpeg">
@@ -151,13 +208,13 @@
       <title>SVG</title>
       <section id="svg-intro">
         <title>Introduction</title>
-        <p>FOP uses <link href="#batik">Batik</link> for SVG support.
+        <p>FOP uses <a href="#batik">Batik</a> for SVG support.
 This format can be handled as an <code>fo:instream-foreign-object</code> or in a separate
 file referenced with <code>fo:external-graphic</code>.</p>
       <note>   
 Batik's SVG Rasterizer utility may also be used to convert standalone SVG
 documents into PDF.  For more information please see the
-<link href="http://xml.apache.org/batik/svgrasterizer.html">SVG Rasterizer documentation</link>
+<a href="http://xml.apache.org/batik/svgrasterizer.html">SVG Rasterizer documentation</a>
 on the Batik site.
       </note>
       </section>
@@ -184,8 +241,8 @@
         <title>Placing SVG Text into PDF</title>
         <p>If possible, Batik will use normal PDF text when inserting text. It does
 this by checking if the text can be drawn normally and the font is
-supported. This example svg <link href="dev/svg/text.svg">text.svg</link> /
-<!--link href="dev/svg/text.pdf"-->text.pdf<!--/link-->
+supported. This example svg <a href="../dev/svg/text.svg">text.svg</a> /
+<!--link href="../dev/svg/text.pdf"-->text.pdf<!--/link-->
 shows how various types and effects with text are handled.
 Note that tspan and outlined text are not yet implemented.</p>
         <p>
@@ -199,7 +256,7 @@
 for PDF it will use a single character.
         </p>
         <p>
-For PDF output, there is a <link href="configuration.html#svg-strokeSVGText">configuration option to force SVG text to be rendered as text</link>.
+For PDF output, there is a <a href="configuration.html#svg-strokeSVGText">configuration option to force SVG text to be rendered as text</a>.
 The drawback to this approach is that it is effective only for available fonts (including embedded fonts).
 Font sizes are rounded to the next integer point size.
 This will be improved in the future.
@@ -278,10 +335,8 @@
         changing dummy parameter on the URL to avoid caching.
       </p>
       <p>
-        Currently, the images are not automatically released when an OutOfMemoryError is imminent. The
-        image cache can grow to a considerable size over time when a lot of different URLs are in use.
-        Starting with version 0.20.5 you can call <code>org.apache.fop.image.FopImageFactory.resetCache()</code>
-        to manually empty the cache. Image caching will be improved as part of our redesign effort.
+        The image cache has been improved considerably in the redesigned code. Therefore, a resetCache() method
+        has become unnecessary. If you still experience OutOfMemoryErrors, please notify us.
       </p>
     </section>
   </body>

Copied: xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/hyphenation.xml (from r328299, xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.20.5/hyphenation.xml)
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/hyphenation.xml?p2=xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/hyphenation.xml&p1=xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.20.5/hyphenation.xml&r1=328299&r2=328462&rev=328462&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.20.5/hyphenation.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/hyphenation.xml Tue Oct 25 12:49:46 2005
@@ -1,6 +1,6 @@
 <?xml version="1.0" standalone="no"?>
 <!--
-  Copyright 1999-2004 The Apache Software Foundation
+  Copyright 1999-2005 The Apache Software Foundation
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -15,11 +15,10 @@
   limitations under the License.
 -->
 <!-- $Id$ -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
-    "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/core/context/resources/schema/dtd/document-v12.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
   <header>
-    <title>FOP: Hyphenation</title>
+    <title>Apache FOP: Hyphenation</title>
     <version>$Revision$</version>
   </header>
   <body>
@@ -29,21 +28,21 @@
       <title>Introduction</title>
       <p>FOP uses Liang's hyphenation algorithm, well known from TeX. It needs
        language specific pattern and other data for operation.</p>
-      <p>Because of <link href="#license-issues">licensing issues</link> (and for 
+      <p>Because of <a href="#license-issues">licensing issues</a> (and for 
        convenience), all hyphenation patterns for FOP are made available through 
-       the <fork href="http://offo.sourceforge.net/hyphenation/index.html">Objects For 
-       Formatting Objects</fork> project.</p>
+       the <a class="fork" href="http://offo.sourceforge.net/hyphenation/index.html">Objects For 
+       Formatting Objects</a> project.</p>
       <note>If you have made improvements to an existing FOP hyphenation pattern, 
        or if you have created one from scratch, please consider contributing these 
        to OFFO so that they can benefit other FOP users as well. 
-       Please inquire on the <link href="maillist.html#fop-user">FOP User
-       mailing list</link>.</note>
+       Please inquire on the <a href="../maillist.html#fop-user">FOP User
+       mailing list</a>.</note>
     </section>
     <section id="license-issues">
       <title>License Issues</title>
       <p>Many of the hyphenation files distributed with TeX and its offspring are
-       licenced under the <fork href="http://www.latex-project.org/lppl.html">LaTeX
-       Project Public License (LPPL)</fork>, which prevents them from being
+       licenced under the <a class="fork" href="http://www.latex-project.org/lppl.html">LaTeX
+       Project Public License (LPPL)</a>, which prevents them from being
        distributed with Apache software. The LPPL puts restrictions on file names
        in redistributed derived works which we feel can't guarantee. Some
        hyphenation pattern files have other or additional restrictions, for
@@ -59,8 +58,8 @@
     <section id="sources">
       <title>Sources of Custom Hyphenation Pattern Files</title>
       <p>The most important source of hyphenation pattern files is the
-       <fork href="http://www.ctan.org/tex-archive/language/hyphenation/">CTAN TeX
-        Archive</fork>.</p>
+       <a class="fork" href="http://www.ctan.org/tex-archive/language/hyphenation/">CTAN TeX
+        Archive</a>.</p>
     </section>
     <section id="install">
       <title>Installing Custom Hyphenation Patterns</title>
@@ -79,9 +78,9 @@
              hyphenation patterns.</li>
           </ul>
           The language and country codes must match the XSL-FO input, which
-          follows <link href="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt">ISO
-          639</link> (languages) and <link href="http://www.ics.uci.edu/pub/ietf/http/related/iso3166.txt">ISO
-          3166</link> (countries). NOTE: The ISO 639/ISO 3166 convention is that
+          follows <a href="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt">ISO
+          639</a> (languages) and <a href="http://www.ics.uci.edu/pub/ietf/http/related/iso3166.txt">ISO
+          3166</a> (countries). NOTE: The ISO 639/ISO 3166 convention is that
           language names are written in lower case, while country codes are written
           in upper case. FOP does not check whether the language and country specified
           in the FO source are actually from the current standard, but it relies
@@ -91,12 +90,12 @@
         <li>There are basically three ways to make the FOP-compatible hyphenation pattern 
           file(s) accessible to FOP:
           <ul>
-            <li>Download the precompiled JAR from <fork href="http://offo.sourceforge.net/hyphenation/index.html">OFFO
-            </fork> and place it either in the <code>{fop-dir}/lib</code> directory, or 
+            <li>Download the precompiled JAR from <a class="fork" href="http://offo.sourceforge.net/hyphenation/index.html">OFFO
+            </a> and place it either in the <code>{fop-dir}/lib</code> directory, or 
              in a directory of your choice (and append the full path to the JAR to 
              the environment variable <code>FOP_HYPHENATION_PATH</code>).</li>
             <li>Download the desired FOP-compatible hyphenation pattern file(s) from 
-             <fork href="http://offo.sourceforge.net/hyphenation/index.html">OFFO</fork>,
+             <a class="fork" href="http://offo.sourceforge.net/hyphenation/index.html">OFFO</a>,
              and/or take your self created hyphenation pattern file(s), 
              <ul>
                 <li>place them in the directory <code>{fop-dir}/hyph</code>, </li>
@@ -114,7 +113,7 @@
              be created from the supplied pattern(s)).</li>
             <li>Put the pattern source file(s) into a directory of your choice and 
              configure FOP to look for custom patterns in this directory, by setting the
-             <link href="configuration.html#hyphenation-dir">&lt;hyphenation-dir&gt;</link> 
+             <a href="configuration.html#hyphenation-dir">&lt;hyphenation-dir&gt;</a> 
              configuration option.</li>
           </ul>
         </li>
@@ -123,7 +122,7 @@
         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 
-        <link href="configuration.html#hyphenation-dir">&lt;hyphenation-dir&gt;</link> 
+        <a href="configuration.html#hyphenation-dir">&lt;hyphenation-dir&gt;</a> 
         configuration option programmatically (option 3).
       </warning>
     </section>
@@ -133,15 +132,15 @@
     <p>If you would like to build your own hyphenation pattern files, or modify
      existing ones, this section will help you understand how to do so. Even
      when creating a pattern file from scratch, it may be beneficial to start
-     with an existing file and modify it. See <fork href="http://offo.sourceforge.net/hyphenation/index.html">
-     OFFO's Hyphenation page</fork> for examples. 
+     with an existing file and modify it. See <a class="fork" href="http://offo.sourceforge.net/hyphenation/index.html">
+     OFFO's Hyphenation page</a> for examples. 
      Here is a brief explanation of the contents of FOP's hyphenation patterns:</p>
     <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
-     <link href="maillist.html#fop-user">FOP User mailing list</link>, either
+     <a href="../maillist.html#fop-user">FOP User mailing list</a>, either
      confirming their accuracy, or raising specific problems that we can
      address.</warning>
     <ul>
@@ -227,8 +226,8 @@
      online. The original patgen.web source, included in the TeX source distributions,
      contains valuable comments, unfortunately technical details obscure often the
      high level issues. Another important source is
-     <fork href="http://www.ctan.org/tex-archive/systems/knuth/tex/texbook.tex">The
-     TeX Book</fork>, appendix H (either read the TeX source, or run it through
+     <a class="fork" href="http://www.ctan.org/tex-archive/systems/knuth/tex/texbook.tex">The
+     TeX Book</a>, appendix H (either read the TeX source, or run it through
      TeX to typeset it). Secondary articles, for example the works by Petr Sojka,
      may alos give some much needed insigth into problems arising in automated
      hyphenation.</p>

Copied: xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/index.xml (from r328299, xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.90/index.xml)
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/index.xml?p2=xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/index.xml&p1=xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.90/index.xml&r1=328299&r2=328462&rev=328462&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/0.90/index.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/trunk/index.xml Tue Oct 25 12:49:46 2005
@@ -15,16 +15,35 @@
   limitations under the License.
 -->
 <!-- $Id$ -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
   <header>
-    <title>Apache FOP Version 0.90 (FOP Trunk)</title>
+    <title>Apache FOP Trunk (Development code)</title>
     <version>$Revision: 201586 $</version>
   </header>
   <body>
     <section id="intro">
       <title>Introduction</title>
-      <p>These pages contain information that should be helpful for those </p>
+      <p>
+        <strong>FOP Trunk</strong> is the name for the current development code as found in the 
+        <a href="ext:svn-repo/trunk">Subversion repository</a>. This section of the FOP provides
+        the documentation for this version.
+      </p>
+      <p>
+        The Apache FOP team is proud to present to you the largely rewritten codebase which is 
+        finally in a state where you can start to use it. It has taken over three years to get this
+        far and over two years without a new release from the FOP project. We would like to encourage 
+        you to download the code and to play with it. We're still in the process of adding new major
+        features and stabilizing the code. We welcome any feedback you might have and even more, any
+        other form of help to get the project forward.
+      </p>
+    </section>
+    <section id="upgrading">
+      <title>Upgrading from an earlier version</title>
+      <p>
+        If you're upgrading to this version from an earlier version of FOP, please read the 
+        information contained on the <a href="upgrading.html">Upgrading page</a>!
+      </p>
     </section>
   </body>
 </document>



---------------------------------------------------------------------
To unsubscribe, e-mail: fop-commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: fop-commits-help@xmlgraphics.apache.org