vmote       2003/04/06 21:43:41

  Modified:    src/documentation/content/xdocs/design book.xml
               src/documentation/content/xdocs/dev book.xml
  Added:       src/documentation/content/xdocs/dev implement.xml
  Removed:     src/documentation/content/xdocs/design architecture.xml
  Log:
  Move design/architecture.xml to dev/implement.xml.
  
  Revision  Changes    Path
  1.7       +0 -3      xml-fop/src/documentation/content/xdocs/design/book.xml
  
  Index: book.xml
  ===================================================================
  RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/design/book.xml,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- book.xml  24 Mar 2003 21:37:20 -0000      1.6
  +++ book.xml  7 Apr 2003 04:43:41 -0000       1.7
  @@ -14,9 +14,6 @@
         <menu-item label="Index" href="index.html"/>
         <menu-item label="Understanding" href="understanding/index.html"/>
       </menu>
  -    <menu label="Overview">
  -      <menu-item label="Architecture Implementation" href="architecture.html"/>
  -    </menu>
       <menu label="Sections">
         <menu-item label="FO Tree" href="fotree.html"/>
         <menu-item label="Properties" href="properties.html"/>
  
  
  
  1.14      +1 -0      xml-fop/src/documentation/content/xdocs/dev/book.xml
  
  Index: book.xml
  ===================================================================
  RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/dev/book.xml,v
  retrieving revision 1.13
  retrieving revision 1.14
  diff -u -r1.13 -r1.14
  --- book.xml  7 Apr 2003 04:22:59 -0000       1.13
  +++ book.xml  7 Apr 2003 04:43:41 -0000       1.14
  @@ -11,6 +11,7 @@
         <menu-item label="Introduction" href="index.html"/>
         <menu-item label="FAQs" href="faq.html"/>
         <menu-item label="Examples" href="examples.html"/>
  +      <menu-item label="Walk-Thru" href="implement.html"/>
       </menu>
       <menu label="Using">
         <menu-item label="Extensions" href="extensions.html"/>
  
  
  
  1.1                  xml-fop/src/documentation/content/xdocs/dev/implement.xml
  
  Index: implement.xml
  ===================================================================
  <?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>Implementation Overview</title>
      <subtitle>Following a Document Through FOP</subtitle>
      <authors>
        <person name="Arved Sandstrom" email=""/>
      </authors>
    </header>
    <body>
      <p>The purpose of this document is to tie together the FOP design (interface) 
with some of the key points where control is passed within FOP (implementation), so 
that developers can quickly find the section of code that is relevant to their needs. 
The process described is for a "typical" command-line document. All classes are in 
org.apache.fop unless otherwise designated.</p>
      <section>
        <title>Overview</title>
        <p>The input FO document is sent to the FO tree builder via SAX events. 
Fragments of an FO Tree are built from this process. As each page-sequence element is 
completed, it is passed to a layout processor, which in turn converts it into an Area 
Tree. The Area Tree is then given to the Renderer, which converts it into a stream of 
data containing the output document. The sections below will provide additional 
details. Where needed differences between the trunk and maintenance branches are shown 
in tabular format.</p>
      </section>
      <section>
        <title>Startup</title>
        <ul>
          <li>The job starts in <em>apps.Fop.main()</em>.</li>
          <li>Control is passed to <em>apps.CommandLineStarter.run()</em>.</li>
          <li>Control is passed to <em>apps.Driver.render()</em>. This class fires up 
a SAX parser, the events from which indirectly control the remaining processing, 
including building the FO Tree, building the Area Tree, rendering, output and 
logging.</li>
        </ul>
      </section>
      <section>
        <title>Formatting Object Tree</title>
        <table>
          <tr>
            <th>Trunk</th><th>Maintenance</th>
          </tr>
          <tr>
            <td colspan="2">The SAX events that the parser creates are handled by 
<em>fo.FOTreeBuilder</em>, which uses <code>startElement()</code>, 
<code>endElement()</code>, and <code>characters()</code> methods to build the FO 
Tree.</td>
            <td><em>fo.FOTreeBuilder.endElement()</em> runs the end() method for each 
node as it is created. The <em>fo.pagination.PageSequence</em> class overrides this 
end() method to run <em>apps.LayoutHandler.endPageSequence()</em>, which in turn runs 
<em>fo.pagination.PageSequence.format()</em>.</td>
            <td>the end of a PageSequence element causes the PageSequence object to be 
passed to <em>apps.StreamRenderer.render</em>, which in turn runs 
fo.pagination.PageSequence.format.</td>
          </tr>
          <tr>
            <td></td>
            <td><em>fo.pagination.PageSequence.addFlow()</em> programatically adds a 
Flow object to the page sequence.</td>
          </tr>
          <tr>
            <td></td>
            <td>fo.pagination.PageSequence.makePage() creates a BodyArea and passes it 
to <em>fo.Flow.layout</em></td>
          </tr>
          <tr>
            <td colspan="2">the layout process is then driven from 
<em>fo.pagination.PageSequence.format</em>.</td>
          </tr>
        </table>
      </section>
      <section>
        <title>Layout</title>
        <p>There are layout managers for each type of layout decision.
  They take an FO Tree as input and build a laid-out Area Tree from it.
  The layout process involves finding out where line breaks and page breaks should be 
made, then creating the areas on the page.
  Static areas can then be added for any static regions.
  As pages are completed, they are added to the Area Tree.</p>
      </section>
      <section>
        <title>Area Tree</title>
        <p>The area tree is a data structure designed to hold the page areas.
  These pages are then filled with the page regions and various areas.
  The area tree is used primarily as a minimal structure that can be rendered
  by the renderers.</p>
        <p>The area tree is supported by an area tree model. This model
  handles the adding of pages to the area tree. It also handles
  page sequence starts, document level extensions, id references
  and unresolved id areas. This model allows the pages to be handled
  directly by a renderer or to store the pages for later use.
  </p>
      </section>
      <section>
        <title>Rendering</title>
        <p>
  The renderer receives pages from the area tree and renders those pages.
  If a renderer supports out of order rendering then it will either
  render or prepare a page in the correct order. Otherwise the
  pages are rendered in order.
  The task of the renderer is to take the pages and output them to
  the requested type.
  In the case of the AWTRenderer it needs to be able to view any page.
  </p>
        <p>
  When rendering a page it takes the page and renders each page region.
  The main work for a renderer implementation is to handle the viewports
  and inline areas. The inline areas need to be drawn on the page in the
  correct place.
  </p>
      </section>
    </body>
  </document>
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to