xml-general-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From je...@apache.org
Subject cvs commit: xml-site/targets/fop/dev conventions.html conventions.pdf rtflib.html rtflib.pdf api-doc.html doc.html extensions.html faq.html fonts.html implement.html index.html index.pdf release.html svg.html testing.html tools.html
Date Mon, 07 Jul 2003 04:45:21 GMT
jefft       2003/07/06 21:45:20

  Modified:    targets/fop compliance.html logocontest.html logocontest.pdf
                        pdfencryption.html pdfencryption.pdf resources.html
                        resources.pdf team.html team.pdf
               targets/fop/design/alt.design FOPropertySets.html
                        FoXMLEvent.html SyncedFoXmlEventsBuffer.html
                        XMLNamespaces.html codedisplay.js
               targets/fop/design/alt.design/properties
                        AbstractPropertyValue.html FOAttributes.html
                        PropNames.html Property.html PropertyConsts.html
                        PropertyParser.html PropertySets.html
                        PropertyTokenizer.html PropertyValue.html
                        PropertyValueList.html ShorthandPropSets.html
                        codedisplay.js
               targets/fop/dev api-doc.html doc.html extensions.html
                        faq.html fonts.html implement.html index.html
                        index.pdf release.html svg.html testing.html
                        tools.html
  Added:       targets/fop/dev conventions.html conventions.pdf rtflib.html
                        rtflib.pdf
  Log:
  Automatic publish at Mon Jul  7 06:45:25 CEST 2003 from http://forrestbot.cocoondev.org.
  
  Revision  Changes    Path
  1.18      +1 -1      xml-site/targets/fop/compliance.html
  
  Index: compliance.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/compliance.html,v
  retrieving revision 1.17
  retrieving revision 1.18
  diff -u -r1.17 -r1.18
  --- compliance.html	30 May 2003 18:37:32 -0000	1.17
  +++ compliance.html	7 Jul 2003 04:45:16 -0000	1.18
  @@ -965,7 +965,7 @@
   <tr>
   <td><a name="#fo-property-font-family">font-family</a></td><td align="center"><a target="http://www.w3.org/TR/xsl" href="http://www.w3.org/TR/xsl/slice7.html#font-family">&sect;7.8.2</a></td><td align="center" class="yes">yes</td><td align="center" class="yes">.</td><td align="center" class="yes">.</td><td align="left">
   <ul>
  -<li>font-family lists are not suppported, use a single font-family name</li>
  +<li>font-family lists are not supported, use a single font-family name</li>
   </ul>
   </td>
   </tr>
  
  
  
  1.12      +10 -10    xml-site/targets/fop/logocontest.html
  
  Index: logocontest.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/logocontest.html,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- logocontest.html	30 May 2003 18:37:36 -0000	1.11
  +++ logocontest.html	7 Jul 2003 04:45:16 -0000	1.12
  @@ -2,7 +2,7 @@
   <html>
   <head>
   <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  -<title>Logo contest</title>
  +<title>Logo Contest</title>
   <link type="text/css" href="skin/page.css" rel="stylesheet">
   </head>
   <body text="#000000" bgcolor="#FFFFFF">
  @@ -297,7 +297,7 @@
   <table class="title" summary="">
   <tr>
   <td valign="middle">
  -<h1>Logo contest</h1>
  +<h1>Logo Contest</h1>
   </td><td nowrap="nowrap" width="80" align="center"><a class="dida" href="logocontest.pdf"><img alt="printer" src="skin/images/printer.gif" border="0"><br>
             print-friendly<br>
             PDF</a></td>
  @@ -315,10 +315,10 @@
   </li>
   </ul>
   		
  -<p>FOP needs new logo and FOP Team decided to hold an open logo contest. We invite all members of 
  +<p>FOP needs a new logo and so we've decided to hold an open logo contest. We invite all members of 
   		the FOP community as well as any other interested parties to participate as contestants or by expressing 
   		your opinion through voting. We have set up <a href="http://vote.sparklit.com/web_poll.spark/714566">Web Poll</a> where you can see
  -		contestant logos and vote.</p>
  +		contestant logos and vote your favorite.</p>
   		
   <a name="N101C6"></a><a name="The+rules"></a>
   <h3>The rules</h3>
  @@ -326,9 +326,9 @@
   <p>The rules are simple:</p>
   <ul>
   				
  -<li>Everyone can participate as contestant</li>
  +<li>Everyone can participate as a contestant</li>
   				
  -<li>Everyone can vote, but only FOP Team picks out the winner</li>
  +<li>Everyone can vote, but only FOP Team will choose the winner</li>
   				
   <li>No reward except for pride</li>
   				
  @@ -346,16 +346,16 @@
   <a name="N101E8"></a><a name="How+to+participate"></a>
   <h3>How to participate</h3>
   <div style="margin-left: 0 ; border: 2px">
  -<p>Submit your image or link to it to <a href="maillist.html#fop-user">fop-user</a> mail list.
  -			 Vote for a logo you like the most at FOP logo contest <a href="http://vote.sparklit.com/web_poll.spark/714566">Web Poll</a>.
  +<p>Submit your image or link to it at the <a href="maillist.html#fop-user">fop-user</a> mail list.
  +			 Vote for the logo you like the most at FOP logo contest <a href="http://vote.sparklit.com/web_poll.spark/714566">Web Poll</a>.
   			</p>
   </div>
   		
   <a name="N101FA"></a><a name="Credits"></a>
   <h3>Credits</h3>
   <div style="margin-left: 0 ; border: 2px">
  -<p>We would like to thank <a href="http://ant.apache.org">Ant</a> and 
  -			<a href="http://jakarta.apache.org/poi/index.html">POI</a> teams for ideas how to make a logo contest.</p>
  +<p>We would like to thank the <a href="http://ant.apache.org">Ant</a> and 
  +			<a href="http://jakarta.apache.org/poi/index.html">POI</a> teams for their ideas on how to make this logo contest.</p>
   </div>
   	
   </div>
  
  
  
  1.4       +44 -44    xml-site/targets/fop/logocontest.pdf
  
  	<<Binary file>>
  
  
  1.13      +104 -7    xml-site/targets/fop/pdfencryption.html
  
  Index: pdfencryption.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/pdfencryption.html,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- pdfencryption.html	30 May 2003 18:37:37 -0000	1.12
  +++ pdfencryption.html	7 Jul 2003 04:45:16 -0000	1.13
  @@ -304,14 +304,17 @@
   </tr>
   </table>
   <p>
  -<font size="-2">by&nbsp;J.Pietschmann</font>
  +<font size="-2">by&nbsp;J.Pietschmann,&nbsp;Jeremias M&auml;rki</font>
   </p>
   <ul class="minitoc">
   <li>
   <a href="#Overview">Overview</a>
   </li>
   <li>
  -<a href="#Usage">Usage</a>
  +<a href="#Usage+%28command+line%29">Usage (command line)</a>
  +</li>
  +<li>
  +<a href="#Usage+%28embedded%29">Usage (embedded)</a>
   </li>
   <li>
   <a href="#Environment">Environment</a>
  @@ -321,7 +324,7 @@
   </li>
   </ul>
       
  -<a name="N101C5"></a><a name="Overview"></a>
  +<a name="N101C9"></a><a name="Overview"></a>
   <h3>Overview</h3>
   <div style="margin-left: 0 ; border: 2px">
   <div class="frame warning">
  @@ -345,8 +348,8 @@
         </p>
   </div>
       
  -<a name="N101D5"></a><a name="Usage"></a>
  -<h3>Usage</h3>
  +<a name="N101D9"></a><a name="Usage+%28command+line%29"></a>
  +<h3>Usage (command line)</h3>
   <div style="margin-left: 0 ; border: 2px">
   <p>
           Encryption is enabled by supplying any of the encryption related
  @@ -377,7 +380,101 @@
         </p>
   </div>
       
  -<a name="N101FD"></a><a name="Environment"></a>
  +<a name="N10201"></a><a name="Usage+%28embedded%29"></a>
  +<h3>Usage (embedded)</h3>
  +<div style="margin-left: 0 ; border: 2px">
  +<p>
  +        When FOP is embedded in another Java application you need to set an 
  +        options map on the renderer. These are the supported options:
  +      </p>
  +<table class="ForrestTable" cellspacing="1" cellpadding="4">
  +        
  +<tr>
  +          
  +<th colspan="1" rowspan="1">Option</th>
  +          <th colspan="1" rowspan="1">Description</th>
  +          <th colspan="1" rowspan="1">Values</th>
  +          <th colspan="1" rowspan="1">Default</th>
  +        
  +</tr>
  +        
  +<tr>
  +          
  +<td colspan="1" rowspan="1">ownerPassword</td>
  +          <td colspan="1" rowspan="1">The owner password</td>
  +          <td colspan="1" rowspan="1">String</td>
  +          <td colspan="1" rowspan="1"></td>
  +        
  +</tr>
  +        
  +<tr>
  +          
  +<td colspan="1" rowspan="1">userPassword</td>
  +          <td colspan="1" rowspan="1">The user password</td>
  +          <td colspan="1" rowspan="1">String</td>
  +          <td colspan="1" rowspan="1"></td>
  +        
  +</tr>
  +        
  +<tr>
  +          
  +<td colspan="1" rowspan="1">allowPrint</td>
  +          <td colspan="1" rowspan="1">Allows/disallows printing of the PDF</td>
  +          <td colspan="1" rowspan="1">"TRUE" or "FALSE"</td>
  +          <td colspan="1" rowspan="1">"TRUE"</td>
  +        
  +</tr>
  +        
  +<tr>
  +          
  +<td colspan="1" rowspan="1">allowCopyContent</td>
  +          <td colspan="1" rowspan="1">Allows/disallows copy/paste of content</td>
  +          <td colspan="1" rowspan="1">"TRUE" or "FALSE"</td>
  +          <td colspan="1" rowspan="1">"TRUE"</td>
  +        
  +</tr>
  +        
  +<tr>
  +          
  +<td colspan="1" rowspan="1">allowEditContent</td>
  +          <td colspan="1" rowspan="1">Allows/disallows editing of content</td>
  +          <td colspan="1" rowspan="1">"TRUE" or "FALSE"</td>
  +          <td colspan="1" rowspan="1">"TRUE"</td>
  +        
  +</tr>
  +        
  +<tr>
  +          
  +<td colspan="1" rowspan="1">allowEditAnnotations</td>
  +          <td colspan="1" rowspan="1">Allows/disallows editing of annotations</td>
  +          <td colspan="1" rowspan="1">"TRUE" or "FALSE"</td>
  +          <td colspan="1" rowspan="1">"TRUE"</td>
  +        
  +</tr>
  +      
  +</table>
  +<div class="frame note">
  +<div class="label">Note</div>
  +<div class="content">
  +        Encryption is enabled as soon as one of these options is set.
  +      </div>
  +</div>
  +<p>
  +        An example to enable PDF encryption in Java code:
  +      </p>
  +<pre class="code">
  +Driver driver = new Driver();
  +driver.setRenderer(Driver.RENDER_PDF);
  +Map rendererOptions = new java.util.HashMap();
  +rendererOptions.put("ownerPassword", "mypassword");
  +rendererOptions.put("allowCopyContent", "FALSE");
  +rendererOptions.put("allowEditContent", "FALSE");
  +rendererOptions.put("allowPrint", "FALSE");
  +driver.getRenderer().setOptions(rendererOptions);
  +driver.setOutputStream(...</pre>
  +</div>
  +    
  +<a name="N102B7"></a><a name="Environment"></a>
   <h3>Environment</h3>
   <div style="margin-left: 0 ; border: 2px">
   <p>
  @@ -406,7 +503,7 @@
         </p>
   </div>
       
  -<a name="N10223"></a><a name="install_crypto"></a>
  +<a name="N102DD"></a><a name="install_crypto"></a>
   <h3>Installing a crypto provider</h3>
   <div style="margin-left: 0 ; border: 2px">
   <p>
  
  
  
  1.6       +241 -163  xml-site/targets/fop/pdfencryption.pdf
  
  	<<Binary file>>
  
  
  1.33      +4 -1      xml-site/targets/fop/resources.html
  
  Index: resources.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/resources.html,v
  retrieving revision 1.32
  retrieving revision 1.33
  diff -u -r1.32 -r1.33
  --- resources.html	30 May 2003 18:37:37 -0000	1.32
  +++ resources.html	7 Jul 2003 04:45:16 -0000	1.33
  @@ -615,7 +615,10 @@
             
   <li>[software] <a target="_top" href="http://www.rtf2fo.com">RTF2FO</a> is a converter from RTF to XSL-FO by Novosoft (commercial).</li>
             
  -<li>[software] <a target="_top" href="http://www.vbxml.com/xpathvisualizer">The XPath Visualizer</a>. Web site says: "This is a full blown Visual XPath Interpreter for the evaluation of any XPath expression and visual presentation of the resulting nodeset or scalar value." (freeware)</li>
  +<li> [software] <a target="_top" href="http://www.vbxml.com/xpathvisualizer">The XPath Visualizer</a>.
  +Web site says: "This is a full blown Visual XPath Interpreter for the evaluation of any XPath expression and visual presentation of the resulting nodeset or scalar value."
  +Requires Internet Explorer 5+.
  +(freeware)</li>
           
   </ul>
   </div>
  
  
  
  1.15      +59 -59    xml-site/targets/fop/resources.pdf
  
  	<<Binary file>>
  
  
  1.3       +20 -8     xml-site/targets/fop/team.html
  
  Index: team.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/team.html,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- team.html	21 Jun 2003 14:47:44 -0000	1.2
  +++ team.html	7 Jul 2003 04:45:16 -0000	1.3
  @@ -348,6 +348,9 @@
           </li>
           
   <li>
  +<a name="gm"></a><a href="mailto:gmazza.at.apache.org">Glen Mazza</a> (GM)</li>
  +        
  +<li>
   <a name="wvm"></a><a href="mailto:vmote.at.apache.org">Victor Mote</a> (WVM) is the founder and manager of <a target="_top" href="http://www.outfitr.com">Enterprise Outfitters</a>, a business software company, and of <a target="_top" href="http://www.portagepub.com">Portage Publications</a>, a republisher of old documents. Both are located in Colorado Springs, Colorado, USA.</li>
           
   <li>
  @@ -365,7 +368,7 @@
   </ul>
   </div>
       
  -<a name="N10221"></a><a name="contribute-active"></a>
  +<a name="N10228"></a><a name="contribute-active"></a>
   <h3>Active Contributors</h3>
   <div style="margin-left: 0 ; border: 2px">
   <ul>
  @@ -386,10 +389,6 @@
             important creation? Jeremy Logan Leeds was born June 18, 2002.</li>
           
   <li>
  -<a href="mailto:glen.mazza.at.eds.com">Glen Mazza</a>
  -</li>
  -        
  -<li>
   <a href="mailto:atagunov.at.mail.cnt.ru">Anton Tagunov</a>
   </li>
           
  @@ -400,13 +399,13 @@
   </ul>
   </div>
       
  -<a name="N1024A"></a><a name="founder"></a>
  +<a name="N1024C"></a><a name="founder"></a>
   <h3>Founder</h3>
   <div style="margin-left: 0 ; border: 2px">
   <p>FOP was originally created and donated to the Apache Software Foundation by <a href="mailto:jtauber.at.jtauber.com">James Tauber</a>. Information about him can be found at <a target="_top" href="http://www.jtauber.com">his website</a>.</p>
   </div>
       
  -<a name="N1025C"></a><a name="commit-former"></a>
  +<a name="N1025E"></a><a name="commit-former"></a>
   <h3>Former Committers</h3>
   <div style="margin-left: 0 ; border: 2px">
   <ul>
  @@ -446,7 +445,7 @@
   </ul>
   </div>
       
  -<a name="N10296"></a><a name="expertise"></a>
  +<a name="N10298"></a><a name="expertise"></a>
   <h3>Areas of Expertise</h3>
   <div style="margin-left: 0 ; border: 2px">
   <table class="ForrestTable" cellspacing="1" cellpadding="4">
  @@ -459,6 +458,7 @@
             <th colspan="1" rowspan="1">KL </th>
             <th colspan="1" rowspan="1">KLL</th>
             <th colspan="1" rowspan="1">JM </th>
  +          <th colspan="1" rowspan="1">GM </th>
             <th colspan="1" rowspan="1">WVM</th>
             <th colspan="1" rowspan="1">JP </th>
             <th colspan="1" rowspan="1">AS </th>
  @@ -479,6 +479,7 @@
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
  +          <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1">X</td>
           
   </tr>
  @@ -496,6 +497,7 @@
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
  +          <td colspan="1" rowspan="1"></td>
           
   </tr>
           
  @@ -511,6 +513,7 @@
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
  +          <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1">X</td>
           
   </tr>
  @@ -524,6 +527,7 @@
             <td colspan="1" rowspan="1">X</td>
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
  +          <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1">X</td>
             <td colspan="1" rowspan="1">X</td>
             <td colspan="1" rowspan="1"></td>
  @@ -544,6 +548,7 @@
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
  +          <td colspan="1" rowspan="1"></td>
           
   </tr>
           
  @@ -560,6 +565,7 @@
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
  +          <td colspan="1" rowspan="1"></td>
           
   </tr>
           
  @@ -576,6 +582,7 @@
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
  +          <td colspan="1" rowspan="1"></td>
           
   </tr>
           
  @@ -592,6 +599,7 @@
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
  +          <td colspan="1" rowspan="1"></td>
           
   </tr>
           
  @@ -608,6 +616,7 @@
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
  +          <td colspan="1" rowspan="1"></td>
           
   </tr>
           
  @@ -624,6 +633,7 @@
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
  +          <td colspan="1" rowspan="1"></td>
           
   </tr>
           
  @@ -640,12 +650,14 @@
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
  +          <td colspan="1" rowspan="1"></td>
           
   </tr>
           
   <tr>
             
   <td colspan="1" rowspan="1">MIF</td>
  +          <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
             <td colspan="1" rowspan="1"></td>
  
  
  
  1.3       +276 -250  xml-site/targets/fop/team.pdf
  
  	<<Binary file>>
  
  
  1.27      +0 -0      xml-site/targets/fop/design/alt.design/FOPropertySets.html
  
  Index: FOPropertySets.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/FOPropertySets.html,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  
  
  
  1.18      +0 -0      xml-site/targets/fop/design/alt.design/FoXMLEvent.html
  
  Index: FoXMLEvent.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/FoXMLEvent.html,v
  retrieving revision 1.17
  retrieving revision 1.18
  diff -u -r1.17 -r1.18
  
  
  
  1.18      +0 -0      xml-site/targets/fop/design/alt.design/SyncedFoXmlEventsBuffer.html
  
  Index: SyncedFoXmlEventsBuffer.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/SyncedFoXmlEventsBuffer.html,v
  retrieving revision 1.17
  retrieving revision 1.18
  diff -u -r1.17 -r1.18
  
  
  
  1.18      +0 -0      xml-site/targets/fop/design/alt.design/XMLNamespaces.html
  
  Index: XMLNamespaces.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/XMLNamespaces.html,v
  retrieving revision 1.17
  retrieving revision 1.18
  diff -u -r1.17 -r1.18
  
  
  
  1.17      +0 -0      xml-site/targets/fop/design/alt.design/codedisplay.js
  
  Index: codedisplay.js
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/codedisplay.js,v
  retrieving revision 1.16
  retrieving revision 1.17
  diff -u -r1.16 -r1.17
  
  
  
  1.27      +0 -0      xml-site/targets/fop/design/alt.design/properties/AbstractPropertyValue.html
  
  Index: AbstractPropertyValue.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/AbstractPropertyValue.html,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  
  
  
  1.27      +0 -0      xml-site/targets/fop/design/alt.design/properties/FOAttributes.html
  
  Index: FOAttributes.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/FOAttributes.html,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  
  
  
  1.27      +0 -0      xml-site/targets/fop/design/alt.design/properties/PropNames.html
  
  Index: PropNames.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/PropNames.html,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  
  
  
  1.27      +0 -0      xml-site/targets/fop/design/alt.design/properties/Property.html
  
  Index: Property.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/Property.html,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  
  
  
  1.27      +0 -0      xml-site/targets/fop/design/alt.design/properties/PropertyConsts.html
  
  Index: PropertyConsts.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/PropertyConsts.html,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  
  
  
  1.27      +0 -0      xml-site/targets/fop/design/alt.design/properties/PropertyParser.html
  
  Index: PropertyParser.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/PropertyParser.html,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  
  
  
  1.27      +0 -0      xml-site/targets/fop/design/alt.design/properties/PropertySets.html
  
  Index: PropertySets.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/PropertySets.html,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  
  
  
  1.27      +0 -0      xml-site/targets/fop/design/alt.design/properties/PropertyTokenizer.html
  
  Index: PropertyTokenizer.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/PropertyTokenizer.html,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  
  
  
  1.27      +0 -0      xml-site/targets/fop/design/alt.design/properties/PropertyValue.html
  
  Index: PropertyValue.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/PropertyValue.html,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  
  
  
  1.27      +0 -0      xml-site/targets/fop/design/alt.design/properties/PropertyValueList.html
  
  Index: PropertyValueList.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/PropertyValueList.html,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  
  
  
  1.27      +0 -0      xml-site/targets/fop/design/alt.design/properties/ShorthandPropSets.html
  
  Index: ShorthandPropSets.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/ShorthandPropSets.html,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  
  
  
  1.17      +0 -0      xml-site/targets/fop/design/alt.design/properties/codedisplay.js
  
  Index: codedisplay.js
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/codedisplay.js,v
  retrieving revision 1.16
  retrieving revision 1.17
  diff -u -r1.16 -r1.17
  
  
  
  1.5       +14 -0     xml-site/targets/fop/dev/api-doc.html
  
  Index: api-doc.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/dev/api-doc.html,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- api-doc.html	21 Jun 2003 14:47:46 -0000	1.4
  +++ api-doc.html	7 Jul 2003 04:45:19 -0000	1.5
  @@ -164,6 +164,10 @@
   <li>
   <a target="_blank" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Fop&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&namedcmd=Fop+all&newqueryname=fop+patch+queue&tofooter=1&order=Reuse+same+sort+as+last+time">Patch queue</a>
   </li>
  +      
  +<li>
  +<a href="conventions.html">Conventions</a>
  +</li>
       
   </ul>
   </li>
  @@ -209,6 +213,16 @@
         
   <li>
   <a target="_blank" href="http://cvs.apache.org/viewcvs.cgi/xml-fop">ViewCVS</a>
  +</li>
  +    
  +</ul>
  +</li>
  +<li>
  +<font color="#CFDCED">SubPackages</font>
  +<ul>
  +      
  +<li>
  +<a href="rtflib.html">RTFlib</a>
   </li>
       
   </ul>
  
  
  
  1.7       +14 -0     xml-site/targets/fop/dev/doc.html
  
  Index: doc.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/dev/doc.html,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- doc.html	21 Jun 2003 14:47:46 -0000	1.6
  +++ doc.html	7 Jul 2003 04:45:19 -0000	1.7
  @@ -164,6 +164,10 @@
   <li>
   <a target="_blank" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Fop&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&namedcmd=Fop+all&newqueryname=fop+patch+queue&tofooter=1&order=Reuse+same+sort+as+last+time">Patch queue</a>
   </li>
  +      
  +<li>
  +<a href="conventions.html">Conventions</a>
  +</li>
       
   </ul>
   </li>
  @@ -209,6 +213,16 @@
         
   <li>
   <a target="_blank" href="http://cvs.apache.org/viewcvs.cgi/xml-fop">ViewCVS</a>
  +</li>
  +    
  +</ul>
  +</li>
  +<li>
  +<font color="#CFDCED">SubPackages</font>
  +<ul>
  +      
  +<li>
  +<a href="rtflib.html">RTFlib</a>
   </li>
       
   </ul>
  
  
  
  1.18      +14 -0     xml-site/targets/fop/dev/extensions.html
  
  Index: extensions.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/dev/extensions.html,v
  retrieving revision 1.17
  retrieving revision 1.18
  diff -u -r1.17 -r1.18
  --- extensions.html	21 Jun 2003 14:47:46 -0000	1.17
  +++ extensions.html	7 Jul 2003 04:45:19 -0000	1.18
  @@ -164,6 +164,10 @@
   <li>
   <a target="_blank" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Fop&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&namedcmd=Fop+all&newqueryname=fop+patch+queue&tofooter=1&order=Reuse+same+sort+as+last+time">Patch queue</a>
   </li>
  +      
  +<li>
  +<a href="conventions.html">Conventions</a>
  +</li>
       
   </ul>
   </li>
  @@ -209,6 +213,16 @@
         
   <li>
   <a target="_blank" href="http://cvs.apache.org/viewcvs.cgi/xml-fop">ViewCVS</a>
  +</li>
  +    
  +</ul>
  +</li>
  +<li>
  +<font color="#CFDCED">SubPackages</font>
  +<ul>
  +      
  +<li>
  +<a href="rtflib.html">RTFlib</a>
   </li>
       
   </ul>
  
  
  
  1.18      +14 -0     xml-site/targets/fop/dev/faq.html
  
  Index: faq.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/dev/faq.html,v
  retrieving revision 1.17
  retrieving revision 1.18
  diff -u -r1.17 -r1.18
  --- faq.html	21 Jun 2003 14:47:46 -0000	1.17
  +++ faq.html	7 Jul 2003 04:45:19 -0000	1.18
  @@ -164,6 +164,10 @@
   <li>
   <a target="_blank" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Fop&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&namedcmd=Fop+all&newqueryname=fop+patch+queue&tofooter=1&order=Reuse+same+sort+as+last+time">Patch queue</a>
   </li>
  +      
  +<li>
  +<a href="conventions.html">Conventions</a>
  +</li>
       
   </ul>
   </li>
  @@ -209,6 +213,16 @@
         
   <li>
   <a target="_blank" href="http://cvs.apache.org/viewcvs.cgi/xml-fop">ViewCVS</a>
  +</li>
  +    
  +</ul>
  +</li>
  +<li>
  +<font color="#CFDCED">SubPackages</font>
  +<ul>
  +      
  +<li>
  +<a href="rtflib.html">RTFlib</a>
   </li>
       
   </ul>
  
  
  
  1.15      +14 -0     xml-site/targets/fop/dev/fonts.html
  
  Index: fonts.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/dev/fonts.html,v
  retrieving revision 1.14
  retrieving revision 1.15
  diff -u -r1.14 -r1.15
  --- fonts.html	21 Jun 2003 14:47:46 -0000	1.14
  +++ fonts.html	7 Jul 2003 04:45:19 -0000	1.15
  @@ -164,6 +164,10 @@
   <li>
   <a target="_blank" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Fop&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&namedcmd=Fop+all&newqueryname=fop+patch+queue&tofooter=1&order=Reuse+same+sort+as+last+time">Patch queue</a>
   </li>
  +      
  +<li>
  +<a href="conventions.html">Conventions</a>
  +</li>
       
   </ul>
   </li>
  @@ -209,6 +213,16 @@
         
   <li>
   <a target="_blank" href="http://cvs.apache.org/viewcvs.cgi/xml-fop">ViewCVS</a>
  +</li>
  +    
  +</ul>
  +</li>
  +<li>
  +<font color="#CFDCED">SubPackages</font>
  +<ul>
  +      
  +<li>
  +<a href="rtflib.html">RTFlib</a>
   </li>
       
   </ul>
  
  
  
  1.8       +14 -0     xml-site/targets/fop/dev/implement.html
  
  Index: implement.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/dev/implement.html,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- implement.html	21 Jun 2003 14:47:46 -0000	1.7
  +++ implement.html	7 Jul 2003 04:45:19 -0000	1.8
  @@ -164,6 +164,10 @@
   <li>
   <a target="_blank" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Fop&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&namedcmd=Fop+all&newqueryname=fop+patch+queue&tofooter=1&order=Reuse+same+sort+as+last+time">Patch queue</a>
   </li>
  +      
  +<li>
  +<a href="conventions.html">Conventions</a>
  +</li>
       
   </ul>
   </li>
  @@ -209,6 +213,16 @@
         
   <li>
   <a target="_blank" href="http://cvs.apache.org/viewcvs.cgi/xml-fop">ViewCVS</a>
  +</li>
  +    
  +</ul>
  +</li>
  +<li>
  +<font color="#CFDCED">SubPackages</font>
  +<ul>
  +      
  +<li>
  +<a href="rtflib.html">RTFlib</a>
   </li>
       
   </ul>
  
  
  
  1.19      +18 -17    xml-site/targets/fop/dev/index.html
  
  Index: index.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/dev/index.html,v
  retrieving revision 1.18
  retrieving revision 1.19
  diff -u -r1.18 -r1.19
  --- index.html	21 Jun 2003 14:47:46 -0000	1.18
  +++ index.html	7 Jul 2003 04:45:19 -0000	1.19
  @@ -164,6 +164,10 @@
   <li>
   <a target="_blank" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Fop&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&namedcmd=Fop+all&newqueryname=fop+patch+queue&tofooter=1&order=Reuse+same+sort+as+last+time">Patch queue</a>
   </li>
  +      
  +<li>
  +<a href="conventions.html">Conventions</a>
  +</li>
       
   </ul>
   </li>
  @@ -213,6 +217,16 @@
       
   </ul>
   </li>
  +<li>
  +<font color="#CFDCED">SubPackages</font>
  +<ul>
  +      
  +<li>
  +<a href="rtflib.html">RTFlib</a>
  +</li>
  +    
  +</ul>
  +</li>
   </ul>
   </div>
   <!--================= end Menu items ==================-->
  @@ -294,9 +308,6 @@
   <li>
   <a href="#patches">Submitting Patches</a>
   </li>
  -<li>
  -<a href="#code-conventions">Coding Conventions</a>
  -</li>
   </ul>
   </li>
   </ul>
  @@ -440,11 +451,13 @@
           </p>
   <ul>
             
  +<li>Review the archives at <a href="http://marc.theaimsgroup.com/?l=fop-cvs&r=1&w=2">Mailing list ARChives</a> (MARC) at the AIMS group (search).</li>
  +          
   <li>Subscribe by sending an email to <a href="mailto:fop-cvs-subscribe.at.xml.apache.org">fop-cvs-subscribe@xml.apache.org</a>.</li>
           
   </ul>
   </div>
  -<a name="N102C7"></a><a name="dev-code"></a>
  +<a name="N102CE"></a><a name="dev-code"></a>
   <h4>Download and Use the Developers' Code Using CVS</h4>
   <div style="margin-left: 0 ; border: 2px">
   <p>Between releases the newest code can be accessed via cvs. To do this you need to install a cvs
  @@ -453,7 +466,7 @@
        An introduction into cvs and the cvs manual can be found in the
        <a href="http://xml.apache.org/library.html">reference library</a>.</p>
   </div>
  -<a name="N102D9"></a><a name="patches"></a>
  +<a name="N102E0"></a><a name="patches"></a>
   <h4>Submitting Patches</h4>
   <div style="margin-left: 0 ; border: 2px">
   <p>If you have useful changes to source code (bugfixes or enhancements), test files, or documentation that you would like to contribute to the project, please do the following:</p>
  @@ -471,18 +484,6 @@
           
   </ul>
   <p>One of the committers will test your patch and consider its implications for the project. They will then either commit it to the repository or explain on the issue why they did not. Depending on the work load and skill-sets of the various committers, it may take some time before a a submitted patch is addressed.</p>
  -</div>
  -<a name="N102FF"></a><a name="code-conventions"></a>
  -<h4>Coding Conventions</h4>
  -<div style="margin-left: 0 ; border: 2px">
  -<p>As mentioned in <a href="http://xml.apache.org/source.html">Apache XML Project Guidelines</a>,
  -  <strong>all Java Language source code in the repository must be written in conformance to the</strong>
  -          <a href="http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html">Code Conventions
  -  for the Java Programming Language</a> as published by Sun. Additionally we agreed on 4
  -  spaces (no tabs) for indenting.</p>
  -<p>If you don't like those conventions, just use your own standards while developing and reformat the source before
  -  committing with a tool like <a href="http://astyle.sourceforge.net/">astyle</a> (Artistic Style).
  -  </p>
   </div>
   </div>
     
  
  
  
  1.13      +281 -414  xml-site/targets/fop/dev/index.pdf
  
  	<<Binary file>>
  
  
  1.2       +14 -0     xml-site/targets/fop/dev/release.html
  
  Index: release.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/dev/release.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- release.html	21 Jun 2003 14:47:46 -0000	1.1
  +++ release.html	7 Jul 2003 04:45:19 -0000	1.2
  @@ -164,6 +164,10 @@
   <li>
   <a target="_blank" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Fop&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&namedcmd=Fop+all&newqueryname=fop+patch+queue&tofooter=1&order=Reuse+same+sort+as+last+time">Patch queue</a>
   </li>
  +      
  +<li>
  +<a href="conventions.html">Conventions</a>
  +</li>
       
   </ul>
   </li>
  @@ -209,6 +213,16 @@
         
   <li>
   <a target="_blank" href="http://cvs.apache.org/viewcvs.cgi/xml-fop">ViewCVS</a>
  +</li>
  +    
  +</ul>
  +</li>
  +<li>
  +<font color="#CFDCED">SubPackages</font>
  +<ul>
  +      
  +<li>
  +<a href="rtflib.html">RTFlib</a>
   </li>
       
   </ul>
  
  
  
  1.18      +14 -0     xml-site/targets/fop/dev/svg.html
  
  Index: svg.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/dev/svg.html,v
  retrieving revision 1.17
  retrieving revision 1.18
  diff -u -r1.17 -r1.18
  --- svg.html	21 Jun 2003 14:47:46 -0000	1.17
  +++ svg.html	7 Jul 2003 04:45:19 -0000	1.18
  @@ -164,6 +164,10 @@
   <li>
   <a target="_blank" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Fop&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&namedcmd=Fop+all&newqueryname=fop+patch+queue&tofooter=1&order=Reuse+same+sort+as+last+time">Patch queue</a>
   </li>
  +      
  +<li>
  +<a href="conventions.html">Conventions</a>
  +</li>
       
   </ul>
   </li>
  @@ -209,6 +213,16 @@
         
   <li>
   <a target="_blank" href="http://cvs.apache.org/viewcvs.cgi/xml-fop">ViewCVS</a>
  +</li>
  +    
  +</ul>
  +</li>
  +<li>
  +<font color="#CFDCED">SubPackages</font>
  +<ul>
  +      
  +<li>
  +<a href="rtflib.html">RTFlib</a>
   </li>
       
   </ul>
  
  
  
  1.8       +14 -0     xml-site/targets/fop/dev/testing.html
  
  Index: testing.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/dev/testing.html,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- testing.html	21 Jun 2003 14:47:46 -0000	1.7
  +++ testing.html	7 Jul 2003 04:45:20 -0000	1.8
  @@ -164,6 +164,10 @@
   <li>
   <a target="_blank" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Fop&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&namedcmd=Fop+all&newqueryname=fop+patch+queue&tofooter=1&order=Reuse+same+sort+as+last+time">Patch queue</a>
   </li>
  +      
  +<li>
  +<a href="conventions.html">Conventions</a>
  +</li>
       
   </ul>
   </li>
  @@ -209,6 +213,16 @@
         
   <li>
   <a target="_blank" href="http://cvs.apache.org/viewcvs.cgi/xml-fop">ViewCVS</a>
  +</li>
  +    
  +</ul>
  +</li>
  +<li>
  +<font color="#CFDCED">SubPackages</font>
  +<ul>
  +      
  +<li>
  +<a href="rtflib.html">RTFlib</a>
   </li>
       
   </ul>
  
  
  
  1.10      +14 -0     xml-site/targets/fop/dev/tools.html
  
  Index: tools.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/fop/dev/tools.html,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- tools.html	21 Jun 2003 14:47:46 -0000	1.9
  +++ tools.html	7 Jul 2003 04:45:20 -0000	1.10
  @@ -164,6 +164,10 @@
   <li>
   <a target="_blank" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Fop&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&namedcmd=Fop+all&newqueryname=fop+patch+queue&tofooter=1&order=Reuse+same+sort+as+last+time">Patch queue</a>
   </li>
  +      
  +<li>
  +<a href="conventions.html">Conventions</a>
  +</li>
       
   </ul>
   </li>
  @@ -209,6 +213,16 @@
         
   <li>
   <a target="_blank" href="http://cvs.apache.org/viewcvs.cgi/xml-fop">ViewCVS</a>
  +</li>
  +    
  +</ul>
  +</li>
  +<li>
  +<font color="#CFDCED">SubPackages</font>
  +<ul>
  +      
  +<li>
  +<a href="rtflib.html">RTFlib</a>
   </li>
       
   </ul>
  
  
  
  1.1                  xml-site/targets/fop/dev/conventions.html
  
  Index: conventions.html
  ===================================================================
  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  <html>
  <head>
  <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  <title>FOP Development: Coding Conventions</title>
  <link type="text/css" href="../skin/page.css" rel="stylesheet">
  </head>
  <body text="#000000" bgcolor="#FFFFFF">
  <!--================= start Navigation Path ==================-->
  <table summary="navigation path" width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <td nowrap="nowrap" valign="middle" bgcolor="#CFDCED" height="20"><img height="1" width="5" alt="" border="0" src="../skin/images/spacer.gif"><!--===== breadcrumb trail (javascript-generated) ====--><font size="2" face="Arial, Helvetica, Sans-serif"><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script></font></td>
  </tr>
  <tr>
  <td bgcolor="#4C6C8F" height="2"><img height="2" width="2" alt="" border="0" src="../skin/images/spacer.gif"></td>
  </tr>
  </table>
  <!--================= end Navigation Path ==================-->
  <!--================= start Banner ==================-->
  <table summary="header with logos" width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <!--================= start Group Logo ==================-->
  <td bgcolor="#294563"><a href="http://xml.apache.org/"><img border="0" class="logoImage" alt="Apache XML" src="../images/group-logo.gif"></a></td>
  <!--================= end Group Logo ==================-->
  <!--================= start Project Logo ==================--><td width="100%" align="center" bgcolor="#294563"><a href="http://xml.apache.org/fop/"><img border="0" class="logoImage" alt="FOP" src="../images/logo.jpg"></a></td>
  <!--================= end Project Logo ==================-->
  <!--================= start Search ==================--><td valign="top" rowspan="2" bgcolor="#294563">
  <form target="_blank" action="http://www.google.com/search" method="get">
  <table summary="search" border="0" cellspacing="0" cellpadding="0" bgcolor="#4C6C8F">
  <tr>
  <td colspan="3"><img height="10" width="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <tr>
  <td><img height="1" width="1" alt="" src="../skin/images/spacer.gif"></td><td nowrap="nowrap"><input value="xml.apache.org" name="sitesearch" type="hidden"><input size="15" name="q" id="query" type="text"><img height="1" width="5" alt="" src="../skin/images/spacer.gif"><input name="Search" value="Search" type="submit">
  <br>
  <font face="Arial, Helvetica, Sans-serif" size="2" color="white">
                        the Apache XML site
                        
                        
                      </font></td><td><img height="1" width="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <tr>
  <td><img alt="" border="0" height="10" width="9" src="../skin/images/search-left.gif"></td><td><img height="1" width="1" alt="" src="../skin/images/spacer.gif"></td><td><img alt="" border="0" height="10" width="9" src="../skin/images/search-right.gif"></td>
  </tr>
  </table>
  </form>
  </td>
  <!--================= start Search ==================--><td bgcolor="#294563"><img height="10" width="10" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <tr>
  <td valign="bottom" bgcolor="#294563" colspan="2">
  <!--================= start Tabs ==================-->
  <div class="tab">
  <table summary="tab bar" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <td width="8"><img alt="" height="8" width="8" src="../skin/images/spacer.gif"></td><td valign="bottom">
  <table summary="non selected tab" style="height: 1.6em" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-left.gif"></td><td valign="middle" bgcolor="#B2C4E0"><a href="../index.html"><font face="Arial, Helvetica, Sans-serif">Home</font></a></td><td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-right.gif"></td>
  </tr>
  </table>
  </td><td width="8"><img alt="" height="8" width="8" src="../skin/images/spacer.gif"></td><td valign="bottom">
  <table summary="selected tab" style="height: 1.7em" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="../skin/images/tabSel-left.gif"></td><td valign="middle" bgcolor="#4C6C8F"><font color="#ffffff" size="2" face="Arial, Helvetica, Sans-serif"><b><a href="index.html"><font color="#000000">Development</font></a></b></font></td><td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="../skin/images/tabSel-right.gif"></td>
  </tr>
  </table>
  </td><td width="8"><img alt="" height="8" width="8" src="../skin/images/spacer.gif"></td><td valign="bottom">
  <table summary="non selected tab" style="height: 1.6em" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-left.gif"></td><td valign="middle" bgcolor="#B2C4E0"><a href="../design/index.html"><font face="Arial, Helvetica, Sans-serif">Design</font></a></td><td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-right.gif"></td>
  </tr>
  </table>
  </td><td width="8"><img alt="" height="8" width="8" src="../skin/images/spacer.gif"></td><td valign="bottom">
  <table summary="non selected tab" style="height: 1.6em" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-left.gif"></td><td valign="middle" bgcolor="#B2C4E0"><a href="../design/alt.design/index.html"><font face="Arial, Helvetica, Sans-serif">Alt Design</font></a></td><td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-right.gif"></td>
  </tr>
  </table>
  </td>
  </tr>
  </table>
  </div>
  <!--================= end Tabs ==================-->
  </td><td bgcolor="#294563"><img alt="" width="1" height="1" src="../skin/images/spacer.gif"></td>
  </tr>
  <tr>
  <td bgcolor="#4C6C8F" colspan="4"><img width="1" height="10" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  </table>
  <!--================= end Banner ==================-->
  <!--================= start Menu, NavBar, Content ==================-->
  <table summary="page content" bgcolor="#ffffff" width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <td valign="top">
  <table summary="menu" border="0" cellspacing="0" cellpadding="0">
  <tr>
  <!--================= start left top NavBar ==================-->
  <td rowspan="3" valign="top">
  <table summary="blue line" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <td bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <tr>
  <td bgcolor="#CFDCED"><font color="#4C6C8F" size="4" face="Arial, Helvetica, Sans-serif">&nbsp;</font></td>
  </tr>
  <tr>
  <td bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  </table>
  </td>
  <!--================= end left top NavBar ==================--><td bgcolor="#294563"><img width="1" height="1" alt="" src="../skin/images/spacer.gif"></td><td valign="bottom" bgcolor="#4C6C8F"><img width="10" height="10" alt="" src="../skin/images/spacer.gif"></td><td nowrap="nowrap" valign="top" bgcolor="#4C6C8F">
  <!--================= start Menu items ==================-->
  <div class="menu">
  <ul>
  <li>
  <font color="#CFDCED">Introduction</font>
  <ul>
        
  <li>
  <a href="index.html">Basics</a>
  </li>
      
  </ul>
  </li>
  <li>
  <font color="#CFDCED">Design</font>
  <ul>
        
  <li>
  <a href="../design/index.html">Resolved</a>
  </li>
        
  <li>
  <a target="_blank" href="http://nagoya.apache.org/wiki/apachewiki.cgi?FOPProjectPages">Unresolved (Wiki)</a>
  </li>
        
  <li>
  <a href="svg.html">SVG</a>
  </li>
        
  <li>
  <a href="fonts.html">Fonts</a>
  </li>
        
  <li>
  <a href="extensions.html">Extensions</a>
  </li>
      
  </ul>
  </li>
  <li>
  <font color="#CFDCED">Develop</font>
  <ul>
        
  <li>
  <a href="api-doc.html">API Doc</a>
  </li>
        
  <li>
  <a href="implement.html">Walk-Thru</a>
  </li>
        
  <li>
  <a target="_blank" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Fop&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&namedcmd=Fop+all&newqueryname=fop+patch+queue&tofooter=1&order=Reuse+same+sort+as+last+time">Patch queue</a>
  </li>
        
  <li>
  <span class="sel"><font color="#ffcc00">Conventions</font></span>
  </li>
      
  </ul>
  </li>
  <li>
  <font color="#CFDCED">Test</font>
  <ul>
        
  <li>
  <a href="testing.html">Testing</a>
  </li>
      
  </ul>
  </li>
  <li>
  <font color="#CFDCED">Deploy</font>
  <ul>
        
  <li>
  <a href="doc.html">Doc Mgmt</a>
  </li>
        
  <li>
  <a href="release.html">Release</a>
  </li>
        
  <li>
  <a target="_blank" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Fop&short_desc=&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&order=bugs.component">Bugs</a>
  </li>
      
  </ul>
  </li>
  <li>
  <font color="#CFDCED">Resources</font>
  <ul>
        
  <li>
  <a href="faq.html">FAQs</a>
  </li>
        
  <li>
  <a href="tools.html">Tools</a>
  </li>
        
  <li>
  <a target="_blank" href="http://cvs.apache.org/viewcvs.cgi/xml-fop">ViewCVS</a>
  </li>
      
  </ul>
  </li>
  <li>
  <font color="#CFDCED">SubPackages</font>
  <ul>
        
  <li>
  <a href="rtflib.html">RTFlib</a>
  </li>
      
  </ul>
  </li>
  </ul>
  </div>
  <!--================= end Menu items ==================-->
  </td><td valign="bottom" bgcolor="#4C6C8F"><img width="10" height="10" alt="" src="../skin/images/spacer.gif"></td><td bgcolor="#294563"><img width="1" height="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <tr>
  <td valign="bottom" align="left" colspan="2" rowspan="2" bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="../skin/images/menu-left.gif"></td><td bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="../skin/images/spacer.gif"></td><td valign="bottom" align="right" colspan="2" rowspan="2" bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="../skin/images/menu-right.gif"></td>
  </tr>
  <tr>
  <td height="1" bgcolor="#294563"><img width="1" height="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  </table>
  </td><td valign="top" width="100%">
  <table summary="content" width="100%" border="0" cellpadding="0" cellspacing="0">
  <!--================= start middle NavBar ==================-->
  <tr>
  <td colspan="4" bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <tr>
  <td align="left" width="10" bgcolor="#CFDCED"><img width="10" height="1" alt="" src="../skin/images/spacer.gif"></td><td align="left" width="50%" bgcolor="#CFDCED"><font color="#4C6C8F" size="3" face="Arial, Helvetica, Sans-serif">
                  &nbsp;
                  
                  </font><img width="10" height="8" alt="" src="../skin/images/spacer.gif"></td><td align="right" width="50%" bgcolor="#CFDCED"><font color="#4C6C8F" size="3" face="Arial, Helvetica, Sans-serif">
                  &nbsp;
                  
                  </font><img width="10" height="8" alt="" src="../skin/images/spacer.gif"></td><td width="10" bgcolor="#CFDCED"><img width="10" height="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <tr>
  <td colspan="4" bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <!--================= end middle NavBar ==================-->
  <!--================= start Content==================-->
  <tr>
  <td align="left" width="10"><img width="10" height="1" alt="" src="../skin/images/spacer.gif"></td><td align="left" width="100%">
  <div class="content">
  <table class="title" summary="">
  <tr>
  <td valign="middle">
  <h1>FOP Development: Coding Conventions</h1>
  </td><td nowrap="nowrap" width="80" align="center"><a class="dida" href="conventions.pdf"><img alt="printer" src="../skin/images/printer.gif" border="0"><br>
            print-friendly<br>
            PDF</a></td>
  </tr>
  </table>
  <ul class="minitoc">
  <li>
  <a href="#java">Java</a>
  <ul class="minitoc">
  <li>
  <a href="#java-style">Java Style</a>
  </li>
  <li>
  <a href="#java-checkstyle">Checkstyle</a>
  </li>
  <li>
  <a href="#java-best-practices">Java Best Practices</a>
  </li>
  </ul>
  </li>
  </ul>
      
  <a name="N101BE"></a><a name="java"></a>
  <h3>Java</h3>
  <div style="margin-left: 0 ; border: 2px">
  <a name="N101C4"></a><a name="java-style"></a>
  <h4>Java Style</h4>
  <div style="margin-left: 0 ; border: 2px">
  <p>In order to facilitate the human reading of FOP source code, the FOP developers have agreed on a set of coding conventions.
  The basis of these coding conventions is documented in the <a href="http://xml.apache.org/source.html">Apache XML Project Guidelines</a>, which requires that <strong>all Java Language source code in the repository must be written in conformance to Sun's</strong> <a href="http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html">Code Conventions for the Java Programming Language</a>.
  In addition, the FOP developers have agreed to other conventions, which are summarized in the following table:</p>
  <table class="ForrestTable" cellspacing="1" cellpadding="4">
            
  <tr>
              
  <th colspan="1" rowspan="1">Convention</th>
              <th colspan="1" rowspan="1">Rationale</th>
              <th colspan="1" rowspan="1">Enforced By</th>
            
  </tr>
            
  <tr>
              
  <td colspan="1" rowspan="1">Every Java source file starts with the Apache licence header.</td>
              <td colspan="1" rowspan="1">Required by Apache.</td>
              <td colspan="1" rowspan="1">checkstyle</td>
            
  </tr>
            
  <tr>
              
  <td colspan="1" rowspan="1">No tabs in content</td>
              <td colspan="1" rowspan="1">Programmers should not have to adjust the tab settings in their editor to be able to read the source code.</td>
              <td colspan="1" rowspan="1">checkstyle</td>
            
  </tr>
            
  <tr>
              
  <td colspan="1" rowspan="1">Indentation of 4 spaces per level</td>
              <td colspan="1" rowspan="1">Maximize readability.</td>
              <td colspan="1" rowspan="1">Not enforced</td>
            
  </tr>
            
  <tr>
              
  <td colspan="1" rowspan="1">Comments must be in English</td>
              <td colspan="1" rowspan="1">To avoid the need for everyone to learn all languages, English has become the standard language for many technology projects, and is the only human language that all FOP developers are expected to know.</td>
              <td colspan="1" rowspan="1">Not enforced</td>
            
  </tr>
            
  <tr>
              
  <td colspan="1" rowspan="1">Fully qualify all import statements (no "import java.util.*")</td>
              <td colspan="1" rowspan="1">Clarity</td>
              <td colspan="1" rowspan="1">checkstyle</td>
            
  </tr>
            
  <tr>
              
  <td colspan="1" rowspan="1">No underscores in variable names except for static finals.</td>
              <td colspan="1" rowspan="1">Upper/lower case distinctions can be made in all other variable names, eliminating the need for artificial word boundaries.</td>
              <td colspan="1" rowspan="1">checkstyle</td>
            
  </tr>
            
  <tr>
              
  <td colspan="1" rowspan="1">Opening brace for a block should be on the same line as its control statement (if, while, etc.).</td>
              <td colspan="1" rowspan="1">Standardization, general preference.</td>
              <td colspan="1" rowspan="1">checkstyle</td>
            
  </tr>
          
  </table>
  <p>For developers that dislike these conventions, one workaround is to develop using their own style, then use a formatting tool like <a href="http://astyle.sourceforge.net/">astyle</a> (Artistic Style) before committing.</p>
  </div>
  <a name="N10273"></a><a name="java-checkstyle"></a>
  <h4>Checkstyle</h4>
  <div style="margin-left: 0 ; border: 2px">
  <p>The java syntax checker "<a target="_top" href="http://checkstyle.sourceforge.net">Checkstyle</a>" is used to enforce many of the FOP coding standards.
  The standards enforced through Checkstyle are documented in its configuration file (xml-fop/checkstyle.cfg).
  The conventions defined in the configuration file are an integral part of FOP's coding conventions, and should not be changed without common consent.
  In other words, the configuration file contains additional conventions that are not documented on this page, but are generally accepted as good style within the java community (i.e. they are the default behavior of checkstyle, which the FOP developers have decided to adopt <em>de facto</em>).
  Any apparent contradiction between the configuration file and this document should be raised on the fop-dev mailing list so that it can be clarified.</p>
  <p>To use the "checkstyle" target in FOP's build process, download the source from the <a target="_top" href="http://checkstyle.sourceforge.net">Checkstyle web site</a>, place checkstyle-all-*.jar in the lib directory and call "build checkstyle". Output (in the build directory) includes checkstyle_report.txt and checkstyle_report.xml. If you copy the file contrib/checkstyle-noframes.xsl from Checkstyle into FOP's root directory, you will also get an HTML report.</p>
  <p>Checkstyle is probably most useful when integrated into your IDE. See the Checkstyle web site for more information about IDE plugins.</p>
  </div>
  <a name="N1028E"></a><a name="java-best-practices"></a>
  <h4>Java Best Practices</h4>
  <div style="margin-left: 0 ; border: 2px">
  <p>The following general principles are a distillation of best practice expectations on the FOP project.</p>
  <ul>
            
  <li>Apply common sense when coding. When coding keep in mind that others will read your code and have to understand it.</li>
            
  <li>Readability comes before performance, at least initially.</li>
            
  <li>If you can refactor some code to make it more understandable, please do so.</li>
            
  <li>Properly document code, especially where it's important.</li>
            
  <li>Use interfaces instead of implementations where possible.
  This favors a clearer design and makes switching between implementations easier (Examples: List instead of ArrayList/Vector, Map instead of HashMap/Hashtable).</li>
  
  
            
  <li>Avoid using exceptions for flow control.</li>
            
  <li>Try to catch exceptions as much as possible and rethrow higher level exceptions (meaning hiding the low level detailed and putting a message that is more related to the function of your code).</li> 
            
  <li>It is important not to lose the stack trace which contains important information.
  Use chained exception for that. Avalon Framework provides [CascadingException] (and similar) for this.
  Exception class names and stack traces must be treated like gold.
  Do whatever is required so that this information is not lost.
  Printing error messages to System.err or System.out is useless in a server-side environment where this info is usually lost.</li>
            
  <li>Always log the exception at the higher level (i.e. where it is handled and not rethrown).</li> 
            
  <li>Try to avoid catching Throwable or Exception and catch specific exceptions instead.</li>
          
  </ul>
  </div>
  </div>
    
  </div>
  </td><td width="10"><img width="10" height="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <!--================= end Content==================-->
  </table>
  </td>
  </tr>
  </table>
  <!--================= end Menu, NavBar, Content ==================-->
  <!--================= start Footer ==================-->
  <table summary="footer" cellspacing="0" cellpadding="0" width="100%" border="0">
  <tr>
  <td colspan="2" height="1" bgcolor="#4C6C8F"><img height="1" width="1" alt="" src="../skin/images/spacer.gif"><a href="../skin/images/label.gif"></a><a href="../skin/images/page.gif"></a><a href="../skin/images/chapter.gif"></a><a href="../skin/images/chapter_open.gif"></a><a href="../skin/images/current.gif"></a><a href="..//favicon.ico"></a></td>
  </tr>
  <tr>
  <td colspan="2" bgcolor="#CFDCED" class="copyright" align="center"><font size="2" face="Arial, Helvetica, Sans-Serif">Copyright &copy;
            1999-2003&nbsp;The Apache Software Foundation. All rights reserved.<script type="text/javascript" language="JavaScript"><!--
                document.write(" - "+"Last Published: " + document.lastModified);
              //  --></script></font></td>
  </tr>
  <tr>
  <td colspan="2" align="left" bgcolor="#CFDCED" class="logos"></td>
  </tr>
  </table>
  <!--================= end Footer ==================-->
  </body>
  </html>
  
  
  
  1.1                  xml-site/targets/fop/dev/conventions.pdf
  
  	<<Binary file>>
  
  
  1.1                  xml-site/targets/fop/dev/rtflib.html
  
  Index: rtflib.html
  ===================================================================
  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  <html>
  <head>
  <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  <title>FOP Development: RTFLib (jfor)</title>
  <link type="text/css" href="../skin/page.css" rel="stylesheet">
  </head>
  <body text="#000000" bgcolor="#FFFFFF">
  <!--================= start Navigation Path ==================-->
  <table summary="navigation path" width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <td nowrap="nowrap" valign="middle" bgcolor="#CFDCED" height="20"><img height="1" width="5" alt="" border="0" src="../skin/images/spacer.gif"><!--===== breadcrumb trail (javascript-generated) ====--><font size="2" face="Arial, Helvetica, Sans-serif"><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script></font></td>
  </tr>
  <tr>
  <td bgcolor="#4C6C8F" height="2"><img height="2" width="2" alt="" border="0" src="../skin/images/spacer.gif"></td>
  </tr>
  </table>
  <!--================= end Navigation Path ==================-->
  <!--================= start Banner ==================-->
  <table summary="header with logos" width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <!--================= start Group Logo ==================-->
  <td bgcolor="#294563"><a href="http://xml.apache.org/"><img border="0" class="logoImage" alt="Apache XML" src="../images/group-logo.gif"></a></td>
  <!--================= end Group Logo ==================-->
  <!--================= start Project Logo ==================--><td width="100%" align="center" bgcolor="#294563"><a href="http://xml.apache.org/fop/"><img border="0" class="logoImage" alt="FOP" src="../images/logo.jpg"></a></td>
  <!--================= end Project Logo ==================-->
  <!--================= start Search ==================--><td valign="top" rowspan="2" bgcolor="#294563">
  <form target="_blank" action="http://www.google.com/search" method="get">
  <table summary="search" border="0" cellspacing="0" cellpadding="0" bgcolor="#4C6C8F">
  <tr>
  <td colspan="3"><img height="10" width="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <tr>
  <td><img height="1" width="1" alt="" src="../skin/images/spacer.gif"></td><td nowrap="nowrap"><input value="xml.apache.org" name="sitesearch" type="hidden"><input size="15" name="q" id="query" type="text"><img height="1" width="5" alt="" src="../skin/images/spacer.gif"><input name="Search" value="Search" type="submit">
  <br>
  <font face="Arial, Helvetica, Sans-serif" size="2" color="white">
                        the Apache XML site
                        
                        
                      </font></td><td><img height="1" width="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <tr>
  <td><img alt="" border="0" height="10" width="9" src="../skin/images/search-left.gif"></td><td><img height="1" width="1" alt="" src="../skin/images/spacer.gif"></td><td><img alt="" border="0" height="10" width="9" src="../skin/images/search-right.gif"></td>
  </tr>
  </table>
  </form>
  </td>
  <!--================= start Search ==================--><td bgcolor="#294563"><img height="10" width="10" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <tr>
  <td valign="bottom" bgcolor="#294563" colspan="2">
  <!--================= start Tabs ==================-->
  <div class="tab">
  <table summary="tab bar" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <td width="8"><img alt="" height="8" width="8" src="../skin/images/spacer.gif"></td><td valign="bottom">
  <table summary="non selected tab" style="height: 1.6em" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-left.gif"></td><td valign="middle" bgcolor="#B2C4E0"><a href="../index.html"><font face="Arial, Helvetica, Sans-serif">Home</font></a></td><td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-right.gif"></td>
  </tr>
  </table>
  </td><td width="8"><img alt="" height="8" width="8" src="../skin/images/spacer.gif"></td><td valign="bottom">
  <table summary="selected tab" style="height: 1.7em" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="../skin/images/tabSel-left.gif"></td><td valign="middle" bgcolor="#4C6C8F"><font color="#ffffff" size="2" face="Arial, Helvetica, Sans-serif"><b><a href="index.html"><font color="#000000">Development</font></a></b></font></td><td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="../skin/images/tabSel-right.gif"></td>
  </tr>
  </table>
  </td><td width="8"><img alt="" height="8" width="8" src="../skin/images/spacer.gif"></td><td valign="bottom">
  <table summary="non selected tab" style="height: 1.6em" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-left.gif"></td><td valign="middle" bgcolor="#B2C4E0"><a href="../design/index.html"><font face="Arial, Helvetica, Sans-serif">Design</font></a></td><td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-right.gif"></td>
  </tr>
  </table>
  </td><td width="8"><img alt="" height="8" width="8" src="../skin/images/spacer.gif"></td><td valign="bottom">
  <table summary="non selected tab" style="height: 1.6em" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-left.gif"></td><td valign="middle" bgcolor="#B2C4E0"><a href="../design/alt.design/index.html"><font face="Arial, Helvetica, Sans-serif">Alt Design</font></a></td><td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-right.gif"></td>
  </tr>
  </table>
  </td>
  </tr>
  </table>
  </div>
  <!--================= end Tabs ==================-->
  </td><td bgcolor="#294563"><img alt="" width="1" height="1" src="../skin/images/spacer.gif"></td>
  </tr>
  <tr>
  <td bgcolor="#4C6C8F" colspan="4"><img width="1" height="10" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  </table>
  <!--================= end Banner ==================-->
  <!--================= start Menu, NavBar, Content ==================-->
  <table summary="page content" bgcolor="#ffffff" width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <td valign="top">
  <table summary="menu" border="0" cellspacing="0" cellpadding="0">
  <tr>
  <!--================= start left top NavBar ==================-->
  <td rowspan="3" valign="top">
  <table summary="blue line" border="0" cellpadding="0" cellspacing="0">
  <tr>
  <td bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <tr>
  <td bgcolor="#CFDCED"><font color="#4C6C8F" size="4" face="Arial, Helvetica, Sans-serif">&nbsp;</font></td>
  </tr>
  <tr>
  <td bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  </table>
  </td>
  <!--================= end left top NavBar ==================--><td bgcolor="#294563"><img width="1" height="1" alt="" src="../skin/images/spacer.gif"></td><td valign="bottom" bgcolor="#4C6C8F"><img width="10" height="10" alt="" src="../skin/images/spacer.gif"></td><td nowrap="nowrap" valign="top" bgcolor="#4C6C8F">
  <!--================= start Menu items ==================-->
  <div class="menu">
  <ul>
  <li>
  <font color="#CFDCED">Introduction</font>
  <ul>
        
  <li>
  <a href="index.html">Basics</a>
  </li>
      
  </ul>
  </li>
  <li>
  <font color="#CFDCED">Design</font>
  <ul>
        
  <li>
  <a href="../design/index.html">Resolved</a>
  </li>
        
  <li>
  <a target="_blank" href="http://nagoya.apache.org/wiki/apachewiki.cgi?FOPProjectPages">Unresolved (Wiki)</a>
  </li>
        
  <li>
  <a href="svg.html">SVG</a>
  </li>
        
  <li>
  <a href="fonts.html">Fonts</a>
  </li>
        
  <li>
  <a href="extensions.html">Extensions</a>
  </li>
      
  </ul>
  </li>
  <li>
  <font color="#CFDCED">Develop</font>
  <ul>
        
  <li>
  <a href="api-doc.html">API Doc</a>
  </li>
        
  <li>
  <a href="implement.html">Walk-Thru</a>
  </li>
        
  <li>
  <a target="_blank" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Fop&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&namedcmd=Fop+all&newqueryname=fop+patch+queue&tofooter=1&order=Reuse+same+sort+as+last+time">Patch queue</a>
  </li>
        
  <li>
  <a href="conventions.html">Conventions</a>
  </li>
      
  </ul>
  </li>
  <li>
  <font color="#CFDCED">Test</font>
  <ul>
        
  <li>
  <a href="testing.html">Testing</a>
  </li>
      
  </ul>
  </li>
  <li>
  <font color="#CFDCED">Deploy</font>
  <ul>
        
  <li>
  <a href="doc.html">Doc Mgmt</a>
  </li>
        
  <li>
  <a href="release.html">Release</a>
  </li>
        
  <li>
  <a target="_blank" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Fop&short_desc=&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&order=bugs.component">Bugs</a>
  </li>
      
  </ul>
  </li>
  <li>
  <font color="#CFDCED">Resources</font>
  <ul>
        
  <li>
  <a href="faq.html">FAQs</a>
  </li>
        
  <li>
  <a href="tools.html">Tools</a>
  </li>
        
  <li>
  <a target="_blank" href="http://cvs.apache.org/viewcvs.cgi/xml-fop">ViewCVS</a>
  </li>
      
  </ul>
  </li>
  <li>
  <font color="#CFDCED">SubPackages</font>
  <ul>
        
  <li>
  <span class="sel"><font color="#ffcc00">RTFlib</font></span>
  </li>
      
  </ul>
  </li>
  </ul>
  </div>
  <!--================= end Menu items ==================-->
  </td><td valign="bottom" bgcolor="#4C6C8F"><img width="10" height="10" alt="" src="../skin/images/spacer.gif"></td><td bgcolor="#294563"><img width="1" height="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <tr>
  <td valign="bottom" align="left" colspan="2" rowspan="2" bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="../skin/images/menu-left.gif"></td><td bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="../skin/images/spacer.gif"></td><td valign="bottom" align="right" colspan="2" rowspan="2" bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="../skin/images/menu-right.gif"></td>
  </tr>
  <tr>
  <td height="1" bgcolor="#294563"><img width="1" height="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  </table>
  </td><td valign="top" width="100%">
  <table summary="content" width="100%" border="0" cellpadding="0" cellspacing="0">
  <!--================= start middle NavBar ==================-->
  <tr>
  <td colspan="4" bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <tr>
  <td align="left" width="10" bgcolor="#CFDCED"><img width="10" height="1" alt="" src="../skin/images/spacer.gif"></td><td align="left" width="50%" bgcolor="#CFDCED"><font color="#4C6C8F" size="3" face="Arial, Helvetica, Sans-serif">
                  &nbsp;
                  
                  </font><img width="10" height="8" alt="" src="../skin/images/spacer.gif"></td><td align="right" width="50%" bgcolor="#CFDCED"><font color="#4C6C8F" size="3" face="Arial, Helvetica, Sans-serif">
                  &nbsp;
                  
                  </font><img width="10" height="8" alt="" src="../skin/images/spacer.gif"></td><td width="10" bgcolor="#CFDCED"><img width="10" height="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <tr>
  <td colspan="4" bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <!--================= end middle NavBar ==================-->
  <!--================= start Content==================-->
  <tr>
  <td align="left" width="10"><img width="10" height="1" alt="" src="../skin/images/spacer.gif"></td><td align="left" width="100%">
  <div class="content">
  <table class="title" summary="">
  <tr>
  <td valign="middle">
  <h1>FOP Development: RTFLib (jfor)</h1>
  </td><td nowrap="nowrap" width="80" align="center"><a class="dida" href="rtflib.pdf"><img alt="printer" src="../skin/images/printer.gif" border="0"><br>
            print-friendly<br>
            PDF</a></td>
  </tr>
  </table>
  <ul class="minitoc">
  <li>
  <a href="#general">General Information</a>
  <ul class="minitoc">
  <li>
  <a href="#intro">Introduction</a>
  </li>
  <li>
  <a href="#history">History</a>
  </li>
  <li>
  <a href="#status">Status</a>
  </li>
  </ul>
  </li>
  <li>
  <a href="#userdoc">User Documentation</a>
  <ul class="minitoc">
  <li>
  <a href="#userdoc-overview">Overview</a>
  </li>
  <li>
  <a href="#userdoc-structure">Document Structure</a>
  </li>
  <li>
  <a href="#userdoc-attributes">Attributes</a>
  </li>
  </ul>
  </li>
  </ul>
      
  <a name="N101BE"></a><a name="general"></a>
  <h3>General Information</h3>
  <div style="margin-left: 0 ; border: 2px">
  <a name="N101C4"></a><a name="intro"></a>
  <h4>Introduction</h4>
  <div style="margin-left: 0 ; border: 2px">
  <p>The RTFLib package is an open-source, <em>independent</em> package suitable for writing RTF files in a java environment.
  By <em>independent</em> we mean:</p>
  <ul>
            
  <li>Although it is used by FOP to generate FOP's RTF output, it is not dependent on FOP for any of its functionality.</li>
            
  <li>It does not require FOP as a front-end, nor does it even require XSL-FO for input.
  It can be used anywhere RTF output is required and java is available.</li>
          
  </ul>
  <p>The FOP development team intends to keep the RTFLib package independent so that it can be used for other purposes.</p>
  </div>
  <a name="N101E0"></a><a name="history"></a>
  <h4>History</h4>
  <div style="margin-left: 0 ; border: 2px">
  <p>RTFLib was originally developed by <a href="mailto:bdelacretaz.at.apache.org">Bertrand Delacr&eacute;taz</a> and the <a href="http://www.jfor.org">jfor</a> team. jfor was written under an Apache-style license, and the jfor team contributed the code to the Apache Software Foundation in June, 2003. RTFLib is a subset of the original jfor project, which also includes an XSL-FO parsing mechanism for a complete XSL-FO to RTF solution.</p>
  </div>
  <a name="N101F2"></a><a name="status"></a>
  <h4>Status</h4>
  <div style="margin-left: 0 ; border: 2px">
  <p>Although FOP's implementation of the RTFLib package is very incomplete, the RTFLib package itself is relatively mature. RTFLib is only available in the trunk <a href="index.html#lines">line of FOP development</a>.</p>
  <div class="frame warning">
  <div class="label">Warning</div>
  <div class="content">This documentation is a work in progress. If you see errors or omissions, please report them to the <a href="index.html#mail-fop-dev">fop-dev mailing list</a>.</div>
  </div>
  </div>
  </div>
      
  <a name="N10208"></a><a name="userdoc"></a>
  <h3>User Documentation</h3>
  <div style="margin-left: 0 ; border: 2px">
  <a name="N1020E"></a><a name="userdoc-overview"></a>
  <h4>Overview</h4>
  <div style="margin-left: 0 ; border: 2px">
  <p>Perhaps the easiest way to see how to use RTFLib is by looking at an example. A set of test documents is part of the package, and can be <a href="http://cvs.apache.org/viewcvs.cgi/xml-fop/src/java/org/apache/fop/rtf/rtflib/testdocs/">viewed online</a>.
  A quick look at the Abstract <a href="http://cvs.apache.org/viewcvs.cgi/xml-fop/src/java/org/apache/fop/rtf/rtflib/testdocs/TestDocument.java?rev=HEAD&content-type=text/vnd.viewcvs-markup">TestDocument</a> class, and one of the Concrete subclasses, <a href="http://cvs.apache.org/viewcvs.cgi/xml-fop/src/java/org/apache/fop/rtf/rtflib/testdocs/SimpleDocument.java?rev=HEAD&content-type=text/vnd.viewcvs-markup">SimpleDocument</a> will provide the basics of how to use the package.</p>
  <p>There are two basic concepts you will need to understand to use RTFLib:</p>
  <ul>
            
  <li>Documents are created by filling bigger containers with successively smaller containers, and eventually with content.</li>
            
  <li>Attributes may be set for each container or content as it is created</li>
          
  </ul>
  <p>RTFLib handles the process of converting to and writing the RTF content as the document is created. All you need to do is flush the document at the end to make sure that the last pieces get written.</p>
  </div>
  <a name="N10233"></a><a name="userdoc-structure"></a>
  <h4>Document Structure</h4>
  <div style="margin-left: 0 ; border: 2px">
  <div class="frame warning">
  <div class="label">Warning</div>
  <div class="content">This section is very incomplete.</div>
  </div>
  <p>The following table summarizes the various containers that can be created:</p>
  <table class="ForrestTable" cellspacing="1" cellpadding="4">
            
  <tr>
              
  <th colspan="1" rowspan="1">Name</th>
              <th colspan="1" rowspan="1">Class.Method where created</th>
              <th colspan="1" rowspan="1">Attribute Set(s)</th>
              <th colspan="1" rowspan="1">Valid children</th>
            
  </tr>
            
  <tr>
              
  <td colspan="1" rowspan="1">Document Area</td>
              <td colspan="1" rowspan="1">RtfFile.startDocumentArea()</td>
              <td colspan="1" rowspan="1">.</td>
              <td colspan="1" rowspan="1">Section</td>
            
  </tr>
            
  <tr>
              
  <td colspan="1" rowspan="1">Section</td>
              <td colspan="1" rowspan="1">RtfDocumentArea.newSection()</td>
              <td colspan="1" rowspan="1">.</td>
              <td colspan="1" rowspan="1">Paragraph</td>
            
  </tr>
            
  <tr>
              
  <td colspan="1" rowspan="1">Paragraph</td>
              <td colspan="1" rowspan="1">RtfSection.newParagraph()</td>
              <td colspan="1" rowspan="1">.</td>
              <td colspan="1" rowspan="1">Text</td>
            
  </tr>
            
  <tr>
              
  <td colspan="1" rowspan="1">Text</td>
              <td colspan="1" rowspan="1">RtfParagraph.newText()</td>
              <td colspan="1" rowspan="1">.</td>
              <td colspan="1" rowspan="1">N/A</td>
            
  </tr>
          
  </table>
  </div>
  <a name="N102B6"></a><a name="userdoc-attributes"></a>
  <h4>Attributes</h4>
  <div style="margin-left: 0 ; border: 2px">
  <div class="frame warning">
  <div class="label">Warning</div>
  <div class="content">This section is very incomplete.</div>
  </div>
  <p>Attributes can be set for each container and piece of content in the document. The general approach is to build an RtfAttributes object containing the various attributes, then pass that RtfAttributes object to the method that creates the new container or content. The following information lists the various attributes that can be set for each type of container.</p>
  </div>
  </div>
    
  </div>
  </td><td width="10"><img width="10" height="1" alt="" src="../skin/images/spacer.gif"></td>
  </tr>
  <!--================= end Content==================-->
  </table>
  </td>
  </tr>
  </table>
  <!--================= end Menu, NavBar, Content ==================-->
  <!--================= start Footer ==================-->
  <table summary="footer" cellspacing="0" cellpadding="0" width="100%" border="0">
  <tr>
  <td colspan="2" height="1" bgcolor="#4C6C8F"><img height="1" width="1" alt="" src="../skin/images/spacer.gif"><a href="../skin/images/label.gif"></a><a href="../skin/images/page.gif"></a><a href="../skin/images/chapter.gif"></a><a href="../skin/images/chapter_open.gif"></a><a href="../skin/images/current.gif"></a><a href="..//favicon.ico"></a></td>
  </tr>
  <tr>
  <td colspan="2" bgcolor="#CFDCED" class="copyright" align="center"><font size="2" face="Arial, Helvetica, Sans-Serif">Copyright &copy;
            1999-2003&nbsp;The Apache Software Foundation. All rights reserved.<script type="text/javascript" language="JavaScript"><!--
                document.write(" - "+"Last Published: " + document.lastModified);
              //  --></script></font></td>
  </tr>
  <tr>
  <td colspan="2" align="left" bgcolor="#CFDCED" class="logos"></td>
  </tr>
  </table>
  <!--================= end Footer ==================-->
  </body>
  </html>
  
  
  
  1.1                  xml-site/targets/fop/dev/rtflib.pdf
  
  	<<Binary file>>
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org


Mime
View raw message