git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196197 13f79535-47bb-0310-9956-ffa450edef68

21 years ago · b2c66e0039
--- a/src/documentation/content/xdocs/book.xml
+++ b/src/documentation/content/xdocs/book.xml
@@ -31,8 +31,6 @@
          <menu-item label="Ant task" href="anttask.html"/>
          <menu-item label="Output Formats" href="output.html"/>
          <menu-item label="Compliance" href="compliance.html"/>
          <menu-item label="Implemented" href="implemented.html"/>
          <menu-item label="Limitations" href="limitations.html"/>
        </menu>

        <menu label="Extras">
--- a/src/documentation/content/xdocs/dev/index.xml
+++ b/src/documentation/content/xdocs/dev/index.xml
@@ -1,90 +1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
    "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/resources/schema/dtd/document-v11.dtd">

      <document>
        <header>
          <title>FOP 1.0 development</title>
        </header>
        <body>
          <section>
            <title>Introduction</title>
            <p>
 These pages contain information that is relevant to the
 current development of FOP.
            </p>
    <p>FOP is the world's first print formatter driven by XSL formatting
       objects and the world's first output independent formatter. It is a
       Java application that reads a formatting object tree and then
       renders the resulting pages to a specified output. <link href="../output.html">Output formats</link>
       currently supported are PDF, PCL, PS, SVG, XML (area tree representation),
       Print, AWT, MIF and TXT.
       The primary output target is PDF.
    </p>
  <note>
 FOP - someone who is overly concerned with style, also conveniently
 can mean Formatting Object Processor.
  </note>
        <figure width="480" height="260" src="../images/document.jpg" alt="Render Diagram" />
    <p>The latest version of Fop is 0.20.4 and it supports the
       <jump href="http://www.w3.org/TR/2001/REC-xsl-20011015/">XSL-FO Version 1.0
       W3C Recommendation</jump>.
       You can <link href="../download.html">download</link>
       Fop including a precompiled version, the source code and many example files to
       get you started. Pointers to introductions into xsl:fo can be found in the
       <link href="../resources.html">resources</link> section. Please be aware, that
       Fop is at the moment not a full implementation of the basic conformance level
       of the xsl:fo standard. You can find a list of supported flow objects and properties
       in the section <link href="../implemented.html">Features</link> and in section
       <link href="../limitations.html">Limitations</link> in what way this support is
       limited.
    </p>
    <p>FOP is part of Apache's XML project. The homepage of FOP is
       <jump href="http://xml.apache.org/fop">http://xml.apache.org/fop</jump>.
       Here you can find information about using and developing with FOP.
    </p>
    <p>Users can subscribe to fop-user@xml.apache.org by sending an email
        to <jump href="mailto:fop-user-subscribe@xml.apache.org">fop-user-subscribe@xml.apache.org</jump>
        this is where user specific topics are discussed.
     </p>
          </section>
          <section>
            <title>Formatting</title>
        <figure width="480" height="260" src="../images/layout.jpg" alt="Formatting Diagram" />
 <p>
 This image is a demonstration of a two page document. The xml data on the left
 is formatted into the two pages on the right. The document contains static areasthat appear on every page, an external graphic in this case an svg document.
 There is a footnote on the first page and a table that goes across both pages.
 </p>
 <p>
 The advantage of XSL is the ability to take an XML document and to format
 the information into a page layout. The XML document can be generated
 in any way, the most common would be to use XSLT. FOP takes the XML
 and formats the data into pages. The pages are then rendered to the
 requested output.
 </p>
 <p>
 This is a real document. The image was created by rendering the document
 to the svg renderer then putting the rendered pages into an svg document
 along with the xml.
            </p>
          </section>
          <section>
            <title>FOP Objectives</title>
            <p>
 The goals of the Apache XML FOP Project are to deliver an XSL FO->PDF formatter that is compliant to at least the Basic
       conformance level described in the W3C Recommendation from 15 October 2001, and that complies with the 11 March 1999 Portable Document
       Format Specification (Version 1.3) from Adobe Systems.
    </p>

    <p>Conformance to the XML 1.0 Recommendation, XSLT 1.0 Recommendation and the XML Namespaces Recommendation is
       understood. Other relevant documents, such as the XPath and XLink Working Drafts, are referenced as necessary. The FOP
       Project will attempt to use the latest version of evolving specifications.
    </p>

   <p>To reach this aim currently the layout system is being redesigned to
 better handle the formatting of all different types of formatting objects.
            </p>
          </section>
        </body>
    </document>
 <document>
  <header>
    <title>Information for FOP Developers</title>
  </header>
  <body>
    <section>
      <title>Introduction</title>
      <p>These pages contain information that should be helpful for those developing FOP.</p>
      <p>For basic and user information on FOP, please visit the <link href="http://xml.apache.org/fop">FOP homepage</link>.</p>
      <p>It is important to understand that there are currently three lines of development on the FOP product:</p>
      <ul>
        <li>The oldest is the one that releases are currently generated from, and is also called the "maintenance branch". Because of limitations in its design, the FOP committers decided to freeze new development on this branch, and are providing only bug fixes. This branch is tagged as "fop-0_20_2-maintain" in the CVS repository.</li>
        <li>The main development line is the future of FOP. It was spawned from the "maintenance" branch, but had to quickly be "broken" so that the needed redesign could be dropped into place. It is currently not as mature as the "maintenance" branch, but has far greater long-term prospects. It is also known as the "root" or "trunk".</li>
      <li>The "Alt Design" is exactly that: an alternative design approach. Because its efforts are largely complementary and parallel to the main development branch, and because it is expected to be merged at some point into the trunk, it is <link href="design/alt.design/index.html">documented separately</link>. The authors of this effort are currently in the process of merging their work into the trunk.</li>
      </ul>
    <p>Please note that patches for enhancements to the maintenance branch will generally not be considered. Bug fixes are welcome there, but new developers are strongly encouraged to apply their efforts to the trunk development line.</p>
    <p>Because there is a fair amount of common information between the maintenance and trunk development lines, we attempt to document them together, highlighting differences only where needed.</p>
    </section>
  </body>
 </document>
--- a/src/documentation/content/xdocs/faq.xml
+++ b/src/documentation/content/xdocs/faq.xml
@@ -1660,11 +1660,14 @@ class rendtest {
            </ul>
          </li>
          <li>
            Something doesn't work with FOP but works with another formatter
            (AntennaHouse, PassiveTex). Check whether this is already mentioned
            in the release notes, the FOP limitations document or the FAQ. Post
            to fop-dev or open a bug on <link
            href="http://nagoya.apache.org">bugzilla</link>.
            In the case where something works properly with another formatter,
            (AntennaHouse, PassiveTex, etc.) but doesn't work with FOP, please
            check the <link href="relnotes.html">Release Notes</link>, the
            <link href="compliance.html">FOP Standards Compliance</link> document,
            and the remaining FAQ in this document. If not found there, look at the
            list of <link href="bugs.html#issues_existing">Bugs Already Reported</link>.
            If not found there, please post a question on the fop-user mailing list
            or <link href="bugs.html#issues_new">Open a New Bug</link>.
          </li>
          <li>
            Question about how to use FOP, how to perform certain tasks with FOP
--- a/src/documentation/content/xdocs/implemented.xml
+++ b/src/documentation/content/xdocs/implemented.xml
@@ -1,256 +0,0 @@
 <?xml version="1.0" standalone="no"?>
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
    "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/resources/schema/dtd/document-v11.dtd">

 <document>
 <header>
 <title>Implemented</title>
 </header>
 <body>
 <section>
  <title>Features</title>
  <section>
    <title>What's Implemented?</title>
      <p>The following formatting objects and properties of the XSL-FO 1.0
         W3C Recommendation are implemented. Please also have a look at the
         section on <jump href="limitations.html">limitations</jump>.
      </p>
  </section>
  <section>
    <title>1) Formatting Objects</title>
    <p>This section follows the tables in 
      <jump href="http://www.w3.org/TR/2001/REC-xsl-20011015/sliceB.html#FO-summary">Appendix B, "Formatting Object Summary"</jump> of the XSL-FO specification. 
      Items that are not currently implemented are listed at the end of each sub-section.</p>
    <section>
      <title>B.1 Declaration and Pagination and Layout Formatting Objects</title>
      <ul>
        <li>root</li>
        <li>page-sequence</li>
        <li>page-sequence-master</li>
        <li>single-page-master-reference</li>
        <li>repeatable-page-master-reference</li>
        <li>repeatable-page-master-alternatives</li>
        <li>conditional-page-master-reference</li>
        <li>layout-master-set</li>
        <li>simple-page-master</li>
        <li>region-body</li>
        <li>region-before</li>
        <li>region-after</li>
        <li>region-start</li>
        <li>region-end</li>
        <li>flow</li>
        <li>static-content</li>
      </ul>
      <p>Not implemented: declarations, color-profile, title</p>
    </section>

    <section>
      <title>B.2 Block Formatting Objects</title>
      <ul>
        <li>block</li>
        <li>block-container (limited)</li>
      </ul>
    </section>

    <section>
      <title>B.3 Inline Formatting Objects</title>
      <ul>
        <li>character</li>
        <li>external-graphic</li>
        <li>inline</li>
        <li>instream-foreign-object</li>
        <li>leader</li>
        <li>page-number </li>
        <li>page-number-citation, see <jump href="limitations.html">limitations</jump></li>
      </ul>
      <p>Not implemented: bidi-override, initial-property-set, inline-container</p>
    </section>

    <section>
      <title>B.4 Table Formatting Objects</title>
      <ul>
        <li>table</li>
        <li>table-body</li>
        <li>table-cell</li>
        <li>table-column</li>
        <li>table-footer</li>
        <li>table-header</li>
        <li>table-row</li>
      </ul>
      <p>Not implemented: table-and-caption, table-caption </p>
    </section>

    <section>
      <title>B.5 List Formatting Objects</title>
      <ul>
        <li>list-block </li>
        <li>list-item </li>
        <li>list-item-body </li>
        <li>list-item-label </li>
      </ul>
    </section>

    <section>
      <title>B.6 Link and Multi Formatting Objects</title>
      <ul>
        <li>basic-link (internal and external)</li>
      </ul>
      <p>Not implemented: multi-switch, multi-case, multi-toggle,
         multi-properties, multi-property-set</p>
    </section>

    <section>
      <title>B.7 Out-of-line Formatting Objects</title>
      <ul>
        <li>footnote</li>
        <li>footnote-body</li>
      </ul>
      <p>Not implemented: float</p>
    </section>

    <section>
      <title>B.8 Other Formatting Objects</title>
      <ul>
        <li>wrapper</li>
        <li>marker, retrieve marker</li>
      </ul>
    </section>
  </section>

  <section>
    <title>2) Properties</title>
  <p>Property values can be computed. Compound properties are also understood by FOP.</p>
    <ul>
      <li>background-color </li>
      <li>background-image </li>
      <li>blank-or-not-blank</li>
      <li>border-after-color</li>
      <li>border-after-style</li>
      <li>border-after-width</li>
      <li>border-before-color</li>
      <li>border-before-style</li>
      <li>border-before-width</li>
      <li>border-bottom</li>
      <li>border-bottom-color</li>
      <li>border-bottom-style</li>
      <li>border-bottom-width</li>
      <li>border-color (only one value allowed) </li>
      <li>border-end-color</li>
      <li>border-end-style</li>
      <li>border-end-width</li>
      <li>border-left</li>
      <li>border-left-color</li>
      <li>border-left-style</li>
      <li>border-left-width</li>
      <li>border-right</li>
      <li>border-right-color</li>
      <li>border-right-style</li>
      <li>border-right-width</li>
      <li>border-start-color</li>
      <li>border-start-style</li>
      <li>border-start-width</li>
      <li>border-style</li>
      <li>border-top</li>
      <li>border-top-color</li>
      <li>border-top-style</li>
      <li>border-top-width</li>
      <li>border-width</li>
      <li>bottom</li>
      <li>break-after </li>
      <li>break-before </li>
      <li>character</li>
      <li>color </li>
      <li>column-count</li>
      <li>column-gap</li>
      <li>column-width </li>
      <li>country</li>
      <li>end-indent </li>
      <li>extent </li>
      <li>external-destination</li>
      <li>flow-name </li>
      <li>font-family </li>
      <li>font-size </li>
      <li>font-style </li>
      <li>font-weight </li>
      <li>height</li>
      <li>hyphenate</li>
      <li>hyphenation-character</li>
      <li>hyphenation-push-character-count</li>
      <li>hyphenation-remain-character-count</li>
      <li>id</li>
      <li>initial-page-number</li>
      <li>internal-destination</li>
      <li>keep-with-next (broken)</li>
      <li>language</li>
      <li>leader-alignment (not value "page")</li>
      <li>leader-length (see limitations)</li>
      <li>leader-pattern (not value "use-content")</li>
      <li>leader-pattern-width</li>
      <li>left</li>
      <li>letter-spacing</li>
      <li>line-height </li>
      <li>margin (only on pages and regions) </li>
      <li>margin-bottom (only on pages and regions) </li>
      <li>margin-left (only on pages and regions) </li>
      <li>margin-right (only on pages and regions) </li>
      <li>margin-top (only on pages and regions) </li>
      <li>master-name </li>
      <li>master-reference </li>
      <li>maximum-repeats</li>
      <li>number-columns-spanned</li>
      <li>odd-or-even</li>
      <li>padding (only one value allowed) </li>
      <li>padding-after</li>
      <li>padding-before</li>
      <li>padding-bottom </li>
      <li>padding-end</li>
      <li>padding-left  </li>
      <li>padding-right  </li>
      <li>padding-start</li>
      <li>padding-top  </li>
      <li>page-height </li>
      <li>page-position</li>
      <li>page-width </li>
      <li>position (allowed values: "static" (default),"relative", "absolute", fixed ) </li>
      <li>provisional-distance-between-starts </li>
      <li>provisional-label-separation </li>
      <li>ref-id </li>
      <li>region-name</li>
      <li>right</li>
      <li>rule-style</li>
      <li>rule-thickness </li>
      <li>space-after.optimum </li>
      <li>space-before.optimum </li>
      <li>span</li>
      <li>src </li>
      <li>start-indent </li>
      <li>table-omit-footer-at-break</li>
      <li>table-omit-header-at-break</li>
      <li>text-align </li>
      <li>text-align-last </li>
      <li>text-decoration</li>
      <li>text-indent </li>
      <li>top</li>
      <li>white-space-collapse</li>
      <li>width</li>
      <li>wrap-option</li>
    </ul>
    <p>All other properties are not implemented.</p>
  </section>

  <section>
    <title>3) SVG Support</title>
 <p>
 FOP uses <jump href="http://xml.apache.org/batik/">Batik</jump> directly for its SVG support. Therefore FOP supports the same
 elements and properties as are supported by Batik. Because FOP is designed for
 rendering to a static medium, only static SVG is supported.
 </p>
 <p>
 Due to certain PDF limitations, some SVG images, particularly those with filter effects
 or transparency, may not come out correctly.  However, these images should still be rendered correctly by the AWT and Print renderers.
 </p>
  </section>
 </section>
 </body>
 </document>

--- a/src/documentation/content/xdocs/index.xml
+++ b/src/documentation/content/xdocs/index.xml
@@ -29,10 +29,9 @@
       get you started. Pointers to introductions into xsl:fo can be found in the
       <link href="resources.html">resources</link> section. Please be aware, that
       FOP is at the moment not a full implementation of the basic conformance level
       of the xsl:fo standard. You can find a list of supported flow objects and properties
       in the section <link href="implemented.html">Features</link> and in section
       <link href="limitations.html">Limitations</link> in what way this support is
       limited.
       of the xsl:fo standard. The <link href="compliance.html">FOP Compliance
       page</link> lists all objects and properties in the standard, and indicates
       FOP's current compliance with those features.
    </p>
    <p>FOP is part of Apache's XML project. The homepage of FOP is
       <link href="http://xml.apache.org/fop">http://xml.apache.org/fop</link>.
--- a/src/documentation/content/xdocs/limitations.xml
+++ b/src/documentation/content/xdocs/limitations.xml
@@ -1,79 +0,0 @@
 <?xml version="1.0"?>
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
    "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/resources/schema/dtd/document-v11.dtd">

 <document>
    <header>
        <title>Limitations</title>
    </header>

    <body>
 <section>
  <title>Limitations</title>
  <p>FOP implements the fo objects and properties listed
     in <jump href="implemented.html">features</jump>, sometimes it does so only in a limited way.
  </p>

  <section>
    <title>fo:leader</title>
    <p>leader-length.minimum is not used at all</p>
  </section>

  <section>
    <title>page-number-citation</title>
    <p>Only works for table of contents without any problems. The case where the page number doesn't
    fit on a line isn't handled, and any text on the same line and after the page-number might not
    appear exactly where you want it to.
    </p>
  </section>

  <section>
    <title>Padding</title>
    <p>Padding works in conjunction with indents and spaces. It is only implemented
       for blocks. At the moment padding can't be used to make extra space (indents+spaces
       must be used), but only to control how much the background-color extends beyond
       the content rectangle.
    </p>
  </section>
  <section>
    <title>Tables</title>
    <p>There two limitations for tables: 1) FOP needs you to explicitly specify column widths
       2) Cells have to contain block-level FOs. They can't contain straight character data.
    </p>
    <p>A working basic example of a table looks like this: </p>
  <source><![CDATA[
 <fo:table>
 <fo:table-column column-width="150pt"/>
 <fo:table-column column-width="150pt"/>
 <fo:table-body font-size="10pt" font-family="sans-serif">
  <fo:table-row>
   <fo:table-cell>
    <fo:block>text</fo:block>
   </fo:table-cell>
   <fo:table-cell>
    <fo:block>text</fo:block>
   </fo:table-cell>
  </fo:table-row>
  <fo:table-row>
   <fo:table-cell>
    <fo:block>text</fo:block>
   </fo:table-cell>
   <fo:table-cell>
    <fo:block>text</fo:block>
   </fo:table-cell>
  </fo:table-row>
  <fo:table-row>
   <fo:table-cell>
    <fo:block>text</fo:block>
   </fo:table-cell>
   <fo:table-cell>
    <fo:block>text</fo:block>
   </fo:table-cell>
  </fo:table-row>
 </fo:table-body>
 </fo:table>]]></source>
  </section>
 </section>
 </body>
 </document>