From 77aa00905f20f2bbb7db771b4bba7e1e76740630 Mon Sep 17 00:00:00 2001
From: Jeremias Maerki <jeremias@apache.org>
Date: Tue, 15 Nov 2005 20:49:37 +0000
Subject: [PATCH] Updates on the output formats.

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@344439 13f79535-47bb-0310-9956-ffa450edef68
---
 .../content/xdocs/trunk/output.xml            | 156 ++++++++++--------
 1 file changed, 83 insertions(+), 73 deletions(-)

diff --git a/src/documentation/content/xdocs/trunk/output.xml b/src/documentation/content/xdocs/trunk/output.xml
index ec5274ee4..500d31f3d 100644
--- a/src/documentation/content/xdocs/trunk/output.xml
+++ b/src/documentation/content/xdocs/trunk/output.xml
@@ -184,57 +184,6 @@ out = proc.getOutputStream();]]></source>
     </ul>
   </section>
 </section>
-<!--section id="pcl">
-  <title>PCL</title>
-    <warning>The PCL Renderer is not yet functional in FOP Trunk!!!</warning>
-    <p>
-      This format is for the Hewlett-Packard PCL printers.
-      It should produce output as close to identical as possible to the
-      printed output of the PDFRenderer within the limitations of the
-      renderer, and output device.
-    </p>
-    <p>
-      The output created by the PCLRenderer is generic PCL 5 as documented
-      in the "HP PCL 5 Printer Language Technical Reference Manual" (copyright 1990).
-      This should allow any device fully supporting PCL 5 to be able to
-      print the output generated by the PCLRenderer.
-    </p>
-    <section id="pcl-limitations">
-      <title>Limitations</title>
-      <ul>
-        <li>Text or graphics outside the left or top of the printable area are not rendered properly. In general things that should print to the left of the printable area are shifted to the right so that they start at the left edge of the printable area and an error message is generated.</li>
-        <li>The Helvetica and Times fonts are not well supported among PCL printers so Helvetica is mapped to Arial and Times is mapped to Times New. This is done in the PCLRenderer, no changes are required in the FO's. The metrics and appearance for Helvetica/Arial and Times/Times New are nearly identical, so this has not been a problem so far.</li>
-        <li>Only the original fonts built into FOP are supported.</li>
-        <li>For the non-symbol fonts, the ISO 8859/1 symbol set is used (PCL set "0N").</li>
-        <li>Multibyte characters are not supported.</li>
-        <li>SVG is not supported.</li>
-        <li>Images print black and white only (not dithered). When the renderer prints a color image it uses a threshold value, colors above the threshold are printed as white and below are black. If you need to print a non-monochrome image you should dither it first.</li>
-        <li>Image scaling is accomplished by modifying the effective resolution of the image data. The available resolutions are 75, 100, 150, 300, and 600 DPI.</li>
-        <li>Color printing is not supported. Colors are rendered by mapping the color intensity to one of the PCL fill shades (from white to black in 9 steps).</li>
-      </ul>
-    </section>
-
-    <section id="pcl-additional">
-      <title>Additional Features</title>
-      <p>There are some special features that are controlled by some public variables on the PCLRenderer class.</p>
-
-      <dl>
-        <dt>orientation</dt>
-        <dd>The logical page orientation is controlled by the public orientation variable. Legal values are:-->
-          <!--ul>
-            <li>0 Portrait</li>
-            <li>1 Landscape</li>
-            <li>2 Reverse Portrait</li>
-            <li>3 Reverse Landscape</li>
-          </ul-->
-        <!--/dd>
-        <dt>curdiv, paperheight</dt>
-        <dd>The curdiv and paperheight variables allow multiple virtual pages to be printed on a piece of paper. This allows a standard laser printer to use perforated paper where every perforation will represent an individual page. The paperheight sets the height of a piece of paper in decipoints. This will be divided by the page.getHeight() to determine the number of equal sized divisions (pages) that will fit on the paper. The curdiv variable may be read/written to get/set the current division on the page (to set the starting division and read the ending division for multiple invocations).</dd>
-        <dt>topmargin, leftmargin</dt>
-        <dd>The topmargin and leftmargin may be used to increase the top and left margins for printing.</dd>
-      </dl>
-    </section>
-</section-->
 <section id="ps">
   <title>PostScript</title>
   <p>
@@ -266,19 +215,6 @@ out = proc.getOutputStream();]]></source>
     and produces best results on Microsoft Word.
   </p>
 </section>
-<section id="svg">
-  <title>SVG</title>
-  <p>
-    This format creates an SVG document that has links between the pages.
-    This is primarily for slides and creating svg images of pages.
-    Large documents will create SVG files that are far too large for
-    and SVG viewer to handle. Since FO documents usually have text the
-    SVG document will have a large number of text elements.
-    The font information for the text is obtained from the JVM in the
-    same way as the AWT viewer, if the SVG is view where the fonts are
-    different, such as another platform, then the page may appear wrong.
-  </p>
-</section>
 <section id="xml">
   <title>XML (Area Tree XML)</title>
   <p>
@@ -289,6 +225,7 @@ out = proc.getOutputStream();]]></source>
 </section>
 <section id="awt">
   <title>Java2D/AWT</title>
+    <warning>The Java2D/AWT, Print and Bitmap renderers may not yet fully work as expected. There are some known bugs and missing features.</warning>
     <p>
       The AWT viewer shows a window with the pages displayed inside a
       Java graphic. It displays one page at a time.
@@ -317,17 +254,8 @@ out = proc.getOutputStream();]]></source>
     FOUserAgent.
   </p>
 </section>
-<section id="mif">
-  <title>MIF</title>
-  <warning>The MIF handler is not yet functional in FOP Trunk!!!</warning>
-  <p>
-    This format is the Maker Interchange Format which is used by
-    Adobe Framemaker.
-  </p>
-</section>
 <section id="txt">
   <title>TXT</title>
-  <warning>The TXT renderer is not yet functional in FOP Trunk!!!</warning>
   <p>
     The text renderer produces plain ASCII text output
     that attempts to match the output of the PDFRenderer as closely as
@@ -358,6 +286,88 @@ out = proc.getOutputStream();]]></source>
     <li>line-height="10.5pt"</li>
   </ul>
 </section>
+<section id="sandbox">
+  <title>Output Formats in the Sandbox</title>
+  <p>
+    Due to the state of certain renderers we moved some of them to a "sandbox" area until 
+    they are ready for more serious use. The renderers and FOEventHandlers in the sandbox
+    can be found under src/sandbox and are compiled into build/fop-sandbox.jar during the
+    main build. The output formats in the sandbox are marked as such below.
+  </p>
+  <section id="pcl">
+    <title>PCL</title>
+    <warning>The PCL Renderer is in the sandbox and not yet functional in FOP Trunk!!! Please help us ressurrect this feature.</warning>
+    <p>
+      This format is for the Hewlett-Packard PCL printers.
+      It should produce output as close to identical as possible to the
+      printed output of the PDFRenderer within the limitations of the
+      renderer, and output device.
+    </p>
+    <!--p>
+      The output created by the PCLRenderer is generic PCL 5 as documented
+      in the "HP PCL 5 Printer Language Technical Reference Manual" (copyright 1990).
+      This should allow any device fully supporting PCL 5 to be able to
+      print the output generated by the PCLRenderer.
+    </p>
+    <section id="pcl-limitations">
+      <title>Limitations</title>
+      <ul>
+        <li>Text or graphics outside the left or top of the printable area are not rendered properly. In general things that should print to the left of the printable area are shifted to the right so that they start at the left edge of the printable area and an error message is generated.</li>
+        <li>The Helvetica and Times fonts are not well supported among PCL printers so Helvetica is mapped to Arial and Times is mapped to Times New. This is done in the PCLRenderer, no changes are required in the FO's. The metrics and appearance for Helvetica/Arial and Times/Times New are nearly identical, so this has not been a problem so far.</li>
+        <li>Only the original fonts built into FOP are supported.</li>
+        <li>For the non-symbol fonts, the ISO 8859/1 symbol set is used (PCL set "0N").</li>
+        <li>Multibyte characters are not supported.</li>
+        <li>SVG is not supported.</li>
+        <li>Images print black and white only (not dithered). When the renderer prints a color image it uses a threshold value, colors above the threshold are printed as white and below are black. If you need to print a non-monochrome image you should dither it first.</li>
+        <li>Image scaling is accomplished by modifying the effective resolution of the image data. The available resolutions are 75, 100, 150, 300, and 600 DPI.</li>
+        <li>Color printing is not supported. Colors are rendered by mapping the color intensity to one of the PCL fill shades (from white to black in 9 steps).</li>
+      </ul>
+    </section>
+
+    <section id="pcl-additional">
+      <title>Additional Features</title>
+      <p>There are some special features that are controlled by some public variables on the PCLRenderer class.</p>
+
+      <dl>
+        <dt>orientation</dt>
+        <dd>The logical page orientation is controlled by the public orientation variable. Legal values are:-->
+          <!--ul>
+            <li>0 Portrait</li>
+            <li>1 Landscape</li>
+            <li>2 Reverse Portrait</li>
+            <li>3 Reverse Landscape</li>
+          </ul-->
+        <!--/dd>
+        <dt>curdiv, paperheight</dt>
+        <dd>The curdiv and paperheight variables allow multiple virtual pages to be printed on a piece of paper. This allows a standard laser printer to use perforated paper where every perforation will represent an individual page. The paperheight sets the height of a piece of paper in decipoints. This will be divided by the page.getHeight() to determine the number of equal sized divisions (pages) that will fit on the paper. The curdiv variable may be read/written to get/set the current division on the page (to set the starting division and read the ending division for multiple invocations).</dd>
+        <dt>topmargin, leftmargin</dt>
+        <dd>The topmargin and leftmargin may be used to increase the top and left margins for printing.</dd>
+      </dl>
+    </section-->
+  </section>
+  <section id="mif">
+    <title>MIF</title>
+    <warning>The MIF handler is in the sandbox and not yet functional in FOP Trunk!!! Please help us ressurrect this feature.</warning>
+    <p>
+      This format is the Maker Interchange Format which is used by
+      Adobe Framemaker.
+    </p>
+   </section>
+   <section id="svg">
+     <title>SVG</title>
+     <warning>The SVG renderer is in the sandbox and may not work as expected in FOP Trunk!!! Please help us improve this feature.</warning>
+     <p>
+       This format creates an SVG document that has links between the pages.
+       This is primarily for slides and creating svg images of pages.
+       Large documents will create SVG files that are far too large for
+       and SVG viewer to handle. Since FO documents usually have text the
+       SVG document will have a large number of text elements.
+       The font information for the text is obtained from the JVM in the
+       same way as the AWT viewer, if the SVG is view where the fonts are
+       different, such as another platform, then the page may appear wrong.
+     </p>
+   </section>
+</section>
 
   </body>
 </document>
-- 
2.39.5