[FOray-commit] SF.net SVN: foray: [7753] trunk/foray/doc/web/module/index.html
Modular XSL-FO Implementation for Java.
Status: Alpha
Brought to you by:
victormote
Menu
▾
▴
[FOray-commit] SF.net SVN: foray: [7753] trunk/foray/doc/web/module/index.html
|
From: <vic...@us...> - 2006-07-01 20:12:50
|
Revision: 7753 Author: victormote Date: 2006-07-01 13:12:45 -0700 (Sat, 01 Jul 2006) ViewCVS: http://svn.sourceforge.net/foray/?rev=7753&view=rev Log Message: ----------- Update module documentation. Modified Paths: -------------- trunk/foray/doc/web/module/index.html Modified: trunk/foray/doc/web/module/index.html =================================================================== --- trunk/foray/doc/web/module/index.html 2006-07-01 19:31:10 UTC (rev 7752) +++ trunk/foray/doc/web/module/index.html 2006-07-01 20:12:45 UTC (rev 7753) @@ -18,6 +18,7 @@ <ul> <li><a href="#intro">Introduction</a></li> + <li><a href="#axsl">aXSL</a></li> <li><a href="#list">Summary of Modules</a></li> <li><a href="#build">Building a Module</a></li> </ul> @@ -34,10 +35,21 @@ <p>The purpose of this page is to briefly describe the FOray modules and the dependencies between them.</p> +<h2><a name="axsl">aXSL</a></h2> +<p>FOray has adopted the <a href="http://www.axsl.org">aXSL</a> (API for XSL) +view of document processing. +In a nutshell, this philosophy views document processing not as a monolithic +task, but as a set of discrete modules with well-defined interfaces between them. +This means that very few FOray modules have dependencies on other FOray modules. +Instead, they depend on aXSL interfaces, the implementations of which may or may +not be other FOray modules. +This modular design not only makes improving one module a simpler, cleaner, and +less-risky task, but also allows developers to mix-and-match the "best-of-breed" +modules that may be available.</p> + <h2><a name="list">Summary of Modules</a></h2> -<p>The following table lists each component, in the order in which it should -be built:</p> +<p>The following table lists each FOray module:</p> <table border="1" cellpadding="2"> <tr> @@ -58,8 +70,9 @@ <tr> <td><a class="Menu" href="/module/common/index.html">FOrayCommon</a></td> <td>foray-common</td> - <td>Classes that contain features used by, or potentially used by, more than - one FOray module.</td> + <td>Low-level utilities that contain features used by, or potentially used +by, more than one FOray module. +These tend to be things that we wish were part of the Java distribution.</td> <td>Libraries.</td> </tr> <tr class="Heading1"> @@ -72,30 +85,41 @@ <td>Universals.</td> </tr> <tr> + <td>FOrayPretty</td> + <td>foray-pretty</td> + <td>Classes for pretty-printing XML output.</td> + <td>Universals.</td> + </tr> + <tr> <td><a class="Menu" href="/module/graphic/index.html">FOrayGraphic</a></td> <td>foray-graphic</td> <td>An axslGraphic-compliant module for handling graphics, both bitmapped images and vector drawings.</td> - <td>Universals, axslGraphic.</td> + <td>Universals</td> </tr> <tr> <td><a class="Menu" href="/module/font/index.html">FOrayFont</a></td> <td>foray-font</td> <td>An axslFont-compliant module for handling fonts.</td> - <td>Universals, FOrayPS (to parse Type1 fonts), axslFont.</td> + <td>Universals, FOrayPS (to parse Type1 fonts), FOrayPretty.</td> </tr> <tr> + <td>FOrayHyphen</td> + <td>foray-hyphen</td> + <td>Hyphenates words in various languages.</td> + <td>Universals.</td> + </tr> + <tr> <td>FOrayText</td> <td>foray-text</td> - <td>Classes for handling text-related chores such as line-breaking and - hyphenation.</td> - <td>Universals, axslFont.</td> + <td>Handles line-breaking chores.</td> + <td>Universals.</td> </tr> <tr> <td><a class="Menu" href="/module/pdf/index.html">FOrayPDF</a></td> <td>foray-pdf</td> <td>Classes for building a PDF file from scratch.</td> - <td>Universals, FOrayPS, axslGraphic, axslFont.</td> + <td>Universals, FOrayPS.</td> </tr> <tr> <td>FOrayMIF</td> @@ -109,43 +133,61 @@ <tr> <td><a class="Menu" href="/module/fotree/index.html">FOrayFOTree</a></td> <td>foray-fotree</td> - <td>Classes for parsing an XSL-FO file.</td> - <td>Universals, axslGraphic, axslFont, FOrayText.</td> + <td>Classes for parsing an XSL-FO file and making its contents available.</td> + <td>Universals.</td> </tr> <tr> <td>FOrayAreaTree</td> <td>foray-areatree</td> <td>Classes representing a formatted document.</td> - <td>Universals, axslGraphic, axslFont, FOrayText, FOrayFOTree.</td> + <td>Universals.</td> </tr> <tr> + <td>FOrayOutput</td> + <td>foray-output</td> + <td>Classes that convert an FOTree into an output document. This is useful +for output formats like MIF and RTF that do their own layout.</td> + <td>Universals, FOrayMIF.</td> + </tr> + <tr> <td>FOrayRender</td> <td>foray-render</td> - <td>Classes that convert an AreaTree into an output document.</td> - <td>Universals, axslGraphic, axslFont, FOrayAreaTree, FOrayPS, - FOrayPDF, FOrayMIF.</td> + <td>Classes that convert an AreaTree into an output document. This is useful +for output formats that require layout to be done for them.</td> + <td>Universals, FOrayOutput, FOrayPS.</td> </tr> <tr class="Heading1"> <td colspan="4">Layout Systems</td> </tr> <tr> + <td>FOrayLayout</td> + <td>foray-layout</td> + <td>Abstractions useful for any layout system.</td> + <td>Universals.</td> + </tr> + <tr> <td>FOrayPioneer</td> <td>foray-pioneer</td> <td>The original open-source XSL-FO layout system. It is “eager” and therefore not very sophisticated.</td> - <td>Universals, axslGraphic, axslFont, FOrayText, FOrayFOTree, - FOrayAreaTree.</td> + <td>Universals, FOrayLayout.</td> </tr> <tr class="Heading1"> <td colspan="4">Applications</td> </tr> <tr> + <td><a class="Menu" href="/">FOrayCore</a></td> + <td>foray-core</td> + <td>XSL-FO processing application, using any set of aXSL components.</td> + <td>Universals.</td> + </tr> + <tr> <td><a class="Menu" href="/">FOray</a></td> <td>foray-app</td> - <td>XSL-FO processing application.</td> - <td>Universals, axslGraphic, FOrayGraphic, axslFont, FOrayFont, - FOrayText, FOrayPDF, FOrayFOTree, FOrayAreaTree, FOrayPioneer, - FOrayRenderer.</td> + <td>XSL-FO processing application, using FOray modules.</td> + <td>Universals, FOrayGraphic, FOrayFont, FOrayHyphen, FOrayText, FOrayPDF, +FOrayFOTree, FOrayAreaTree, FOrayLayout, FOrayPioneer, FOrayOutput, +FOrayRenderer, FOrayCore.</td> </tr> </table> @@ -153,7 +195,7 @@ <p>Although each FOray module has its own build script, the preferred way to build FOray modules is to use the main build script, which can intelligently build any subset of FOray that is needed. -See <a href="/app/using/build.html">Building a Subset of FOray</a> for +See <a href="/app/using/build.html#subset">Building a Subset of FOray</a> for details.</p> <!--#include virtual="/00-rsrc/include/leftmenu-end.html" --> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
