commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tobr...@apache.org
Subject cvs commit: jakarta-commons-sandbox/codec PROPOSAL.html STATUS.html TODO RELEASE-PLAN
Date Mon, 24 Feb 2003 10:48:46 GMT
tobrien     2003/02/24 02:48:45

  Modified:    codec    PROPOSAL.html STATUS.html TODO RELEASE-PLAN
  Log:
  updated project documents
  
  Revision  Changes    Path
  1.5       +85 -70    jakarta-commons-sandbox/codec/PROPOSAL.html
  
  Index: PROPOSAL.html
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/codec/PROPOSAL.html,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- PROPOSAL.html	16 Feb 2003 19:04:03 -0000	1.4
  +++ PROPOSAL.html	24 Feb 2003 10:48:45 -0000	1.5
  @@ -1,76 +1,91 @@
  -<html>
  -<head>
  -<title>Proposal for Codec Package</title>
  -</head>
  -<body bgcolor="white">
  -
  -<div align="center">
  -<h1>Proposal for <em>Codec</em> Package</h1>
  -</div>
  -
  -<h3>(0) Rationale</h3>
  -
  -<p>Many software projects have a need to use various formats of data, and to
  -be able to switch between various formats.  The codec package seeks to 
  -encapsulate some of the most popular encode/decode algorithms in one easy
  -to use, well tested package.  A base64 codec is the first candidate, with 
  -others to follow soon.</p>
  -
  -
  -<h3>(1) Scope of the Package</h3>
  -
  -<p>This proposal is to create a package of Java utility classes for the
  -encoding/decoding of various types of data. A base64 codec will be the
  -first implementation.</p>
  -
  -
  -<h3>(1.5) Interaction With Other Packages</h3>
  +<?xml version="1.0"?>
   
  -<p><em>Codec</em> relies only on standard JDK 1.2 (or later) APIs for
  -production deployment.  It utilizes the JUnit unit testing framework for
  -developing and executing unit tests, but this is of interest only to
  -developers of the component.  Codec will be a dependency for
  -several existing components in the open source world.</p>
  -
  -<p>No external configuration files are utilized.</p>
  -
  -
  -<h3>(2) Initial Source of the Package</h3>
  -
  -<p>The original Java classes (<code>Base64</code>, etc.) are splashed
around
  -various Apache subprojects.  We intend to seek them out and integrate them.</p>
  -
  -<p>The proposed package name for the new component is
  -<code>org.apache.commons.codec</code>.</p>
  -
  -
  -<h3>(3)  Required Jakarta-Commons Resources</h3>
  -
  -<ul>
  -<li>CVS Repository - New directory <code>codec</code> in the
  -    <code>jakarta-commons</code> CVS repository.</li>
  -<li>Mailing List - Discussions will take place on the general
  +<html>
  + <head>
  +  <title>Jakarta Commons-Codec: Proposal</title>
  + </head>
  +
  + <body bgcolor="white">
  +  <div align="center">
  +   <h1>Proposal for <em>Codec</em> Package</h1><br/>
  +   <h4>January 24, 2002</h4>
  +  </div>
  +
  +  <h3>(0) Rationale</h3>
  +  <p>
  +   Many software projects have a need to use various formats of data, 
  +   and to be able to switch between various formats.  The codec package 
  +   seeks to encapsulate some of the most popular encode/decode 
  +   algorithms in one easy to use, well tested package.  A base64 codec 
  +   is the first candidate, with others to follow soon.
  +  </p>
  +
  +  <h3>(1) Scope of the Package</h3>
  +  <p>
  +   This proposal is to create a package of Java utility classes for the
  +   encoding/decoding of various types of data. A base64 codec will be the
  +   first implementation.
  +  </p>
  +
  +  <h3>(1.5) Interaction With Other Packages</h3>
  +
  +  <p>
  +   <em>Codec</em> relies only on standard JDK 1.2 (or later) APIs for
  +   production deployment.  It utilizes the JUnit unit testing framework for
  +   developing and executing unit tests, but this is of interest only to
  +   developers of the component.  Codec will be a dependency for
  +   several existing components in the open source world.
  +  </p>
  +
  +  <p>No external configuration files are utilized.</p>
  +
  +  <h3>(2) Initial Source of the Package</h3>
  +
  +  <p>
  +   The original Java classes (<code>Base64</code>, etc.) are splashed around
  +   various Apache subprojects.  We intend to seek them out and integrate them.
  +  </p>
  +
  +  <p>
  +   The proposed package name for the new component is
  +   <code>org.apache.commons.codec</code>.
  +  </p>
  +
  +  <h3>(3)  Required Jakarta-Commons Resources</h3>
  +
  +  <ul>
  +   <li>
  +    CVS Repository - New directory <code>codec</code> in the
  +    <code>jakarta-commons</code> CVS repository.
  +   </li>
  +   <li>
  +    Mailing List - Discussions will take place on the general
       <em>commons-dev@jakarta.apache.org</em> mailing list.  To help
       list subscribers identify messages of interest, it is suggested that
       the message subject of messages about this component be prefixed with
  -    [Codec].</li>
  -<li>Bugzilla - New component "Codec" under the "Commons" product
  -    category, with appropriate version identifiers as needed.</li>
  -<li>Jyve FAQ - New category "commons-codec" (when available).</li>
  -</ul>
  -
  -
  -<h3>(4) Initial Committers</h3>
  -
  -<p>The initial committers on the Lang component shall be as follows:
  -<ul>
  -<li>Scott Sanders (sanders)</li>
  -<li>Henri Yandell (bayard)</li>
  -<li>Daniel Rall (dlr)</li>
  -<li>Tim O'Brien (tobrien)</li>
  -<!-- Add your real name and user name here -->
  -</ul>
  -</p>
  +    [Codec].
  +   </li>
  +   <li>
  +    Bugzilla - New component "Codec" under the "Commons" product
  +    category, with appropriate version identifiers as needed.
  +   </li>
  +   <li>
  +    Jyve FAQ - New category "commons-codec" (when available).
  +   </li>
  +  </ul>
  +
  +  <h3>(4) Initial Committers</h3>
  +
  +  <p>
  +   The initial committers on the Lang component shall be as follows:
  +   <ul>
  +    <li>Scott Sanders (sanders)</li>
  +    <li>Henri Yandell (bayard)</li>
  +    <li>Daniel Rall (dlr)</li>
  +    <li>Tim O'Brien (tobrien)</li>
  +    <!-- Add your real name and user name here -->
  +   </ul>
  +  </p>
   
  -</body>
  + </body>
   </html>
  
  
  
  1.3       +128 -94   jakarta-commons-sandbox/codec/STATUS.html
  
  Index: STATUS.html
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/codec/STATUS.html,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- STATUS.html	22 Feb 2002 05:27:33 -0000	1.2
  +++ STATUS.html	24 Feb 2003 10:48:45 -0000	1.3
  @@ -1,98 +1,132 @@
  +<?xml version="1.0"?>
  +
   <html>
  -<head>
  -<title>Status File for Jakarta Commons "Codec" Component</title>
  -</head>
  -<body bgcolor="white">
  -
  -
  -<div align="center">
  -<h1>The Jakarta Commons <em>Codec</em> Component</h1>
  -$Id$<br />
  -<a href="#Introduction">[Introduction]</a>
  -<a href="#Dependencies">[Dependencies]</a>
  -<a href="#Release Info">[Release Info]</a>
  -<a href="#Committers">[Committers]</a>
  -<a href="#Action Items">[Action Items]</a>
  -<br /><br />
  -</div>
  -
  -
  -<a name="Introduction"></a>
  -<h3>1.  INTRODUCTION</h3>
  -
  -<p>The <em>Codec</em> Component contains a set of Java classes that provide
  -encode/decode functionality and helper methods for various data formats.  
  -The following classes are included:</p>
  -<ul>
  -<li><strong>Base64</strong> - Encoding/decoding of the popular base64
format.</li>
  -<li><strong>Soundex</strong> - Encoding of Strings to soundex values.</li>
  -<li><strong>Metaphone</strong> - Encoding of Strings to metaphone values,
a more advanced soundex-like algorithm.</li>
  -</ul>
  -
  -
  -<a name="Dependencies"></a>
  -<h3>2.  DEPENDENCIES</h3>
  -
  -<p>The <em>Codec</em> component is dependent upon the following external
  -components for development and use:</p>
  -<ul>
  -<li><a href="http://java.sun.com/j2se">Java Development Kit</a>
  -    (Version 1.2 or later)</li>
  -<li><a href="http://www.junit.org">JUnit Testing Framework</a>
  -    (Version 3.7 or later) - for unit tests only, not required
  -    for deployment</li>
  -</ul>
  -
  -
  -<a name="Release Info"></a>
  -<h3>3.  RELEASE INFO</h3>
  -
  -<p>Current Release: Codec is yet to be released.  We hope it will be RSN.</p>
  -
  -<p>Planned Next Release:  Real Soon Now :)  See the
  -<a href="#Action Items">Action Items</a> list for tasks that need to be
  -completed prior to this release.</p>
  -
  -
  -<a name="Committers"></a>
  -<h3>4.  COMMITTERS</h3>
  -
  -<p>The following individuals are the primary developers and maintainers of this
  -component.  Developers who plan to use <em>Codec</em> in their own
  -projects are encouraged to collaborate on the future development of this
  -component to ensure that it continues to meet a variety of needs.</p>
  -<ul>
  -<li><a href="mailto:sanders@apache.org">Scott Sanders</a></li>
  -<li><a href="mailto:bayard@apache.org">Henri Yandell</a></li>
  -<li>Fancy volunteering?  We need you!</li>
  -</ul>
  -
  -
  -<a name="Action Items"></a>
  -<h3>5.  ACTION ITEMS</h3>
  -
  -<p>The following action items need to be completed prior to a Version 1.3
  -release of this component:</p>
  -
  -<table border="1">
  -
  -  <tr>
  -    <th width="80%">Action Item</th>
  -    <th width="20%">Volunteer</th>
  -  </tr>
  -
  -  <tr>
  -    <td><strong>Integration</strong>.  Seek and integrate various codec
related classes.</td>
  -    <td align="center">Everyone</td>
  -  </tr>
  -
  -  <tr>
  -    <td><strong>Install / Use Documentation</strong>.  Create simple
  -        installation and User's Guide documentation for this component.</td>
  -    <td align="center">scott</td>
  -  </tr>
  + <head>
  +  <title>Jakarta Commons-Codec: Status</title>
  + </head>
  +
  + <body bgcolor="white">
  +  <div align="center">
  +   <h1>The Jakarta Commons <em>Codec</em> Component</h1>
  +   $Id$<br/>
  +   <a href="#Introduction">[Introduction]</a>
  +   <a href="#Dependencies">[Dependencies]</a>
  +   <a href="#Release Info">[Release Info]</a>
  +   <a href="#Committers">[Committers]</a>
  +   <a href="#Action Items">[Action Items]</a>
  +   <br/><br/>
  +  </div>
  +
  +  <a name="Introduction"></a>
  +  <h3>1.  INTRODUCTION</h3>
  +
  +  <p>
  +   The <em>Codec</em> Component contains a set of Java classes that provide
  +   encode/decode functionality and helper methods for various data formats.  
  +   The following classes are included:
  +   <ul>
  +    <li>Binary Encoders/Decoders
  +     <ul>
  +      <li><strong>Base64</strong> - Encoding/decoding of the popular
base64 format.</li>
  +     </ul>
  +    </li>
  +    <li>Phonetic Encoders
  +     <ul>
  +      <li><strong>Soundex</strong> - Encoding of Strings to soundex values.</li>
  +      <li><strong>Metaphone</strong> - Encoding of Strings to metaphone
values, a more 
  +          advanced soundex-like algorithm.</li>
  +      <li><strong>RefinedSoundex</strong></li>
  +      <li><strong>DoubleMetaphone</strong></li>
  +      <li><strong>Nysiis</strong></li>
  +     </ul>
  +    </li>
  +   </ul>
  +  </p>
  +
  +  <a name="Dependencies"></a>
  +  <h3>2.  DEPENDENCIES</h3>
  +
  +  <p>
  +   The <em>Codec</em> component is dependent upon the following external
  +   components for development and use:
  +  </p>
  +
  +  <table border="1" width="600">
  +   <tr>
  +    <td width="33%" rowspan="2" valign="middle" align="center">Component</td>
  +    <td width="10%" rowspan="2" valign="middle" align="center">Version</td>
  +    <td width="50%" colspan="3" align="center">Dependency</td>
  +    <td width="7%" rowspan="2" valign="middle" align="center">Distribute</td>
  +   </tr>
  +   <tr>
  +    <td align="center">
  +     Compilation
  +    </td>
  +    <td align="center">
  +     Runtime
  +    </td>
  +    <td align="center">
  +     Testing
  +    </td>
  +   </tr>
  +   <tr>
  +    <td align="right">
  +     <a href="http://java.sun.com/j2se">Java Development Kit</a>
  +    </td>
  +    <td align="center">1.2+</td>
  +    <td align="center" colspan="3" bgcolor="green">Yes</td>
  +    <td align="center"><b>No</b></td>
  +   </tr>
  +   <tr>
  +    <td align="right">
  +     <a href="http://www.junit.org">JUnit Testing Framework</a>
  +    </td>
  +    <td align="center">3.7+</td>
  +    <td align="center" colspan="2" bgcolor="red">No</td>
  +    <td align="center" bgcolor="green">Yes</td>
  +    <td align="center"><b>No</b></td>
  +   </tr>
  +  </table>
  +
  +
  +
  +  <a name="Release Info"></a>
  +  <h3>3.  RELEASE INFO</h3>
  +
  +  <p>
  +   Current Release: Codec is a project in the Jakarta Commons Sandbox and does not
  +   currently have a quality release.  Please see RELEASE-PLAN for details about
  +   the upcoming March 2003 release.
  +  </p>
  +
  +  <p>
  +   Planned Next Release: <b>1.1 March 2003</b>
  +  </p>
  +
  +  <a name="Committers"></a>
  +  <h3>4.  COMMITTERS</h3>
  +
  +  <p>
  +   The following individuals are the primary developers and maintainers of this
  +   component.  Developers who plan to use <em>Codec</em> in their own
  +   projects are encouraged to collaborate on the future development of this
  +   component to ensure that it continues to meet a variety of needs.
  +  </p>
  +
  +  <ul>
  +   <li><a href="mailto:sanders@apache.org">Scott Sanders</a></li>
  +   <li><a href="mailto:bayard@apache.org">Henri Yandell</a></li>
  +   <li><a href="mailto:tobrien@apache.org">Tim O'Brien</li>
  +  </ul>
  +
  +  <a name="Action Items"></a>
  +  <h3>5.  ACTION ITEMS</h3>
  +
  +  <p>
  +   Please see the file TODO for more information.
  +  </p>
   
  -</table>
  +  </table>
   
  -</body>
  + </body>
   </html>
  
  
  
  1.9       +3 -3      jakarta-commons-sandbox/codec/TODO
  
  Index: TODO
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/codec/TODO,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- TODO	8 Feb 2003 20:40:38 -0000	1.8
  +++ TODO	24 Feb 2003 10:48:45 -0000	1.9
  @@ -25,9 +25,7 @@
   
   * Add a Rot13 implementation to text package 
   
  -* Add a Decoder interface 
   
  -* Refactor Base64 to implement both Encoder and Decoder 
   
   * Documentation! Create Forrest documentation for Codec AFTER documentation has evolved
in Wiki 
   
  @@ -49,8 +47,10 @@
   
   * add more documentation to Base64
   
  -** DONE 
  +** DONE (this list will help us generate RELEASE-NOTES when it comes time for a release)
   
  +2/1?/03 - TOB - * Refactor Base64 to implement both Encoder and Decoder 
  +2/1?/03 - TOB - * Add a Decoder interface 
   2/7/03 - TOB - Removed all deprecated classes this includes
                  base64.Base64
                  .Soundex, .RefinedSoundex, and .DoubleMetaphone
  
  
  
  1.2       +9 -6      jakarta-commons-sandbox/codec/RELEASE-PLAN
  
  Index: RELEASE-PLAN
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/codec/RELEASE-PLAN,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- RELEASE-PLAN	4 Feb 2003 06:37:42 -0000	1.1
  +++ RELEASE-PLAN	24 Feb 2003 10:48:45 -0000	1.2
  @@ -1,4 +1,7 @@
  +$Id$
  +
   Jakarta Commons Codec  
  +
   *** Release Plan
   
   This document outline the current goals for the next release.  
  @@ -23,19 +26,19 @@
   
   * As described in the TODO
   
  -Codec 1.1 Beta:
  +Codec 1.1 Release Candidate`1:
   
  -* Code freeze date: Feb 15, 2003
  -* Tag date: Feb 17, 2003
  +* Code freeze date: Mar 1, 2003
  +* Tag date: Mar 8, 2003
   * Goals:
       * Cut a release which can be used to as the base for performing
         tests and reporting bugs. 
       * Evaluate and clean up as many bugs that are there
         jakarta.apache.org/bugs.
   
  -Codec 1.1 Final:
  +Codec 1.1 Final (Tentative):
   
  -* Code freeze date: Feb 25, 2003
  +* Code freeze date: Mar 25, 2003
   * Tag date: Mar 1, 2003
   * Goals:
       * Fix bugs reported on the beta and subsequent builds. 
  @@ -43,5 +46,5 @@
         called "final".
       * Build out documentation using Forrest
   
  -* Release Manager: To be determined
  +* Release Manager: Tim O'Brien <tobrien@apache.org>
   
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message