CVS: jfor/docs/website/www.jfor.org index.html,NONE,1.1 jars-registered.gif,NONE,1.1 jfor-cocoon-howto.html,NONE,1.1 jfor-license.html,NONE,1.1

Bertrand Delacretaz <[email protected]> Fri, 12 Jul 2002 00:02:10 -0700
Newsgroups gmane.text.xml.jfor.cvs
Message-ID <[email protected]> 
Update of /cvsroot/jfor/jfor/docs/website/www.jfor.org
In directory usw-pr-cvs1:/tmp/cvs-serv29939/docs/website/www.jfor.org

Added Files:
	index.html jars-registered.gif jfor-cocoon-howto.html 
	jfor-license.html 
Log Message:
www.jfor.org files added to repository

--- NEW FILE: index.html ---
<html>

<head>
<title>jfor - Open-Source Java XSL-FO to RTF converter - XML to RTF publishing</title>
<meta name="keywords" content="jfor xsl-fo xsl:fo rtf java xml xsl fop pdf winword word codeconsult Bertrand Delacrétaz www.jfor.org www.codeconsult.org">

<style type="text/css">
BODY,TD,H1,H2,H3,H4
{
        font-family: arial, verdana, sans-serif;
        color: black;
        background: white;
}
.mainTitle
{
        font-size:140%;
        background: rgb(220,220,220);
        padding:2mm;
}
.news
{
        font-size:90%;
}
</style>

</head>

<body bgcolor="white">

<h3 class="mainTitle">
jfor homepage - Open-Source Java XSL-FO to RTF converter
</h3>

<p class="news">
As of V0.7.0, jfor is released under a new ASF-compatible license found 
<a href="jfor-license.html">here</a>
<br>As always, we we would appreciate your feedback at <a href="mailto:[email protected]">[email protected]</a> 
(but please use the <a href="http://sourceforge.net/mail/?group_id=29441">mailing lists</a> for questions about jfor usage). 

<br>The jfor/Cocoon 2 HOWTO is now available at <a href="http://www.jfor.org/jfor-cocoon-howto.html">http://www.jfor.org/jfor-cocoon-howto.html</a>!
</p>
<hr>

<h3>WHAT IS JFOR?</h3>
<b>jfor</b> <a href="#jfor-explain">(*)</a> converts XML documents conforming to the XSL-FO specification to RTF
format, the goal being to use the same XSL-FO documents (as often generated using XSLT transforms) to generate PDF (using
<a href="http://xml.apache.org/fop">FOP</a>
or similar) and RTF (using jfor) documents.

<p>jfor is licensed under the <a target="_top" href="http://www.mozilla.org/MPL/MPL-1.1.html">Mozilla Public License V1.1</a>.</p>

<p>Through an intermediate transformation to XSL-FO, jfor can be used to convert any raw or XML data to RTF format.

<p>jfor comes <b>without any warranty of any kind</b>. Use at your own risk. No guts, no glory.

<p>Although there are PDF-to-RTF converters, the RTF that they generate usually loses
too much structure to be easily editable. jfor uses a simple mapping from XSL-FO to RTF without
any layout computations, which means that the conversion is much faster than with FOP, for example (because jfor has
much less to do - there's no magic here).

<p>jfor attempts to preserve the structure of
the document (a table is a table, a list is a list, etc.), which can cause some loss
of presentation information (distances between elements, etc.).

<p>During development, we usually test jfor with:
<ul>
<li>XSL-FO documents that are compatible with FOP 0.19
<li>Microsoft Word 97 to check the output RTF documents.
</ul>

<p>Both a command-line converter and an adapter for Cocoon 1.8 are provided.
<br>We are working to integrate jfor with Cocoon 2, an alpha version of the RTFSerializer is available.
</p>

<p>jfor also includes a general-purpose RTF generation library (see
package ch.codeconsult.jfor.rtflib.testdocs for usage examples).

<p>More information about XSL-FO, XSL and XML can be found on
<a href="http://www.xml.com">www.xml.com</a>
and <a href="http://www.w3c.org">www.w3c.org</a>, among others.
<br/>
See also Dave Pawson's <a href="http://www.dpawson.co.uk/xsl/sect3/index.html">FO questions</a>.
</p>

<h3><a name="links">LINKS</a></h3>
<ul>
<li>jfor homepage <a href="http://www.jfor.org">http://www.jfor.org</a>
<li><a href="http://lists.sourceforge.net/lists/listinfo/jfor-announce">jfor-announce</a> mailing list: announces new releases
and important events about jfor.
<li><a href="http://lists.sourceforge.net/lists/listinfo/jfor-users">jfor-users</a> mailing list:
jfor usage and support questions (answers too, hopefully).
<li>Before asking please check the <a href="http://sourceforge.net/mail/?group_id=29441">mailing list archives</a>!
<li>SourceForge project <a href="http://sourceforge.net/projects/jfor">http://sourceforge.net/projects/jfor</a>
(source code, binary distribution, discussion forums, etc.)
<br>The SourceForge site usually contains the most up-to-date information about jfor.
<li>RTF specifications:
	<ul>
	<li>
		<a href="http://www.biblioscape.com/rtf15_spec.htm">RTF 1.5 specification</a>. 
		This is the format used by Word 97, and the one we use for jfor whenever possible.
	</li>
	<li>
		<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnrtfspec/html/rtfspec.asp">RTF 1.6 specification</a>. 
		This is the format used by Word 2000. 
		Some RTF features that are not available in RTF 1.5 are implemented against this spec,
		with fallback to 1.5 so that generated documents display as well as possible in RTF 1.5 readers. 
	</li>
	</ul>
</li>
</ul>

<h3>HOW TO COMPILE, RUN, ETC.</h3>
More information will be provided here shortly - in the meantime, see the README V0.1 in the "files" area of the SourceForge project (also included in the source distribution).

<h3>THE TEAM</h3>
<ul>
<li><a href="mailto:[email protected]">Bertrand Delacrétaz</a>: project manager and lead developer (<a href="http://www.codeconsult.ch">www.codeconsult.ch</a>).
<li><a href="mailto:[email protected]">Andreas Putz</a>: major code contributions, including image handling (<a href="http://www.skynamics.com">www.skynamics.com</a>).
<li><a href="mailto:[email protected]">Chris Scott</a>: major code contributions that "make it look good".
<li><a href="mailto:[email protected]">Laurent Caprani</a>: provided interesting insight and analysis of RTF constructs.
<li><a href="mailto:[email protected]">Gianugo Rabellino</a>: Cocoon 2 serializer + build.xml changes for conditional compilation of Cocoon modules .
<li><a href="mailto:[email protected]">Roberto Marra</a>: preliminary work on the RTF library and FOP study.
</ul>

<h3>CONTRIBUTING</h3>
We are currently looking for the following contributions:
<li>Feedback! Please let us know (<a href="mailto:[email protected]">[email protected]</a>) how you are using jfor,
on which platforms, for which types of documents, etc.
<li>XSL-FO test documents that demonstrate jfor features or problems. Small, focused and self-explanatory documents
(like the ones found in the "samples" directory of the jfor source distribution) are most welcome.
<li>Code enhancements or fixes - some XSL-FO files in the "samples" directory show a number of problems that need to
be fixed.

<h3>LIMITATIONS</h3>
As of V0.5, jfor has limited support of FO blocks, inline elements, lists, tables and images.
<br>Using jfor to convert the files found in the "samples" directory of the source distribution should give you a good overview of jfor's current capabilities and limitations.

<br>&nbsp;
<br><a name="jfor-explain"><i>* jfor=<b>J</b>ava xsl-<b>FO</b> to <b>R</b>tf converter</i></a>
<hr>

<table width="100%">
<tr>
        <td valign="top">
        <A href="http://sourceforge.net">
        <IMG src="http://sourceforge.net/sflogo.php?group_id=29441" width="88" height="31"
        border="0" alt="SourceForge Logo"></A>
        hosts the <a href="http://sourceforge.net/projects/jfor/">jfor project</a>.
        </td>
        <td valign="top" align="right">
        <a href="http://www.jars.com"><img src="./jars-registered.gif"></a>
        </td>
</tr>
</table>

</body>

</html>

--- NEW FILE: jars-registered.gif ---
GIF89ag
é`ChùvšAgÂh#í¸†Š
2”Ñm;f”ÔP0±Äf[åeJ#4`P™ôe	S—¬éDB˜1^—åv_ÍòȚ?ødÚ,Œ…ÞA[ɇȚîŧ}ª
t@{1Nà6ÖŒp€6dÚ­¡)©Îµç[òÿ¶(A=µ*ä©PO%vjkQ`>ÐSÈTeR8§t¬Øé±:IxÐY~Zºi©@Á§íˆýzÑ«ÒeAhªëN=Ñ
TëºíÛ*qᦶ,k+8wï¢9À¦o&›êzïmU°éÆ8±ð»ðå0bKÉ
TUfX^<Yšr6qÅmjAFŒ`ìÃ"DuÀc^<qðŽÌÒ¼}µFs•Ë°¾%©¾×DqÏ%6»)nç“Ð&•,ŒÙzq¾LWÀ^¢a
¢¾æ&í
‚’¢ÀÄÁWr–kˆ…*
„™2û	ä(TQJDPÂÁn°ƒJ³tÂNe(¹Ÿú”–4=§;kˆip„¢<+kÁÑFÿ˜~°ˆ[ÁÊYÖr
‰1‡&CâW 8ƒ.„âkÃ%v0#)äJ”t–榉ϑˆišò@v._Œ¡A$H-î‡8"J	“0ú‰W!ˆ)ˆD¡1€gÄca"À1BD‚@„ã›XÁ”J^<}|²Ãç$J•ô`&£Jû1’r ¬žAnÑ,ôâÙÅ^R9MÙQS¾@4>', ì%]©Êõíq–ÔRÀEýÁýë¥wˆ™&¤¥‚H1MÁ3¸,SŽkùf*2)
%I	š`ÁÏ IB’F4¡Œzt£ ý¨HCŠ¤%!ÄE(M©JWÊR9´¥0©LW:!ŠÚ
--- NEW FILE: jfor-cocoon-howto.html ---
<html>
<head>
<title>jfor/Cocoon 2 HOWTO: dynamic generation of RTF documents from XML with Cocoon 2 and jfor</title>
<meta name="keywords" content="jfor xsl-fo xsl:fo cocoon apache rtf java xml xsl fop pdf winword word codeconsult Bertrand Delacrétaz www.jfor.org www.codeconsult.org">

<style type="text/css">
BODY,TD,H1,H2,H3,H4
{
        font-family: arial, verdana, sans-serif;
        color: black;
        background: white;
}
.mainTitle
{
        font-size:140%;
        background: rgb(220,220,220);
        padding:2mm;
}
.subTitle
{
        font-size:140%;
}

.news,.note
{
        font-size:90%;
}
</style>
</head>

<body>
<h3 class="mainTitle">
jfor/Cocoon 2 HOWTO: dynamic generation of RTF documents from XML with Cocoon 2 and jfor
</h3>

<p>
A short technical note about how to activate RTF generation with <a href="http://xml.apache.org/cocoon">Cocoon 2</a>.
<br/>
Written by Bertrand Delacrétaz, <a href="mailto:[email protected]">[email protected]</a> - February 13th, 2002.
</p>

<p class="subTitle">Intro</p>
<ul>
<li>See <a href="http://www.jfor.org">http://www.jfor.org</a> for more info about the jfor library that is used here to generate RTF.</li>
<li>Keep in mind that jfor is still fairly limited in its layout abilities.</li>
<li>This procedure has been tested with Cocoon 2.0.1.</li>
<li>More info on Cocoon can be found at <a href="http://xml.apache.org/cocoon">http://xml.apache.org/cocoon</a></li>
</ul>

<p class="subTitle">How to activate and test dynamic RTF generation with Cocoon</p>
<p>Basically, as jfor cannot currently be distributed with Cocoon due to slight license incompatibilites, you must recompile Cocoon with
the jfor library (jfor.jar) to activate the RTF serializer in Cocoon.</p>
<ol>

<li><b>Download and unpack the Cocoon source code.</b>
<br/>
For V2.0.1 the file to download is called cocoon-2.0.1-src.something (where something is a format like "tar.gz") and
can be found under <a href="http://xml.apache.org/cocoon/dist/">http://xml.apache.org/cocoon/dist/</a>
</li>

<li><b>Make sure you can compile the standard Cocoon distribution</b>
<br/>
You will need a java compiler for this (tested with JDK 1.3.1, see Cocoon web site for more details about compiler requirements).
<br/>
Follow the instructions found in the INSTALL file of the Cocoon distribution to compile it.
<br/>
During compilation, you should see messages saying that "Classes of the optional package JFOR are not available".
This is correct as the standard Cocoon distribution does not include the required jfor JAR file.
</li>

<li><b>Add jfor.jar to the Cocoon source tree</b>
<br/>
Download the latest version of the jfor jar file from the "files" are of jfor's SourceForge site at <a href="http://sourceforge.net/projects/jfor">http://sourceforge.net/projects/jfor</a>
<br/>
Copy jfor-XXX.jar (where XXX is jfor's version number) to the lib/optional subdirectory of your Cocoon source tree (the directory that contains
fop-XXX.jar, for example).
<br/>
Recompile Cocoon as you did before, this time the "Classes of the optional package JFOR are not available" message should not appear.
</li>

<li><b>Install Cocoon</b>
<br/>
Follow Cocoon's INSTALL file instructions.
<br/>
If you already have a tomcat installation (the web server that is often used to run Cocoon), it's just a matter of copying the cocoon.war
file generated during Cocoon compilation to the webapps directory of tomcat and restarting tomcat.
</li>

<li><b>Test Cocoon</b>
<br/>
For a standard tomcat/cocoon installation, http://localhost:8080/cocoon should show the Cocoon demonstration page ("Multimedia Hello World", etc.)
</li>

<li><b>Add the hello.rtf definition to the sitemap.xmap</b>
<br/>
This will activate an RTF version of the Cocoon "hello" demonstration page.
<br/>
In the main sitemap.xmap file or your Cocoon installation (under the tomcat installation directory, in webapps/cocoon):
<br/>
after this element that already exists:
<pre>
&lt;map:match pattern="hello.pdf">
 . . .
&lt;/map:match>
</pre>
<br/>
add this one:
<pre>
&lt;map:match pattern="hello.rtf">
	&lt;map:generate src="docs/samples/hello-page.xml"/>
	&lt;map:transform src="stylesheets/page/simple-page2fo.xsl"/>
	&lt;map:serialize type="fo2rtf"/>
&lt;/map:match>
</pre>
</li>

<li><b>Test the RTF serializer</b>
<br/>
If all goes well, requesting http://localhost:8080/cocoon/hello.rtf should deliver an RTF document saying "Hello, this is my first Cocoon page".
<br/>
If it does, you're in business!
<br/>
If not, your best bet is to look at the Cocoon log files under the WEB-INF/logs directory found under webapps/cocoon under the tomcat installation directory
</li>

<li><b>Where to go next</b>
<br/>
Study the above sitemap entry and the stylesheets/page/simple-page2fo.xsl to see how Cocoon is now able to generate RTF out of the hello-page.xml document.
<br/>
The full range of Cocoon features (access to XML documents over HTTP, XML databases, dynamic generation, etc.) is now available for you to generate RTF documents!
</li>

</ol>

<p class="subTitle">Coda</p>
<p>
Enjoy - and please let us know at <a href="mailto:[email protected]">[email protected]</a>!
<br>
And, if you have a problem with jfor: help us solve it, contributions (code, documentation, etc.) are most welcome!
</p>


</body>
</html>



--- NEW FILE: jfor-license.html ---
<html>

<head>
<title>jfor - Open-Source Java XSL-FO to RTF converter - XML to RTF publishing</title>
<meta name="keywords" content="jfor xsl-fo xsl:fo rtf java xml xsl fop pdf winword word codeconsult Bertrand Delacrétaz www.jfor.org www.codeconsult.org">

<style type="text/css">
BODY,TD,H1,H2,H3,H4
{
        font-family: arial, verdana, sans-serif;
        color: black;
        background: white;
}
.mainTitle
{
        font-size:140%;
        background: rgb(220,220,220);
        padding:2mm;
}
.news
{
        font-size:90%;
}
</style>

</head>

<body bgcolor="white">

<h3 class="mainTitle">
jfor Apache-Style Software License
</h3>

Although 
<a href="index.html">jfor</a> 
was first licensed under the MPL (Mozilla Public License), since V0.7.0 it is released
under the following license, to make it possible to distribute jfor with Apache Software Foundation 
projects.   

<div align="center">
<table cellspacing="2" cellpadding="2" border="1">
<tr>

<td>
<pre>
jfor Apache-Style Software License.


Copyright (c) 2002 by the jfor project. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer. 

2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in
   the documentation and/or other materials provided with the
   distribution.

3. The end-user documentation included with the redistribution,
   if any, must include the following acknowledgment:  
      "This product includes software developed 
        by the jfor project (http://www.jfor.org)."
   Alternately, this acknowledgment may appear in the software itself,
   if and wherever such third-party acknowledgments normally appear.

4. The name "jfor" must not be used to endorse 
   or promote products derived from this software without prior written 
   permission.  For written permission, please contact [email protected].

5. Products derived from this software may not be called "jfor",
   nor may "jfor" appear in their name, without prior written
   permission of [email protected].

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED.  IN NO EVENT SHALL THE JFOR PROJECT OR ITS CONTRIBUTORS BE 
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
====================================================================
</pre>
</td>
</tr>
</table>
</div>

</td>
</tr>
</table>

</body>

</html>



-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Gadgets, caffeine, t-shirts, fun stuff.
http://thinkgeek.com/sf