[FOray-commit] SF.net SVN: foray: [8259] trunk/foray/doc/web/app/using
Modular XSL-FO Implementation for Java.
Status: Alpha
Brought to you by:
victormote
Menu
▾
▴
[FOray-commit] SF.net SVN: foray: [8259] trunk/foray/doc/web/app/using
|
From: <vic...@us...> - 2006-09-30 20:08:15
|
Revision: 8259
http://svn.sourceforge.net/foray/?rev=8259&view=rev
Author: victormote
Date: 2006-09-30 13:08:08 -0700 (Sat, 30 Sep 2006)
Log Message:
-----------
Update the release notes.
Modified Paths:
--------------
trunk/foray/doc/web/app/using/download.html
trunk/foray/doc/web/app/using/release.html
Modified: trunk/foray/doc/web/app/using/download.html
===================================================================
--- trunk/foray/doc/web/app/using/download.html 2006-09-30 18:29:41 UTC (rev 8258)
+++ trunk/foray/doc/web/app/using/download.html 2006-09-30 20:08:08 UTC (rev 8259)
@@ -17,18 +17,15 @@
<h1>FOray: Downloading the Application</h1>
-<ul>
- <li><a href="#intro">Introduction</a></li>
-</ul>
-
<h2><a name="intro">Introduction</a></h2>
-<p class="Warning">FOray does not currently have a usable version to download.
-We hope to have a beta site available by April 15, 2005. Please
-check the website from time to time for progress reports.</p>
+<p class="Warning">The current release of FOray (0.2) is not a mature product
+and may not be suitable for your needs.
+Please see the <a href="release.htm#0.2">Release Notes</a> for more
+information.</p>
<p>The FOray application can be downloaded through from
-<a rel="external" href="http://sourceforge.net/projects/foray/">FOray’s
+<a rel="external" href="http://sourceforge.net/projects/foray/">FOray's
SourceForge site</a>.
Thank you SourceForge!</p>
Modified: trunk/foray/doc/web/app/using/release.html
===================================================================
--- trunk/foray/doc/web/app/using/release.html 2006-09-30 18:29:41 UTC (rev 8258)
+++ trunk/foray/doc/web/app/using/release.html 2006-09-30 20:08:08 UTC (rev 8259)
@@ -20,6 +20,7 @@
<ul>
<li><a href="#intro">Introduction</a></li>
<li><a href="#unreleased">Unreleased Changes</a></li>
+ <li><a href="#0_2">Release 0.2</a></li>
<li><a href="#0_1">Release 0.1</a></li>
</ul>
@@ -32,7 +33,23 @@
<p>Unreleased changes can be obtained from the root of the source code
repository.</p>
<h3>Unreleased changes of interest to Users</h3>
+<h3>Unreleased changes of interest to Developers</h3>
+<h2><a name="0_2">Release 0.2</a></h2>
+<h3>Release 0.2 changes of interest to Users</h3>
+<p class="warning">FOray 0.2 is primarily for developers and module users.
+Although many parts of FOray work well, and are usable as modules, the
+application as a whole has some general problems that require attention.</p>
+
+<p>Here are the more significant of the known issues:</p>
+<ul>
+ <li>The FO Tree does not parse all expressions properly. Valid FO syntax
+ is sometimes flagged as an error.</li>
+ <li>The Area Tree does not handle tables and lists properly in most cases.
+ Specifically, these items will likely not be placed in the proper place,
+ and may not even be placed in a reasonable place.</li>
+</ul>
+
<h4>General Configuration Changes</h4>
<ul>
<li>The names of several configuration file entries have been changed for
@@ -139,7 +156,7 @@
facilitate making these options available on the command line.</li>
<li>A boolean configuration option <strong>cache-graphics</strong> was
added.
-It defaults to “false�?.
+It defaults to "false"?.
If set to true, graphic objects will be cached and can be reused, resulting in
potential speed improvement.
If set to false, graphic objects are not reused, resulting in potential memory
@@ -160,7 +177,7 @@
file is now respected for CID fonts.</li>
<li>PDF output for CID fonts now includes the ToUnicode CMap. This allows
cut-and-paste, index, search, etc. to work correctly on PDF text for these
-fonts. This fixes FOP’s Bugzilla entry #5335.</li>
+fonts. This fixes FOP's Bugzilla entry #5335.</li>
<li>Italic angle information is now parsed from PFM files.</li>
<li>FontBBox and StemV (StdVW) information is now parsed from PFA and PFB
files.</li>
@@ -220,14 +237,14 @@
applications that built the font metrics files):</p>
<ul>
- <li><strong>font-resource</strong> (was the “-er�? [embed-resource]
+ <li><strong>font-resource</strong> (was the "-er"? [embed-resource]
command-line option).
Font files can be included in fop.jar when building fop. Both font-resource and
font-file can be specified for the same font, but if font-file is specified and
can be opened, it will take precedence over font-resource. Please note that the
companion option -ef already exists in the font configuration file as
<strong>embed-file</strong> (now called <strong>font-file</strong>).</li>
- <li><strong>embed-name</strong> (was the “-fn�? command-line option). If
+ <li><strong>embed-name</strong> (was the "-fn"? command-line option). If
embed-name is
specified, it will be used as the name of the font in the output document, if
the font is embedded in that document. This is sometimes useful when trying to
@@ -236,7 +253,7 @@
<i>not </i>specified, FOray first
attempts to extract and embed the name from the font itself. If that fails, it
uses the configured attribute <strong>name</strong>.</li>
- <li><strong>ttc-name</strong> (was the “-ttcname�? command-line option.
+ <li><strong>ttc-name</strong> (was the "-ttcname"? command-line option.
If you are reading data from a TrueType Collection (.ttc
file) you must specify which font from the collection you will read metrics
from.</li>
@@ -252,7 +269,7 @@
<strong>embed-resource</strong>. Since those attributes have been renamed to
clarify their use,
you must now explicitly state what embedding behavior is desired. Valid options
-are “all�?, “subset�?, and “none�?. The default is “none�?.</li>
+are "all"?, "subset"?, and "none"?. The default is "none"?.</li>
</ul>
<p>In addition, the following changes related to the direct parsing of font files
@@ -263,13 +280,13 @@
configuration file. This is currently not used at all, except as a fallback
name to be embedded in an output file if no other name can be found. Its main
purpose is for reference in writing and parsing the configuration file, but it
-may be used as a “key�? for other configuration elements in the future.</li>
+may be used as a "key"? for other configuration elements in the future.</li>
<li>The former attribute <strong>embed-file</strong> for the element
<strong>font</strong> in the font
configuration file, has been renamed to <strong>font-file</strong>.
This change was made for clarity since, for some font types, the font file
contains both the embedding information and the metrics information.</li>
- <li>Note that the former TTFReader command-line option “-enc�? has no
+ <li>Note that the former TTFReader command-line option "-enc"? has no
analog in the configuration file. The artifical reencoding that this option
enabled is no longer necessary now that CID fonts are properly embedded in the
PDF output (see change below regarding ToUnicode CMap).</li>
@@ -277,9 +294,9 @@
<h4>Other Changes</h4>
<ul>
- <li>Since we have now obtained rights to the internet domain “foray.org�?, the
-package structure of all FOray module classes has been moved from “com.outfitr�?
-to “org.foray�?. The package structure for fop-maint remains unchanged.</li>
+ <li>Since we have now obtained rights to the internet domain "foray.org"?, the
+package structure of all FOray module classes has been moved from "com.outfitr"?
+to "org.foray"?. The package structure for fop-maint remains unchanged.</li>
<li>Starting with Release 0.2, FOray requires a minimum java runtime
environment of 1.4.</li>
<li><em>All</em> properties should now be supported at the parse level,
@@ -288,7 +305,7 @@
note that this does not mean that all properties are used or used properly by
the layout or rendering systems.</li>
<li>The class for running FOray from the command-line has been renamed
-“FOray�?.</li>
+"FOray"?.</li>
<li>The outer-layer application API has changed significantly. This will
not affect command-line users, but will affect anyone running FOray embedded
within another application. Details of the new API can be found at <a
@@ -313,7 +330,14 @@
for more information.</li>
</ul>
-<h3>Unreleased changes of interest to Developers</h3>
+<h3>Release 0.2 changes of interest to Developers</h3>
+
+<h4>Modularity Changes</h4>
+<p>As of Release 0.2, all FOray modules are independent of each other, using
+the aXSL interfaces to achieve pluggability and interoperability.
+With the exception of dependencies on the utility-type modules (Common, Pretty,
+and PS), FOray modules now have no dependencies on other FOray modules.</p>
+
<ul>
<li>The following methods have been added to the FontConsumer interface to
allow the client application to control what combinations of FreeStandingFonts
@@ -335,10 +359,10 @@
and writing tasks concurrently, it should not use this method, as doing
so will corrupt the logical connection between the glyph indices used to
embed the font and those used to write the document contents. Please note that
-FOray’s reference FO processing implementation is currently unable to use this
+FOray's reference FO processing implementation is currently unable to use this
method because of such concurrent processing.</li>
<li>To assist in parsing Type1 fonts, FOray now has the modest beginnings of
-a PostScript interpreter emulation. It is included as part of the new “FOrayPS�?
+a PostScript interpreter emulation. It is included as part of the new "FOrayPS"?
module. We hope to use this for future project such as embedding EPS files in
PDF output.</li>
<li>The filter and encoding classes that were part of the pdf module have
@@ -351,12 +375,9 @@
and, with reasonable care, multiple instances should be manageable. A
getFontServer() method has been added to the FontConsumer interface, as the
FontConsumer must now know which FontServer it is using.</li>
- <li>FOray has been split up into 12 isolated modules, each with its own
-well-defined dependencies. This greatly increases their reusability in other
-applications.</li>
<li>Each of the Font, Graphic, and Text subsystems now has a Server class
associated with it (e.g. GraphicServer). Instances of these servers may be
-passed to FOraySession’s constructor. If not, default instances will be created
+passed to FOraySession's constructor. If not, default instances will be created
by FOraySession. This means that you can enhance your local system by extending
these Server classes. Also, because the Servers live outside of the FOray
application, they can conceivably persist for multiple Sessions.</li>
@@ -377,11 +398,12 @@
</ul>
<h2><a name="0_1">Release 0.1</a></h2>
-<p>Release 0.1 is currently in alpha testing. It can be obtained from the source
+<p>Release 0.1 can be obtained from the source
code repository by using the tag <code>rel_0_1_branch</code>.</p>
<p>Release 0.1 is totally oriented toward modularization of the system, and
toward improvements to the font system.</p>
-<h3>Changes since FOP 0.20.5 of interest to Users</h3>
+
+<h3>Changes from FOP 0.20.5 to FOray 0.1 of interest to Users</h3>
<p>Current work is deliberately focused on architecture, not features. However,
the following improvements have resulted as side-effects of the architectural
changes:</p>
@@ -407,7 +429,7 @@
No other changes have been made to the way fonts are configured.</li>
</ul>
-<h3>Changes since FOP 0.20.5 of interest to Developers</h3>
+<h3>Changes from FOP 0.20.5 to FOray 0.1 of interest to Developers</h3>
<ul>
<li>Font-related classes have been extracted into a separate module.</li>
<li>Graphic and PDF-related classes have also been extracted into separate
@@ -418,13 +440,13 @@
concepts has been clarified greatly (probably needs more work).</li>
<li>Visibility on most Font-related classes has been reduced.</li>
<li>The following methods in the forayFont class called Font (called
-fonts/FontMetrics in FOP’s HEAD) were returning values in millionths of a point:
+fonts/FontMetrics in FOP's HEAD) were returning values in millionths of a point:
getAscender(), getDescender(), getCapHeight(), getXHeight(), and getCharWidth().
Methods using values returned by these methods were typically dividing the
returned values by 1000. The Font methods have been changed to return values in
millipoints (1/1000 of a point), and the corresponding methods in fop-maint have
been changed to <i>not </i>divide by 1000. Although this makes sense, it may be
-confusing to anyone trying to implement the forayFont module into FOP’s
+confusing to anyone trying to implement the forayFont module into FOP's
HEAD.</li>
</ul>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|